THPSimpleSetVolume

C Specification

#include "THPSimple.h"

BOOL THPSimpleSetVolume(s32 vol, s32 time);

Arguments

*`vol`*	The 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 THP audio data's playback volume.

The simple player changes the volume of the THP audio player from the current value to the value specified by vol, and takes the amount of time specified by time. vol takes values in a range from 0 to 127. time is in milliseconds in a range from 0 to 60,000.

Be aware that when the THPSimpleOpen function is called, volume is initialized to 127.

Revision History