Copyright © 2011-2016 MultiMedia Soft

WaveformAnalyzer.SetEmptySettings method

Previous pageReturn to chapter overviewNext page

Remarks

 

Applies settings used to render the waveform analyzer while no sound is loaded and no waveform is displayed.

For details about the use of the Waveform Analyzer refer to the How to use the Waveform Analyzer section.

For further details about methods of the Waveform Analyzer refer to the WaveformAnalyzer class section.

 

 

Syntax

 

[Visual Basic]

Public Function SetEmptySettings (

nDurationMs as Int32,

nChannels as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes SetEmptySettings (

Int32 nDurationMs,

Int32 nChannels

);


 

[C++]

public: enumErrorCodes SetEmptySettings (

Int32 nDurationMs,

Int32 nChannels

);


 

 

Parameter

Description

 

 

nDurationMs

Number representing the displayed duration expressed in milliseconds.

This value in taken into consideration until the instance of the editor component is empty or after closing the sound under editing through a call to the CloseSound method; if for example this value should be set to 20000 (20 seconds) and a sound file having a duration of 5 seconds should be loaded, the waveform analyzer would display these 5 seconds only.

nChannels

Number representing the number of displayed channels.

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.ERR_NOERROR (0)

The method call was successful