Methods > Players and stream mixers > GetPlayerHandle method

Remarks

Obtains the handle of the given player. This method can be used in combination with the PlayerSettingsApply method of the Audio Sound Editor API for .NET component and with the StartFromDjStudioPlayer and StartSplitFromDjStudioPlayer methods of the Audio Sound Recorder API for .NET component.

Syntax

[Visual Basic]

Public Function GetPlayerHandle (

nPlayerIndex as Int16

) as Int32

[C#]

public Int32 GetPlayerHandle (

Int16 nPlayerIndex

);

[C++]

public: Int32 GetPlayerHandle (

Int16 nPlayerIndex

);

Parameter	Description

nPlayerIndex	Number representing the zero-based index of the involved player

Return value

Value	Meaning

Value > 0	The player's handle
Negative value	An error occurred (see the LastError property for further error details)