Copyright © 2008-2023 MultiMedia Soft

TracksBoard.ItemSpeakerGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the speaker assigned to the given item. The current speaker can be modified through the TracksBoard.ItemSpeakerSet method.

 

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 ItemSpeakerGet (

nUniqueId as Int32,

ByRef nSpeaker as enumSpeakers

) as enumErrorCodes


 

[C#]

public enumErrorCodes ItemSpeakerGet (

Int32 nUniqueId,

ref enumSpeakers nSpeaker

);


 

[C++]

public: enumErrorCodes ItemSpeakerGet (

Int32 nUniqueId,

enumSpeakers __gc *nSpeaker

);


 

 

Parameter

Description

 

 

nUniqueId

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

TracksBoard.ItemClone when an existing item has been cloned

nSpeaker

Reference that, after returning from the method call, will the contain speaker assigned to the given item.

Supported values are the following:

Mnemonic value

Numeric value

Meaning

SPEAKER_FRONT

0

Front speakers (Stereo)

SPEAKER_REAR

1

Rear speakers (Stereo)

SPEAKER_CENTER_LFE

2

Center speakers (Stereo)

SPEAKER_REAR_CENTER

3

Rear center speakers (Stereo)

SPEAKER_FRONT_LEFT

4

Front-left speaker (Mono)

SPEAKER_FRONT_RIGHT

5

Front-right speaker (Mono)

SPEAKER_REAR_LEFT

6

Rear-left speaker (Mono)

SPEAKER_REAR_RIGHT

7

Rear-right speaker (Mono)

SPEAKER_CENTER

8

Center speaker (Mono)

SPEAKER_LFE

9

LFE or Subwoofer speaker (Mono)

SPEAKER_REAR_CENTER_LEFT

10

Rear Center Left speaker (Mono)

SPEAKER_REAR_CENTER_RIGHT

11

Rear Center Right speaker (Mono)

 

 

 

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