|
SoundComposer.ItemUniqueIdGet method |
  
|
|
SoundComposer.ItemUniqueIdGet method |
|
Remarks
Obtains the unique identifier of a specific item previously added to the session.
For further details about sound composing see the the SoundComposerMan class and the How to compose a sound tutorial.
Syntax
[Visual Basic] Public Function ItemUniqueIdGet ( nPlayerIndex as Int16, nItem as Int32, ByRef nUniqueId as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes ItemUniqueIdGet ( Int16 nPlayerIndex, Int32 nItem, ref Int32 nUniqueId ); |
[C++] public: enumErrorCodes ItemUniqueIdGet ( Int16 nPlayerIndex, Int32 nItem, Int32 __gc *nUniqueId ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the player that owns the sound composer session |
nItem |
Zero-based index of the item. The total number of items added to the session can be obtained through the SoundComposer.SessionItemsCountGet method. |
nUniqueId |
Reference that, on return from the method call, will contain the unique identifier of the 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. |
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. |
