Methods > Players and stream mixers

Remarks

Changes both the sound tempo and pitch, as if an LP disc was played at wrong RPM rate. The use of this method will speed up the sound playback and voices will result altered; if you don't want to alter voices, use the SetTempoPerc 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 BOOL_FALSE.

When dealing with video clips, calls to this method will have no effect if the video clip has not been loaded with the VideoPlayer.LoadForTempoChange, VideoPlayer.LoadFromMemoryForTempoChange, VideoPlayer.LoadFromMemorySyncForTempoChange or VideoPlayer.LoadSyncForTempoChange methods.

After a successful call to this method, the duration of the song will change: the new duration, expressed in seconds, is notified through the SoundDurationChanged event.

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

Syntax

[Visual Basic]

control.SetRatePerc (

nPlayer as Integer,

fRatePerc as single

) as enumErrorCodes

[C++]

short control.SetRatePerc (

short nPlayer,

float fRatePerc

);

Parameter	Description

nPlayer	Number representing the zero-based index of the involved player
fRatePerc	The Sample Rate variation expressed in percentage; supported values are from -90 to 90. Setting this parameter to 0 will set the original sound sample rate value.

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.