TracksBoard.ItemMuteStateSet method |
|
Remarks
Modifies the mute state of the given item. The current mute state can be modified through the TracksBoard.ItemMuteStateGet 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 not being in mute state.
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 ItemMuteStateSet ( nUniqueId as Int32, bMuted as Boolean ) as enumErrorCodes |
[C#] public enumErrorCodes ItemMuteStateSet ( Int32 nUniqueId, bool bMuted ); |
[C++] public: enumErrorCodes ItemMuteStateSet ( Int32 nUniqueId, bool bMuted ); |
Parameter |
Description |
||||||
|
|
||||||
nUniqueId |
Unique identification number assigned to the sound item after being generated by one of the following methods:
|
||||||
bMuted |
Boolean value indicating if the item must be muted. Supported values are the following:
|
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 |