Copyright © 2011-2018 MultiMedia Soft

SoundGenerator.CompositeWaveTonePrepare method

Previous pageReturn to chapter overviewNext page

Remarks

 

Prepares a composite audio stream which can host multiple wave tones added by one of more calls to the SoundGenerator.CompositeWaveToneAddNewWaveTone method. Once all of the needed wave tones have been added, you can generate and load into the editor the final composite wave tone through the SoundGenerator.CompositeWaveToneGenerate method.

 

For further details about sound generation see the SoundGeneratorMan class and the How to generate wave tones, noises, DTMF tones and text to speech tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function CompositeWaveTonePrepare (

nSampleRate as Int32,

nChannels as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes CompositeWaveTonePrepare (

Int32 nSampleRate,

Int32 nChannels

);


 

[C++]

public: enumErrorCodes CompositeWaveTonePrepare (

Int32 nSampleRate,

Int32 nChannels

);


 

Parameter

Description

 

 

nSampleRate

Sample rate of the stream, e.g. 44100

nChannels

Number of channels of the audio stream.

Supported values are the following:

Value

Meaning

1

Mono audio stream

2

Stereo audio stream

4

3.1 audio stream

6

5.1 audio stream

8

7.1 audio stream

 

 

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.