Copyright © 2001-2019 MultiMedia Soft

SoundComposer.SessionAutomaticStopWhenDoneGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Verifies if the sound composer session is set to be automatically stopped when playback of the last item is completed. The automatic stop can be set or reset through the SoundComposer.SessionAutomaticStopWhenDoneSet 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.SessionAutomaticStopWhenDoneGet (

nPlayer as Integer,

ByRef bAutomaticStop as enumBoolean

) as enumErrorCodes


 

[C++]

short control.SoundGenerator.SessionAutomaticStopWhenDoneGet (

short nPlayer,

short *bAutomaticStop

);


 

Parameter

Description

 

 

nPlayer

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

bAutomaticStop

Reference that, on return from the method call, will contain the boolean flag specifying if the sound composer session is set to 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.