#include <vlc_aout.h>

Public Attributes
VLC_COMMON_MEMBERS struct aout_sys_t *	sys

int(*	start )(audio_output_t , audio_sample_format_t fmt)

void(*	stop )(audio_output_t *)

int(*	time_get )(audio_output_t , mtime_t delay)

void(*	play )(audio_output_t , block_t )

void(*	pause )(audio_output_t *, bool pause, mtime_t date)

void(*	flush )(audio_output_t *, bool wait)

int(*	volume_set )(audio_output_t *, float volume)

int(*	mute_set )(audio_output_t *, bool mute)

int(*	device_select )(audio_output_t , const char id)

struct {
void(* volume_report )(audio_output_t *, float)

void(* mute_report )(audio_output_t *, bool)

void(* policy_report )(audio_output_t *, bool)

void(* device_report )(audio_output_t , const char )

void(* hotplug_report )(audio_output_t , const char , const char *)

int(* gain_request )(audio_output_t *, float)

void(* restart_request )(audio_output_t *, unsigned)

}	event

Detailed Description

Audio output object

Member Data Documentation

int(* audio_output::device_select)(audio_output_t *, const char *id)

Selects an audio output device (optional, may be NULL).

Parameters

id	nul-terminated device unique identifier.

Returns: 0 on success, non-zero on failure.

Warning: A stream may or may not have been started when called.

void(* audio_output::flush)(audio_output_t *, bool wait)

Flushes or drains the playback buffers (mandatory, cannot be NULL).

Parameters

wait	true to wait for playback of pending buffers (drain), false to discard pending buffers (flush)

Note: A stream must have been started when called.

int(* audio_output::mute_set)(audio_output_t *, bool mute)

Changes muting (optinal, may be NULL).

Parameters

mute	true to mute, false to unmute

Warning: A stream may or may not have been started when called.

void(* audio_output::pause)(audio_output_t *, bool pause, mtime_t date)

Pauses or resumes playback (optional, may be NULL).

Parameters

pause	pause if true, resume from pause if false
date	timestamp when the pause or resume was requested

Note: A stream must have been started when called.

void(* audio_output::play)(audio_output_t *, block_t *)

Queues a block of samples for playback (mandatory, cannot be NULL).

Note: A stream must have been started when called.

int(* audio_output::start)(audio_output_t *, audio_sample_format_t *fmt)

Starts a new stream (mandatory, cannot be NULL).

Parameters

fmt	input stream sample format upon entry, output stream sample format upon return [IN/OUT]

Returns: VLC_SUCCESS on success, non-zero on failure

Note: No other stream may be already started when called.

void(* audio_output::stop)(audio_output_t *)

Stops the existing stream (optional, may be NULL).

Note: A stream must have been started when called.

VLC_COMMON_MEMBERS struct aout_sys_t* audio_output::sys

Private data for callbacks

int(* audio_output::time_get)(audio_output_t *, mtime_t *delay)

Estimates playback buffer latency (optional, may be NULL).

Parameters

delay pointer to the delay until the next sample to be written to the playback buffer is rendered [OUT]

Returns: 0 on success, non-zero on failure or lack of data

Note: A stream must have been started when called.

int(* audio_output::volume_set)(audio_output_t *, float volume)

Changes playback volume (optional, may be NULL).

Parameters

volume requested volume (0. = mute, 1. = nominal)

Note: The volume is always a positive number.

Warning: A stream may or may not have been started when called.

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

C:/Users/max/ti/qt5/qvisu/vlc/include/vlc/plugins/vlc_aout.h

Public Attributes

Detailed Description

Member Data Documentation