vlc_player.h File Reference

VLC Player API. More...

Include dependency graph for vlc_player.h:

Go to the source code of this file.

Data Structures
struct	vlc_player_chapter
	Player chapter structure. More...
struct	vlc_player_title
	Player title structure. More...
struct	vlc_player_program
	Player program structure. More...
struct	vlc_player_track
	Player track structure. More...
union	vlc_player_metadata_cbs
	Player metadata callbacks. More...
struct	vlc_player_aout_cbs
	Player aout callbacks. More...
struct	vlc_player_vout_cbs
	Player vout callbacks. More...
struct	vlc_player_cbs
	Player callbacks. More...
struct	vlc_player_timer_point
	Player timer point. More...
struct	vlc_player_timer_smpte_timecode
	Player smpte timecode. More...
struct	vlc_player_timer_cbs
	Player timer callbacks. More...
struct	vlc_player_timer_smpte_cbs
	Player smpte timer callbacks. More...

Macros
#define	VLC_PLAYER_CAP_SEEK   (1<<0)
	Player capability: can seek.
#define	VLC_PLAYER_CAP_PAUSE   (1<<1)
	Player capability: can pause.
#define	VLC_PLAYER_CAP_CHANGE_RATE   (1<<2)
	Player capability: can change the rate.
#define	VLC_PLAYER_CAP_REWIND   (1<<3)
	Player capability: can seek back.
#define	VLC_PLAYER_TELETEXT_KEY_RED   ('r' << 16)
	Player teletext key: Red.
#define	VLC_PLAYER_TELETEXT_KEY_GREEN   ('g' << 16)
	Player teletext key: Green.
#define	VLC_PLAYER_TELETEXT_KEY_YELLOW   ('y' << 16)
	Player teletext key: Yellow.
#define	VLC_PLAYER_TELETEXT_KEY_BLUE   ('b' << 16)
	Player teletext key: Blue.
#define	VLC_PLAYER_TELETEXT_KEY_INDEX   ('i' << 16)
	Player teletext key: Index.
#define	VLC_PLAYER_TITLE_MENU   0x01
	vlc_player_title.flags: The title is a menu.
#define	VLC_PLAYER_TITLE_INTERACTIVE   0x02
	vlc_player_title.flags: The title is interactive.
#define	VLC_PLAYER_TITLE_MAIN   0x04
	vlc_player_title.flags: The title is the main one.

Typedefs
typedef struct vlc_player_t	vlc_player_t
	Player opaque structure.
typedef struct vlc_player_title_list	vlc_player_title_list
	Opaque structure representing a list of vlc_player_title.
typedef struct vlc_player_metadata_listener_id	vlc_player_metadata_listener_id
	Player metadata listener opaque structure.
typedef struct vlc_player_aout_listener_id	vlc_player_aout_listener_id
	Player aout listener opaque structure.
typedef struct vlc_player_vout_listener_id	vlc_player_vout_listener_id
	Player vout listener opaque structure.
typedef struct vlc_player_listener_id	vlc_player_listener_id
	Player listener opaque structure.
typedef struct vlc_player_timer_id	vlc_player_timer_id
	Player timer opaque structure.

Enumerations
enum	vlc_player_lock_type { VLC_PLAYER_LOCK_NORMAL , VLC_PLAYER_LOCK_REENTRANT }
	Player lock type (normal or reentrant) More...
enum	vlc_player_state {   VLC_PLAYER_STATE_STOPPED , VLC_PLAYER_STATE_STARTED , VLC_PLAYER_STATE_PLAYING , VLC_PLAYER_STATE_PAUSED ,   VLC_PLAYER_STATE_STOPPING }
	State of the player. More...
enum	vlc_player_error { VLC_PLAYER_ERROR_NONE , VLC_PLAYER_ERROR_GENERIC }
	Error of the player. More...
enum	vlc_player_seek_speed { VLC_PLAYER_SEEK_PRECISE , VLC_PLAYER_SEEK_FAST }
	Seek speed type. More...
enum	vlc_player_whence { VLC_PLAYER_WHENCE_ABSOLUTE , VLC_PLAYER_WHENCE_RELATIVE }
	Player seek/delay directive. More...
enum	vlc_player_nav {   VLC_PLAYER_NAV_ACTIVATE , VLC_PLAYER_NAV_UP , VLC_PLAYER_NAV_DOWN , VLC_PLAYER_NAV_LEFT ,   VLC_PLAYER_NAV_RIGHT , VLC_PLAYER_NAV_POPUP , VLC_PLAYER_NAV_MENU }
	Menu (VCD/DVD/BD) and viewpoint navigations. More...
enum	vlc_player_abloop { VLC_PLAYER_ABLOOP_NONE , VLC_PLAYER_ABLOOP_A , VLC_PLAYER_ABLOOP_B }
	A to B loop state. More...
enum	vlc_player_restore_playback_pos { VLC_PLAYER_RESTORE_PLAYBACK_POS_NEVER , VLC_PLAYER_RESTORE_PLAYBACK_POS_ASK , VLC_PLAYER_RESTORE_PLAYBACK_POS_ALWAYS }
enum	vlc_player_select_policy { VLC_PLAYER_SELECT_EXCLUSIVE , VLC_PLAYER_SELECT_SIMULTANEOUS }
	Player selection policy. More...
enum	vlc_player_metadata_option { VLC_PLAYER_METADATA_LOUDNESS_MOMENTARY , VLC_PLAYER_METADATA_LOUDNESS_FULL }
	Player metadata option. More...
enum	vlc_player_vout_action { VLC_PLAYER_VOUT_STARTED , VLC_PLAYER_VOUT_STOPPED }
	action of vlc_player_cbs.on_vout_changed callback More...
enum	vlc_player_list_action { VLC_PLAYER_LIST_ADDED , VLC_PLAYER_LIST_REMOVED , VLC_PLAYER_LIST_UPDATED }
	Action of vlc_player_cbs.on_track_list_changed, vlc_player_cbs.on_program_list_changed callbacks. More...

Functions
vlc_player_t *	vlc_player_New (vlc_object_t *parent, enum vlc_player_lock_type lock_type)
	Create a new player instance.
void	vlc_player_Delete (vlc_player_t *player)
	Delete a player instance.
void	vlc_player_Lock (vlc_player_t *player)
	Lock the player.
void	vlc_player_Unlock (vlc_player_t *player)
	Unlock the player.
void	vlc_player_CondWait (vlc_player_t *player, vlc_cond_t *cond)
	Wait on a condition variable.
void	vlc_player_SetStartPaused (vlc_player_t *player, bool start_paused)
	Ask to start in a paused state.
void	vlc_player_SetPauseOnCork (vlc_player_t *player, bool enabled)
	Enable or disable pause on cork event.
int	vlc_player_SetCurrentMedia (vlc_player_t *player, input_item_t *media)
	Set the current media.
void	vlc_player_SetNextMedia (vlc_player_t *player, input_item_t *media)
	Set the next media.
input_item_t *	vlc_player_GetCurrentMedia (vlc_player_t *player)
	Get the current played media.
input_item_t *	vlc_player_GetNextMedia (vlc_player_t *player)
	Get the next played media.
static input_item_t *	vlc_player_HoldCurrentMedia (vlc_player_t *player)
	Helper that hold the current media.
int	vlc_player_Start (vlc_player_t *player)
	Start the playback of the current media.
int	vlc_player_Stop (vlc_player_t *player)
	Stop the playback of the current media.
void	vlc_player_Pause (vlc_player_t *player)
	Pause the playback.
void	vlc_player_Resume (vlc_player_t *player)
	Resume the playback from a pause.
void	vlc_player_NextVideoFrame (vlc_player_t *player)
	Pause and display the next video frame.
enum vlc_player_state	vlc_player_GetState (vlc_player_t *player)
	Get the state of the player.
enum vlc_player_error	vlc_player_GetError (vlc_player_t *player)
	Get the error state of the player.
static bool	vlc_player_IsStarted (vlc_player_t *player)
	Helper to get the started state.
static bool	vlc_player_IsPaused (vlc_player_t *player)
	Helper to get the paused state.
static void	vlc_player_TogglePause (vlc_player_t *player)
	Helper to toggle the pause state.
int	vlc_player_GetCapabilities (vlc_player_t *player)
	Get the player capabilities.
static bool	vlc_player_CanSeek (vlc_player_t *player)
	Helper to get the seek capability.
static bool	vlc_player_CanPause (vlc_player_t *player)
	Helper to get the pause capability.
static bool	vlc_player_CanChangeRate (vlc_player_t *player)
	Helper to get the change-rate capability.
static bool	vlc_player_CanRewind (vlc_player_t *player)
	Helper to get the rewindable capability.
float	vlc_player_GetRate (vlc_player_t *player)
	Get the rate of the player.
void	vlc_player_ChangeRate (vlc_player_t *player, float rate)
	Change the rate of the player.
void	vlc_player_IncrementRate (vlc_player_t *player)
	Increment the rate of the player (faster)
void	vlc_player_DecrementRate (vlc_player_t *player)
	Decrement the rate of the player (Slower)
vlc_tick_t	vlc_player_GetLength (vlc_player_t *player)
	Get the length of the current media.
vlc_tick_t	vlc_player_GetTime (vlc_player_t *player)
	Get the time of the current media.
double	vlc_player_GetPosition (vlc_player_t *player)
	Get the position of the current media.
void	vlc_player_SeekByPos (vlc_player_t *player, double position, enum vlc_player_seek_speed speed, enum vlc_player_whence whence)
	Seek the current media by position.
void	vlc_player_SeekByTime (vlc_player_t *player, vlc_tick_t time, enum vlc_player_seek_speed speed, enum vlc_player_whence whence)
	Seek the current media by time.
static void	vlc_player_SetPosition (vlc_player_t *player, double position)
	Helper to set the absolute position precisely.
static void	vlc_player_SetPositionFast (vlc_player_t *player, double position)
	Helper to set the absolute position fast.
static void	vlc_player_JumpPos (vlc_player_t *player, double jumppos)
	Helper to jump the position precisely.
static void	vlc_player_SetTime (vlc_player_t *player, vlc_tick_t time)
	Helper to set the absolute time precisely.
static void	vlc_player_SetTimeFast (vlc_player_t *player, vlc_tick_t time)
	Helper to set the absolute time fast.
static void	vlc_player_JumpTime (vlc_player_t *player, vlc_tick_t jumptime)
	Helper to jump the time precisely.
void	vlc_player_DisplayPosition (vlc_player_t *player)
	Display the player position on the vout OSD.
int	vlc_player_SetAtoBLoop (vlc_player_t *player, enum vlc_player_abloop abloop)
	Enable A to B loop of the current media.
enum vlc_player_abloop	vlc_player_GetAtoBLoop (vlc_player_t *player, vlc_tick_t *a_time, double *a_pos, vlc_tick_t *b_time, double *b_pos)
	Get the A to B loop status.
void	vlc_player_Navigate (vlc_player_t *player, enum vlc_player_nav nav)
	Navigate (for DVD/Bluray menus or viewpoint)
void	vlc_player_UpdateViewpoint (vlc_player_t *player, const vlc_viewpoint_t *viewpoint, enum vlc_player_whence whence)
	Update the viewpoint.
bool	vlc_player_IsRecording (vlc_player_t *player)
	Check if the playing is recording.
void	vlc_player_SetRecordingEnabled (vlc_player_t *player, bool enabled, const char *dir_path)
	Enable or disable recording for the current media.
static void	vlc_player_ToggleRecording (vlc_player_t *player)
	Helper to toggle the recording state.
int	vlc_player_AddAssociatedMedia (vlc_player_t *player, enum es_format_category_e cat, const char *uri, bool select, bool notify, bool check_ext)
	Add an associated (or external) media to the current media.
int	vlc_player_GetSignal (vlc_player_t *player, float *quality, float *strength)
	Get the signal quality and strength of the current media.
const struct input_stats_t *	vlc_player_GetStatistics (vlc_player_t *player)
	Get the statistics of the current media.
void	vlc_player_RestorePlaybackPos (vlc_player_t *player)
	Restore the previous playback position of the current media.
vlc_object_t *	vlc_player_GetV4l2Object (vlc_player_t *player)
	Get the V4L2 object used to do controls.
vlc_player_title_list *	vlc_player_title_list_Hold (vlc_player_title_list *titles)
	Hold the title list of the player.
void	vlc_player_title_list_Release (vlc_player_title_list *titles)
	Release of previously held title list.
size_t	vlc_player_title_list_GetCount (vlc_player_title_list *titles)
	Get the number of title of a list.
const struct vlc_player_title *	vlc_player_title_list_GetAt (vlc_player_title_list *titles, size_t idx)
	Get the title at a given index.
vlc_player_title_list *	vlc_player_GetTitleList (vlc_player_t *player)
	Get the title list of the current media.
ssize_t	vlc_player_GetSelectedTitleIdx (vlc_player_t *player)
	Get the selected title index for the current media.
static const struct vlc_player_title *	vlc_player_GetSelectedTitle (vlc_player_t *player)
	Helper to get the current selected title.
void	vlc_player_SelectTitleIdx (vlc_player_t *player, size_t index)
	Select a title index for the current media.
void	vlc_player_SelectTitle (vlc_player_t *player, const struct vlc_player_title *title)
	Select a title for the current media.
void	vlc_player_SelectChapter (vlc_player_t *player, const struct vlc_player_title *title, size_t chapter_idx)
	Select a chapter for the current media.
void	vlc_player_SelectNextTitle (vlc_player_t *player)
	Select the next title for the current media.
void	vlc_player_SelectPrevTitle (vlc_player_t *player)
	Select the previous title for the current media.
ssize_t	vlc_player_GetSelectedChapterIdx (vlc_player_t *player)
	Get the selected chapter index for the current media.
static const struct vlc_player_chapter *	vlc_player_GetSelectedChapter (vlc_player_t *player)
	Helper to get the current selected chapter.
void	vlc_player_SelectChapterIdx (vlc_player_t *player, size_t index)
	Select a chapter index for the current media.
void	vlc_player_SelectNextChapter (vlc_player_t *player)
	Select the next chapter for the current media.
void	vlc_player_SelectPrevChapter (vlc_player_t *player)
	Select the previous chapter for the current media.
struct vlc_player_program *	vlc_player_program_Dup (const struct vlc_player_program *prgm)
	Duplicate a program.
void	vlc_player_program_Delete (struct vlc_player_program *prgm)
	Delete a duplicated program.
size_t	vlc_player_GetProgramCount (vlc_player_t *player)
	Get the number of programs.
const struct vlc_player_program *	vlc_player_GetProgramAt (vlc_player_t *player, size_t index)
	Get the program at a specific index.
const struct vlc_player_program *	vlc_player_GetProgram (vlc_player_t *player, int group_id)
	Get a program from an ES group identifier.
void	vlc_player_SelectProgram (vlc_player_t *player, int group_id)
	Select a program from an ES group identifier.
void	vlc_player_SelectNextProgram (vlc_player_t *player)
	Select the next program.
void	vlc_player_SelectPrevProgram (vlc_player_t *player)
	Select the previous program.
static const struct vlc_player_program *	vlc_player_GetSelectedProgram (vlc_player_t *player)
	Helper to get the current selected program.
struct vlc_player_track *	vlc_player_track_Dup (const struct vlc_player_track *track)
	Duplicate a track.
void	vlc_player_track_Delete (struct vlc_player_track *track)
	Delete a duplicated track.
size_t	vlc_player_GetTrackCount (vlc_player_t *player, enum es_format_category_e cat)
	Get the number of tracks for an ES category.
const struct vlc_player_track *	vlc_player_GetTrackAt (vlc_player_t *player, enum es_format_category_e cat, size_t index)
	Get the track at a specific index for an ES category.
static size_t	vlc_player_GetVideoTrackCount (vlc_player_t *player)
	Helper to get the video track count.
static const struct vlc_player_track *	vlc_player_GetVideoTrackAt (vlc_player_t *player, size_t index)
	Helper to get a video track at a specific index.
static size_t	vlc_player_GetAudioTrackCount (vlc_player_t *player)
	Helper to get the audio track count.
static const struct vlc_player_track *	vlc_player_GetAudioTrackAt (vlc_player_t *player, size_t index)
	Helper to get an audio track at a specific index.
static size_t	vlc_player_GetSubtitleTrackCount (vlc_player_t *player)
	Helper to get the subtitle track count.
static const struct vlc_player_track *	vlc_player_GetSubtitleTrackAt (vlc_player_t *player, size_t index)
	Helper to get a subtitle track at a specific index.
const struct vlc_player_track *	vlc_player_GetTrack (vlc_player_t *player, vlc_es_id_t *es_id)
	Get a track from an ES identifier.
vout_thread_t *	vlc_player_GetEsIdVout (vlc_player_t *player, vlc_es_id_t *es_id, enum vlc_vout_order *order)
	Get and the video output used by a ES identifier.
vlc_es_id_t *	vlc_player_GetEsIdFromVout (vlc_player_t *player, vout_thread_t *vout)
	Get the ES identifier of a video output.
static const struct vlc_player_track *	vlc_player_GetSelectedTrack (vlc_player_t *player, enum es_format_category_e cat)
	Helper to get the selected track from an ES category.
void	vlc_player_SelectTracksByStringIds (vlc_player_t *player, enum es_format_category_e cat, const char *str_ids)
	Select tracks by their string identifier.
unsigned	vlc_player_SelectEsId (vlc_player_t *player, vlc_es_id_t *es_id, enum vlc_player_select_policy policy)
	Select a track from an ES identifier.
static unsigned	vlc_player_SelectTrack (vlc_player_t *player, const struct vlc_player_track *track, enum vlc_player_select_policy policy)
	Helper to select a track.
unsigned	vlc_player_SelectEsIdList (vlc_player_t *player, enum es_format_category_e cat, vlc_es_id_t *const es_id_list[])
	Select multiple tracks from a list of ES identifiers.
void	vlc_player_CycleTrack (vlc_player_t *player, enum es_format_category_e cat, enum vlc_vout_order vout_order, bool next)
	Cycle through the tracks.
static void	vlc_player_SelectNextTrack (vlc_player_t *player, enum es_format_category_e cat, enum vlc_vout_order vout_order)
	Helper to select the next track.
static void	vlc_player_SelectPrevTrack (vlc_player_t *player, enum es_format_category_e cat, enum vlc_vout_order vout_order)
	Helper to select the Previous track.
void	vlc_player_UnselectEsId (vlc_player_t *player, vlc_es_id_t *es_id)
	Unselect a track from an ES identifier.
static void	vlc_player_UnselectTrack (vlc_player_t *player, const struct vlc_player_track *track)
	Helper to unselect a track.
static void	vlc_player_UnselectTrackCategory (vlc_player_t *player, enum es_format_category_e cat)
	Helper to unselect all tracks from an ES category.
void	vlc_player_RestartEsId (vlc_player_t *player, vlc_es_id_t *es_id)
	Restart a track from an ES identifier.
static void	vlc_player_RestartTrack (vlc_player_t *player, const struct vlc_player_track *track)
	Helper to restart a track.
static void	vlc_player_RestartTrackCategory (vlc_player_t *player, enum es_format_category_e cat)
	Helper to restart all selected tracks from an ES category.
void	vlc_player_SelectCategoryLanguage (vlc_player_t *player, enum es_format_category_e cat, const char *lang)
	Select the language for an ES category.
char *	vlc_player_GetCategoryLanguage (vlc_player_t *player, enum es_format_category_e cat)
	Get the language of an ES category.
static void	vlc_player_SelectAudioLanguage (vlc_player_t *player, const char *lang)
	Helper to select the audio language.
static void	vlc_player_SelectSubtitleLanguage (vlc_player_t *player, const char *lang)
	Helper to select the subtitle language.
void	vlc_player_SetTrackCategoryEnabled (vlc_player_t *player, enum es_format_category_e cat, bool enabled)
	Enable or disable a track category.
bool	vlc_player_IsTrackCategoryEnabled (vlc_player_t *player, enum es_format_category_e cat)
	Check if a track category is enabled.
static void	vlc_player_SetVideoEnabled (vlc_player_t *player, bool enabled)
	Helper to enable or disable video tracks.
static bool	vlc_player_IsVideoEnabled (vlc_player_t *player)
	Helper to check if video tracks are enabled.
static void	vlc_player_SetAudioEnabled (vlc_player_t *player, bool enabled)
	Helper to enable or disable audio tracks.
static bool	vlc_player_IsAudioEnabled (vlc_player_t *player)
	Helper to check if audio tracks are enabled.
static void	vlc_player_SetSubtitleEnabled (vlc_player_t *player, bool enabled)
	Helper to enable or disable subtitle tracks.
static bool	vlc_player_IsSubtitleEnabled (vlc_player_t *player)
	Helper to check if subtitle tracks are enabled.
static void	vlc_player_ToggleSubtitle (vlc_player_t *player)
	Helper to toggle subtitles.
void	vlc_player_SetSubtitleTextScale (vlc_player_t *player, unsigned scale)
	Set the subtitle text scaling factor.
unsigned	vlc_player_GetSubtitleTextScale (vlc_player_t *player)
	Get the subtitle text scaling factor.
vlc_tick_t	vlc_player_GetCategoryDelay (vlc_player_t *player, enum es_format_category_e cat)
	Get the delay of an ES category for the current media.
int	vlc_player_SetCategoryDelay (vlc_player_t *player, enum es_format_category_e cat, vlc_tick_t delay, enum vlc_player_whence whence)
	Set the delay of one category for the current media.
vlc_tick_t	vlc_player_GetEsIdDelay (vlc_player_t *player, vlc_es_id_t *es_id)
	Get the delay of a track.
int	vlc_player_SetEsIdDelay (vlc_player_t *player, vlc_es_id_t *es_id, vlc_tick_t delay, enum vlc_player_whence whence)
	Set the delay of one track.
static vlc_tick_t	vlc_player_GetAudioDelay (vlc_player_t *player)
	Helper to get the audio delay.
static void	vlc_player_SetAudioDelay (vlc_player_t *player, vlc_tick_t delay, enum vlc_player_whence whence)
	Helper to set the audio delay.
static vlc_tick_t	vlc_player_GetVideoDelay (vlc_player_t *player)
	Helper to get the audio delay.
static void	vlc_player_SetVideoDelay (vlc_player_t *player, vlc_tick_t delay, enum vlc_player_whence whence)
	Helper to set the audio delay.
static vlc_tick_t	vlc_player_GetSubtitleDelay (vlc_player_t *player)
	Helper to get the subtitle delay.
static void	vlc_player_SetSubtitleDelay (vlc_player_t *player, vlc_tick_t delay, enum vlc_player_whence whence)
	Helper to set the subtitle delay.
void	vlc_player_SetAssociatedSubsFPS (vlc_player_t *player, float fps)
	Set the associated subtitle FPS.
float	vlc_player_GetAssociatedSubsFPS (vlc_player_t *player)
	Get the associated subtitle FPS.
bool	vlc_player_HasTeletextMenu (vlc_player_t *player)
	Check if the media has a teletext menu.
void	vlc_player_SetTeletextEnabled (vlc_player_t *player, bool enabled)
	Enable or disable teletext.
bool	vlc_player_IsTeletextEnabled (vlc_player_t *player)
	Check if teletext is enabled.
void	vlc_player_SelectTeletextPage (vlc_player_t *player, unsigned page)
	Select a teletext page or do an action from a key.
unsigned	vlc_player_GetTeletextPage (vlc_player_t *player)
	Get the current teletext page.
void	vlc_player_SetTeletextTransparency (vlc_player_t *player, bool enabled)
	Enable or disable teletext transparency.
bool	vlc_player_IsTeletextTransparent (vlc_player_t *player)
	Check if teletext is transparent.
void	vlc_player_SetRenderer (vlc_player_t *player, vlc_renderer_item_t *renderer)
	Set the renderer.
vlc_renderer_item_t *	vlc_player_GetRenderer (vlc_player_t *player)
	Get the renderer.
vlc_player_metadata_listener_id *	vlc_player_AddMetadataListener (vlc_player_t *player, enum vlc_player_metadata_option option, const union vlc_player_metadata_cbs *cbs, void *cbs_data)
	Add a metadata listener.
void	vlc_player_RemoveMetadataListener (vlc_player_t *player, vlc_player_metadata_listener_id *listener_id)
	Remove a metadata listener.
audio_output_t *	vlc_player_aout_Hold (vlc_player_t *player)
	Get the audio output.
void	vlc_player_aout_Reset (vlc_player_t *player)
	Reset the main audio output.
vlc_player_aout_listener_id *	vlc_player_aout_AddListener (vlc_player_t *player, const struct vlc_player_aout_cbs *cbs, void *cbs_data)
	Add a listener callback for audio output events.
void	vlc_player_aout_RemoveListener (vlc_player_t *player, vlc_player_aout_listener_id *listener_id)
	Remove a aout listener callback.
float	vlc_player_aout_GetVolume (vlc_player_t *player)
	Get the audio volume.
int	vlc_player_aout_SetVolume (vlc_player_t *player, float volume)
	Set the audio volume.
int	vlc_player_aout_IncrementVolume (vlc_player_t *player, int steps, float *result)
	Increment the audio volume.
static int	vlc_player_aout_DecrementVolume (vlc_player_t *player, int steps, float *result)
	Helper to decrement the audio volume.
int	vlc_player_aout_IsMuted (vlc_player_t *player)
	Check if the audio output is muted.
int	vlc_player_aout_Mute (vlc_player_t *player, bool mute)
	Mute or unmute the audio output.
static int	vlc_player_aout_ToggleMute (vlc_player_t *player)
	Helper to toggle the mute state.
int	vlc_player_aout_EnableFilter (vlc_player_t *player, const char *name, bool add)
	Enable or disable an audio filter.
vout_thread_t *	vlc_player_vout_Hold (vlc_player_t *player)
	Get and hold the main video output.
vout_thread_t **	vlc_player_vout_HoldAll (vlc_player_t *player, size_t *count)
	Get and hold the list of video output.
vlc_player_vout_listener_id *	vlc_player_vout_AddListener (vlc_player_t *player, const struct vlc_player_vout_cbs *cbs, void *cbs_data)
	Add a listener callback for video output events.
void	vlc_player_vout_RemoveListener (vlc_player_t *player, vlc_player_vout_listener_id *listener_id)
	Remove a vout listener callback.
bool	vlc_player_vout_IsFullscreen (vlc_player_t *player)
	Check if the player is fullscreen.
void	vlc_player_vout_SetFullscreen (vlc_player_t *player, bool enabled)
	Enable or disable the player fullscreen state.
static void	vlc_player_vout_ToggleFullscreen (vlc_player_t *player)
	Helper to toggle the player fullscreen state.
bool	vlc_player_vout_IsWallpaperModeEnabled (vlc_player_t *player)
	Check if the player has wallpaper-mode enaled.
void	vlc_player_vout_SetWallpaperModeEnabled (vlc_player_t *player, bool enabled)
	Enable or disable the player wallpaper-mode.
static void	vlc_player_vout_ToggleWallpaperMode (vlc_player_t *player)
	Helper to toggle the player wallpaper-mode state.
void	vlc_player_vout_Snapshot (vlc_player_t *player)
	Take a snapshot on all vouts.
void	vlc_player_osd_Message (vlc_player_t *player, const char *fmt,...)
	Display an OSD message on all vouts.
vlc_player_listener_id *	vlc_player_AddListener (vlc_player_t *player, const struct vlc_player_cbs *cbs, void *cbs_data)
	Add a listener callback.
void	vlc_player_RemoveListener (vlc_player_t *player, vlc_player_listener_id *listener_id)
	Remove a listener callback.
vlc_player_timer_id *	vlc_player_AddTimer (vlc_player_t *player, vlc_tick_t min_period, const struct vlc_player_timer_cbs *cbs, void *cbs_data)
	Add a timer in order to get times updates.
vlc_player_timer_id *	vlc_player_AddSmpteTimer (vlc_player_t *player, const struct vlc_player_timer_smpte_cbs *cbs, void *cbs_data)
	Add a smpte timer in order to get accurate video frame updates.
void	vlc_player_RemoveTimer (vlc_player_t *player, vlc_player_timer_id *timer)
	Remove a player timer.
int	vlc_player_timer_point_Interpolate (const struct vlc_player_timer_point *point, vlc_tick_t system_now, vlc_tick_t *out_ts, double *out_pos)
	Interpolate the last timer value to now.
vlc_tick_t	vlc_player_timer_point_GetNextIntervalDate (const struct vlc_player_timer_point *point, vlc_tick_t system_now, vlc_tick_t interpolated_ts, vlc_tick_t next_interval)
	Get the date of the next interval.

Detailed Description

VLC Player API.