|
SoundComposer.ItemWaveToneFrequencyGet method |
  
|
|
SoundComposer.ItemWaveToneFrequencyGet method |
|
Remarks
Obtains the frequency used to generate a specific wave tone item. The frequency can be modified through the SoundComposer.ItemWaveToneFrequencySet method.
For further details about sound composing see the the SoundComposerMan class and the How to compose a sound tutorial.
Syntax
[Visual Basic] Public Function ItemWaveToneFrequencyGet ( nUniqueId as Int32, ByRef fFrequency as Single ) as enumErrorCodes |
[C#] public enumErrorCodes ItemWaveToneFrequencyGet ( Int32 nUniqueId, ref float fFrequency ); |
[C++] public: enumErrorCodes ItemWaveToneFrequencyGet ( Int32 nUniqueId, float __gc *fFrequency ); |
Parameter |
Description |
|
|
nUniqueId |
The unique identifier of the element previously returned by the call to the SoundComposer.ItemWaveToneAdd method. |
fFrequency |
Reference that, on return from the method call, will contain the wave tone frequency expressed in Hertz, e.g. 700 |
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. |
