|
SoundGenerator.StreamChannelElementsCountGet method |
  
|
|
SoundGenerator.StreamChannelElementsCountGet method |
|
Remarks
Retrieves the number of sound elements added to the given channel of the audio stream; the unique identifier of each single element can be obtained through the SoundGenerator.StreamChannelElementUniqueIdGet method.
For further details about sound generation see the SoundGenerator object and the How to generate wave tones, noises, DTMF tones and text to speech tutorial.
Syntax
[Visual Basic] Public Function StreamChannelElementsCountGet ( nPlayerIndex as Int16, nChannel as Int16, ByRef nElements as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes StreamChannelElementsCountGet ( Int16 nPlayerIndex, Int16 nChannel, ref Int32 nElements ); |
[C++] public: enumErrorCodes StreamChannelElementsCountGet ( Int16 nPlayerIndex, Int16 nChannel, Int32 __gc *nElements, ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
nChannel |
Channel of the audio stream: can be a value between 0 and the number of channels of the audio stream created through the SoundGenerator.StreamCreateMultiChannelEmpty method. |
nElements |
Reference to a value that, on return from the method call, will contain the number of elements added to the given channel of the audio stream |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred (see the LastError property for further error details) |
enumErrorCodes.NOERROR (0) |
The method call was successful. |
