Classes > TracksBoard class > Methods > TracksBoard.ItemMuteStateGet method

Remarks

Obtains the mute state of the given item. The current mute state can be modified through the TracksBoard.ItemMuteStateSet method; the mute state may be also modified if the item should be inside a track muted through a call to the TracksBoard.TrackMuteStateSet method but would recover its not muted state once moved to another track.

For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.

For further details about methods of the TracksBoard refer to the TracksBoard class section.

Syntax

[Visual Basic]

Public Function ItemMuteStateGet (

nUniqueId as Int32,

ByRef bIsMuted as Boolean

) as enumErrorCodes

[C#]

public enumErrorCodes ItemMuteStateGet (

Int32 nUniqueId,

ref bool bIsMuted

);

[C++]

public: enumErrorCodes ItemMuteStateGet (

Int32 nUniqueId,

bool __gc *bIsMuted

);

Parameter

Description

nUniqueId

Unique identification number assigned to the sound item after being generated by one of the following methods:

•	TracksBoard.ItemSoundFileAdd and TracksBoard.ItemSoundFileRawAdd for sound files

•	TracksBoard.ItemSpeechFromStringAdd and TracksBoard.ItemSpeechFromFileAdd for text to speech items

•	TracksBoard.ItemClone when an existing item has been cloned

bIsMuted

Reference that, after returning from the method call, will contain a boolean value indicating if the item is muted.

Supported values are the following:

Value	Meaning
false (default)	The item is not muted.
true	The item is muted.

Return value

Value	Meaning

Negative value	An error occurred, check the LastError property value in order to get the error code
enumErrorCodes.ERR_NOERROR (0)	The method call was successful