GetPlayerSpeaker method

GetPlayerSpeaker method

Remarks

Obtains the current output speaker of the current output device for the given player. The output speaker can be modified through the SetPlayerSpeaker method.

For further details about speakers assignment, take a look to the How to work with multiple output devices and speakers section.

Syntax

[Visual Basic]

control.GetPlayerSpeaker (

nPlayer as Integer

) as enumSpeakers

[C++]

short control.GetPlayerSpeaker (

short nPlayer

);

Parameter	Description

nPlayer	Number representing the zero-based index of the involved player.

Return value

Value

Meaning

Negative value

An error occurred (see the LastError property for further error details)

Value >= 0

The output speaker assigned to the given player.

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)

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