Copyright © 2005-2018 MultiMedia Soft

PauseSound method

Previous pageReturn to chapter overviewNext page

Remarks

 

Pauses a playing song. 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.Pause method.

 

A successful call to this method will fire the SoundPaused event.

 

 

Syntax

 

[Visual Basic]

Public Function PauseSound (

nPlayerIndex as Int16

) as enumErrorCodes


 

[C#]

public enumErrorCodes PauseSound (

Int16 nPlayerIndex

);


 

[C++]

public: enumErrorCodes PauseSound (

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.