|
SoundComposer.SessionAutomaticStopWhenDoneSet method |
  
|
|
SoundComposer.SessionAutomaticStopWhenDoneSet method |
|
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 SoundComposerMan class and the How to compose a sound tutorial.
Syntax
[Visual Basic] Public Function SessionAutomaticStopWhenDoneSet ( nPlayerIndex as Int16, bAutomaticStop as bool ) as enumErrorCodes |
[C#] public enumErrorCodes SessionAutomaticStopWhenDoneSet ( Int16 nPlayerIndex, bool bAutomaticStop ); |
[C++] public: enumErrorCodes SessionAutomaticStopWhenDoneSet ( Int16 nPlayerIndex, bool bAutomaticStop ); |
Parameter |
Description |
||||||
|
|
||||||
nPlayerIndex |
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:
|
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. |
