|
SoundGenerator.StreamChannelElementUniqueIdGet method |
  
|
|
SoundGenerator.StreamChannelElementUniqueIdGet method |
|
Remarks
Retrieves the unique identifier of a specific sound element added to the given channel of the audio stream. The total number of elements added to a specific channel can be obtained through the SoundGenerator.StreamChannelElementsCountGet 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 StreamChannelElementUniqueIdGet ( nPlayerIndex as Int16, nChannel as Int16, nElement as Int32, ByRef nUniqueId as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes StreamChannelElementUniqueIdGet ( Int16 nPlayerIndex, Int16 nChannel, Int32 nElement, ref Int32 nUniqueId ); |
[C++] public: enumErrorCodes StreamChannelElementUniqueIdGet ( Int16 nPlayerIndex, Int16 nChannel, Int32 nElement, Int32 __gc *nUniqueId, ); |
Parameter |
Description |
|
|
nPlayer |
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. |
nElement |
The zero-based index of the element added to the given channel of the audio stream. The total number of elements added to a specific channel can be obtained through the SoundGenerator.StreamChannelElementsCountGet method. |
nUniqueId |
Reference to a value that, on return from the method call, will contain the unique identifier of the element previously returned by one of the following calls: - SoundGenerator.StreamChannelAddTone - SoundGenerator.StreamChannelAddNoise - SoundGenerator.StreamChannelAddDtmfString - SoundGenerator.StreamChannelAddSlidingTone |
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. |
