Copyright © 2001-2019 MultiMedia Soft

SoundComposer.ItemUniqueIdGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the unique identifier of a specific item previously added to the session.

 

For further details about sound composing see the the SoundComposer object and the How to compose a sound tutorial.

 

 

Syntax

 

[Visual Basic]

control.SoundGenerator.ItemUniqueIdGet (

nPlayer as Integer,

nItem as Long,

ByRef nUniqueId as Long

) as enumErrorCodes


 

[C++]

short control.SoundGenerator.ItemUniqueIdGet (

short nPlayer,

long nItem,

long *nUniqueId

);


 

Parameter

Description

 

 

nPlayer

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.