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