|
SoundComposer.ItemIsPlaying method |
  
|
|
SoundComposer.ItemIsPlaying method |
|
Remarks
Verifies if the given item is in playback status.
For further details about sound composing see the the SoundComposerMan class and the How to compose a sound tutorial.
Syntax
[Visual Basic] Public Function ItemIsPlaying ( nPlayerIndex as Int16, nUniqueId as Int32, ByRef bIsPlaying as bool ) as enumErrorCodes |
[C#] public enumErrorCodes ItemIsPlaying ( Int16 nPlayerIndex, Int32 nUniqueId, ref bool bIsPlaying ); |
[C++] public: enumErrorCodes ItemIsPlaying ( Int16 nPlayerIndex, Int32 nUniqueId, bool __gc *bIsPlaying ); |
Parameter |
Description |
||||||
|
|
||||||
nPlayerIndex |
Number representing the zero-based index of the player that owns the sound composer session |
||||||
nUniqueId |
The unique identifier of the sound file item previously returned by the call to one of the following methods: - SoundComposer.ItemSoundFileAdd, SoundComposer.ItemSoundFileMemoryAdd, SoundComposer.ItemSoundFileRawAdd, SoundComposer.ItemSoundFileMemoryRawAdd for sound file items. - SoundComposer.ItemSpeechFromStringAdd and SoundComposer.ItemSpeechFromFileAdd for text to speech items. |
||||||
bIsPlaying |
Reference that, on return from the method call, will contain the boolean flag specifying if the item is currently playing. 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. |
