libvlc.h File Reference

Go to the source code of this file.

Defines

#define VLC_LIBVLC_H   1
#define VLC_PUBLIC_API
#define VLC_DEPRECATED_API   VLC_PUBLIC_API

Functions

void libvlc_exception_init (libvlc_exception_t *p_exception)
 Initialize an exception structure.
int libvlc_exception_raised (const libvlc_exception_t *p_exception)
 Has an exception been raised?
void libvlc_exception_raise (libvlc_exception_t *p_exception, const char *psz_format,...)
 Raise an exception using a user-provided message.
void libvlc_exception_clear (libvlc_exception_t *)
 Clear an exception object so it can be reused.
const char * libvlc_exception_get_message (const libvlc_exception_t *p_exception)
 Get an exception's message.
libvlc_instance_tlibvlc_new (int, const char *const *, libvlc_exception_t *)
 Create and initialize a libvlc instance.
int libvlc_get_vlc_id (libvlc_instance_t *p_instance)
 Return a libvlc instance identifier for legacy APIs.
void libvlc_release (libvlc_instance_t *)
 Decrement the reference count of a libvlc instance, and destroy it if it reaches zero.
void libvlc_retain (libvlc_instance_t *)
 Increments the reference count of a libvlc instance.
void libvlc_add_intf (libvlc_instance_t *p_instance, const char *name, libvlc_exception_t *p_exception)
 Try to start a user interface for the libvlc instance, and wait until the user exits.
void libvlc_wait (libvlc_instance_t *p_instance)
 Waits until an interface causes the instance to exit.
const char * libvlc_get_version (void)
 Retrieve libvlc version.
const char * libvlc_get_compiler (void)
 Retrieve libvlc compiler version.
const char * libvlc_get_changeset (void)
 Retrieve libvlc changeset.
libvlc_media_tlibvlc_media_new (libvlc_instance_t *p_instance, const char *psz_mrl, libvlc_exception_t *p_e)
 Create a media with the given MRL.
libvlc_media_tlibvlc_media_new_as_node (libvlc_instance_t *p_instance, const char *psz_name, libvlc_exception_t *p_e)
 Create a media as an empty node with the passed name.
void libvlc_media_add_option (libvlc_media_t *p_md, const char *ppsz_options, libvlc_exception_t *p_e)
 Add an option to the media.
void libvlc_media_retain (libvlc_media_t *p_meta_desc)
 Retain a reference to a media descriptor object (libvlc_media_t).
void libvlc_media_release (libvlc_media_t *p_meta_desc)
 Decrement the reference count of a media descriptor object.
char * libvlc_media_get_mrl (libvlc_media_t *p_md, libvlc_exception_t *p_e)
 Get the media resource locator (mrl) from a media descriptor object.
libvlc_media_tlibvlc_media_duplicate (libvlc_media_t *)
 Duplicate a media descriptor object.
char * libvlc_media_get_meta (libvlc_media_t *p_meta_desc, libvlc_meta_t e_meta, libvlc_exception_t *p_e)
 Read the meta of the media.
libvlc_state_t libvlc_media_get_state (libvlc_media_t *p_meta_desc, libvlc_exception_t *p_e)
 Get current state of media descriptor object.
libvlc_media_list_tlibvlc_media_subitems (libvlc_media_t *p_md, libvlc_exception_t *p_e)
 Get subitems of media descriptor object.
libvlc_event_manager_tlibvlc_media_event_manager (libvlc_media_t *p_md, libvlc_exception_t *p_e)
 Get event manager from media descriptor object.
libvlc_time_t libvlc_media_get_duration (libvlc_media_t *p_md, libvlc_exception_t *p_e)
 Get duration of media descriptor object item.
int libvlc_media_is_preparsed (libvlc_media_t *p_md, libvlc_exception_t *p_e)
 Get preparsed status for media descriptor object.
void libvlc_media_set_user_data (libvlc_media_t *p_md, void *p_new_user_data, libvlc_exception_t *p_e)
 Sets media descriptor's user_data.
void * libvlc_media_get_user_data (libvlc_media_t *p_md, libvlc_exception_t *p_e)
 Get media descriptor's user_data.
libvlc_media_player_tlibvlc_media_player_new (libvlc_instance_t *, libvlc_exception_t *)
 Create an empty Media Player object.
libvlc_media_player_tlibvlc_media_player_new_from_media (libvlc_media_t *, libvlc_exception_t *)
 Create a Media Player object from a Media.
void libvlc_media_player_release (libvlc_media_player_t *)
 Release a media_player after use Decrement the reference count of a media player object.
void libvlc_media_player_retain (libvlc_media_player_t *)
 Retain a reference to a media player object.
void libvlc_media_player_set_media (libvlc_media_player_t *, libvlc_media_t *, libvlc_exception_t *)
 Set the media that will be used by the media_player.
libvlc_media_tlibvlc_media_player_get_media (libvlc_media_player_t *, libvlc_exception_t *)
 Get the media used by the media_player.
libvlc_event_manager_tlibvlc_media_player_event_manager (libvlc_media_player_t *, libvlc_exception_t *)
 Get the Event Manager from which the media player send event.
void libvlc_media_player_play (libvlc_media_player_t *, libvlc_exception_t *)
 Play.
void libvlc_media_player_pause (libvlc_media_player_t *, libvlc_exception_t *)
 Pause.
void libvlc_media_player_stop (libvlc_media_player_t *, libvlc_exception_t *)
 Stop.
void libvlc_media_player_set_drawable (libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t *)
 Set the drawable where the media player should render its video output.
libvlc_drawable_t libvlc_media_player_get_drawable (libvlc_media_player_t *, libvlc_exception_t *)
 Get the drawable where the media player should render its video output.
libvlc_time_t libvlc_media_player_get_length (libvlc_media_player_t *, libvlc_exception_t *)
 Get the current movie length (in ms).
libvlc_time_t libvlc_media_player_get_time (libvlc_media_player_t *, libvlc_exception_t *)
 Get the current movie time (in ms).
void libvlc_media_player_set_time (libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *)
 Set the movie time (in ms).
float libvlc_media_player_get_position (libvlc_media_player_t *, libvlc_exception_t *)
void libvlc_media_player_set_position (libvlc_media_player_t *, float, libvlc_exception_t *)
void libvlc_media_player_set_chapter (libvlc_media_player_t *, int, libvlc_exception_t *)
int libvlc_media_player_get_chapter (libvlc_media_player_t *, libvlc_exception_t *)
int libvlc_media_player_get_chapter_count (libvlc_media_player_t *, libvlc_exception_t *)
int libvlc_media_player_will_play (libvlc_media_player_t *, libvlc_exception_t *)
float libvlc_media_player_get_rate (libvlc_media_player_t *, libvlc_exception_t *)
void libvlc_media_player_set_rate (libvlc_media_player_t *, float, libvlc_exception_t *)
libvlc_state_t libvlc_media_player_get_state (libvlc_media_player_t *, libvlc_exception_t *)
float libvlc_media_player_get_fps (libvlc_media_player_t *, libvlc_exception_t *)
int libvlc_media_player_has_vout (libvlc_media_player_t *, libvlc_exception_t *)
 Does this media player have a video output?
int libvlc_media_player_is_seekable (libvlc_media_player_t *p_mi, libvlc_exception_t *p_e)
 Is this media player seekable?
int libvlc_media_player_can_pause (libvlc_media_player_t *p_mi, libvlc_exception_t *p_e)
 Can this media player be paused?
void libvlc_toggle_fullscreen (libvlc_media_player_t *, libvlc_exception_t *)
 Toggle fullscreen status on video output.
void libvlc_set_fullscreen (libvlc_media_player_t *, int, libvlc_exception_t *)
 Enable or disable fullscreen on a video output.
int libvlc_get_fullscreen (libvlc_media_player_t *, libvlc_exception_t *)
 Get current fullscreen status.
int libvlc_video_get_height (libvlc_media_player_t *, libvlc_exception_t *)
 Get current video height.
int libvlc_video_get_width (libvlc_media_player_t *, libvlc_exception_t *)
 Get current video width.
char * libvlc_video_get_aspect_ratio (libvlc_media_player_t *, libvlc_exception_t *)
 Get current video aspect ratio.
void libvlc_video_set_aspect_ratio (libvlc_media_player_t *, char *, libvlc_exception_t *)
 Set new video aspect ratio.
int libvlc_video_get_spu (libvlc_media_player_t *, libvlc_exception_t *)
 Get current video subtitle.
void libvlc_video_set_spu (libvlc_media_player_t *, int, libvlc_exception_t *)
 Set new video subtitle.
int libvlc_video_set_subtitle_file (libvlc_media_player_t *, char *, libvlc_exception_t *)
 Set new video subtitle file.
char * libvlc_video_get_crop_geometry (libvlc_media_player_t *, libvlc_exception_t *)
 Get current crop filter geometry.
void libvlc_video_set_crop_geometry (libvlc_media_player_t *, char *, libvlc_exception_t *)
 Set new crop filter geometry.
void libvlc_toggle_teletext (libvlc_media_player_t *, libvlc_exception_t *)
 Toggle teletext transparent status on video output.
int libvlc_video_get_teletext (libvlc_media_player_t *, libvlc_exception_t *)
 Get current teletext page requested.
void libvlc_video_set_teletext (libvlc_media_player_t *, int, libvlc_exception_t *)
 Set new teletext page to retrieve.
void libvlc_video_take_snapshot (libvlc_media_player_t *, char *, unsigned int, unsigned int, libvlc_exception_t *)
 Take a snapshot of the current video window.
void libvlc_video_resize (libvlc_media_player_t *, int, int, libvlc_exception_t *)
 Resize the current video output window.
int libvlc_video_reparent (libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t *)
 Change the parent for the current the video output.
void libvlc_video_redraw_rectangle (libvlc_media_player_t *, const libvlc_rectangle_t *, libvlc_exception_t *)
 Tell windowless video output to redraw rectangular area (MacOS X only).
void libvlc_video_set_size (libvlc_instance_t *, int, int, libvlc_exception_t *)
 Set the default video output size.
void libvlc_video_set_viewport (libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t *)
 Set the default video output viewport for a windowless video output (MacOS X only).
void libvlc_audio_toggle_mute (libvlc_instance_t *, libvlc_exception_t *)
 Toggle mute status.
int libvlc_audio_get_mute (libvlc_instance_t *, libvlc_exception_t *)
 Get current mute status.
void libvlc_audio_set_mute (libvlc_instance_t *, int, libvlc_exception_t *)
 Set mute status.
int libvlc_audio_get_volume (libvlc_instance_t *, libvlc_exception_t *)
 Get current audio level.
void libvlc_audio_set_volume (libvlc_instance_t *, int, libvlc_exception_t *)
 Set current audio level.
int libvlc_audio_get_track_count (libvlc_media_player_t *, libvlc_exception_t *)
 Get number of available audio tracks.
int libvlc_audio_get_track (libvlc_media_player_t *, libvlc_exception_t *)
 Get current audio track.
void libvlc_audio_set_track (libvlc_media_player_t *, int, libvlc_exception_t *)
 Set current audio track.
int libvlc_audio_get_channel (libvlc_instance_t *, libvlc_exception_t *)
 Get current audio channel.
void libvlc_audio_set_channel (libvlc_instance_t *, int, libvlc_exception_t *)
 Set current audio channel.
void libvlc_event_attach (libvlc_event_manager_t *p_event_manager, libvlc_event_type_t i_event_type, libvlc_callback_t f_callback, void *user_data, libvlc_exception_t *p_e)
 Register for an event notification.
void libvlc_event_detach (libvlc_event_manager_t *p_event_manager, libvlc_event_type_t i_event_type, libvlc_callback_t f_callback, void *p_user_data, libvlc_exception_t *p_e)
 Unregister an event notification.
const char * libvlc_event_type_name (libvlc_event_type_t event_type)
 Get an event's type name.
libvlc_media_library_tlibvlc_media_library_new (libvlc_instance_t *p_inst, libvlc_exception_t *p_e)
void libvlc_media_library_release (libvlc_media_library_t *p_mlib)
 Release media library object.
void libvlc_media_library_retain (libvlc_media_library_t *p_mlib)
 Retain a reference to a media library object.
void libvlc_media_library_load (libvlc_media_library_t *p_mlib, libvlc_exception_t *p_e)
 Load media library.
void libvlc_media_library_save (libvlc_media_library_t *p_mlib, libvlc_exception_t *p_e)
 Save media library.
libvlc_media_list_tlibvlc_media_library_media_list (libvlc_media_library_t *p_mlib, libvlc_exception_t *p_e)
 Get media library subitems.
libvlc_media_discoverer_tlibvlc_media_discoverer_new_from_name (libvlc_instance_t *p_inst, const char *psz_name, libvlc_exception_t *p_e)
 Discover media service by name.
void libvlc_media_discoverer_release (libvlc_media_discoverer_t *p_mdis)
 Release media discover object.
char * libvlc_media_discoverer_localized_name (libvlc_media_discoverer_t *p_mdis)
 Get media service discover object its localized name.
libvlc_media_list_tlibvlc_media_discoverer_media_list (libvlc_media_discoverer_t *p_mdis)
 Get media service discover media list.
libvlc_event_manager_tlibvlc_media_discoverer_event_manager (libvlc_media_discoverer_t *p_mdis)
 Get event manager from media service discover object.
int libvlc_media_discoverer_is_running (libvlc_media_discoverer_t *p_mdis)
 Query if media service discover object is running.
unsigned libvlc_get_log_verbosity (const libvlc_instance_t *p_instance, libvlc_exception_t *p_e)
 Return the VLC messaging verbosity level.
void libvlc_set_log_verbosity (libvlc_instance_t *p_instance, unsigned level, libvlc_exception_t *p_e)
 Set the VLC messaging verbosity level.
libvlc_log_tlibvlc_log_open (libvlc_instance_t *, libvlc_exception_t *)
 Open a VLC message log instance.
void libvlc_log_close (libvlc_log_t *, libvlc_exception_t *)
 Close a VLC message log instance.
unsigned libvlc_log_count (const libvlc_log_t *, libvlc_exception_t *)
 Returns the number of messages in a log instance.
void libvlc_log_clear (libvlc_log_t *, libvlc_exception_t *)
 Clear a log instance.
libvlc_log_iterator_tlibvlc_log_get_iterator (const libvlc_log_t *, libvlc_exception_t *)
 Allocate and returns a new iterator to messages in log.
void libvlc_log_iterator_free (libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e)
 Release a previoulsy allocated iterator.
int libvlc_log_iterator_has_next (const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e)
 Return whether log iterator has more messages.
libvlc_log_message_tlibvlc_log_iterator_next (libvlc_log_iterator_t *p_iter, libvlc_log_message_t *p_buffer, libvlc_exception_t *p_e)
 Return the next log message.


Generated on Wed Aug 13 08:05:37 2008 for VLC by  doxygen 1.5.1