A2DPVolumeControl Class Reference

Abstract class for handling of the volume of the audio data. More...

#include <A2DPVolumeControl.h>

Inheritance diagram for A2DPVolumeControl:

Public Member Functions
	A2DPVolumeControl ()=default
	Default constructor.
int32_t	get_volume_factor ()
	Gets the current volume factor.
int32_t	get_volume_factor_max ()
	Gets the maximum volume factor value.
void	set_enabled (bool enabled)
	Enables or disables volume control.
void	set_mono_downmix (bool enabled)
	Enables or disables mono downmix.
virtual void	set_volume (uint8_t volume)=0
	Sets the volume level (pure virtual function)
virtual void	update_audio_data (Frame *data, uint16_t frameCount)
	Updates audio data with volume control and optional mono downmix.
virtual void	update_audio_data (uint8_t *data, uint16_t byteCount)
	Updates audio data with volume control and optional mono downmix.

Protected Member Functions
int32_t	clip (int32_t value)
	Clips audio sample value to prevent overflow.

Protected Attributes
bool	is_volume_used = false
	Flag indicating if volume control is enabled.
bool	mono_downmix = false
	Flag indicating if mono downmix is enabled.
int32_t	volumeFactor = 1
	Current volume factor.
int32_t	volumeFactorClippingLimit = 0xfff
	Volume factor clipping limit (4095)
int32_t	volumeFactorMax = 0x1000
	Maximum volume factor (4096)

Detailed Description

Abstract class for handling of the volume of the audio data.

Author

Phil Schatzmann

Copyright

Apache License Version 2

Member Function Documentation

clip()

int32_t A2DPVolumeControl::clip ( int32_t  value )

inlineprotected

Clips audio sample value to prevent overflow.

Parameters

value

Input audio sample value

Returns

Clipped value within valid 16-bit range (-32768 to 32767)

get_volume_factor()

int32_t A2DPVolumeControl::get_volume_factor ( )

inline

Gets the current volume factor.

Returns

Volume factor in the range of 0 to 4096

get_volume_factor_max()

int32_t A2DPVolumeControl::get_volume_factor_max ( )

inline

Gets the maximum volume factor value.

Returns

Maximum factor value (4096)

set_enabled()

void A2DPVolumeControl::set_enabled ( bool  enabled )

inline

Enables or disables volume control.

Parameters

enabled

True to enable volume control, false to disable

set_mono_downmix()

void A2DPVolumeControl::set_mono_downmix ( bool  enabled )

inline

Enables or disables mono downmix.

Parameters

enabled

True to enable mono downmix, false to disable

set_volume()

virtual void A2DPVolumeControl::set_volume ( uint8_t  volume )

pure virtual

Sets the volume level (pure virtual function)

Parameters

volume

Volume level (0-127)

Implemented in A2DPDefaultVolumeControl, A2DPSimpleExponentialVolumeControl, A2DPLinearVolumeControl, and A2DPNoVolumeControl.

update_audio_data() [1/2]

virtual void A2DPVolumeControl::update_audio_data ( Frame *  data, uint16_t  frameCount  )

inlinevirtual

Updates audio data with volume control and optional mono downmix.

Parameters

data	Pointer to audio frame data
frameCount	Number of frames to process

Reimplemented in A2DPNoVolumeControl.

update_audio_data() [2/2]

virtual void A2DPVolumeControl::update_audio_data ( uint8_t *  data, uint16_t  byteCount  )

inlinevirtual

Updates audio data with volume control and optional mono downmix.

Parameters

data	Pointer to raw audio data (uint8_t)
byteCount	Number of bytes to process

---

The documentation for this class was generated from the following file:

• src/A2DPVolumeControl.h