Browse Source

Clarify AudioStream buffer size units;

bjorn 7 years ago
parent
commit
b8961ddd41
2 changed files with 3 additions and 3 deletions
  1. 2 2
      api/init.lua
  2. 1 1
      api/lovr/data/newAudioStream.lua

+ 2 - 2
api/init.lua

@@ -1892,7 +1892,7 @@ return {
                 {
                 {
                   name = "bufferSize",
                   name = "bufferSize",
                   type = "number",
                   type = "number",
-                  description = "The size of the stream's audio buffer.",
+                  description = "The size of the stream's audio buffer, in samples.",
                   default = "4096"
                   default = "4096"
                 }
                 }
               },
               },
@@ -1914,7 +1914,7 @@ return {
                 {
                 {
                   name = "bufferSize",
                   name = "bufferSize",
                   type = "number",
                   type = "number",
-                  description = "The size of the stream's audio buffer.",
+                  description = "The size of the stream's audio buffer, in samples.",
                   default = "4096"
                   default = "4096"
                 }
                 }
               },
               },

+ 1 - 1
api/lovr/data/newAudioStream.lua

@@ -13,7 +13,7 @@ return {
     bufferSize = {
     bufferSize = {
       type = 'number',
       type = 'number',
       default = '4096',
       default = '4096',
-      description = 'The size of the stream\'s audio buffer.'
+      description = 'The size of the stream\'s audio buffer, in samples.'
     }
     }
   },
   },
   returns = {
   returns = {