Typedefs | Enumerations | Functions

LibVLC audio controls
[LibVLC media player]

Collaboration diagram for LibVLC audio controls:

Typedefs

typedef enum
libvlc_audio_output_device_types_t 		libvlc_audio_output_device_types_t
 Audio device types.
typedef enum
libvlc_audio_output_channel_t 		libvlc_audio_output_channel_t
 Audio channels.

Enumerations

enum  libvlc_audio_output_device_types_t {
  libvlc_AudioOutputDevice_Error = -1, libvlc_AudioOutputDevice_Mono = 1, libvlc_AudioOutputDevice_Stereo = 2, libvlc_AudioOutputDevice_2F2R = 4,
  libvlc_AudioOutputDevice_3F2R = 5, libvlc_AudioOutputDevice_5_1 = 6, libvlc_AudioOutputDevice_6_1 = 7, libvlc_AudioOutputDevice_7_1 = 8,
  libvlc_AudioOutputDevice_SPDIF = 10
}
 

Audio device types.

More...
enum  libvlc_audio_output_channel_t {
  libvlc_AudioChannel_Error = -1, libvlc_AudioChannel_Stereo = 1, libvlc_AudioChannel_RStereo = 2, libvlc_AudioChannel_Left = 3,
  libvlc_AudioChannel_Right = 4, libvlc_AudioChannel_Dolbys = 5
}
 

Audio channels.

More...

Functions

LIBVLC_API libvlc_audio_output_t * libvlc_audio_output_list_get (libvlc_instance_t *p_instance)
 Get the list of available audio outputs.
LIBVLC_API void libvlc_audio_output_list_release (libvlc_audio_output_t *p_list)
 Free the list of available audio outputs.
LIBVLC_API int libvlc_audio_output_set (libvlc_media_player_t *p_mi, const char *psz_name)
 Set the audio output.
LIBVLC_API int libvlc_audio_output_device_count (libvlc_instance_t *p_instance, const char *psz_audio_output)
 Get count of devices for audio output, these devices are hardware oriented like analor or digital output of sound card.
LIBVLC_API char * libvlc_audio_output_device_longname (libvlc_instance_t *p_instance, const char *psz_audio_output, int i_device)
 Get long name of device, if not available short name given.
LIBVLC_API char * libvlc_audio_output_device_id (libvlc_instance_t *p_instance, const char *psz_audio_output, int i_device)
 Get id name of device.
LIBVLC_API void libvlc_audio_output_device_set (libvlc_media_player_t *p_mi, const char *psz_audio_output, const char *psz_device_id)
 Set audio output device.
LIBVLC_API int libvlc_audio_output_get_device_type (libvlc_media_player_t *p_mi)
 Get current audio device type.
LIBVLC_API void libvlc_audio_output_set_device_type (libvlc_media_player_t *p_mi, int device_type)
 Set current audio device type.
LIBVLC_API void libvlc_audio_toggle_mute (libvlc_media_player_t *p_mi)
 Toggle mute status.
LIBVLC_API int libvlc_audio_get_mute (libvlc_media_player_t *p_mi)
 Get current mute status.
LIBVLC_API void libvlc_audio_set_mute (libvlc_media_player_t *p_mi, int status)
 Set mute status.
LIBVLC_API int libvlc_audio_get_volume (libvlc_media_player_t *p_mi)
 Get current software audio volume.
LIBVLC_API int libvlc_audio_set_volume (libvlc_media_player_t *p_mi, int i_volume)
 Set current software audio volume.
LIBVLC_API int libvlc_audio_get_track_count (libvlc_media_player_t *p_mi)
 Get number of available audio tracks.
LIBVLC_API
libvlc_track_description_t * 		libvlc_audio_get_track_description (libvlc_media_player_t *p_mi)
 Get the description of available audio tracks.
LIBVLC_API int libvlc_audio_get_track (libvlc_media_player_t *p_mi)
 Get current audio track.
LIBVLC_API int libvlc_audio_set_track (libvlc_media_player_t *p_mi, int i_track)
 Set current audio track.
LIBVLC_API int libvlc_audio_get_channel (libvlc_media_player_t *p_mi)
 Get current audio channel.
LIBVLC_API int libvlc_audio_set_channel (libvlc_media_player_t *p_mi, int channel)
 Set current audio channel.
LIBVLC_API int64_t libvlc_audio_get_delay (libvlc_media_player_t *p_mi)
 Get current audio delay.
LIBVLC_API int libvlc_audio_set_delay (libvlc_media_player_t *p_mi, int64_t i_delay)
 Set current audio delay.

Typedef Documentation

typedef enum libvlc_audio_output_channel_t libvlc_audio_output_channel_t

Audio channels.

typedef enum libvlc_audio_output_device_types_t libvlc_audio_output_device_types_t

Audio device types.

Enumeration Type Documentation

enum libvlc_audio_output_channel_t

Audio channels.

Enumerator:
libvlc_AudioChannel_Error 
libvlc_AudioChannel_Stereo 
libvlc_AudioChannel_RStereo 
libvlc_AudioChannel_Left 
libvlc_AudioChannel_Right 
libvlc_AudioChannel_Dolbys 
enum libvlc_audio_output_device_types_t

Audio device types.

Enumerator:
libvlc_AudioOutputDevice_Error 
libvlc_AudioOutputDevice_Mono 
libvlc_AudioOutputDevice_Stereo 
libvlc_AudioOutputDevice_2F2R 
libvlc_AudioOutputDevice_3F2R 
libvlc_AudioOutputDevice_5_1 
libvlc_AudioOutputDevice_6_1 
libvlc_AudioOutputDevice_7_1 
libvlc_AudioOutputDevice_SPDIF 

Function Documentation

LIBVLC_API int libvlc_audio_get_channel ( libvlc_media_player_t *  p_mi  ) 

Get current audio channel.

Parameters:
p_mi media player
Returns:
the audio channel
See also:
libvlc_audio_output_channel_t
LIBVLC_API int64_t libvlc_audio_get_delay ( libvlc_media_player_t *  p_mi  ) 

Get current audio delay.

Parameters:
p_mi media player
Returns:
the audio delay (microseconds)
Version:
LibVLC 1.1.1 or later
LIBVLC_API int libvlc_audio_get_mute ( libvlc_media_player_t *  p_mi  ) 

Get current mute status.

Parameters:
p_mi media player
Returns:
the mute status (boolean)
LIBVLC_API int libvlc_audio_get_track ( libvlc_media_player_t *  p_mi  ) 

Get current audio track.

Parameters:
p_mi media player
Returns:
the audio track (int), or -1 if none.
LIBVLC_API int libvlc_audio_get_track_count ( libvlc_media_player_t *  p_mi  ) 

Get number of available audio tracks.

Parameters:
p_mi media player
Returns:
the number of available audio tracks (int), or -1 if unavailable
LIBVLC_API libvlc_track_description_t* libvlc_audio_get_track_description ( libvlc_media_player_t *  p_mi  ) 

Get the description of available audio tracks.

Parameters:
p_mi media player
Returns:
list with description of available audio tracks, or NULL
LIBVLC_API int libvlc_audio_get_volume ( libvlc_media_player_t *  p_mi  ) 

Get current software audio volume.

Parameters:
p_mi media player
Returns:
the software volume in percents (0 = mute, 100 = nominal / 0dB)
LIBVLC_API int libvlc_audio_output_device_count ( libvlc_instance_t *  p_instance,
const char *  psz_audio_output 
)

Get count of devices for audio output, these devices are hardware oriented like analor or digital output of sound card.

Parameters:
p_instance libvlc instance
psz_audio_output - name of audio output,
See also:
libvlc_audio_output_t
Returns:
number of devices
LIBVLC_API char* libvlc_audio_output_device_id ( libvlc_instance_t *  p_instance,
const char *  psz_audio_output,
int  i_device 
)

Get id name of device.

Parameters:
p_instance libvlc instance
psz_audio_output - name of audio output,
See also:
libvlc_audio_output_t
Parameters:
i_device device index
Returns:
id name of device, use for setting device, need to be free after use
LIBVLC_API char* libvlc_audio_output_device_longname ( libvlc_instance_t *  p_instance,
const char *  psz_audio_output,
int  i_device 
)

Get long name of device, if not available short name given.

Parameters:
p_instance libvlc instance
psz_audio_output - name of audio output,
See also:
libvlc_audio_output_t
Parameters:
i_device device index
Returns:
long name of device
LIBVLC_API void libvlc_audio_output_device_set ( libvlc_media_player_t *  p_mi,
const char *  psz_audio_output,
const char *  psz_device_id 
)

Set audio output device.

Changes are only effective after stop and play.

Parameters:
p_mi media player
psz_audio_output - name of audio output,
See also:
libvlc_audio_output_t
Parameters:
psz_device_id device
LIBVLC_API int libvlc_audio_output_get_device_type ( libvlc_media_player_t *  p_mi  ) 

Get current audio device type.

Device type describes something like character of output sound - stereo sound, 2.1, 5.1 etc

Parameters:
p_mi media player
Returns:
the audio devices type
See also:
libvlc_audio_output_device_types_t
LIBVLC_API libvlc_audio_output_t* libvlc_audio_output_list_get ( libvlc_instance_t *  p_instance  ) 

Get the list of available audio outputs.

Parameters:
p_instance libvlc instance
Returns:
list of available audio outputs. It must be freed it with
See also:
libvlc_audio_output_list_release
libvlc_audio_output_t . In case of error, NULL is returned.
LIBVLC_API void libvlc_audio_output_list_release ( libvlc_audio_output_t *  p_list  ) 

Free the list of available audio outputs.

Parameters:
p_list list with audio outputs for release
LIBVLC_API int libvlc_audio_output_set ( libvlc_media_player_t *  p_mi,
const char *  psz_name 
)

Set the audio output.

Change will be applied after stop and play.

Parameters:
p_mi media player
psz_name name of audio output, use psz_name of
See also:
libvlc_audio_output_t
Returns:
0 if function succeded, -1 on error
LIBVLC_API void libvlc_audio_output_set_device_type ( libvlc_media_player_t *  p_mi,
int  device_type 
)

Set current audio device type.

Parameters:
p_mi vlc instance
device_type the audio device type, according to
See also:
libvlc_audio_output_device_types_t
LIBVLC_API int libvlc_audio_set_channel ( libvlc_media_player_t *  p_mi,
int  channel 
)

Set current audio channel.

Parameters:
p_mi media player
channel the audio channel,
See also:
libvlc_audio_output_channel_t
Returns:
0 on success, -1 on error
LIBVLC_API int libvlc_audio_set_delay ( libvlc_media_player_t *  p_mi,
int64_t  i_delay 
)

Set current audio delay.

The audio delay will be reset to zero each time the media changes.

Parameters:
p_mi media player
i_delay the audio delay (microseconds)
Returns:
0 on success, -1 on error
Version:
LibVLC 1.1.1 or later
LIBVLC_API void libvlc_audio_set_mute ( libvlc_media_player_t *  p_mi,
int  status 
)

Set mute status.

Parameters:
p_mi media player
status If status is true then mute, otherwise unmute
LIBVLC_API int libvlc_audio_set_track ( libvlc_media_player_t *  p_mi,
int  i_track 
)

Set current audio track.

Parameters:
p_mi media player
i_track the track (int)
Returns:
0 on success, -1 on error
LIBVLC_API int libvlc_audio_set_volume ( libvlc_media_player_t *  p_mi,
int  i_volume 
)

Set current software audio volume.

Parameters:
p_mi media player
i_volume the volume in percents (0 = mute, 100 = 0dB)
Returns:
0 if the volume was set, -1 if it was out of range
LIBVLC_API void libvlc_audio_toggle_mute ( libvlc_media_player_t *  p_mi  ) 

Toggle mute status.

Parameters:
p_mi media player
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines
Generated by  doxygen 1.7.1