Copyright © 2005-2018 MultiMedia Soft

StreamMixerPlayerRemove method

Previous pageReturn to chapter overviewNext page

Remarks

 

Removes a player from the given stream mixer; when a player is removed from a stream mixer it will redirect its audio output to the output device set into the InitSoundSystem 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 StreamMixerPlayerRemove (

nStreamMixerID as Int32,

nPlayerIndex as Int16

) as enumErrorCodes


 

[C#]

public enumErrorCodes StreamMixerPlayerRemove (

Int32 nStreamMixerID,

Int16 nPlayerIndex

);


 

[C++]

public: enumErrorCodes StreamMixerPlayerRemove (

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