|
SoundGenerator.StreamElementToneFrequencyGet method |
  
|
|
SoundGenerator.StreamElementToneFrequencyGet method |
|
Remarks
Obtains the current frequency of the wave tone element identified by a specific unique identifier. The frequency of a wave tone element can be modified through the SoundGenerator.StreamElementToneFrequencySet 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] control.SoundGenerator.StreamElementToneFrequencyGet ( nPlayer as Integer, nUniqueId as Long, ByRef fFrequency as Single ) as enumErrorCodes |
[C++] short control.SoundGenerator.StreamElementToneFrequencyGet ( short nPlayer, long nUniqueId, float *fFrequency ); |
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: |
fFrequency |
Reference to a value that, on return from the method call, will contain the wave tone frequency expressed in Hertz |
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 |
