Methods > Players and stream mixers > StreamMixerPlayerAdd method

Remarks

Adds a player to the given stream mixer; when a player is added to a stream mixer it will redirect its audio output to the stream mixer instead of sending it to the output device set into the InitSoundSystem method.

A player added to a stream mixer can be removed at a later time through the StreamMixerPlayerRemove method.

Further information about the use of custom Stream Mixers can be found inside the How to use custom Stream Mixers tutorial.

Syntax

[Visual Basic]

Public Function StreamMixerPlayerAdd (

nStreamMixerID as Int32,

nPlayerIndex as Int16

) as enumErrorCodes

[C#]

public enumErrorCodes StreamMixerPlayerAdd (

Int32 nStreamMixerID,

Int16 nPlayerIndex

);

[C++]

public: enumErrorCodes StreamMixerPlayerAdd (

Int32 nStreamMixerID,

Int16 nPlayerIndex

);

Parameter	Description

nStreamMixerID	Unique identifier of the stream mixer created by a previous call to the StreamMixerCreate method
nPlayerIndex	Number representing the zero-based index of the involved player

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