Difference between revisions of "API Sound.GetBits"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(XML import)
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
wiki page name
+
<sidebar>API Contents</sidebar>
==SoundGetBits==
+
Gets the number of bits per sample for the sound
  
Gets the number of bits per sample for the sound
+
<div style="width:25%; float:right" class="toc">
----
+
====Class hierarchy====
 +
[[API Sound|Sound]]
 +
:[[API Sound|GetBits]]
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
''[[Variable types|HANDLE]] Sounds''
+
[[Variable Types|HANDLE]] ''Sounds''
 
:The handle of the sound object to read
 
:The handle of the sound object to read
  
===Return value===
+
 
[[Variable types|BYTE]]
+
==Return value==
 +
[[Variable Types|BYTE]]
  
 
Returns the number of bits per sample for the sound
 
Returns the number of bits per sample for the sound
  
===Detailed description===
 
''No additional information''
 
  
===Examples===
+
==Detailed description==
====Calling in a calculation:====
+
The bits per sample is specified in creation through [[API Sound.Create|Sound.Create]].
 +
 
 +
 
 +
==Examples==
 +
===Calling in a calculation===
 
* Declare a variable 'result' of type BYTE
 
* Declare a variable 'result' of type BYTE
* Add to a calculation icon: result = ::Sound.GetBits(sounds)
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetBits(sounds)</pre>
 +
 
 +
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Gets the number of bits per sample for the sound

Class hierarchy

Sound

GetBits

Parameters

HANDLE Sounds

The handle of the sound object to read


Return value

BYTE

Returns the number of bits per sample for the sound


Detailed description

The bits per sample is specified in creation through Sound.Create.


Examples

Calling in a calculation

  • Declare a variable 'result' of type BYTE
  • Add to a calculation icon:
    result = ::Sound.GetBits(sounds)

No additional examples