Copyright © 2008-2018 MultiMedia Soft

SoundComposer.ItemWaveToneAdd method

Previous pageReturn to chapter overviewNext page

Remarks

 

Adds a wave tone item to the audio stream previously created through the SoundComposer.SessionInit 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 ItemWaveToneAdd (

strFriendlyName as String,

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 ItemWaveToneAdd (

string strFriendlyName,

Int16 nChannel,

enumSoundGenWaveTypes nWaveType,

float fFrequency,

float fAmplitude,

Int32 nDurationMs,

Int32 nOffsetMs,

ref Int32 nUniqueId

);


 

[C++]

public: enumErrorCodes ItemWaveToneAdd (

string strFriendlyName,

Int16 nChannel,

enumSoundGenWaveTypes nWaveType,

float fFrequency,

float fAmplitude,

Int32 nDurationMs,

Int32 nOffsetMs,

Int32 __gc  *nUniqueId

);


 

Parameter

Description

 

 

strFriendlyName

Friendly name of the item

nChannel

Channel of the audio stream that will reproduce the item: can be a value between 0 and the number of channels of the audio stream created through the SoundComposer.SessionInit 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

nOffsetMs

Offset of the sliding 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:

 

- SoundComposer.ItemWaveToneFrequencyGet to obtain the frequency of the wave tone

- SoundComposer.ItemWaveToneFrequencySet to modify the frequency of the wave tone

- SoundComposer.ItemWaveToneTypeGet to obtain the current type of wave tone

- SoundComposer.ItemWaveToneTypeSet to modify the current type of wave tone

 

- SoundComposer.ItemAmplitudeGet to obtain the amplitude of the item

- SoundComposer.ItemAmplitudeSet to modify the amplitude of the item

- SoundComposer.ItemChannelGet to obtain the channel of of the audio stream that will reproduce the item

- SoundComposer.ItemChannelSet to modify the channel of of the audio stream that will reproduce the item

- SoundComposer.ItemRemove to remove the item from the sound composition

- SoundComposer.ItemDurationGet to obtain the duration, expressed in milliseconds, of the item

- SoundComposer.ItemDurationSet to modify the duration, expressed in milliseconds, of the item

- SoundComposer.ItemOffsetGet to obtain the offset, expressed in milliseconds, of the item respect to the beginning of the audio stream

- SoundComposer.ItemOffsetSet to modify the offset, expressed in milliseconds, of the item respect to the beginning of the audio stream

- SoundComposer.ItemTypeGet to obtain the item's type

- SoundComposer.ItemFriendlyNameGet to obtain the friendly name of the item

- SoundComposer.ItemFriendlyNameSet to modify the friendly name of the item

 

 

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.