Browse Source

Audio removals;

bjorn 4 years ago
parent
commit
c4861ff500

+ 0 - 476
api/init.lua

@@ -74,36 +74,6 @@ return {
             "lovr.audio.newSource"
           },
           methods = {
-            {
-              name = "getCone",
-              summary = "Get the Source's volume cone.",
-              description = "Returns the directional volume cone of the Source.  The cone is specified by three values: `innerAngle`, `outerAngle`, and `outerVolume`.  If the listener is inside the `innerAngle`, the Source won't have its volume reduced.  Otherwise, the volume will start to decrease, reaching a minimum volume of `outerVolume` once the listener is `outerAngle` degrees from the direction of the Source.",
-              key = "Source:getCone",
-              module = "lovr.audio",
-              notes = "The default `innerAngle` for a Source is `0`.\n\nThe default `outerAngle` for a Source is `2 * math.pi`.\n\nThe default `outerVolume` for a Source is `0`.\n\n`Source:setOrientation` can be used to change which way the cone points.",
-              variants = {
-                {
-                  arguments = {},
-                  returns = {
-                    {
-                      name = "innerAngle",
-                      type = "number",
-                      description = "The inner cone angle, in radians."
-                    },
-                    {
-                      name = "outerAngle",
-                      type = "number",
-                      description = "The outer cone angle, in radians."
-                    },
-                    {
-                      name = "outerVolume",
-                      type = "number",
-                      description = "The outer cone angle, in radians."
-                    }
-                  }
-                }
-              }
-            },
             {
               name = "getDuration",
               summary = "Get the duration of the Source.",
@@ -133,39 +103,6 @@ return {
                 }
               }
             },
-            {
-              name = "getFalloff",
-              summary = "Get the falloff parameters for the Source.",
-              description = "Returns parameters that control how the volume of the Source falls of with distance.",
-              key = "Source:getFalloff",
-              module = "lovr.audio",
-              related = {
-                "Source:getVolumeLimits",
-                "Source:setVolumeLimits"
-              },
-              variants = {
-                {
-                  arguments = {},
-                  returns = {
-                    {
-                      name = "reference",
-                      type = "number",
-                      description = "The distance at which the volume will start to decrease."
-                    },
-                    {
-                      name = "max",
-                      type = "number",
-                      description = "The distance at which the Source will be its quietest."
-                    },
-                    {
-                      name = "rolloff",
-                      type = "number",
-                      description = "How quickly the sound falls off between the reference and max distances (1.0 is the default)."
-                    }
-                  }
-                }
-              }
-            },
             {
               name = "getOrientation",
               summary = "Get the orientation of the Source.",
@@ -206,25 +143,6 @@ return {
                 }
               }
             },
-            {
-              name = "getPitch",
-              summary = "Get the pitch of the Source.",
-              description = "Returns the current pitch factor of the Source.  The default is 1.0.",
-              key = "Source:getPitch",
-              module = "lovr.audio",
-              variants = {
-                {
-                  arguments = {},
-                  returns = {
-                    {
-                      name = "pitch",
-                      type = "number",
-                      description = "The current pitch."
-                    }
-                  }
-                }
-              }
-            },
             {
               name = "getPose",
               summary = "Get the pose of the Source.",
@@ -315,36 +233,6 @@ return {
                 }
               }
             },
-            {
-              name = "getVelocity",
-              summary = "Get the velocity of the Source.",
-              description = "Returns the velocity of the Source, in meters per second.  This affects the doppler effect.",
-              key = "Source:getVelocity",
-              module = "lovr.audio",
-              notes = "The Source does not move based on its velocity.",
-              variants = {
-                {
-                  arguments = {},
-                  returns = {
-                    {
-                      name = "x",
-                      type = "number",
-                      description = "The x velocity."
-                    },
-                    {
-                      name = "y",
-                      type = "number",
-                      description = "The y velocity."
-                    },
-                    {
-                      name = "z",
-                      type = "number",
-                      description = "The z velocity."
-                    }
-                  }
-                }
-              }
-            },
             {
               name = "getVolume",
               summary = "Get the volume of the Source.",
@@ -364,30 +252,6 @@ return {
                 }
               }
             },
-            {
-              name = "getVolumeLimits",
-              summary = "Get the volume limits of the Source.",
-              description = "Returns the minimum and maximum volume of the Source.  These limits have priority over the parameters set by `Source:setFalloff` and `Source:setCone`, so they can be used to make sure a Source can always be heard even if it's far away.",
-              key = "Source:getVolumeLimits",
-              module = "lovr.audio",
-              variants = {
-                {
-                  arguments = {},
-                  returns = {
-                    {
-                      name = "min",
-                      type = "number",
-                      description = "The minimum volume of the Source."
-                    },
-                    {
-                      name = "max",
-                      type = "number",
-                      description = "The maximum volume of the Source."
-                    }
-                  }
-                }
-              }
-            },
             {
               name = "isLooping",
               summary = "Check if the Source is looping.",
@@ -426,25 +290,6 @@ return {
                 }
               }
             },
-            {
-              name = "isRelative",
-              summary = "Check if the Source is relative to the listener.",
-              description = "Returns whether or not the Source is relative to the listener.  If a Source is relative then its position, velocity, cone, and orientation are all treated as relative to the audio listener, instead of absolute positions in space.",
-              key = "Source:isRelative",
-              module = "lovr.audio",
-              variants = {
-                {
-                  arguments = {},
-                  returns = {
-                    {
-                      name = "relative",
-                      type = "boolean",
-                      description = "Whether or not the Source is relative."
-                    }
-                  }
-                }
-              }
-            },
             {
               name = "pause",
               summary = "Pause the Source.",
@@ -497,69 +342,6 @@ return {
                 }
               }
             },
-            {
-              name = "setCone",
-              summary = "Set the Source's volume cone.",
-              description = "Sets the directional volume cone of the Source.  The cone is specified by three values: `innerAngle`, `outerAngle`, and `outerVolume`.  If the listener is inside the `innerAngle`, the Source won't have its volume changed.  Otherwise, the volume will start to decrease, reaching a minimum volume of `outerVolume` once the listener is `outerAngle` degrees from the direction of the Source.",
-              key = "Source:setCone",
-              module = "lovr.audio",
-              notes = "The default `innerAngle` for a Source is `0`.\n\nThe default `outerAngle` for a Source is `2 * math.pi`.\n\nThe default `outerVolume` for a Source is `0`.\n\nThe direction of the cone can be changed using `Source:setOrientation`.",
-              variants = {
-                {
-                  arguments = {
-                    {
-                      name = "innerAngle",
-                      type = "number",
-                      description = "The inner cone angle, in radians."
-                    },
-                    {
-                      name = "outerAngle",
-                      type = "number",
-                      description = "The outer cone angle, in radians."
-                    },
-                    {
-                      name = "outerVolume",
-                      type = "number",
-                      description = "The outer cone angle, in radians."
-                    }
-                  },
-                  returns = {}
-                }
-              }
-            },
-            {
-              name = "setFalloff",
-              summary = "Set the falloff parameters for the Source.",
-              description = "Sets parameters that control how the volume of the Source falls of with distance.\n\nOnly mono sources support positional falloff.  Using this function on a stereo Source will cause an error.",
-              key = "Source:setFalloff",
-              module = "lovr.audio",
-              related = {
-                "Source:getVolumeLimits",
-                "Source:setVolumeLimits"
-              },
-              variants = {
-                {
-                  arguments = {
-                    {
-                      name = "reference",
-                      type = "number",
-                      description = "The distance at which the volume will start to decrease."
-                    },
-                    {
-                      name = "max",
-                      type = "number",
-                      description = "The distance at which the Source will be its quietest."
-                    },
-                    {
-                      name = "rolloff",
-                      type = "number",
-                      description = "How quickly the sound falls off between the reference and max distances (1.0 is the default)."
-                    }
-                  },
-                  returns = {}
-                }
-              }
-            },
             {
               name = "setLooping",
               summary = "Set whether or not the Source loops.",
@@ -619,25 +401,6 @@ return {
                 }
               }
             },
-            {
-              name = "setPitch",
-              summary = "Set the pitch of the Source.",
-              description = "Sets the pitch of the Source.  The default is 1.0.",
-              key = "Source:setPitch",
-              module = "lovr.audio",
-              variants = {
-                {
-                  arguments = {
-                    {
-                      name = "pitch",
-                      type = "number",
-                      description = "The new pitch."
-                    }
-                  },
-                  returns = {}
-                }
-              }
-            },
             {
               name = "setPose",
               summary = "Set the pose of the Source.",
@@ -721,55 +484,6 @@ return {
                 }
               }
             },
-            {
-              name = "setRelative",
-              summary = "Set whether or not the Source is relative.",
-              description = "Sets whether or not the Source is relative to the listener.  If a Source is relative then its position, velocity, cone, and orientation are all treated as relative to the audio listener.",
-              key = "Source:setRelative",
-              module = "lovr.audio",
-              variants = {
-                {
-                  arguments = {
-                    {
-                      name = "relative",
-                      type = "boolean",
-                      description = "Whether or not the Source should be relative."
-                    }
-                  },
-                  returns = {}
-                }
-              }
-            },
-            {
-              name = "setVelocity",
-              summary = "Set the velocity of the Source.",
-              description = "Sets the velocity of the Source, in meters per second.  This affects the doppler effect.",
-              key = "Source:setVelocity",
-              module = "lovr.audio",
-              notes = "The Source does not move based on its velocity.",
-              variants = {
-                {
-                  arguments = {
-                    {
-                      name = "x",
-                      type = "number",
-                      description = "The x velocity."
-                    },
-                    {
-                      name = "y",
-                      type = "number",
-                      description = "The y velocity."
-                    },
-                    {
-                      name = "z",
-                      type = "number",
-                      description = "The z velocity."
-                    }
-                  },
-                  returns = {}
-                }
-              }
-            },
             {
               name = "setVolume",
               summary = "Set the volume of the Source.",
@@ -789,30 +503,6 @@ return {
                 }
               }
             },
-            {
-              name = "setVolumeLimits",
-              summary = "Set the volume limits of the Source.",
-              description = "Sets the minimum and maximum volume of the Source.  These limits have priority over the parameters set by `Source:setFalloff` and `Source:setCone`, so they can be used to make sure a Source can always be heard even if it's far away.",
-              key = "Source:setVolumeLimits",
-              module = "lovr.audio",
-              variants = {
-                {
-                  arguments = {
-                    {
-                      name = "min",
-                      type = "number",
-                      description = "The minimum volume of the Source."
-                    },
-                    {
-                      name = "max",
-                      type = "number",
-                      description = "The maximum volume of the Source."
-                    }
-                  },
-                  returns = {}
-                }
-              }
-            },
             {
               name = "stop",
               summary = "Stop the Source.",
@@ -861,32 +551,6 @@ return {
         }
       },
       functions = {
-        {
-          name = "getDopplerEffect",
-          tag = "listener",
-          summary = "Get the doppler effect parameters.",
-          description = "Returns the parameters that control the simulated doppler effect.",
-          key = "lovr.audio.getDopplerEffect",
-          module = "lovr.audio",
-          notes = "The default factor is 1.0 and the default speed of sound is 343.29.",
-          variants = {
-            {
-              arguments = {},
-              returns = {
-                {
-                  name = "factor",
-                  type = "number",
-                  description = "The doppler effect scaling factor."
-                },
-                {
-                  name = "speedOfSound",
-                  type = "number",
-                  description = "The speed of sound, in meters per second."
-                }
-              }
-            }
-          }
-        },
         {
           name = "getOrientation",
           tag = "listener",
@@ -1035,37 +699,6 @@ return {
             }
           }
         },
-        {
-          name = "getVelocity",
-          tag = "listener",
-          summary = "Get the velocity of the audio listener.",
-          description = "Returns the velocity of the audio listener, in meters per second.  This affects the doppler effect.",
-          key = "lovr.audio.getVelocity",
-          module = "lovr.audio",
-          notes = "The audio listener does not move based on its velocity.",
-          variants = {
-            {
-              arguments = {},
-              returns = {
-                {
-                  name = "x",
-                  type = "number",
-                  description = "The x velocity."
-                },
-                {
-                  name = "y",
-                  type = "number",
-                  description = "The y velocity."
-                },
-                {
-                  name = "z",
-                  type = "number",
-                  description = "The z velocity."
-                }
-              }
-            }
-          }
-        },
         {
           name = "getVolume",
           tag = "listener",
@@ -1139,51 +772,6 @@ return {
             }
           }
         },
-        {
-          name = "pause",
-          tag = "sources",
-          summary = "Pause all Sources.",
-          description = "Pause all playing audio Sources.",
-          key = "lovr.audio.pause",
-          module = "lovr.audio",
-          related = {
-            "lovr.audio.stop"
-          },
-          variants = {
-            {
-              arguments = {},
-              returns = {}
-            }
-          }
-        },
-        {
-          name = "setDopplerEffect",
-          tag = "listener",
-          summary = "Set the doppler effect parameters.",
-          description = "Sets the parameters that control the simulated doppler effect: The effect intensity and the speed of sound.",
-          key = "lovr.audio.setDopplerEffect",
-          module = "lovr.audio",
-          notes = "The default factor is 1.0 and the default speed of sound is 343.29.",
-          variants = {
-            {
-              arguments = {
-                {
-                  name = "factor",
-                  type = "number",
-                  description = "The doppler effect scaling factor.",
-                  default = "1.0"
-                },
-                {
-                  name = "speedOfSound",
-                  type = "number",
-                  description = "The speed of sound, in meters per second.",
-                  default = "343.29"
-                }
-              },
-              returns = {}
-            }
-          }
-        },
         {
           name = "setOrientation",
           tag = "listener",
@@ -1305,37 +893,6 @@ return {
             }
           }
         },
-        {
-          name = "setVelocity",
-          tag = "listener",
-          summary = "Set the velocity of the audio listener.",
-          description = "Sets the velocity of the audio listener, in meters per second.  This affects the doppler effect.",
-          key = "lovr.audio.setVelocity",
-          module = "lovr.audio",
-          notes = "The audio listener does not move based on its velocity.",
-          variants = {
-            {
-              arguments = {
-                {
-                  name = "x",
-                  type = "number",
-                  description = "The x velocity."
-                },
-                {
-                  name = "y",
-                  type = "number",
-                  description = "The y velocity."
-                },
-                {
-                  name = "z",
-                  type = "number",
-                  description = "The z velocity."
-                }
-              },
-              returns = {}
-            }
-          }
-        },
         {
           name = "setVolume",
           tag = "listener",
@@ -1356,39 +913,6 @@ return {
               }
             }
           }
-        },
-        {
-          name = "stop",
-          tag = "sources",
-          summary = "Stop all Sources.",
-          description = "Stops all audio.",
-          key = "lovr.audio.stop",
-          module = "lovr.audio",
-          notes = "If you want to resume the stopped audio later, see `lovr.audio.pause`.",
-          related = {
-            "Source:stop",
-            "lovr.audio.pause"
-          },
-          variants = {
-            {
-              arguments = {},
-              returns = {}
-            }
-          }
-        },
-        {
-          name = "update",
-          tag = "sources",
-          summary = "Updates the audio system.",
-          description = "Updates all playing sources. This must be called regularly for audio playback to occur. This is called automatically by the default implementation of `lovr.run`.",
-          key = "lovr.audio.update",
-          module = "lovr.audio",
-          variants = {
-            {
-              arguments = {},
-              returns = {}
-            }
-          }
         }
       },
       enums = {

+ 0 - 37
api/lovr/audio/Source/getCone.lua

@@ -1,37 +0,0 @@
-return {
-  summary = 'Get the Source\'s volume cone.',
-  description = [[
-    Returns the directional volume cone of the Source.  The cone is specified by three values:
-    `innerAngle`, `outerAngle`, and `outerVolume`.  If the listener is inside the `innerAngle`, the
-    Source won't have its volume reduced.  Otherwise, the volume will start to decrease, reaching a
-    minimum volume of `outerVolume` once the listener is `outerAngle` degrees from the direction of
-    the Source.
-  ]],
-  arguments = {},
-  returns = {
-    {
-      name = 'innerAngle',
-      type = 'number',
-      description = 'The inner cone angle, in radians.'
-    },
-    {
-      name = 'outerAngle',
-      type = 'number',
-      description = 'The outer cone angle, in radians.'
-    },
-    {
-      name = 'outerVolume',
-      type = 'number',
-      description = 'The outer cone angle, in radians.'
-    }
-  },
-  notes = [[
-    The default `innerAngle` for a Source is `0`.
-
-    The default `outerAngle` for a Source is `2 * math.pi`.
-
-    The default `outerVolume` for a Source is `0`.
-
-    `Source:setOrientation` can be used to change which way the cone points.
-  ]]
-}

+ 0 - 31
api/lovr/audio/Source/getFalloff.lua

@@ -1,31 +0,0 @@
-return {
-  summary = 'Get the falloff parameters for the Source.',
-  description = [[
-    Returns parameters that control how the volume of the Source falls of with distance.
-  ]],
-  arguments = {},
-  returns = {
-    {
-      name = 'reference',
-      type = 'number',
-      description = 'The distance at which the volume will start to decrease.'
-    },
-    {
-      name = 'max',
-      type = 'number',
-      description = 'The distance at which the Source will be its quietest.'
-    },
-    {
-      name = 'rolloff',
-      type = 'number',
-      description = [[
-        How quickly the sound falls off between the reference and max distances (1.0 is the
-        default).
-      ]]
-    }
-  },
-  related = {
-    'Source:getVolumeLimits',
-    'Source:setVolumeLimits'
-  }
-}

+ 0 - 12
api/lovr/audio/Source/getPitch.lua

@@ -1,12 +0,0 @@
-return {
-  summary = 'Get the pitch of the Source.',
-  description = 'Returns the current pitch factor of the Source.  The default is 1.0.',
-  arguments = {},
-  returns = {
-    {
-      name = 'pitch',
-      type = 'number',
-      description = 'The current pitch.'
-    }
-  }
-}

+ 0 - 25
api/lovr/audio/Source/getVelocity.lua

@@ -1,25 +0,0 @@
-return {
-  summary = 'Get the velocity of the Source.',
-  description = [[
-    Returns the velocity of the Source, in meters per second.  This affects the doppler effect.
-  ]],
-  arguments = {},
-  returns = {
-    {
-      name = 'x',
-      type = 'number',
-      description = 'The x velocity.'
-    },
-    {
-      name = 'y',
-      type = 'number',
-      description = 'The y velocity.'
-    },
-    {
-      name = 'z',
-      type = 'number',
-      description = 'The z velocity.'
-    }
-  },
-  notes = 'The Source does not move based on its velocity.'
-}

+ 0 - 21
api/lovr/audio/Source/getVolumeLimits.lua

@@ -1,21 +0,0 @@
-return {
-  summary = 'Get the volume limits of the Source.',
-  description = [[
-    Returns the minimum and maximum volume of the Source.  These limits have priority over the
-    parameters set by `Source:setFalloff` and `Source:setCone`, so they can be used to make sure a
-    Source can always be heard even if it's far away.
-  ]],
-  arguments = {},
-  returns = {
-    {
-      name = 'min',
-      type = 'number',
-      description = 'The minimum volume of the Source.'
-    },
-    {
-      name = 'max',
-      type = 'number',
-      description = 'The maximum volume of the Source.'
-    }
-  }
-}

+ 0 - 16
api/lovr/audio/Source/isRelative.lua

@@ -1,16 +0,0 @@
-return {
-  summary = 'Check if the Source is relative to the listener.',
-  description = [[
-    Returns whether or not the Source is relative to the listener.  If a Source is relative then its
-    position, velocity, cone, and orientation are all treated as relative to the audio listener,
-    instead of absolute positions in space.
-  ]],
-  arguments = {},
-  returns = {
-    {
-      name = 'relative',
-      type = 'boolean',
-      description = 'Whether or not the Source is relative.'
-    }
-  }
-}

+ 0 - 37
api/lovr/audio/Source/setCone.lua

@@ -1,37 +0,0 @@
-return {
-  summary = 'Set the Source\'s volume cone.',
-  description = [[
-    Sets the directional volume cone of the Source.  The cone is specified by three values:
-    `innerAngle`, `outerAngle`, and `outerVolume`.  If the listener is inside the `innerAngle`, the
-    Source won't have its volume changed.  Otherwise, the volume will start to decrease, reaching a
-    minimum volume of `outerVolume` once the listener is `outerAngle` degrees from the direction of
-    the Source.
-  ]],
-  arguments = {
-    {
-      name = 'innerAngle',
-      type = 'number',
-      description = 'The inner cone angle, in radians.'
-    },
-    {
-      name = 'outerAngle',
-      type = 'number',
-      description = 'The outer cone angle, in radians.'
-    },
-    {
-      name = 'outerVolume',
-      type = 'number',
-      description = 'The outer cone angle, in radians.'
-    }
-  },
-  returns = {},
-  notes = [[
-    The default `innerAngle` for a Source is `0`.
-
-    The default `outerAngle` for a Source is `2 * math.pi`.
-
-    The default `outerVolume` for a Source is `0`.
-
-    The direction of the cone can be changed using `Source:setOrientation`.
-  ]]
-}

+ 0 - 34
api/lovr/audio/Source/setFalloff.lua

@@ -1,34 +0,0 @@
-return {
-  summary = 'Set the falloff parameters for the Source.',
-  description = [[
-    Sets parameters that control how the volume of the Source falls of with distance.
-
-    Only mono sources support positional falloff.  Using this function on a stereo Source will cause
-    an error.
-  ]],
-  arguments = {
-    {
-      name = 'reference',
-      type = 'number',
-      description = 'The distance at which the volume will start to decrease.'
-    },
-    {
-      name = 'max',
-      type = 'number',
-      description = 'The distance at which the Source will be its quietest.'
-    },
-    {
-      name = 'rolloff',
-      type = 'number',
-      description = [[
-        How quickly the sound falls off between the reference and max distances (1.0 is the
-        default).
-      ]]
-    }
-  },
-  returns = {},
-  related = {
-    'Source:getVolumeLimits',
-    'Source:setVolumeLimits'
-  }
-}

+ 0 - 12
api/lovr/audio/Source/setPitch.lua

@@ -1,12 +0,0 @@
-return {
-  summary = 'Set the pitch of the Source.',
-  description = 'Sets the pitch of the Source.  The default is 1.0.',
-  arguments = {
-    {
-      name = 'pitch',
-      type = 'number',
-      description = 'The new pitch.'
-    }
-  },
-  returns = {}
-}

+ 0 - 15
api/lovr/audio/Source/setRelative.lua

@@ -1,15 +0,0 @@
-return {
-  summary = 'Set whether or not the Source is relative.',
-  description = [[
-    Sets whether or not the Source is relative to the listener.  If a Source is relative then its
-    position, velocity, cone, and orientation are all treated as relative to the audio listener.
-  ]],
-  arguments = {
-    {
-      name = 'relative',
-      type = 'boolean',
-      description = 'Whether or not the Source should be relative.'
-    }
-  },
-  returns = {}
-}

+ 0 - 25
api/lovr/audio/Source/setVelocity.lua

@@ -1,25 +0,0 @@
-return {
-  summary = 'Set the velocity of the Source.',
-  description = [[
-    Sets the velocity of the Source, in meters per second.  This affects the doppler effect.
-  ]],
-  arguments = {
-    {
-      name = 'x',
-      type = 'number',
-      description = 'The x velocity.'
-    },
-    {
-      name = 'y',
-      type = 'number',
-      description = 'The y velocity.'
-    },
-    {
-      name = 'z',
-      type = 'number',
-      description = 'The z velocity.'
-    }
-  },
-  returns = {},
-  notes = 'The Source does not move based on its velocity.'
-}

+ 0 - 21
api/lovr/audio/Source/setVolumeLimits.lua

@@ -1,21 +0,0 @@
-return {
-  summary = 'Set the volume limits of the Source.',
-  description = [[
-    Sets the minimum and maximum volume of the Source.  These limits have priority over the
-    parameters set by `Source:setFalloff` and `Source:setCone`, so they can be used to make sure a
-    Source can always be heard even if it's far away.
-  ]],
-  arguments = {
-    {
-      name = 'min',
-      type = 'number',
-      description = 'The minimum volume of the Source.'
-    },
-    {
-      name = 'max',
-      type = 'number',
-      description = 'The maximum volume of the Source.'
-    }
-  },
-  returns = {}
-}

+ 0 - 19
api/lovr/audio/getDopplerEffect.lua

@@ -1,19 +0,0 @@
-return {
-  tag = 'listener',
-  summary = 'Get the doppler effect parameters.',
-  description = 'Returns the parameters that control the simulated doppler effect.',
-  arguments = {},
-  returns = {
-    {
-      name = 'factor',
-      type = 'number',
-      description = 'The doppler effect scaling factor.'
-    },
-    {
-      name = 'speedOfSound',
-      type = 'number',
-      description = 'The speed of sound, in meters per second.'
-    }
-  },
-  notes = 'The default factor is 1.0 and the default speed of sound is 343.29.'
-}

+ 0 - 27
api/lovr/audio/getVelocity.lua

@@ -1,27 +0,0 @@
-return {
-  tag = 'listener',
-  summary = 'Get the velocity of the audio listener.',
-  description = [[
-    Returns the velocity of the audio listener, in meters per second.  This affects the doppler
-    effect.
-  ]],
-  arguments = {},
-  returns = {
-    {
-      name = 'x',
-      type = 'number',
-      description = 'The x velocity.'
-    },
-    {
-      name = 'y',
-      type = 'number',
-      description = 'The y velocity.'
-    },
-    {
-      name = 'z',
-      type = 'number',
-      description = 'The z velocity.'
-    }
-  },
-  notes = 'The audio listener does not move based on its velocity.'
-}

+ 0 - 10
api/lovr/audio/pause.lua

@@ -1,10 +0,0 @@
-return {
-  tag = 'sources',
-  summary = 'Pause all Sources.',
-  description = 'Pause all playing audio Sources.',
-  arguments = {},
-  returns = {},
-  related = {
-    'lovr.audio.stop'
-  }
-}

+ 0 - 24
api/lovr/audio/setDopplerEffect.lua

@@ -1,24 +0,0 @@
-return {
-  tag = 'listener',
-  summary = 'Set the doppler effect parameters.',
-  description = [[
-    Sets the parameters that control the simulated doppler effect: The effect intensity and the
-    speed of sound.
-  ]],
-  arguments = {
-    {
-      name = 'factor',
-      type = 'number',
-      default = '1.0',
-      description = 'The doppler effect scaling factor.'
-    },
-    {
-      name = 'speedOfSound',
-      type = 'number',
-      default = '343.29',
-      description = 'The speed of sound, in meters per second.'
-    }
-  },
-  returns = {},
-  notes = 'The default factor is 1.0 and the default speed of sound is 343.29.'
-}

+ 0 - 27
api/lovr/audio/setVelocity.lua

@@ -1,27 +0,0 @@
-return {
-  tag = 'listener',
-  summary = 'Set the velocity of the audio listener.',
-  description = [[
-    Sets the velocity of the audio listener, in meters per second.  This affects the doppler
-    effect.
-  ]],
-  arguments = {
-    {
-      name = 'x',
-      type = 'number',
-      description = 'The x velocity.'
-    },
-    {
-      name = 'y',
-      type = 'number',
-      description = 'The y velocity.'
-    },
-    {
-      name = 'z',
-      type = 'number',
-      description = 'The z velocity.'
-    }
-  },
-  returns = {},
-  notes = 'The audio listener does not move based on its velocity.'
-}

+ 0 - 12
api/lovr/audio/stop.lua

@@ -1,12 +0,0 @@
-return {
-  tag = 'sources',
-  summary = 'Stop all Sources.',
-  description = 'Stops all audio.',
-  arguments = {},
-  returns = {},
-  notes = 'If you want to resume the stopped audio later, see `lovr.audio.pause`.',
-  related = {
-    'Source:stop',
-    'lovr.audio.pause'
-  }
-}

+ 0 - 10
api/lovr/audio/update.lua

@@ -1,10 +0,0 @@
-return {
-  tag = 'sources',
-  summary = 'Updates the audio system.',
-  description = [[
-    Updates all playing sources. This must be called regularly for audio playback to occur. This is
-    called automatically by the default implementation of `lovr.run`.
-  ]],
-  arguments = {},
-  returns = {}
-}