Methods > Players and stream mixers

Remarks

Stops a playing song; if no song is currently playing, the method call is ignored. In case the given player should have been loaded with a video clip, the call to this method would have the same effect of the VideoPlayer.Stop method.

A successful call to this method invokes the CallbackForPlayersEvents delegate with the nEvent parameter set to EV_SOUND_STOPPED.

Syntax

[Visual Basic]

Public Function StopSound (

nPlayerIndex as Int16

) as enumErrorCodes

[C#]

public enumErrorCodes StopSound (

Int16 nPlayerIndex

);

[C++]

public: enumErrorCodes StopSound (

Int16 nPlayerIndex

);

Parameter	Description

nPlayerIndex	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)
enumErrorCodes.NOERROR (0)	The method call was successful.