Copyright © 2001-2019 MultiMedia Soft

SoundComposer.SessionAutomaticStopWhenDoneSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Instructs the sound composer session to automatically stop or to continue playing the session stream when playback of the last item is completed. The automatic stop setting can be verified through the SoundComposer.SessionAutomaticStopWhenDoneGet method.

 

For further details about sound composing see the the SoundComposer object and the How to compose a sound tutorial.

 

 

Syntax

 

[Visual Basic]

control.SoundGenerator.SessionAutomaticStopWhenDoneSet (

nPlayer as Integer,

bAutomaticStop as enumBoolean

) as enumErrorCodes


 

[C++]

short control.SoundGenerator.SessionAutomaticStopWhenDoneSet (

short nPlayer,

short bAutomaticStop

);


 

Parameter

Description

 

 

nPlayer

Number representing the zero-based index of the player that owns the sound composer session

bAutomaticStop

Boolean flag specifying if the sound composer session must be automatically stopped when playback of the last item is completed.

Supported values are the following:

Mnemonic Value

Meaning

false (Default)

Automatic stop is disabled

true

Automatic stop is enabled

 

 

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.