vlc_aout_intf.h File Reference

This file defines functions, structures and macros for audio output object. More...

Go to the source code of this file.

Defines
#define	AOUT_VOLUME_DEFAULT   256
#define	AOUT_VOLUME_MAX   512
#define	aout_VolumeGet(a)   aout_VolumeGet(VLC_OBJECT(a))
#define	aout_VolumeSet(a, b)   aout_VolumeSet(VLC_OBJECT(a), b)
#define	aout_VolumeUp(a, b, c)   aout_VolumeUp(VLC_OBJECT(a), b, c)
#define	aout_VolumeDown(a, b, c)   aout_VolumeUp(a, -(b), c)
#define	aout_ToggleMute(a, b)   aout_ToggleMute(VLC_OBJECT(a), b)
#define	aout_EnableFilter(o, n, b)   aout_EnableFilter( VLC_OBJECT(o), n, b )
Functions
VLC_API audio_volume_t	aout_VolumeGet (vlc_object_t *)
	Gets the volume of the output device (independent of mute).
VLC_API int	aout_VolumeSet (vlc_object_t *, audio_volume_t)
	Sets the volume of the output device.
VLC_API int	aout_VolumeUp (vlc_object_t *, int, audio_volume_t *)
	Raises the volume.
VLC_API int	aout_ToggleMute (vlc_object_t *, audio_volume_t *)
	Toggles the mute state.
VLC_API int	aout_SetMute (vlc_object_t *, audio_volume_t *, bool)
	Sets mute status.
VLC_API bool	aout_IsMuted (vlc_object_t *)
	Gets the output mute status.
VLC_API void	aout_EnableFilter (vlc_object_t *, const char *, bool)
	Enable or disable an audio filter.

---

Detailed Description

This file defines functions, structures and macros for audio output object.

---

Define Documentation

#define aout_EnableFilter	(		o,
			n,
			b
	)			aout_EnableFilter( VLC_OBJECT(o), n, b )

#define aout_ToggleMute	(		a,
			b
	)			aout_ToggleMute(VLC_OBJECT(a), b)

#define AOUT_VOLUME_DEFAULT   256

Referenced by aout_VolumeHardSet(), aout_VolumeSoftInit(), and commitVolume().

#define AOUT_VOLUME_MAX   512

Referenced by aout_VolumeUp().

#define aout_VolumeDown	(		a,
			b,
			c
	)			aout_VolumeUp(a, -(b), c)

#define aout_VolumeGet

(

a

)

aout_VolumeGet(VLC_OBJECT(a))

Referenced by str_format_meta().

#define aout_VolumeSet	(		a,
			b
	)			aout_VolumeSet(VLC_OBJECT(a), b)

#define aout_VolumeUp	(		a,
			b,
			c
	)			aout_VolumeUp(VLC_OBJECT(a), b, c)

---

Function Documentation

VLC_API void aout_EnableFilter	(	vlc_object_t *	p_this,
		const char *	psz_name,
		bool	b_add
	)

Enable or disable an audio filter.

Parameters:

	p_this	a vlc object
	psz_name	name of the filter
	b_add	are we adding or removing the filter ?

References aout_ChangeFilterString(), aout_InputRequestRestart(), findAout, VLC_OBJECT, and vlc_object_release.

VLC_API bool aout_IsMuted

(

vlc_object_t *

)

Gets the output mute status.

References cancelVolume(), and prepareVolume().

VLC_API int aout_SetMute	(	vlc_object_t *	,
		audio_volume_t *	,
		bool
	)

Sets mute status.

References commitVolume(), and prepareVolume().

VLC_API int aout_ToggleMute	(	vlc_object_t *	,
		audio_volume_t *
	)

Toggles the mute state.

References commitVolume(), and prepareVolume().

VLC_API audio_volume_t aout_VolumeGet

(

vlc_object_t *

)

Gets the volume of the output device (independent of mute).

References cancelVolume(), and prepareVolume().

VLC_API int aout_VolumeSet	(	vlc_object_t *	obj,
		audio_volume_t	volume
	)

Sets the volume of the output device.

The mute status is not changed.

References commitVolume(), and prepareVolume().

VLC_API int aout_VolumeUp	(	vlc_object_t *	obj,
		int	value,
		audio_volume_t *	volp
	)

Raises the volume.

Parameters:

	value	how much to increase (> 0) or decrease (< 0) the volume
	volp	if non-NULL, will contain contain the resulting volume

References AOUT_VOLUME_MAX, commitVolume(), prepareVolume(), and var_InheritInteger.