Browse Source

Added some std.audio.AudioFormat docs.

Mark Sibly 8 years ago
parent
commit
26da50e1c7
1 changed files with 18 additions and 1 deletions
  1. 18 1
      modules/std/audio/audioformat.monkey2

+ 18 - 1
modules/std/audio/audioformat.monkey2

@@ -1,13 +1,31 @@
 
 
 Namespace std.audio
 Namespace std.audio
 
 
+#rem monkeydoc Audio formats.
+
+| AudioFormat	| Description
+|:--------------|:-----------
+| `Unknown`		| Unknown format.
+| `Mono8`		| 8 bit mono.
+| `Mono16`		| 16 bit mono.
+| `Stereo8`		| 8 bit stereo.
+| `Stereo16`	| 16 bit stereo.
+#end
 Enum AudioFormat
 Enum AudioFormat
+	Unknown=0
 	Mono8=1
 	Mono8=1
 	Mono16=2
 	Mono16=2
 	Stereo8=3
 	Stereo8=3
 	Stereo16=4
 	Stereo16=4
 End
 End
 
 
+#rem monkeydoc Number of bytes per audio sample.
+
+Returns the number of bytes per audio sample for the given audio format.
+
+@param format The audio format.
+
+#end
 Function BytesPerSample:Int( format:AudioFormat )
 Function BytesPerSample:Int( format:AudioFormat )
 	Select format
 	Select format
 	Case AudioFormat.Mono8 Return 1
 	Case AudioFormat.Mono8 Return 1
@@ -17,4 +35,3 @@ Function BytesPerSample:Int( format:AudioFormat )
 	End
 	End
 	Return 0
 	Return 0
 End
 End
-