VLC  4.0.0-dev
libvlc_media_player.h File Reference

LibVLC simple media player external API. More...

Include dependency graph for libvlc_media_player.h:

Go to the source code of this file.

Data Structures

struct  libvlc_title_description_t
 
struct  libvlc_chapter_description_t
 Description for chapters. More...
 
struct  libvlc_audio_output_t
 Description for audio output. More...
 
struct  libvlc_audio_output_device_t
 Description for audio output device. More...
 
struct  libvlc_video_setup_device_cfg_t
 
struct  libvlc_video_setup_device_info_t
 
struct  libvlc_video_render_cfg_t
 
struct  libvlc_video_output_cfg_t
 
struct  libvlc_video_frame_hdr10_metadata_t
 
struct  libvlc_player_program_t
 

Macros

#define libvlc_role_Last   libvlc_role_Test
 Testing. More...
 

Typedefs

typedef struct libvlc_media_player_t libvlc_media_player_t
 
typedef struct libvlc_title_description_t libvlc_title_description_t
 
typedef struct libvlc_chapter_description_t libvlc_chapter_description_t
 Description for chapters. More...
 
typedef struct libvlc_audio_output_t libvlc_audio_output_t
 Description for audio output. More...
 
typedef struct libvlc_audio_output_device_t libvlc_audio_output_device_t
 Description for audio output device. More...
 
typedef enum libvlc_video_marquee_option_t libvlc_video_marquee_option_t
 Marq options definition. More...
 
typedef enum libvlc_navigate_mode_t libvlc_navigate_mode_t
 Navigation mode. More...
 
typedef enum libvlc_position_t libvlc_position_t
 Enumeration of values used to set position (e.g. More...
 
typedef enum libvlc_teletext_key_t libvlc_teletext_key_t
 Enumeration of teletext keys than can be passed via libvlc_video_set_teletext() More...
 
typedef struct libvlc_equalizer_t libvlc_equalizer_t
 Opaque equalizer handle. More...
 
typedef enum libvlc_video_color_primaries_t libvlc_video_color_primaries_t
 Enumeration of the Video color primaries. More...
 
typedef enum libvlc_video_color_space_t libvlc_video_color_space_t
 Enumeration of the Video color spaces. More...
 
typedef enum libvlc_video_transfer_func_t libvlc_video_transfer_func_t
 Enumeration of the Video transfer functions. More...
 
typedef void *(* libvlc_video_lock_cb) (void *opaque, void **planes)
 Callback prototype to allocate and lock a picture buffer. More...
 
typedef void(* libvlc_video_unlock_cb) (void *opaque, void *picture, void *const *planes)
 Callback prototype to unlock a picture buffer. More...
 
typedef void(* libvlc_video_display_cb) (void *opaque, void *picture)
 Callback prototype to display a picture. More...
 
typedef unsigned(* libvlc_video_format_cb) (void **opaque, char *chroma, unsigned *width, unsigned *height, unsigned *pitches, unsigned *lines)
 Callback prototype to configure picture buffers format. More...
 
typedef void(* libvlc_video_cleanup_cb) (void *opaque)
 Callback prototype to configure picture buffers format. More...
 
typedef struct libvlc_video_setup_device_cfg_t libvlc_video_setup_device_cfg_t
 
typedef struct libvlc_video_setup_device_info_t libvlc_video_setup_device_info_t
 
typedef bool(* libvlc_video_output_setup_cb) (void **opaque, const libvlc_video_setup_device_cfg_t *cfg, libvlc_video_setup_device_info_t *out)
 Callback prototype called to initialize user data. More...
 
typedef void(* libvlc_video_output_cleanup_cb) (void *opaque)
 Callback prototype called to release user data. More...
 
typedef struct libvlc_video_render_cfg_t libvlc_video_render_cfg_t
 
typedef struct libvlc_video_output_cfg_t libvlc_video_output_cfg_t
 
typedef bool(* libvlc_video_update_output_cb) (void *opaque, const libvlc_video_render_cfg_t *cfg, libvlc_video_output_cfg_t *output)
 Callback prototype called on video size changes. More...
 
typedef void(* libvlc_video_swap_cb) (void *opaque)
 Callback prototype called after performing drawing calls. More...
 
typedef bool(* libvlc_video_makeCurrent_cb) (void *opaque, bool enter)
 Callback prototype to set up the OpenGL context for rendering. More...
 
typedef void *(* libvlc_video_getProcAddress_cb) (void *opaque, const char *fct_name)
 Callback prototype to load opengl functions. More...
 
typedef struct libvlc_video_frame_hdr10_metadata_t libvlc_video_frame_hdr10_metadata_t
 
typedef enum libvlc_video_metadata_type_t libvlc_video_metadata_type_t
 
typedef void(* libvlc_video_frameMetadata_cb) (void *opaque, libvlc_video_metadata_type_t type, const void *metadata)
 Callback prototype to receive metadata before rendering. More...
 
typedef enum libvlc_video_engine_t libvlc_video_engine_t
 Enumeration of the Video engine to be used on output. More...
 
typedef void(* libvlc_video_output_resize_cb) (void *report_opaque, unsigned width, unsigned height)
 Callback type that can be called to request a render size changes. More...
 
typedef void(* libvlc_video_output_set_resize_cb) (void *opaque, libvlc_video_output_resize_cb report_size_change, void *report_opaque)
 Set the callback to call when the host app resizes the rendering area. More...
 
typedef bool(* libvlc_video_output_select_plane_cb) (void *opaque, size_t plane, void *output)
 Tell the host the rendering for the given plane is about to start. More...
 
typedef void(* libvlc_audio_play_cb) (void *data, const void *samples, unsigned count, int64_t pts)
 Callback prototype for audio playback. More...
 
typedef void(* libvlc_audio_pause_cb) (void *data, int64_t pts)
 Callback prototype for audio pause. More...
 
typedef void(* libvlc_audio_resume_cb) (void *data, int64_t pts)
 Callback prototype for audio resumption. More...
 
typedef void(* libvlc_audio_flush_cb) (void *data, int64_t pts)
 Callback prototype for audio buffer flush. More...
 
typedef void(* libvlc_audio_drain_cb) (void *data)
 Callback prototype for audio buffer drain. More...
 
typedef void(* libvlc_audio_set_volume_cb) (void *data, float volume, bool mute)
 Callback prototype for audio volume change. More...
 
typedef int(* libvlc_audio_setup_cb) (void **opaque, char *format, unsigned *rate, unsigned *channels)
 Callback prototype to setup the audio playback. More...
 
typedef void(* libvlc_audio_cleanup_cb) (void *opaque)
 Callback prototype for audio playback cleanup. More...
 
typedef struct libvlc_player_program_t libvlc_player_program_t
 
typedef struct libvlc_player_programlist_t libvlc_player_programlist_t
 Opaque struct containing a list of program. More...
 
typedef enum libvlc_audio_output_channel_t libvlc_audio_output_channel_t
 Audio channels. More...
 
typedef enum libvlc_media_player_role libvlc_media_player_role_t
 Media player roles. More...
 

Enumerations

enum  { libvlc_title_menu = 0x01 , libvlc_title_interactive = 0x02 }
 Description for titles. More...
 
enum  libvlc_video_marquee_option_t {
  libvlc_marquee_Enable = 0 , libvlc_marquee_Text , libvlc_marquee_Color , libvlc_marquee_Opacity ,
  libvlc_marquee_Position , libvlc_marquee_Refresh , libvlc_marquee_Size , libvlc_marquee_Timeout ,
  libvlc_marquee_X , libvlc_marquee_Y
}
 Marq options definition. More...
 
enum  libvlc_navigate_mode_t {
  libvlc_navigate_activate = 0 , libvlc_navigate_up , libvlc_navigate_down , libvlc_navigate_left ,
  libvlc_navigate_right , libvlc_navigate_popup
}
 Navigation mode. More...
 
enum  libvlc_position_t {
  libvlc_position_disable =-1 , libvlc_position_center , libvlc_position_left , libvlc_position_right ,
  libvlc_position_top , libvlc_position_top_left , libvlc_position_top_right , libvlc_position_bottom ,
  libvlc_position_bottom_left , libvlc_position_bottom_right
}
 Enumeration of values used to set position (e.g. More...
 
enum  libvlc_teletext_key_t {
  libvlc_teletext_key_red = 'r' << 16 , libvlc_teletext_key_green = 'g' << 16 , libvlc_teletext_key_yellow = 'y' << 16 , libvlc_teletext_key_blue = 'b' << 16 ,
  libvlc_teletext_key_index = 'i' << 16
}
 Enumeration of teletext keys than can be passed via libvlc_video_set_teletext() More...
 
enum  libvlc_video_color_primaries_t {
  libvlc_video_primaries_BT601_525 = 1 , libvlc_video_primaries_BT601_625 = 2 , libvlc_video_primaries_BT709 = 3 , libvlc_video_primaries_BT2020 = 4 ,
  libvlc_video_primaries_DCI_P3 = 5 , libvlc_video_primaries_BT470_M = 6
}
 Enumeration of the Video color primaries. More...
 
enum  libvlc_video_color_space_t { libvlc_video_colorspace_BT601 = 1 , libvlc_video_colorspace_BT709 = 2 , libvlc_video_colorspace_BT2020 = 3 }
 Enumeration of the Video color spaces. More...
 
enum  libvlc_video_transfer_func_t {
  libvlc_video_transfer_func_LINEAR = 1 , libvlc_video_transfer_func_SRGB = 2 , libvlc_video_transfer_func_BT470_BG = 3 , libvlc_video_transfer_func_BT470_M = 4 ,
  libvlc_video_transfer_func_BT709 = 5 , libvlc_video_transfer_func_PQ = 6 , libvlc_video_transfer_func_SMPTE_240 = 7 , libvlc_video_transfer_func_HLG = 8
}
 Enumeration of the Video transfer functions. More...
 
enum  libvlc_video_metadata_type_t { libvlc_video_metadata_frame_hdr10 }
 
enum  libvlc_video_engine_t {
  libvlc_video_engine_disable , libvlc_video_engine_opengl , libvlc_video_engine_gles2 , libvlc_video_engine_d3d11 ,
  libvlc_video_engine_d3d9
}
 Enumeration of the Video engine to be used on output. More...
 
enum  libvlc_video_logo_option_t {
  libvlc_logo_enable , libvlc_logo_file , libvlc_logo_x , libvlc_logo_y ,
  libvlc_logo_delay , libvlc_logo_repeat , libvlc_logo_opacity , libvlc_logo_position
}
 option values for libvlc_video_{get,set}_logo_{int,string} More...
 
enum  libvlc_video_adjust_option_t {
  libvlc_adjust_Enable = 0 , libvlc_adjust_Contrast , libvlc_adjust_Brightness , libvlc_adjust_Hue ,
  libvlc_adjust_Saturation , libvlc_adjust_Gamma
}
 option values for libvlc_video_{get,set}_adjust_{int,float,bool} 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...
 
enum  libvlc_media_player_role {
  libvlc_role_None = 0 , libvlc_role_Music , libvlc_role_Video , libvlc_role_Communication ,
  libvlc_role_Game , libvlc_role_Notification , libvlc_role_Animation , libvlc_role_Production ,
  libvlc_role_Accessibility
}
 Media player roles. More...
 

Functions

LIBVLC_API libvlc_media_player_tlibvlc_media_player_new (libvlc_instance_t *p_libvlc_instance)
 Create an empty Media Player object. More...
 
LIBVLC_API libvlc_media_player_tlibvlc_media_player_new_from_media (libvlc_media_t *p_md)
 Create a Media Player object from a Media. More...
 
LIBVLC_API void libvlc_media_player_release (libvlc_media_player_t *p_mi)
 Release a media_player after use Decrement the reference count of a media player object. More...
 
LIBVLC_API void libvlc_media_player_retain (libvlc_media_player_t *p_mi)
 Retain a reference to a media player object. More...
 
LIBVLC_API void libvlc_media_player_set_media (libvlc_media_player_t *p_mi, libvlc_media_t *p_md)
 Set the media that will be used by the media_player. More...
 
LIBVLC_API libvlc_media_tlibvlc_media_player_get_media (libvlc_media_player_t *p_mi)
 Get the media used by the media_player. More...
 
LIBVLC_API libvlc_event_manager_tlibvlc_media_player_event_manager (libvlc_media_player_t *p_mi)
 Get the Event Manager from which the media player send event. More...
 
LIBVLC_API bool libvlc_media_player_is_playing (libvlc_media_player_t *p_mi)
 is_playing More...
 
LIBVLC_API int libvlc_media_player_play (libvlc_media_player_t *p_mi)
 Play. More...
 
LIBVLC_API void libvlc_media_player_set_pause (libvlc_media_player_t *mp, int do_pause)
 Pause or resume (no effect if there is no media) More...
 
LIBVLC_API void libvlc_media_player_pause (libvlc_media_player_t *p_mi)
 Toggle pause (no effect if there is no media) More...
 
LIBVLC_API int libvlc_media_player_stop_async (libvlc_media_player_t *p_mi)
 Stop asynchronously. More...
 
LIBVLC_API int libvlc_media_player_set_renderer (libvlc_media_player_t *p_mi, libvlc_renderer_item_t *p_item)
 Set a renderer to the media player. More...
 
LIBVLC_API void libvlc_video_set_callbacks (libvlc_media_player_t *mp, libvlc_video_lock_cb lock, libvlc_video_unlock_cb unlock, libvlc_video_display_cb display, void *opaque)
 Set callbacks and private data to render decoded video to a custom area in memory. More...
 
LIBVLC_API void libvlc_video_set_format (libvlc_media_player_t *mp, const char *chroma, unsigned width, unsigned height, unsigned pitch)
 Set decoded video chroma and dimensions. More...
 
LIBVLC_API void libvlc_video_set_format_callbacks (libvlc_media_player_t *mp, libvlc_video_format_cb setup, libvlc_video_cleanup_cb cleanup)
 Set decoded video chroma and dimensions. More...
 
LIBVLC_API bool libvlc_video_set_output_callbacks (libvlc_media_player_t *mp, libvlc_video_engine_t engine, libvlc_video_output_setup_cb setup_cb, libvlc_video_output_cleanup_cb cleanup_cb, libvlc_video_output_set_resize_cb resize_cb, libvlc_video_update_output_cb update_output_cb, libvlc_video_swap_cb swap_cb, libvlc_video_makeCurrent_cb makeCurrent_cb, libvlc_video_getProcAddress_cb getProcAddress_cb, libvlc_video_frameMetadata_cb metadata_cb, libvlc_video_output_select_plane_cb select_plane_cb, void *opaque)
 Set callbacks and data to render decoded video to a custom texture. More...
 
LIBVLC_API void libvlc_media_player_set_nsobject (libvlc_media_player_t *p_mi, void *drawable)
 Set the NSView handler where the media player should render its video output. More...
 
LIBVLC_API void * libvlc_media_player_get_nsobject (libvlc_media_player_t *p_mi)
 Get the NSView handler previously set with libvlc_media_player_set_nsobject(). More...
 
LIBVLC_API void libvlc_media_player_set_xwindow (libvlc_media_player_t *p_mi, uint32_t drawable)
 Set an X Window System drawable where the media player should render its video output. More...
 
LIBVLC_API uint32_t libvlc_media_player_get_xwindow (libvlc_media_player_t *p_mi)
 Get the X Window System window identifier previously set with libvlc_media_player_set_xwindow(). More...
 
LIBVLC_API void libvlc_media_player_set_hwnd (libvlc_media_player_t *p_mi, void *drawable)
 Set a Win32/Win64 API window handle (HWND) where the media player should render its video output. More...
 
LIBVLC_API void * libvlc_media_player_get_hwnd (libvlc_media_player_t *p_mi)
 Get the Windows API window handle (HWND) previously set with libvlc_media_player_set_hwnd(). More...
 
LIBVLC_API void libvlc_media_player_set_android_context (libvlc_media_player_t *p_mi, void *p_awindow_handler)
 Set the android context. More...
 
LIBVLC_API void libvlc_audio_set_callbacks (libvlc_media_player_t *mp, libvlc_audio_play_cb play, libvlc_audio_pause_cb pause, libvlc_audio_resume_cb resume, libvlc_audio_flush_cb flush, libvlc_audio_drain_cb drain, void *opaque)
 Sets callbacks and private data for decoded audio. More...
 
LIBVLC_API void libvlc_audio_set_volume_callback (libvlc_media_player_t *mp, libvlc_audio_set_volume_cb set_volume)
 Set callbacks and private data for decoded audio. More...
 
LIBVLC_API void libvlc_audio_set_format_callbacks (libvlc_media_player_t *mp, libvlc_audio_setup_cb setup, libvlc_audio_cleanup_cb cleanup)
 Sets decoded audio format via callbacks. More...
 
LIBVLC_API void libvlc_audio_set_format (libvlc_media_player_t *mp, const char *format, unsigned rate, unsigned channels)
 Sets a fixed decoded audio format. More...
 
LIBVLC_API libvlc_time_t libvlc_media_player_get_length (libvlc_media_player_t *p_mi)
 Get the current movie length (in ms). More...
 
LIBVLC_API libvlc_time_t libvlc_media_player_get_time (libvlc_media_player_t *p_mi)
 Get the current movie time (in ms). More...
 
LIBVLC_API int libvlc_media_player_set_time (libvlc_media_player_t *p_mi, libvlc_time_t i_time, bool b_fast)
 Set the movie time (in ms). More...
 
LIBVLC_API float libvlc_media_player_get_position (libvlc_media_player_t *p_mi)
 Get movie position as percentage between 0.0 and 1.0. More...
 
LIBVLC_API int libvlc_media_player_set_position (libvlc_media_player_t *p_mi, float f_pos, bool b_fast)
 Set movie position as percentage between 0.0 and 1.0. More...
 
LIBVLC_API void libvlc_media_player_set_chapter (libvlc_media_player_t *p_mi, int i_chapter)
 Set movie chapter (if applicable). More...
 
LIBVLC_API int libvlc_media_player_get_chapter (libvlc_media_player_t *p_mi)
 Get movie chapter. More...
 
LIBVLC_API int libvlc_media_player_get_chapter_count (libvlc_media_player_t *p_mi)
 Get movie chapter count. More...
 
LIBVLC_API int libvlc_media_player_get_chapter_count_for_title (libvlc_media_player_t *p_mi, int i_title)
 Get title chapter count. More...
 
LIBVLC_API void libvlc_media_player_set_title (libvlc_media_player_t *p_mi, int i_title)
 Set movie title. More...
 
LIBVLC_API int libvlc_media_player_get_title (libvlc_media_player_t *p_mi)
 Get movie title. More...
 
LIBVLC_API int libvlc_media_player_get_title_count (libvlc_media_player_t *p_mi)
 Get movie title count. More...
 
LIBVLC_API void libvlc_media_player_previous_chapter (libvlc_media_player_t *p_mi)
 Set previous chapter (if applicable) More...
 
LIBVLC_API void libvlc_media_player_next_chapter (libvlc_media_player_t *p_mi)
 Set next chapter (if applicable) More...
 
LIBVLC_API float libvlc_media_player_get_rate (libvlc_media_player_t *p_mi)
 Get the requested movie play rate. More...
 
LIBVLC_API int libvlc_media_player_set_rate (libvlc_media_player_t *p_mi, float rate)
 Set movie play rate. More...
 
LIBVLC_API libvlc_state_t libvlc_media_player_get_state (libvlc_media_player_t *p_mi)
 Get current movie state. More...
 
LIBVLC_API unsigned libvlc_media_player_has_vout (libvlc_media_player_t *p_mi)
 How many video outputs does this media player have? More...
 
LIBVLC_API bool libvlc_media_player_is_seekable (libvlc_media_player_t *p_mi)
 Is this media player seekable? More...
 
LIBVLC_API bool libvlc_media_player_can_pause (libvlc_media_player_t *p_mi)
 Can this media player be paused? More...
 
LIBVLC_API bool libvlc_media_player_program_scrambled (libvlc_media_player_t *p_mi)
 Check if the current program is scrambled. More...
 
LIBVLC_API void libvlc_media_player_next_frame (libvlc_media_player_t *p_mi)
 Display the next frame (if supported) More...
 
LIBVLC_API void libvlc_media_player_navigate (libvlc_media_player_t *p_mi, unsigned navigate)
 Navigate through DVD Menu. More...
 
LIBVLC_API void libvlc_media_player_set_video_title_display (libvlc_media_player_t *p_mi, libvlc_position_t position, unsigned int timeout)
 Set if, and how, the video title will be shown when media is played. More...
 
LIBVLC_API libvlc_media_tracklist_tlibvlc_media_player_get_tracklist (libvlc_media_player_t *p_mi, libvlc_track_type_t type)
 Get the track list for one type. More...
 
LIBVLC_API libvlc_media_track_tlibvlc_media_player_get_selected_track (libvlc_media_player_t *p_mi, libvlc_track_type_t type)
 Get the selected track for one type. More...
 
LIBVLC_API libvlc_media_track_tlibvlc_media_player_get_track_from_id (libvlc_media_player_t *p_mi, const char *psz_id)
 
LIBVLC_API void libvlc_media_player_select_track (libvlc_media_player_t *p_mi, const libvlc_media_track_t *track)
 Select a track. More...
 
LIBVLC_API void libvlc_media_player_unselect_track_type (libvlc_media_player_t *p_mi, libvlc_track_type_t type)
 Unselect all tracks for a given type. More...
 
LIBVLC_API void libvlc_media_player_select_tracks (libvlc_media_player_t *p_mi, libvlc_track_type_t type, const libvlc_media_track_t **tracks, size_t track_count)
 Select multiple tracks for one type. More...
 
LIBVLC_API void libvlc_media_player_select_tracks_by_ids (libvlc_media_player_t *p_mi, libvlc_track_type_t type, const char *psz_ids)
 Select tracks by their string identifier. More...
 
LIBVLC_API int libvlc_media_player_add_slave (libvlc_media_player_t *p_mi, libvlc_media_slave_type_t i_type, const char *psz_uri, bool b_select)
 Add a slave to the current media player. More...
 
LIBVLC_API void libvlc_player_program_delete (libvlc_player_program_t *program)
 Delete a program struct. More...
 
LIBVLC_API size_t libvlc_player_programlist_count (const libvlc_player_programlist_t *list)
 Get the number of programs in a programlist. More...
 
LIBVLC_API libvlc_player_program_tlibvlc_player_programlist_at (libvlc_player_programlist_t *list, size_t index)
 Get a program at a specific index. More...
 
LIBVLC_API void libvlc_player_programlist_delete (libvlc_player_programlist_t *list)
 Release a programlist. More...
 
LIBVLC_API void libvlc_media_player_select_program_id (libvlc_media_player_t *p_mi, int i_group_id)
 Select program with a given program id. More...
 
LIBVLC_API libvlc_player_program_tlibvlc_media_player_get_selected_program (libvlc_media_player_t *p_mi)
 Get the selected program. More...
 
LIBVLC_API libvlc_player_program_tlibvlc_media_player_get_program_from_id (libvlc_media_player_t *p_mi, int i_group_id)
 Get a program struct from a program id. More...
 
LIBVLC_API libvlc_player_programlist_tlibvlc_media_player_get_programlist (libvlc_media_player_t *p_mi)
 Get the program list. More...
 
LIBVLC_API void libvlc_toggle_fullscreen (libvlc_media_player_t *p_mi)
 Toggle fullscreen status on non-embedded video outputs. More...
 
LIBVLC_API void libvlc_set_fullscreen (libvlc_media_player_t *p_mi, bool b_fullscreen)
 Enable or disable fullscreen. More...
 
LIBVLC_API bool libvlc_get_fullscreen (libvlc_media_player_t *p_mi)
 Get current fullscreen status. More...
 
LIBVLC_API void libvlc_video_set_key_input (libvlc_media_player_t *p_mi, unsigned on)
 Enable or disable key press events handling, according to the LibVLC hotkeys configuration. More...
 
LIBVLC_API void libvlc_video_set_mouse_input (libvlc_media_player_t *p_mi, unsigned on)
 Enable or disable mouse click events handling. More...
 
LIBVLC_API int libvlc_video_get_size (libvlc_media_player_t *p_mi, unsigned num, unsigned *px, unsigned *py)
 Get the pixel dimensions of a video. More...
 
LIBVLC_API int libvlc_video_get_cursor (libvlc_media_player_t *p_mi, unsigned num, int *px, int *py)
 Get the mouse pointer coordinates over a video. More...
 
LIBVLC_API float libvlc_video_get_scale (libvlc_media_player_t *p_mi)
 Get the current video scaling factor. More...
 
LIBVLC_API void libvlc_video_set_scale (libvlc_media_player_t *p_mi, float f_factor)
 Set the video scaling factor. More...
 
LIBVLC_API char * libvlc_video_get_aspect_ratio (libvlc_media_player_t *p_mi)
 Get current video aspect ratio. More...
 
LIBVLC_API void libvlc_video_set_aspect_ratio (libvlc_media_player_t *p_mi, const char *psz_aspect)
 Set new video aspect ratio. More...
 
LIBVLC_API libvlc_video_viewpoint_tlibvlc_video_new_viewpoint (void)
 Create a video viewpoint structure. More...
 
LIBVLC_API int libvlc_video_update_viewpoint (libvlc_media_player_t *p_mi, const libvlc_video_viewpoint_t *p_viewpoint, bool b_absolute)
 Update the video viewpoint information. More...
 
LIBVLC_API int64_t libvlc_video_get_spu_delay (libvlc_media_player_t *p_mi)
 Get the current subtitle delay. More...
 
LIBVLC_API float libvlc_video_get_spu_text_scale (libvlc_media_player_t *p_mi)
 Get the current subtitle text scale. More...
 
LIBVLC_API void libvlc_video_set_spu_text_scale (libvlc_media_player_t *p_mi, float f_scale)
 Set the subtitle text scale. More...
 
LIBVLC_API int libvlc_video_set_spu_delay (libvlc_media_player_t *p_mi, int64_t i_delay)
 Set the subtitle delay. More...
 
LIBVLC_API int libvlc_media_player_get_full_title_descriptions (libvlc_media_player_t *p_mi, libvlc_title_description_t ***titles)
 Get the full description of available titles. More...
 
LIBVLC_API void libvlc_title_descriptions_release (libvlc_title_description_t **p_titles, unsigned i_count)
 Release a title description. More...
 
LIBVLC_API int libvlc_media_player_get_full_chapter_descriptions (libvlc_media_player_t *p_mi, int i_chapters_of_title, libvlc_chapter_description_t ***pp_chapters)
 Get the full description of available chapters. More...
 
LIBVLC_API void libvlc_chapter_descriptions_release (libvlc_chapter_description_t **p_chapters, unsigned i_count)
 Release a chapter description. More...
 
LIBVLC_API void libvlc_video_set_crop_ratio (libvlc_media_player_t *mp, unsigned num, unsigned den)
 Set/unset the video crop ratio. More...
 
LIBVLC_API void libvlc_video_set_crop_window (libvlc_media_player_t *mp, unsigned x, unsigned y, unsigned width, unsigned height)
 Set the video crop window. More...
 
LIBVLC_API void libvlc_video_set_crop_border (libvlc_media_player_t *mp, unsigned left, unsigned right, unsigned top, unsigned bottom)
 Set the video crop borders. More...
 
LIBVLC_API int libvlc_video_get_teletext (libvlc_media_player_t *p_mi)
 Get current teletext page requested or 0 if it's disabled. More...
 
LIBVLC_API void libvlc_video_set_teletext (libvlc_media_player_t *p_mi, int i_page)
 Set new teletext page to retrieve. More...
 
LIBVLC_API int libvlc_video_take_snapshot (libvlc_media_player_t *p_mi, unsigned num, const char *psz_filepath, unsigned int i_width, unsigned int i_height)
 Take a snapshot of the current video window. More...
 
LIBVLC_API void libvlc_video_set_deinterlace (libvlc_media_player_t *p_mi, int deinterlace, const char *psz_mode)
 Enable or disable deinterlace filter. More...
 
LIBVLC_API int libvlc_video_get_marquee_int (libvlc_media_player_t *p_mi, unsigned option)
 Get an integer marquee option value. More...
 
LIBVLC_API void libvlc_video_set_marquee_int (libvlc_media_player_t *p_mi, unsigned option, int i_val)
 Enable, disable or set an integer marquee option. More...
 
LIBVLC_API void libvlc_video_set_marquee_string (libvlc_media_player_t *p_mi, unsigned option, const char *psz_text)
 Set a marquee string option. More...
 
LIBVLC_API int libvlc_video_get_logo_int (libvlc_media_player_t *p_mi, unsigned option)
 Get integer logo option. More...
 
LIBVLC_API void libvlc_video_set_logo_int (libvlc_media_player_t *p_mi, unsigned option, int value)
 Set logo option as integer. More...
 
LIBVLC_API void libvlc_video_set_logo_string (libvlc_media_player_t *p_mi, unsigned option, const char *psz_value)
 Set logo option as string. More...
 
LIBVLC_API int libvlc_video_get_adjust_int (libvlc_media_player_t *p_mi, unsigned option)
 Get integer adjust option. More...
 
LIBVLC_API void libvlc_video_set_adjust_int (libvlc_media_player_t *p_mi, unsigned option, int value)
 Set adjust option as integer. More...
 
LIBVLC_API float libvlc_video_get_adjust_float (libvlc_media_player_t *p_mi, unsigned option)
 Get float adjust option. More...
 
LIBVLC_API void libvlc_video_set_adjust_float (libvlc_media_player_t *p_mi, unsigned option, float value)
 Set adjust option as float. More...
 
LIBVLC_API libvlc_audio_output_tlibvlc_audio_output_list_get (libvlc_instance_t *p_instance)
 Gets the list of available audio output modules. More...
 
LIBVLC_API void libvlc_audio_output_list_release (libvlc_audio_output_t *p_list)
 Frees the list of available audio output modules. More...
 
LIBVLC_API int libvlc_audio_output_set (libvlc_media_player_t *p_mi, const char *psz_name)
 Selects an audio output module. More...
 
LIBVLC_API libvlc_audio_output_device_tlibvlc_audio_output_device_enum (libvlc_media_player_t *mp)
 Gets a list of potential audio output devices. More...
 
LIBVLC_API void libvlc_audio_output_device_list_release (libvlc_audio_output_device_t *p_list)
 Frees a list of available audio output devices. More...
 
LIBVLC_API int libvlc_audio_output_device_set (libvlc_media_player_t *mp, const char *device_id)
 Configures an explicit audio output device. More...
 
LIBVLC_API char * libvlc_audio_output_device_get (libvlc_media_player_t *mp)
 Get the current audio output device identifier. More...
 
LIBVLC_API void libvlc_audio_toggle_mute (libvlc_media_player_t *p_mi)
 Toggle mute status. More...
 
LIBVLC_API int libvlc_audio_get_mute (libvlc_media_player_t *p_mi)
 Get current mute status. More...
 
LIBVLC_API void libvlc_audio_set_mute (libvlc_media_player_t *p_mi, int status)
 Set mute status. More...
 
LIBVLC_API int libvlc_audio_get_volume (libvlc_media_player_t *p_mi)
 Get current software audio volume. More...
 
LIBVLC_API int libvlc_audio_set_volume (libvlc_media_player_t *p_mi, int i_volume)
 Set current software audio volume. More...
 
LIBVLC_API int libvlc_audio_get_channel (libvlc_media_player_t *p_mi)
 Get current audio channel. More...
 
LIBVLC_API int libvlc_audio_set_channel (libvlc_media_player_t *p_mi, int channel)
 Set current audio channel. More...
 
LIBVLC_API int64_t libvlc_audio_get_delay (libvlc_media_player_t *p_mi)
 Get current audio delay. More...
 
LIBVLC_API int libvlc_audio_set_delay (libvlc_media_player_t *p_mi, int64_t i_delay)
 Set current audio delay. More...
 
LIBVLC_API unsigned libvlc_audio_equalizer_get_preset_count (void)
 Get the number of equalizer presets. More...
 
LIBVLC_API const char * libvlc_audio_equalizer_get_preset_name (unsigned u_index)
 Get the name of a particular equalizer preset. More...
 
LIBVLC_API unsigned libvlc_audio_equalizer_get_band_count (void)
 Get the number of distinct frequency bands for an equalizer. More...
 
LIBVLC_API float libvlc_audio_equalizer_get_band_frequency (unsigned u_index)
 Get a particular equalizer band frequency. More...
 
LIBVLC_API libvlc_equalizer_tlibvlc_audio_equalizer_new (void)
 Create a new default equalizer, with all frequency values zeroed. More...
 
LIBVLC_API libvlc_equalizer_tlibvlc_audio_equalizer_new_from_preset (unsigned u_index)
 Create a new equalizer, with initial frequency values copied from an existing preset. More...
 
LIBVLC_API void libvlc_audio_equalizer_release (libvlc_equalizer_t *p_equalizer)
 Release a previously created equalizer instance. More...
 
LIBVLC_API int libvlc_audio_equalizer_set_preamp (libvlc_equalizer_t *p_equalizer, float f_preamp)
 Set a new pre-amplification value for an equalizer. More...
 
LIBVLC_API float libvlc_audio_equalizer_get_preamp (libvlc_equalizer_t *p_equalizer)
 Get the current pre-amplification value from an equalizer. More...
 
LIBVLC_API int libvlc_audio_equalizer_set_amp_at_index (libvlc_equalizer_t *p_equalizer, float f_amp, unsigned u_band)
 Set a new amplification value for a particular equalizer frequency band. More...
 
LIBVLC_API float libvlc_audio_equalizer_get_amp_at_index (libvlc_equalizer_t *p_equalizer, unsigned u_band)
 Get the amplification value for a particular equalizer frequency band. More...
 
LIBVLC_API int libvlc_media_player_set_equalizer (libvlc_media_player_t *p_mi, libvlc_equalizer_t *p_equalizer)
 Apply new equalizer settings to a media player. More...
 
LIBVLC_API int libvlc_media_player_get_role (libvlc_media_player_t *p_mi)
 Gets the media role. More...
 
LIBVLC_API int libvlc_media_player_set_role (libvlc_media_player_t *p_mi, unsigned role)
 Sets the media role. More...
 

Detailed Description

LibVLC simple media player external API.

Macro Definition Documentation

◆ libvlc_role_Last

#define libvlc_role_Last   libvlc_role_Test

Testing.