|
TracksBoard.ItemSpeakerSet method |
  
|
|
TracksBoard.ItemSpeakerSet method |
|
Remarks
Modifies the speaker assigned to the given item. The current speaker can be obtained through the TracksBoard.ItemSpeakerGet method.
TracksBoard sessions can manage up to 4 stereo speakers or 8 mono speakers; by default sessions are created with a two speakers configuration (Front speakers) and this can be changed through the TracksBoard.SpeakersNumSet method: if a speaker not managed by the session is assigned to an item, for example if you assign "Rear speakers" when the session is configured for "Front speakers" only, the item will not be played and will not be exported into the final mix but will be in any case visible on the board.
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 ItemSpeakerSet ( nUniqueId as Int32, nSpeaker as enumSpeakers ) as enumErrorCodes |
[C#] public enumErrorCodes ItemSpeakerSet ( Int32 nUniqueId, enumSpeakers nSpeaker ); |
[C++] public: enumErrorCodes ItemSpeakerSet ( Int32 nUniqueId, enumSpeakers nSpeaker ); |
Parameter |
Description |
|||||||||||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||||||||||
nUniqueId |
Unique identification number assigned to the sound item after being generated by one of the following methods:
|
|||||||||||||||||||||||||||||||||||||||
nSpeaker |
The new speaker assigned to the given item. Supported values are the following:
Below you can see the positioning of the Stereo speakers on a wide 7.1 configuration (the reported blue numbers corresponds to the Numeric value of the parameter)
and below you can see the positioning of the Mono speakers on the same wide 7.1 configuration
|
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 |
