THPPlayerSetVolume

C Specification

#include "THPPlayer.h"
BOOL THPPlayerSetVolume(s32 vol, s32 time);

Arguments

vol New volume value.
time Time to transition from the current volume to the new volume (in msec).

Return Values

Returns TRUE if successful; FALSE otherwise.

Description

This function sets the playback volume of the THP audio data.

The player changes the playback volume of the THP audio player in time msec from the current value to the value that vol specifies. 0 through 127 can be specified for vol. time is in units of msec and range from 0 to 60000.

When the THPPlayerOpen function is called, the volume is initialized to 127.

See Also

THPPlayerOpen

Revision History

03/01/2006 Initial version.