Difference between revisions of "API Sound.GetVolume"

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Gets the volume of playbacks for this sound in the range 0 to 1

HANDLE Sounds

The handle of the sound object to read

Returns the volume of playbacks for this sound in the range 0 to 1

The volume returned is specific to the specified handle, and affects all sounds played through this channel.

No additional examples

@@ Line 1: / Line 1: @@
-API contents
+<sidebar>API Contents</sidebar>
 Gets the volume of playbacks for this sound in the range 0 to 1
+<div style="width:25%; float:right" class="toc">
+====Class hierarchy====
+[[API Sound|Sound]]
+:[[API Sound|GetVolume]]
+</div>
+__TOC__
-===Parameters===
+==Parameters==
-''[[Variable types|HANDLE]] Sounds''
+[[Variable Types|HANDLE]] ''Sounds''
 :The handle of the sound object to read
-===Return value===
-[[Variable types|FLOAT]]
+==Return value==
+[[Variable Types|FLOAT]]
 Returns the volume of playbacks for this sound in the range 0 to 1
-===Detailed description===
-''No additional information''
-===Examples===
+==Detailed description==
-====Calling in a calculation====
+The volume returned is specific to the specified handle, and affects all sounds played through this channel.
+==Examples==
+===Calling in a calculation===
 * Declare a variable 'result' of type FLOAT
-* Add to a calculation icon: result = ::Sound.GetVolume(sounds)
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetVolume(sounds)</pre>
+''<span style="color:red;">No additional examples</span>''