Copyright © 2001-2018 MultiMedia Soft

StopSound method

Previous pageReturn to chapter overviewNext page

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 will seek the song to its initial position and will fire the SoundStopped event.

 

 

Syntax

 

[Visual Basic]

control.StopSound (

nPlayer as Integer

) as enumErrorCodes


 

[C++]

short control.StopSound (

short nPlayer

);


 

 

Parameter

Description

 

 

nPlayer

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.ERR_NOERROR (0)

The call was successful.