SoundComposer.ItemContentGet method |
|
Remarks
Obtains contents 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 ItemContentGet ( nPlayerIndex as Int16, nUniqueId as Int32 ) as String |
[C#] public string ItemContentGet ( Int16 nPlayerIndex, Int32 nUniqueId ); |
[C++] public: string ItemContentGet ( Int16 nPlayerIndex, Int32 nUniqueId ); |
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. |
Return value
Value |
Meaning |
|
|
Empty string |
The information is not available or an error occurred (see the LastError property for further error details) |
Valid string |
String containing contents of the item: - for audio files taken from disk the returned string will be the absolute pathname of the file - for audio files taken from memory the returned string will be empty - for text to speech files taken from disk the returned string will be the absolute pathname of the file - for text to speech strings the returned string will be related text |