ILMAVolume Interface

Interface methods:

HRESULT SetAmplitude(int lAmplitude)

Parameters

lAmplitude

Integer value that represents the requested volume amplitude, possible values are between –10 and 10.

Description

Sets the volume of the sound stream.

Returns

S_OK if successful, amplitude values out of the range will be clipped.

S_FALSE otherwise.

 

HRESULT GetAmplitude(int *lAmplitude)

Parameters

lAmplitude

A valid pointer to an integer variable that will receive the current volume.

Description

Gets the current volume value.

Returns

S_OK if successful, S_FALSE otherwise.

 

 

HRESULT SetMute(BOOL bMute)

Parameters

bMute

New status of mute option, TRUE or FALSE.

Description

Sets the mute volume option.

Returns

S_OK if successful, S_FALSE otherwise.

 

HRESULT GetMute(BOOL *bMute)

Parameters

bMute

A valid pointer to a Boolean variable that will receive the current mute volume option.

Description

Gets the current mute volume option status.

Returns

S_OK if successful, S_FALSE otherwise.

 

 

HRESULT GetNumChannels(int *nChannels)

Parameters

nChannels

A valid pointer to an integer variable that will receive the number of channels in the current sound stream.

Description

Gets the number of channels in the current sound stream.

Returns

S_OK if successful, S_FALSE otherwise.