Copyright © 2005-2018 MultiMedia Soft

Effects.PlaybackRateGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the current playback rate percentage for the given player. The playback rate percentage can be modified calling the Effects.PlaybackRateSet method.

This method doesn't work with sounds with more than 2 channels (5.1 or 7.1) or if the EnableMixingFeatures property has been set to false.

 

Further details about songs mixing can be found inside the How to mix your songs section.

See the How to apply special effects to a playing sound section for further details.

 

 

Syntax

 

[Visual Basic]

Public Function PlaybackRateGet (

nPlayerIndex as Int16,

ByRef fRatePerc as Single

) as Single


 

[C#]

public float PlaybackRateGet (

Int16 nPlayerIndex,

ref float fRatePerc

);


 

[C++]

public: enumErrorCodes PlaybackRateGet (

Int16 nPlayerIndex,

float __gc *fRatePerc

);


 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

fRatePerc

Reference that, on return from the method call, will contain the Sample Rate variation expressed in percentage; supported values are from -90 to 90.

 

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.