|
SoundComposer.ItemFriendlyNameGet method |
  
|
|
SoundComposer.ItemFriendlyNameGet method |
|
Remarks
Obtains the friendly name of the given item. The current friendly name can be modified through the SoundComposer.ItemFriendlyNameSet 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 ItemFriendlyNameGet ( nPlayerIndex as Int16, nUniqueId as Int32 ) as String |
[C#] public string ItemFriendlyNameGet ( Int16 nPlayerIndex, Int32 nUniqueId ); |
[C++] public: string ItemFriendlyNameGet ( 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 the friendly name of the item |
