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