Copyright © 2005-2019 MultiMedia Soft

SoundComposer.ItemInfoGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains information about the given 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 ItemInfoGet (

nPlayerIndex as Int16,

nUniqueId as Int32,

ByRef nDurationMs as Int32,

ByRef nChannelsSource as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes ItemInfoGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

ref Int32 nDurationMs,

ref Int32 nChannelsSource

);


 

[C++]

public: enumErrorCodes ItemInfoGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

Int32 __gc *nDurationMs,

Int32 __gc *nChannelsSource

);


 

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.

nDurationMs

Reference that, on return from the method call, will contain the duration of the item expressed in milliseconds.

nChannelsSource

Reference that, on return from the method call, will contain the original number of channels of the sound file.

 

 

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.