SetPlayerOutputDevice method

SetPlayerOutputDevice method

Remarks

Changes the output device (sound card) for the given player. This method can be called at any time, also during playback.

By default, the output device is set at the very beginning through a call to the InitSoundSystem method.

Use the value returned by the GetOutputDevicesCount method in order to know how many output devices are currently installed on the system and the GetOutputDeviceDesc method in order to retrieve the friendly name of every output device.

If the output device is changed successfully, a OutputDeviceChanged event is fired.

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

Syntax

[Visual Basic]

Public Function SetPlayerOutputDevice (

nPlayerIndex as Int16,

nOutputIndex as Int16

) as enumErrorCodes

[C#]

public enumErrorCodes SetPlayerOutputDevice (

Int16 nPlayerIndex,

Int16 nOutputIndex

);

[C++]

public: enumErrorCodes SetPlayerOutputDevice (

Int16 nPlayerIndex,

Int16 nOutputIndex

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the involved player
nOutputIndex	Number representing the index of the output device that will be used by the given player.

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.NOERROR (0)	The method call was successful.

Return to Table of contents