libvlc_audio
[libvlc_media_player]

Collaboration diagram for libvlc_audio:
LibVLC Audio handling. More...

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

VLC_PUBLIC_API
libvlc_audio_output_t * 		libvlc_audio_output_list_get (libvlc_instance_t *, libvlc_exception_t *)
 Get the list of available audio outputs.
VLC_PUBLIC_API void libvlc_audio_output_list_release (libvlc_audio_output_t *)
 Free the list of available audio outputs.
VLC_PUBLIC_API int libvlc_audio_output_set (libvlc_instance_t *, const char *)
 Set the audio output.
VLC_PUBLIC_API int libvlc_audio_output_device_count (libvlc_instance_t *, const char *)
 Get count of devices for audio output, these devices are hardware oriented like analor or digital output of sound card.
VLC_PUBLIC_API char * libvlc_audio_output_device_longname (libvlc_instance_t *, const char *, int)
 Get long name of device, if not available short name given.
VLC_PUBLIC_API char * libvlc_audio_output_device_id (libvlc_instance_t *, const char *, int)
 Get id name of device.
VLC_PUBLIC_API void libvlc_audio_output_device_set (libvlc_instance_t *, const char *, const char *)
 Set device for using.
VLC_PUBLIC_API int libvlc_audio_output_get_device_type (libvlc_instance_t *, libvlc_exception_t *)
 Get current audio device type.
VLC_PUBLIC_API void libvlc_audio_output_set_device_type (libvlc_instance_t *, int, libvlc_exception_t *)
 Set current audio device type.
VLC_PUBLIC_API void libvlc_audio_toggle_mute (libvlc_instance_t *)
 Toggle mute status.
VLC_PUBLIC_API int libvlc_audio_get_mute (libvlc_instance_t *)
 Get current mute status.
VLC_PUBLIC_API void libvlc_audio_set_mute (libvlc_instance_t *, int)
 Set mute status.
VLC_PUBLIC_API int libvlc_audio_get_volume (libvlc_instance_t *)
 Get current audio level.
VLC_PUBLIC_API void libvlc_audio_set_volume (libvlc_instance_t *, int, libvlc_exception_t *)
 Set current audio level.
VLC_PUBLIC_API int libvlc_audio_get_track_count (libvlc_media_player_t *, libvlc_exception_t *)
 Get number of available audio tracks.
VLC_PUBLIC_API
libvlc_track_description_t * 		libvlc_audio_get_track_description (libvlc_media_player_t *, libvlc_exception_t *)
 Get the description of available audio tracks.
VLC_PUBLIC_API int libvlc_audio_get_track (libvlc_media_player_t *, libvlc_exception_t *)
 Get current audio track.
VLC_PUBLIC_API void libvlc_audio_set_track (libvlc_media_player_t *, int, libvlc_exception_t *)
 Set current audio track.
VLC_PUBLIC_API int libvlc_audio_get_channel (libvlc_instance_t *, libvlc_exception_t *)
 Get current audio channel.
VLC_PUBLIC_API void libvlc_audio_set_channel (libvlc_instance_t *, int, libvlc_exception_t *)
 Set current audio channel.

Detailed Description

LibVLC Audio handling.

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

VLC_PUBLIC_API int libvlc_audio_get_channel ( libvlc_instance_t *  ,
libvlc_exception_t *   
)

Get current audio channel.

Parameters:
p_instance vlc instance
p_e an initialized exception pointer
Returns:
the audio channel
See also:
libvlc_audio_output_channel_t

References GetAOut(), var_GetInteger, and vlc_object_release.

VLC_PUBLIC_API int libvlc_audio_get_mute ( libvlc_instance_t *   ) 

Get current mute status.

Parameters:
p_instance libvlc instance
Returns:
the mute status (boolean)

References libvlc_audio_get_volume().

Referenced by libvlc_audio_set_mute().

VLC_PUBLIC_API int libvlc_audio_get_track ( libvlc_media_player_t *  ,
libvlc_exception_t *   
)

Get current audio track.

Parameters:
p_mi media player
p_e an initialized exception pointer
Returns:
the audio track (int)

References i, vlc_list_t::i_count, vlc_value_t::i_int, libvlc_exception_raise(), libvlc_get_input_thread(), libvlc_printerr(), vlc_value_t::p_list, vlc_list_t::p_values, var_Change, var_FreeList(), var_Get, vlc_object_release, and VLC_VAR_GETCHOICES.

VLC_PUBLIC_API int libvlc_audio_get_track_count ( libvlc_media_player_t *  ,
libvlc_exception_t *   
)

Get number of available audio tracks.

Parameters:
p_mi media player
p_e an initialized exception
Returns:
the number of available audio tracks (int)

References libvlc_get_input_thread(), var_CountChoices, and vlc_object_release.

VLC_PUBLIC_API libvlc_track_description_t* libvlc_audio_get_track_description ( libvlc_media_player_t *  ,
libvlc_exception_t *   
)

Get the description of available audio tracks.

Parameters:
p_mi media player
p_e an initialized exception
Returns:
list with description of available audio tracks

References libvlc_get_track_description().

VLC_PUBLIC_API int libvlc_audio_get_volume ( libvlc_instance_t *   ) 

Get current audio level.

Parameters:
p_instance libvlc instance
p_e an initialized exception pointer
Returns:
the audio level (int)

References AOUT_VOLUME_MAX, aout_VolumeGet, and libvlc_instance_t::p_libvlc_int.

Referenced by libvlc_audio_get_mute(), and mediacontrol_sound_get_volume().

VLC_PUBLIC_API int libvlc_audio_output_device_count ( libvlc_instance_t *  ,
const char *   
)

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

References asprintf(), config_FindConfig(), module_config_t::i_list, libvlc_instance_t::p_libvlc_int, module_config_t::pf_update_list, module_value_t::psz, vlc_value_t::psz_string, strdup(), module_config_t::value, and VLC_OBJECT.

VLC_PUBLIC_API char* libvlc_audio_output_device_id ( libvlc_instance_t *  ,
const char *  ,
int   
)

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

References asprintf(), config_FindConfig(), module_config_t::i_list, libvlc_instance_t::p_libvlc_int, module_config_t::pf_update_list, module_config_t::ppsz_list, module_value_t::psz, vlc_value_t::psz_string, strdup(), module_config_t::value, and VLC_OBJECT.

VLC_PUBLIC_API char* libvlc_audio_output_device_longname ( libvlc_instance_t *  ,
const char *  ,
int   
)

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

References asprintf(), config_FindConfig(), module_config_t::i_list, libvlc_instance_t::p_libvlc_int, module_config_t::pf_update_list, module_config_t::ppsz_list, module_config_t::ppsz_list_text, module_value_t::psz, vlc_value_t::psz_string, strdup(), module_config_t::value, and VLC_OBJECT.

VLC_PUBLIC_API void libvlc_audio_output_device_set ( libvlc_instance_t *  ,
const char *  ,
const char *   
)

Set device for using.

Parameters:
p_instance libvlc instance
psz_audio_output - name of audio output,
See also:
libvlc_audio_output_t
Parameters:
psz_device_id device

References asprintf(), config_PutPsz, and libvlc_instance_t::p_libvlc_int.

VLC_PUBLIC_API int libvlc_audio_output_get_device_type ( libvlc_instance_t *  ,
libvlc_exception_t *   
)

Get current audio device type.

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

Parameters:
p_instance vlc instance
p_e an initialized exception pointer
Returns:
the audio devices type
See also:
libvlc_audio_output_device_types_t

References GetAOut(), libvlc_AudioOutputDevice_Error, var_GetInteger, and vlc_object_release.

VLC_PUBLIC_API libvlc_audio_output_t* libvlc_audio_output_list_get ( libvlc_instance_t *  ,
libvlc_exception_t *   
)

Get the list of available audio outputs.

Parameters:
p_instance libvlc instance
p_e an initialized exception pointer
Returns:
list of available audio outputs, at the end free it with
See also:
libvlc_audio_output_list_release

libvlc_audio_output_t

References i, libvlc_audio_output_list_release(), libvlc_exception_raise(), libvlc_printerr(), module_get_name(), module_get_object(), module_list_free(), module_list_get(), module_provides(), libvlc_audio_output_t::psz_name, strdup(), and VLC_UNUSED.

VLC_PUBLIC_API void libvlc_audio_output_list_release ( libvlc_audio_output_t *   ) 

Free the list of available audio outputs.

Parameters:
p_list list with audio outputs for release

References libvlc_audio_output_t::p_next, libvlc_audio_output_t::psz_description, and libvlc_audio_output_t::psz_name.

Referenced by libvlc_audio_output_list_get().

VLC_PUBLIC_API int libvlc_audio_output_set ( libvlc_instance_t *  ,
const char *   
)

Set the audio output.

Change will be applied after stop and play.

Parameters:
p_instance libvlc instance
psz_name name of audio output, use psz_name of
See also:
libvlc_audio_output_t
Returns:
true if function succeded

References config_PutPsz, module_exists(), and libvlc_instance_t::p_libvlc_int.

VLC_PUBLIC_API void libvlc_audio_output_set_device_type ( libvlc_instance_t *  ,
int  ,
libvlc_exception_t *   
)

Set current audio device type.

Parameters:
p_instance vlc instance
device_type the audio device type, according to
See also:
libvlc_audio_output_device_types_t
Parameters:
p_e an initialized exception pointer

References GetAOut(), libvlc_exception_raise(), libvlc_printerr(), var_SetInteger, and vlc_object_release.

VLC_PUBLIC_API void libvlc_audio_set_channel ( libvlc_instance_t *  ,
int  ,
libvlc_exception_t *   
)

Set current audio channel.

Parameters:
p_instance vlc instance
channel the audio channel,
See also:
libvlc_audio_output_channel_t
Parameters:
p_e an initialized exception pointer

References GetAOut(), libvlc_exception_raise(), libvlc_printerr(), var_SetInteger, and vlc_object_release.

VLC_PUBLIC_API void libvlc_audio_set_mute ( libvlc_instance_t *  ,
int   
)

Set mute status.

Parameters:
p_instance libvlc instance
status If status is true then mute, otherwise unmute

References aout_ToggleMute, libvlc_audio_get_mute(), and libvlc_instance_t::p_libvlc_int.

VLC_PUBLIC_API void libvlc_audio_set_track ( libvlc_media_player_t *  ,
int  ,
libvlc_exception_t *   
)

Set current audio track.

Parameters:
p_mi media player
i_track the track (int)
p_e an initialized exception pointer

References vlc_list_t::i_count, libvlc_exception_raise(), libvlc_get_input_thread(), libvlc_printerr(), vlc_value_t::p_list, vlc_list_t::p_values, var_Change, var_FreeList(), var_Set, vlc_object_release, and VLC_VAR_GETCHOICES.

VLC_PUBLIC_API void libvlc_audio_set_volume ( libvlc_instance_t *  ,
int  ,
libvlc_exception_t *   
)

Set current audio level.

Parameters:
p_instance libvlc instance
i_volume the volume (int)
p_e an initialized exception pointer

References AOUT_VOLUME_MAX, aout_VolumeSet, libvlc_exception_raise(), libvlc_printerr(), and libvlc_instance_t::p_libvlc_int.

Referenced by mediacontrol_sound_set_volume().

VLC_PUBLIC_API void libvlc_audio_toggle_mute ( libvlc_instance_t *   ) 

Toggle mute status.

Parameters:
p_instance libvlc instance

References aout_ToggleMute, and libvlc_instance_t::p_libvlc_int.

Generated on Sat Nov 21 08:06:03 2009 for VLC by  doxygen 1.5.6