Copyright © 2005-2018 MultiMedia Soft

SoundGenerator.StreamChannelAddTone method

Previous pageReturn to chapter overviewNext page

Remarks

 

Adds a wave tone generator element to the audio stream previously created through the SoundGenerator.StreamCreateMultiChannelEmpty method.

 

When the rendering of the wave tone element has been completed, the element itself is automatically removed from the the audio stream; if you need to create a wave tone that could be reproduced again after its complete rendering, use the SoundGenerator.StreamCreateTone 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 StreamChannelAddTone (

nPlayerIndex as Int16,

nChannel as Int16,

nWaveType as enumSoundGenWaveTypes,

fFrequency as Single,

fAmplitude as Single,

nDurationMs as Int32,

nOffsetMs as Int32,

ByRef nUniqueId as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes StreamChannelAddTone (

Int16 nPlayerIndex,

Int16 nChannel,

enumSoundGenWaveTypes nWaveType,

float fFrequency,

float fAmplitude,

Int32 nDurationMs,

Int32 nOffsetMs,

ref Int32 nUniqueId

);


 

[C++]

public: enumErrorCodes StreamChannelAddTone (

Int16 nPlayerIndex,

Int16 nChannel,

enumSoundGenWaveTypes nWaveType,

float fFrequency,

float fAmplitude,

Int32 nDurationMs,

Int32 nOffsetMs,

Int32 __gc  *nUniqueId

);


 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

nChannel

Channel of the audio stream that will reproduce the wave tone: can be a value between 0 and the number of channels of the audio stream created through the SoundGenerator.StreamCreateMultiChannelEmpty method.

nWaveType

Type of wave tone.

Supported values are the following:

Mnemonic Value

Value

Meaning

SOUNDGEN_WAVE_TYPE_SINE

0

Sine wave

SOUNDGEN_WAVE_TYPE_SQUARE

1

Square wave

SOUNDGEN_WAVE_TYPE_SAWTOOTH

2

Sawtooth wave

SOUNDGEN_WAVE_TYPE_SAWTOOTH_NEGATIVE

3

Negative sawtooth wave

SOUNDGEN_WAVE_TYPE_TRIANGLE

4

Triangle wave

fFrequency

Wave tone frequency expressed in Hertz

fAmplitude

Wave tone amplitude.

- value 0.0 means that sound volume is muted

- values higher than 0.0 and smaller than 1.0 attenuate the sound volume

- value 1.0 sets the sound at full volume

- values higher than 1.0 amplify the sound volume

nDurationMs

Duration of the wave tone expressed in milliseconds. Set this value to 0 for creating an endless wave tone.

nOffsetMs

Offset of the wave tone, expressed in milliseconds, respect to the beginning of the audio stream.

nUniqueId

Reference to a value that, on return from the method call, will contain the unique identifier of the newly added element: this unique identifier will be used in order to invoke further methods related to the use of this specific element.

- SoundGenerator.StreamElementAmplitudeSet and SoundGenerator.StreamElementAmplitudeGet to modify and retrieve the amplitude of the wave tone element.

- SoundGenerator.StreamElementToneFrequencySet and SoundGenerator.StreamElementToneFrequencyGet to modify and retrieve the wave tone frequency of the element.

- SoundGenerator.StreamElementToneTypeGet to obtain the type of wave tone.

- SoundGenerator.StreamElementRemove to remove the wave tone element from the audio stream.

- SoundGenerator.StreamElementDurationGet to obtain the duration of the wave tone element.

- SoundGenerator.StreamElementOffsetGet to obtain the offset of the wave tone element.

 

 

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.