|
SoundGenerator.StreamElementSlidingToneTypeGet method |
  
|
|
SoundGenerator.StreamElementSlidingToneTypeGet method |
|
Remarks
Obtains the type of sliding wave tone for the given sliding wave tone 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] Public Function StreamElementSlidingToneTypeGet ( nPlayerIndex as Int16, nUniqueId as Int32, ByRef nType as enumSoundGenSlidingWaveTypes ) as enumErrorCodes |
[C#] public enumErrorCodes StreamElementSlidingToneTypeGet ( Int16 nPlayerIndex, Int32 nUniqueId, ref enumSoundGenSlidingWaveTypes nType ); |
[C++] public: enumErrorCodes StreamElementSlidingToneTypeGet ( Int16 nPlayerIndex, Int32 nUniqueId, enumSoundGenSlidingWaveTypes __gc *nType ); |
Parameter |
Description |
|||||||||||||||
|
|
|||||||||||||||
nPlayerIndex |
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 sliding wave tone. Supported values are the following:
|
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. |
