VLC  4.0.0-dev
Data Structures | Macros | Typedefs | Enumerations | Functions
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_media_provider
 Callbacks for the owner of the player. More...
 
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. More...
 
#define VLC_PLAYER_CAP_PAUSE   (1<<1)
 Player capability: can pause. More...
 
#define VLC_PLAYER_CAP_CHANGE_RATE   (1<<2)
 Player capability: can change the rate. More...
 
#define VLC_PLAYER_CAP_REWIND   (1<<3)
 Player capability: can seek back. More...
 
#define VLC_PLAYER_TELETEXT_KEY_RED   ('r' << 16)
 Player teletext key: Red. More...
 
#define VLC_PLAYER_TELETEXT_KEY_GREEN   ('g' << 16)
 Player teletext key: Green. More...
 
#define VLC_PLAYER_TELETEXT_KEY_YELLOW   ('y' << 16)
 Player teletext key: Yellow. More...
 
#define VLC_PLAYER_TELETEXT_KEY_BLUE   ('b' << 16)
 Player teletext key: Blue. More...
 
#define VLC_PLAYER_TELETEXT_KEY_INDEX   ('i' << 16)
 Player teletext key: Index. More...
 
#define VLC_PLAYER_TITLE_MENU   0x01
 vlc_player_title.flags: The title is a menu. More...
 
#define VLC_PLAYER_TITLE_INTERACTIVE   0x02
 vlc_player_title.flags: The title is interactive. More...
 

Typedefs

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

Enumerations

enum  vlc_player_lock_type { VLC_PLAYER_LOCK_NORMAL , VLC_PLAYER_LOCK_REENTRANT }
 Player lock type (normal or reentrant) More...
 
enum  vlc_player_media_stopped_action { VLC_PLAYER_MEDIA_STOPPED_CONTINUE , VLC_PLAYER_MEDIA_STOPPED_PAUSE , VLC_PLAYER_MEDIA_STOPPED_STOP , VLC_PLAYER_MEDIA_STOPPED_EXIT }
 Action when the player is stopped. 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_tvlc_player_New (vlc_object_t *parent, enum vlc_player_lock_type lock_type, const struct vlc_player_media_provider *media_provider, void *media_provider_data)
 Create a new player instance. More...
 
void vlc_player_Delete (vlc_player_t *player)
 Delete a player instance. More...
 
void vlc_player_Lock (vlc_player_t *player)
 Lock the player. More...
 
void vlc_player_Unlock (vlc_player_t *player)
 Unlock the player. More...
 
void vlc_player_CondWait (vlc_player_t *player, vlc_cond_t *cond)
 Wait on a condition variable. More...
 
void vlc_player_SetMediaStoppedAction (vlc_player_t *player, enum vlc_player_media_stopped_action action)
 Setup an action when a media is stopped. More...
 
void vlc_player_SetStartPaused (vlc_player_t *player, bool start_paused)
 Ask to start in a paused state. More...
 
void vlc_player_SetPauseOnCork (vlc_player_t *player, bool enabled)
 Enable or disable pause on cork event. More...
 
int vlc_player_SetCurrentMedia (vlc_player_t *player, input_item_t *media)
 Set the current media. More...
 
input_item_tvlc_player_GetCurrentMedia (vlc_player_t *player)
 Get the current played media. More...
 
static input_item_tvlc_player_HoldCurrentMedia (vlc_player_t *player)
 Helper that hold the current media. More...
 
void vlc_player_InvalidateNextMedia (vlc_player_t *player)
 Invalidate the next media. More...
 
int vlc_player_Start (vlc_player_t *player)
 Start the playback of the current media. More...
 
int vlc_player_Stop (vlc_player_t *player)
 Stop the playback of the current media. More...
 
void vlc_player_Pause (vlc_player_t *player)
 Pause the playback. More...
 
void vlc_player_Resume (vlc_player_t *player)
 Resume the playback from a pause. More...
 
void vlc_player_NextVideoFrame (vlc_player_t *player)
 Pause and display the next video frame. More...
 
enum vlc_player_state vlc_player_GetState (vlc_player_t *player)
 Get the state of the player. More...
 
enum vlc_player_error vlc_player_GetError (vlc_player_t *player)
 Get the error state of the player. More...
 
static bool vlc_player_IsStarted (vlc_player_t *player)
 Helper to get the started state. More...
 
static bool vlc_player_IsPaused (vlc_player_t *player)
 Helper to get the paused state. More...
 
static void vlc_player_TogglePause (vlc_player_t *player)
 Helper to toggle the pause state. More...
 
int vlc_player_GetCapabilities (vlc_player_t *player)
 Get the player capabilities. More...
 
static bool vlc_player_CanSeek (vlc_player_t *player)
 Helper to get the seek capability. More...
 
static bool vlc_player_CanPause (vlc_player_t *player)
 Helper to get the pause capability. More...
 
static bool vlc_player_CanChangeRate (vlc_player_t *player)
 Helper to get the change-rate capability. More...
 
static bool vlc_player_CanRewind (vlc_player_t *player)
 Helper to get the rewindable capability. More...
 
float vlc_player_GetRate (vlc_player_t *player)
 Get the rate of the player. More...
 
void vlc_player_ChangeRate (vlc_player_t *player, float rate)
 Change the rate of the player. More...
 
void vlc_player_IncrementRate (vlc_player_t *player)
 Increment the rate of the player (faster) More...
 
void vlc_player_DecrementRate (vlc_player_t *player)
 Decrement the rate of the player (Slower) More...
 
vlc_tick_t vlc_player_GetLength (vlc_player_t *player)
 Get the length of the current media. More...
 
vlc_tick_t vlc_player_GetTime (vlc_player_t *player)
 Get the time of the current media. More...
 
float vlc_player_GetPosition (vlc_player_t *player)
 Get the position of the current media. More...
 
void vlc_player_SeekByPos (vlc_player_t *player, float position, enum vlc_player_seek_speed speed, enum vlc_player_whence whence)
 Seek the current media by position. More...
 
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. More...
 
static void vlc_player_SetPosition (vlc_player_t *player, float position)
 Helper to set the absolute position precisely. More...
 
static void vlc_player_SetPositionFast (vlc_player_t *player, float position)
 Helper to set the absolute position fast. More...
 
static void vlc_player_JumpPos (vlc_player_t *player, float jumppos)
 Helper to jump the position precisely. More...
 
static void vlc_player_SetTime (vlc_player_t *player, vlc_tick_t time)
 Helper to set the absolute time precisely. More...
 
static void vlc_player_SetTimeFast (vlc_player_t *player, vlc_tick_t time)
 Helper to set the absolute time fast. More...
 
static void vlc_player_JumpTime (vlc_player_t *player, vlc_tick_t jumptime)
 Helper to jump the time precisely. More...
 
void vlc_player_DisplayPosition (vlc_player_t *player)
 Display the player position on the vout OSD. More...
 
int vlc_player_SetAtoBLoop (vlc_player_t *player, enum vlc_player_abloop abloop)
 Enable A to B loop of the current media. More...
 
enum vlc_player_abloop vlc_player_GetAtoBLoop (vlc_player_t *player, vlc_tick_t *a_time, float *a_pos, vlc_tick_t *b_time, float *b_pos)
 Get the A to B loop status. More...
 
void vlc_player_Navigate (vlc_player_t *player, enum vlc_player_nav nav)
 Navigate (for DVD/Bluray menus or viewpoint) More...
 
void vlc_player_UpdateViewpoint (vlc_player_t *player, const vlc_viewpoint_t *viewpoint, enum vlc_player_whence whence)
 Update the viewpoint. More...
 
bool vlc_player_IsRecording (vlc_player_t *player)
 Check if the playing is recording. More...
 
void vlc_player_SetRecordingEnabled (vlc_player_t *player, bool enabled)
 Enable or disable recording for the current media. More...
 
static void vlc_player_ToggleRecording (vlc_player_t *player)
 Helper to toggle the recording state. More...
 
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. More...
 
int vlc_player_GetSignal (vlc_player_t *player, float *quality, float *strength)
 Get the signal quality and strength of the current media. More...
 
const struct input_stats_tvlc_player_GetStatistics (vlc_player_t *player)
 Get the statistics of the current media. More...
 
void vlc_player_RestorePlaybackPos (vlc_player_t *player)
 Restore the previous playback position of the current media. More...
 
vlc_object_tvlc_player_GetV4l2Object (vlc_player_t *player)
 Get the V4L2 object used to do controls. More...
 
vlc_player_title_listvlc_player_title_list_Hold (vlc_player_title_list *titles)
 Hold the title list of the player. More...
 
void vlc_player_title_list_Release (vlc_player_title_list *titles)
 Release of previously held title list. More...
 
size_t vlc_player_title_list_GetCount (vlc_player_title_list *titles)
 Get the number of title of a list. More...
 
const struct vlc_player_titlevlc_player_title_list_GetAt (vlc_player_title_list *titles, size_t idx)
 Get the title at a given index. More...
 
vlc_player_title_listvlc_player_GetTitleList (vlc_player_t *player)
 Get the title list of the current media. More...
 
ssize_t vlc_player_GetSelectedTitleIdx (vlc_player_t *player)
 Get the selected title index for the current media. More...
 
static const struct vlc_player_titlevlc_player_GetSelectedTitle (vlc_player_t *player)
 Helper to get the current selected title. More...
 
void vlc_player_SelectTitleIdx (vlc_player_t *player, size_t index)
 Select a title index for the current media. More...
 
void vlc_player_SelectTitle (vlc_player_t *player, const struct vlc_player_title *title)
 Select a title for the current media. More...
 
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. More...
 
void vlc_player_SelectNextTitle (vlc_player_t *player)
 Select the next title for the current media. More...
 
void vlc_player_SelectPrevTitle (vlc_player_t *player)
 Select the previous title for the current media. More...
 
ssize_t vlc_player_GetSelectedChapterIdx (vlc_player_t *player)
 Get the selected chapter index for the current media. More...
 
static const struct vlc_player_chaptervlc_player_GetSelectedChapter (vlc_player_t *player)
 Helper to get the current selected chapter. More...
 
void vlc_player_SelectChapterIdx (vlc_player_t *player, size_t index)
 Select a chapter index for the current media. More...
 
void vlc_player_SelectNextChapter (vlc_player_t *player)
 Select the next chapter for the current media. More...
 
void vlc_player_SelectPrevChapter (vlc_player_t *player)
 Select the previous chapter for the current media. More...
 
struct vlc_player_programvlc_player_program_Dup (const struct vlc_player_program *prgm)
 Duplicate a program. More...
 
void vlc_player_program_Delete (struct vlc_player_program *prgm)
 Delete a duplicated program. More...
 
size_t vlc_player_GetProgramCount (vlc_player_t *player)
 Get the number of programs. More...
 
const struct vlc_player_programvlc_player_GetProgramAt (vlc_player_t *player, size_t index)
 Get the program at a specific index. More...
 
const struct vlc_player_programvlc_player_GetProgram (vlc_player_t *player, int group_id)
 Get a program from an ES group identifier. More...
 
void vlc_player_SelectProgram (vlc_player_t *player, int group_id)
 Select a program from an ES group identifier. More...
 
void vlc_player_SelectNextProgram (vlc_player_t *player)
 Select the next program. More...
 
void vlc_player_SelectPrevProgram (vlc_player_t *player)
 Select the previous program. More...
 
static const struct vlc_player_programvlc_player_GetSelectedProgram (vlc_player_t *player)
 Helper to get the current selected program. More...
 
struct vlc_player_trackvlc_player_track_Dup (const struct vlc_player_track *track)
 Duplicate a track. More...
 
void vlc_player_track_Delete (struct vlc_player_track *track)
 Delete a duplicated track. More...
 
size_t vlc_player_GetTrackCount (vlc_player_t *player, enum es_format_category_e cat)
 Get the number of tracks for an ES category. More...
 
const struct vlc_player_trackvlc_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. More...
 
static size_t vlc_player_GetVideoTrackCount (vlc_player_t *player)
 Helper to get the video track count. More...
 
static const struct vlc_player_trackvlc_player_GetVideoTrackAt (vlc_player_t *player, size_t index)
 Helper to get a video track at a specific index. More...
 
static size_t vlc_player_GetAudioTrackCount (vlc_player_t *player)
 Helper to get the audio track count. More...
 
static const struct vlc_player_trackvlc_player_GetAudioTrackAt (vlc_player_t *player, size_t index)
 Helper to get an audio track at a specific index. More...
 
static size_t vlc_player_GetSubtitleTrackCount (vlc_player_t *player)
 Helper to get the subtitle track count. More...
 
static const struct vlc_player_trackvlc_player_GetSubtitleTrackAt (vlc_player_t *player, size_t index)
 Helper to get a subtitle track at a specific index. More...
 
const struct vlc_player_trackvlc_player_GetTrack (vlc_player_t *player, vlc_es_id_t *es_id)
 Get a track from an ES identifier. More...
 
vout_thread_tvlc_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. More...
 
vlc_es_id_tvlc_player_GetEsIdFromVout (vlc_player_t *player, vout_thread_t *vout)
 Get the ES identifier of a video output. More...
 
static const struct vlc_player_trackvlc_player_GetSelectedTrack (vlc_player_t *player, enum es_format_category_e cat)
 Helper to get the selected track from an ES category. More...
 
void vlc_player_SelectTracksByStringIds (vlc_player_t *player, enum es_format_category_e cat, const char *str_ids)
 Select tracks by their string identifier. More...
 
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. More...
 
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. More...
 
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. More...
 
void vlc_player_SelectNextTrack (vlc_player_t *player, enum es_format_category_e cat)
 Select the next track. More...
 
void vlc_player_SelectPrevTrack (vlc_player_t *player, enum es_format_category_e cat)
 Select the Previous track. More...
 
void vlc_player_UnselectEsId (vlc_player_t *player, vlc_es_id_t *es_id)
 Unselect a track from an ES identifier. More...
 
static void vlc_player_UnselectTrack (vlc_player_t *player, const struct vlc_player_track *track)
 Helper to unselect a track. More...
 
static void vlc_player_UnselectTrackCategory (vlc_player_t *player, enum es_format_category_e cat)
 Helper to unselect all tracks from an ES category. More...
 
void vlc_player_RestartEsId (vlc_player_t *player, vlc_es_id_t *es_id)
 Restart a track from an ES identifier. More...
 
static void vlc_player_RestartTrack (vlc_player_t *player, const struct vlc_player_track *track)
 Helper to restart a track. More...
 
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. More...
 
void vlc_player_SelectCategoryLanguage (vlc_player_t *player, enum es_format_category_e cat, const char *lang)
 Select the language for an ES category. More...
 
char * vlc_player_GetCategoryLanguage (vlc_player_t *player, enum es_format_category_e cat)
 Get the language of an ES category. More...
 
static void vlc_player_SelectAudioLanguage (vlc_player_t *player, const char *lang)
 Helper to select the audio language. More...
 
static void vlc_player_SelectSubtitleLanguage (vlc_player_t *player, const char *lang)
 Helper to select the subtitle language. More...
 
void vlc_player_SetTrackCategoryEnabled (vlc_player_t *player, enum es_format_category_e cat, bool enabled)
 Enable or disable a track category. More...
 
bool vlc_player_IsTrackCategoryEnabled (vlc_player_t *player, enum es_format_category_e cat)
 Check if a track category is enabled. More...
 
static void vlc_player_SetVideoEnabled (vlc_player_t *player, bool enabled)
 Helper to enable or disable video tracks. More...
 
static bool vlc_player_IsVideoEnabled (vlc_player_t *player)
 Helper to check if video tracks are enabled. More...
 
static void vlc_player_SetAudioEnabled (vlc_player_t *player, bool enabled)
 Helper to enable or disable audio tracks. More...
 
static bool vlc_player_IsAudioEnabled (vlc_player_t *player)
 Helper to check if audio tracks are enabled. More...
 
static void vlc_player_SetSubtitleEnabled (vlc_player_t *player, bool enabled)
 Helper to enable or disable subtitle tracks. More...
 
static bool vlc_player_IsSubtitleEnabled (vlc_player_t *player)
 Helper to check if subtitle tracks are enabled. More...
 
static void vlc_player_ToggleSubtitle (vlc_player_t *player)
 Helper to toggle subtitles. More...
 
void vlc_player_SetSubtitleTextScale (vlc_player_t *player, unsigned scale)
 Set the subtitle text scaling factor. More...
 
unsigned vlc_player_GetSubtitleTextScale (vlc_player_t *player)
 Get the subtitle text scaling factor. More...
 
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. More...
 
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. More...
 
vlc_tick_t vlc_player_GetEsIdDelay (vlc_player_t *player, vlc_es_id_t *es_id)
 Get the delay of a track. More...
 
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. More...
 
static vlc_tick_t vlc_player_GetAudioDelay (vlc_player_t *player)
 Helper to get the audio delay. More...
 
static void vlc_player_SetAudioDelay (vlc_player_t *player, vlc_tick_t delay, enum vlc_player_whence whence)
 Helper to set the audio delay. More...
 
static vlc_tick_t vlc_player_GetSubtitleDelay (vlc_player_t *player)
 Helper to get the subtitle delay. More...
 
static void vlc_player_SetSubtitleDelay (vlc_player_t *player, vlc_tick_t delay, enum vlc_player_whence whence)
 Helper to set the subtitle delay. More...
 
void vlc_player_SetAssociatedSubsFPS (vlc_player_t *player, float fps)
 Set the associated subtitle FPS. More...
 
float vlc_player_GetAssociatedSubsFPS (vlc_player_t *player)
 Get the associated subtitle FPS. More...
 
bool vlc_player_HasTeletextMenu (vlc_player_t *player)
 Check if the media has a teletext menu. More...
 
void vlc_player_SetTeletextEnabled (vlc_player_t *player, bool enabled)
 Enable or disable teletext. More...
 
bool vlc_player_IsTeletextEnabled (vlc_player_t *player)
 Check if teletext is enabled. More...
 
void vlc_player_SelectTeletextPage (vlc_player_t *player, unsigned page)
 Select a teletext page or do an action from a key. More...
 
unsigned vlc_player_GetTeletextPage (vlc_player_t *player)
 Get the current teletext page. More...
 
void vlc_player_SetTeletextTransparency (vlc_player_t *player, bool enabled)
 Enable or disable teletext transparency. More...
 
bool vlc_player_IsTeletextTransparent (vlc_player_t *player)
 Check if teletext is transparent. More...
 
void vlc_player_SetRenderer (vlc_player_t *player, vlc_renderer_item_t *renderer)
 Set the renderer. More...
 
vlc_renderer_item_tvlc_player_GetRenderer (vlc_player_t *player)
 Get the renderer. More...
 
vlc_player_metadata_listener_idvlc_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. More...
 
void vlc_player_RemoveMetadataListener (vlc_player_t *player, vlc_player_metadata_listener_id *listener_id)
 Remove a metadata listener. More...
 
audio_output_tvlc_player_aout_Hold (vlc_player_t *player)
 Get the audio output. More...
 
void vlc_player_aout_Reset (vlc_player_t *player)
 Reset the main audio output. More...
 
vlc_player_aout_listener_idvlc_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. More...
 
void vlc_player_aout_RemoveListener (vlc_player_t *player, vlc_player_aout_listener_id *listener_id)
 Remove a aout listener callback. More...
 
float vlc_player_aout_GetVolume (vlc_player_t *player)
 Get the audio volume. More...
 
int vlc_player_aout_SetVolume (vlc_player_t *player, float volume)
 Set the audio volume. More...
 
int vlc_player_aout_IncrementVolume (vlc_player_t *player, int steps, float *result)
 Increment the audio volume. More...
 
static int vlc_player_aout_DecrementVolume (vlc_player_t *player, int steps, float *result)
 Helper to decrement the audio volume. More...
 
int vlc_player_aout_IsMuted (vlc_player_t *player)
 Check if the audio output is muted. More...
 
int vlc_player_aout_Mute (vlc_player_t *player, bool mute)
 Mute or unmute the audio output. More...
 
static int vlc_player_aout_ToggleMute (vlc_player_t *player)
 Helper to toggle the mute state. More...
 
int vlc_player_aout_EnableFilter (vlc_player_t *player, const char *name, bool add)
 Enable or disable an audio filter. More...
 
vout_thread_tvlc_player_vout_Hold (vlc_player_t *player)
 Get and hold the main video output. More...
 
vout_thread_t ** vlc_player_vout_HoldAll (vlc_player_t *player, size_t *count)
 Get and hold the list of video output. More...
 
vlc_player_vout_listener_idvlc_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. More...
 
void vlc_player_vout_RemoveListener (vlc_player_t *player, vlc_player_vout_listener_id *listener_id)
 Remove a vout listener callback. More...
 
bool vlc_player_vout_IsFullscreen (vlc_player_t *player)
 Check if the player is fullscreen. More...
 
void vlc_player_vout_SetFullscreen (vlc_player_t *player, bool enabled)
 Enable or disable the player fullscreen state. More...
 
static void vlc_player_vout_ToggleFullscreen (vlc_player_t *player)
 Helper to toggle the player fullscreen state. More...
 
bool vlc_player_vout_IsWallpaperModeEnabled (vlc_player_t *player)
 Check if the player has wallpaper-mode enaled. More...
 
void vlc_player_vout_SetWallpaperModeEnabled (vlc_player_t *player, bool enabled)
 Enable or disable the player wallpaper-mode. More...
 
static void vlc_player_vout_ToggleWallpaperMode (vlc_player_t *player)
 Helper to toggle the player wallpaper-mode state. More...
 
void vlc_player_vout_Snapshot (vlc_player_t *player)
 Take a snapshot on all vouts. More...
 
void vlc_player_osd_Message (vlc_player_t *player, const char *fmt,...)
 Display an OSD message on all vouts. More...
 
vlc_player_listener_idvlc_player_AddListener (vlc_player_t *player, const struct vlc_player_cbs *cbs, void *cbs_data)
 Add a listener callback. More...
 
void vlc_player_RemoveListener (vlc_player_t *player, vlc_player_listener_id *listener_id)
 Remove a listener callback. More...
 
vlc_player_timer_idvlc_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. More...
 
vlc_player_timer_idvlc_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. More...
 
void vlc_player_RemoveTimer (vlc_player_t *player, vlc_player_timer_id *timer)
 Remove a player timer. More...
 
int vlc_player_timer_point_Interpolate (const struct vlc_player_timer_point *point, vlc_tick_t system_now, vlc_tick_t *out_ts, float *out_pos)
 Interpolate the last timer value to now. More...
 
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. More...
 

Detailed Description

VLC Player API.