Copyright © 2001-2018 MultiMedia Soft

SoundGenerator.StreamElementToneFrequencySet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Modifies the frequency of the wave tone element identified by a specific unique identifier. The current frequency of a wave tone element can be obtained through the SoundGenerator.StreamElementToneFrequencyGet 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.StreamElementToneFrequencySet (

nPlayer as Integer,

nUniqueId as Long,

fFrequency as Single

) as enumErrorCodes


 

[C++]

short control.SoundGenerator.StreamElementToneFrequencySet (

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:

- SoundGenerator.StreamChannelAddTone

- SoundGenerator.StreamChannelElementUniqueIdGet

fFrequency

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