Copyright © 2005-2016 MultiMedia Soft

SoundGenerator.StreamElementToneFrequencyGet method

Previous pageReturn to chapter overviewNext page

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]

Public Function StreamElementToneFrequencyGet (

nPlayerIndex as Int16,

nUniqueId as Int32,

ByRef fFrequency as Single

) as enumErrorCodes


 

[C#]

public enumErrorCodes StreamElementToneFrequencyGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

ref float fFrequency

);


 

[C++]

public: enumErrorCodes StreamElementToneFrequencyGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

float __gc *fFrequency

);


 

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:

- SoundGenerator.StreamChannelAddTone

- SoundGenerator.StreamChannelElementUniqueIdGet

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 (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.