|
SoundGenerator.StreamElementNoiseTypeGet method |
  
|
|
SoundGenerator.StreamElementNoiseTypeGet method |
|
Remarks
Obtains the type of noise for the given noise element.
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] control.SoundGenerator.StreamElementNoiseTypeGet ( nPlayer as Integer, nUniqueId as Long, ByRef nType as enumSoundGenNoiseTypes ) as enumErrorCodes |
[C++] short control.SoundGenerator.StreamElementNoiseTypeGet ( short nPlayer, long nUniqueId, short *nType ); |
Parameter |
Description |
||||||||||||
|
|
||||||||||||
nPlayer |
Number representing the zero-based index of the involved player |
||||||||||||
nUniqueId |
The unique identifier of the element previously returned by one of the following calls: |
||||||||||||
nType |
Reference to a value that, on return from the method call, will contain the type of noise. Supported values are the following:
|
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred, check the LastError property value in order to get the error code |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful |
