THPPlayerSetVolume

Syntax

#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. (msec)

Return Values

Returns TRUE if successful, FALSE otherwise.

Description

The THPPlayerSetVolume function sets the THP audio data's playback volume.

The player changes the volume of the THP audio player from the present volume to the volume specified by vol, taking the amount of time specified by time. Values from 0 through 127 can be specified for vol. time is specified in milliseconds in the range from 0 to 60,000.

Note that when the THPPlayerOpen function is called, the volume value is initialized to 127.

Revision History

2006/03/01 Initial version.