- Generated by
1.9.4
|
VLC 4.0.0-dev
|
A LibVLC media player plays one media (usually in a custom drawable). More...
Modules | |
| LibVLC video controls | |
| LibVLC audio controls | |
| LibVLC media player time watch API | |
Files | |
| file | libvlc_media_player.h |
| LibVLC simple media player external API. | |
Data Structures | |
| struct | libvlc_track_description_t |
| Description for video, audio tracks and subtitles. More... | |
| 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 |
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... | |
A LibVLC media player plays one media (usually in a custom drawable).
| typedef void(* libvlc_audio_cleanup_cb) (void *opaque) |
Callback prototype for audio playback cleanup.
This is called when the media player no longer needs an audio output.
| [in] | opaque | data pointer as passed to libvlc_audio_set_callbacks() |
| typedef void(* libvlc_audio_drain_cb) (void *data) |
Callback prototype for audio buffer drain.
LibVLC may invoke this callback when the decoded audio track is ending. There will be no further decoded samples for the track, but playback should nevertheless continue until all already pending buffers are rendered.
| [in] | data | data pointer as passed to libvlc_audio_set_callbacks() |
| typedef void(* libvlc_audio_flush_cb) (void *data, int64_t pts) |
Callback prototype for audio buffer flush.
LibVLC invokes this callback if it needs to discard all pending buffers and stop playback as soon as possible. This typically occurs when the media is stopped.
| [in] | data | data pointer as passed to libvlc_audio_set_callbacks() |
| typedef struct libvlc_audio_output_device_t libvlc_audio_output_device_t |
Description for audio output device.
| typedef struct libvlc_audio_output_t libvlc_audio_output_t |
Description for audio output.
It contains name, description and pointer to next record.
| typedef void(* libvlc_audio_pause_cb) (void *data, int64_t pts) |
Callback prototype for audio pause.
LibVLC invokes this callback to pause audio playback.
| [in] | data | data pointer as passed to libvlc_audio_set_callbacks() |
| pts | time stamp of the pause request (should be elapsed already) |
| typedef void(* libvlc_audio_play_cb) (void *data, const void *samples, unsigned count, int64_t pts) |
Callback prototype for audio playback.
The LibVLC media player decodes and post-processes the audio signal asynchronously (in an internal thread). Whenever audio samples are ready to be queued to the output, this callback is invoked.
The number of samples provided per invocation may depend on the file format, the audio coding algorithm, the decoder plug-in, the post-processing filters and timing. Application must not assume a certain number of samples.
The exact format of audio samples is determined by libvlc_audio_set_format() or libvlc_audio_set_format_callbacks() as is the channels layout.
Note that the number of samples is per channel. For instance, if the audio track sampling rate is 48000 Hz, then 1200 samples represent 25 milliseconds of audio signal - regardless of the number of audio channels.
| [in] | data | data pointer as passed to libvlc_audio_set_callbacks() |
| [in] | samples | pointer to a table of audio samples to play back |
| count | number of audio samples to play back | |
| pts | expected play time stamp (see libvlc_delay()) |
| typedef void(* libvlc_audio_resume_cb) (void *data, int64_t pts) |
Callback prototype for audio resumption.
LibVLC invokes this callback to resume audio playback after it was previously paused.
| [in] | data | data pointer as passed to libvlc_audio_set_callbacks() |
| pts | time stamp of the resumption request (should be elapsed already) |
| typedef void(* libvlc_audio_set_volume_cb) (void *data, float volume, bool mute) |
Callback prototype for audio volume change.
| [in] | data | data pointer as passed to libvlc_audio_set_callbacks() |
| volume | software volume (1. = nominal, 0. = mute) | |
| mute | muted flag |
| typedef int(* libvlc_audio_setup_cb) (void **opaque, char *format, unsigned *rate, unsigned *channels) |
Callback prototype to setup the audio playback.
This is called when the media player needs to create a new audio output.
| [in,out] | opaque | pointer to the data pointer passed to libvlc_audio_set_callbacks() |
| [in,out] | format | 4 bytes sample format |
| [in,out] | rate | sample rate |
| [in,out] | channels | channels count |
| typedef struct libvlc_chapter_description_t libvlc_chapter_description_t |
Description for chapters.
| typedef struct libvlc_equalizer_t libvlc_equalizer_t |
Opaque equalizer handle.
Equalizer settings can be applied to a media player.
| typedef struct libvlc_media_player_t libvlc_media_player_t |
| typedef enum libvlc_navigate_mode_t libvlc_navigate_mode_t |
Navigation mode.
| 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.
| typedef enum libvlc_position_t libvlc_position_t |
Enumeration of values used to set position (e.g.
of video title).
| typedef enum libvlc_teletext_key_t libvlc_teletext_key_t |
Enumeration of teletext keys than can be passed via libvlc_video_set_teletext()
| typedef struct libvlc_title_description_t libvlc_title_description_t |
| typedef struct libvlc_track_description_t libvlc_track_description_t |
Description for video, audio tracks and subtitles.
It contains id, name (description string) and pointer to next record.
| typedef void(* libvlc_video_cleanup_cb) (void *opaque) |
Callback prototype to configure picture buffers format.
| [in] | opaque | private pointer as passed to libvlc_video_set_format_callbacks() (and possibly modified by libvlc_video_format_cb) |
Enumeration of the Video color primaries.
| typedef enum libvlc_video_color_space_t libvlc_video_color_space_t |
Enumeration of the Video color spaces.
| typedef void(* libvlc_video_display_cb) (void *opaque, void *picture) |
Callback prototype to display a picture.
When the video frame needs to be shown, as determined by the media playback clock, the display callback is invoked.
| [in] | opaque | private pointer as passed to libvlc_video_set_callbacks() |
| [in] | picture | private pointer returned from the libvlc_video_lock_cb callback |
| typedef enum libvlc_video_engine_t libvlc_video_engine_t |
Enumeration of the Video engine to be used on output.
can be passed to libvlc_video_set_output_callbacks
| 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.
This callback gets the format of the video as output by the video decoder and the chain of video filters (if any). It can opt to change any parameter as it needs. In that case, LibVLC will attempt to convert the video format (rescaling and chroma conversion) but these operations can be CPU intensive.
| [in,out] | opaque | pointer to the private pointer passed to libvlc_video_set_callbacks() |
| [in,out] | chroma | pointer to the 4 bytes video format identifier |
| [in,out] | width | pointer to the buffer width in pixels |
| [in,out] | height | pointer to the buffer height in pixels |
| [out] | pitches | table of scanline pitches in bytes for each pixel plane (the table is allocated by LibVLC) |
| [out] | lines | table of scanlines count for each plane |
| [in] | (width+1) | - pointer to display width in pixels |
| [in] | (height+1) | - pointer to display height in pixels |
| typedef void(* libvlc_video_frameMetadata_cb) (void *opaque, libvlc_video_metadata_type_t type, const void *metadata) |
Callback prototype to receive metadata before rendering.
| [in] | opaque | private pointer passed to the libvlc_video_set_output_callbacks() |
| [in] | type | type of data passed in metadata |
| [in] | metadata | the type of metadata |
| typedef void *(* libvlc_video_getProcAddress_cb) (void *opaque, const char *fct_name) |
Callback prototype to load opengl functions.
| [in] | opaque | private pointer set on the opaque parameter of libvlc_video_output_setup_cb() |
| fct_name | name of the opengl function to load |
| typedef void *(* libvlc_video_lock_cb) (void *opaque, void **planes) |
Callback prototype to allocate and lock a picture buffer.
Whenever a new video frame needs to be decoded, the lock callback is invoked. Depending on the video chroma, one or three pixel planes of adequate dimensions must be returned via the second parameter. Those planes must be aligned on 32-bytes boundaries.
| [in] | opaque | private pointer as passed to libvlc_video_set_callbacks() |
| [out] | planes | start address of the pixel planes (LibVLC allocates the array of void pointers, this callback must initialize the array) |
| typedef bool(* libvlc_video_makeCurrent_cb) (void *opaque, bool enter) |
Callback prototype to set up the OpenGL context for rendering.
Tell the host the rendering is about to start/has finished.
| [in] | opaque | private pointer set on the opaque parameter of libvlc_video_output_setup_cb() |
| [in] | enter | true to set the context as current, false to unset it |
On Direct3D11 the following may change on the provided ID3D11DeviceContext* between enter being true and enter being false:
Marq options definition.
| typedef enum libvlc_video_metadata_type_t libvlc_video_metadata_type_t |
| typedef struct libvlc_video_output_cfg_t libvlc_video_output_cfg_t |
| typedef void(* libvlc_video_output_cleanup_cb) (void *opaque) |
Callback prototype called to release user data.
| [in] | opaque | private pointer set on the opaque parameter of libvlc_video_output_setup_cb() |
| 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.
libvlc will provide a callback of this type when calling libvlc_video_output_set_resize_cb.
| report_opaque | parameter passed to libvlc_video_output_set_resize_cb. [IN] |
| width | new rendering width requested. [IN] |
| height | new rendering height requested. [IN] |
| 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.
| [in] | opaque | private pointer set on the opaque parameter of libvlc_video_output_setup_cb() |
| plane | number of the rendering plane to select | |
| output | handle of the rendering output for the given plane |
The output parameter receives the ID3D11RenderTargetView* to use for rendering the plane.
If this callback is not used (set to NULL in libvlc_video_set_output_callbacks()) OMSetRenderTargets has to be set during the libvlc_video_makeCurrent_cb() entering call.
The number of planes depend on the DXGI_FORMAT returned during the libvlc_video_update_output_cb() call. It's usually one plane except for semi-planar formats like DXGI_FORMAT_NV12 or DXGI_FORMAT_P010.
This callback is called between libvlc_video_makeCurrent_cb current/not-current calls.
| 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.
This allows text rendering and aspect ratio to be handled properly when the host rendering size changes.
It may be called before the libvlc_video_output_setup_cb callback.
| [in] | opaque | private pointer set on the opaque parameter of libvlc_video_output_setup_cb() |
| [in] | report_size_change | callback which must be called when the host size changes. The callback is valid until another call to libvlc_video_output_set_resize_cb is done. This may be called from any thread. |
| [in] | report_opaque | private pointer to pass to the report_size_change callback. |
| 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.
Setup the rendering environment.
| [in,out] | opaque | private pointer passed to the libvlc_video_set_output_callbacks() on input. The callback can change this value on output to be passed to all the other callbacks set on libvlc_video_set_output_callbacks(). |
| [in] | cfg | requested configuration of the video device |
| [out] | out | libvlc_video_setup_device_info_t* to fill |
For libvlc_video_engine_d3d9 the output must be a IDirect3D9*. A reference to this object is held until the libvlc_video_output_cleanup_cb is called. the device must be created with D3DPRESENT_PARAMETERS.hDeviceWindow set to 0.
For libvlc_video_engine_d3d11 the output must be a ID3D11DeviceContext*. A reference to this object is held until the libvlc_video_output_cleanup_cb is called. The ID3D11Device used to create ID3D11DeviceContext must have multithreading enabled.
If the ID3D11DeviceContext is used outside of the callbacks called by libvlc, the host MUST use a mutex to protect the access to the ID3D11DeviceContext of libvlc. This mutex value is set on d3d11.context_mutex. If the ID3D11DeviceContext is not used outside of the callbacks, the mutex d3d11.context_mutex may be NULL.
| typedef struct libvlc_video_render_cfg_t libvlc_video_render_cfg_t |
| 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 void(* libvlc_video_swap_cb) (void *opaque) |
Callback prototype called after performing drawing calls.
This callback is called outside of libvlc_video_makeCurrent_cb current/not-current calls.
| [in] | opaque | private pointer set on the opaque parameter of libvlc_video_output_setup_cb() |
| typedef enum libvlc_video_transfer_func_t libvlc_video_transfer_func_t |
Enumeration of the Video transfer functions.
| typedef void(* libvlc_video_unlock_cb) (void *opaque, void *picture, void *const *planes) |
Callback prototype to unlock a picture buffer.
When the video frame decoding is complete, the unlock callback is invoked. This callback might not be needed at all. It is only an indication that the application can now read the pixel values if it needs to.
| [in] | opaque | private pointer as passed to libvlc_video_set_callbacks() |
| [in] | picture | private pointer returned from the libvlc_video_lock_cb callback |
| [in] | planes | pixel planes as defined by the libvlc_video_lock_cb callback (this parameter is only for convenience) |
| 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.
Update the rendering output setup.
| [in] | opaque | private pointer set on the opaque parameter of libvlc_video_output_setup_cb() |
| [in] | cfg | configuration of the video that will be rendered |
| [out] | output | configuration describing with how the rendering is setup |
Tone mapping, range and color conversion will be done depending on the values set in the output structure.
| enum libvlc_position_t |
Enumeration of values used to set position (e.g.
of video title).
Enumeration of teletext keys than can be passed via libvlc_video_set_teletext()
| Enumerator | |
|---|---|
| libvlc_teletext_key_red | |
| libvlc_teletext_key_green | |
| libvlc_teletext_key_yellow | |
| libvlc_teletext_key_blue | |
| libvlc_teletext_key_index | |
Enumeration of the Video engine to be used on output.
can be passed to libvlc_video_set_output_callbacks
Enumeration of the Video transfer functions.
| 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.
Use libvlc_audio_set_format() or libvlc_audio_set_format_callbacks() to configure the decoded audio format.
| mp | the media player |
| play | callback to play audio samples (must not be NULL) |
| pause | callback to pause playback (or NULL to ignore) |
| resume | callback to resume playback (or NULL to ignore) |
| flush | callback to flush audio buffers (or NULL to ignore) |
| drain | callback to drain audio buffers (or NULL to ignore) |
| opaque | private pointer for the audio callbacks (as first parameter) |
| 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.
This only works in combination with libvlc_audio_set_callbacks(), and is mutually exclusive with libvlc_audio_set_format_callbacks().
The supported formats are:
All supported formats use the native endianess. If there are more than one channel, samples are interleaved.
| mp | the media player |
| format | a four-characters string identifying the sample format |
| rate | sample rate (expressed in Hz) |
| channels | channels count |
| 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.
This only works in combination with libvlc_audio_set_callbacks().
| mp | the media player |
| setup | callback to select the audio format (cannot be NULL) |
| cleanup | callback to release any allocated resources (or NULL) |
| 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.
This only works in combination with libvlc_audio_set_callbacks(). Use libvlc_audio_set_format() or libvlc_audio_set_format_callbacks() to configure the decoded audio format.
| mp | the media player |
| set_volume | callback to apply audio volume, or NULL to apply volume in software |
| 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.
| p_mi | the media player |
| i_type | subtitle or audio |
| psz_uri | Uri of the slave (should contain a valid scheme). |
| b_select | True if this slave should be selected when it's loaded |
| LIBVLC_API bool libvlc_media_player_can_pause | ( | libvlc_media_player_t * | p_mi | ) |
Can this media player be paused?
| p_mi | the media player |
| true | media player can be paused |
| false | media player cannot be paused |
| LIBVLC_API libvlc_event_manager_t * libvlc_media_player_event_manager | ( | libvlc_media_player_t * | p_mi | ) |
Get the Event Manager from which the media player send event.
| p_mi | the Media Player |
| LIBVLC_API int libvlc_media_player_get_chapter | ( | libvlc_media_player_t * | p_mi | ) |
Get movie chapter.
| p_mi | the Media Player |
| LIBVLC_API int libvlc_media_player_get_chapter_count | ( | libvlc_media_player_t * | p_mi | ) |
Get movie chapter count.
| p_mi | the Media Player |
| LIBVLC_API int libvlc_media_player_get_chapter_count_for_title | ( | libvlc_media_player_t * | p_mi, |
| int | i_title | ||
| ) |
Get title chapter count.
| p_mi | the Media Player |
| i_title | title |
| 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().
The handle will be returned even if LibVLC is not currently outputting any video to it.
| p_mi | the Media Player |
| LIBVLC_API libvlc_time_t libvlc_media_player_get_length | ( | libvlc_media_player_t * | p_mi | ) |
Get the current movie length (in ms).
| p_mi | the Media Player |
| LIBVLC_API libvlc_media_t * libvlc_media_player_get_media | ( | libvlc_media_player_t * | p_mi | ) |
Get the media used by the media_player.
| p_mi | the Media Player |
| 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().
| p_mi | the Media Player |
| LIBVLC_API double libvlc_media_player_get_position | ( | libvlc_media_player_t * | p_mi | ) |
Get movie position as percentage between 0.0 and 1.0.
| p_mi | the Media Player |
| LIBVLC_API libvlc_player_program_t * libvlc_media_player_get_program_from_id | ( | libvlc_media_player_t * | p_mi, |
| int | i_group_id | ||
| ) |
Get a program struct from a program id.
| p_mi | opaque media player handle |
| i_group_id | program id |
| LIBVLC_API libvlc_player_programlist_t * libvlc_media_player_get_programlist | ( | libvlc_media_player_t * | p_mi | ) |
Get the program list.
The program list can be used to get program information and to select specific programs.
| p_mi | the media player |
| LIBVLC_API float libvlc_media_player_get_rate | ( | libvlc_media_player_t * | p_mi | ) |
Get the requested movie play rate.
| p_mi | the Media Player |
| LIBVLC_API libvlc_player_program_t * libvlc_media_player_get_selected_program | ( | libvlc_media_player_t * | p_mi | ) |
Get the selected program.
| p_mi | opaque media player handle |
| LIBVLC_API libvlc_media_track_t * libvlc_media_player_get_selected_track | ( | libvlc_media_player_t * | p_mi, |
| libvlc_track_type_t | type | ||
| ) |
Get the selected track for one type.
| p_mi | the media player |
| type | type of the selected track |
| LIBVLC_API libvlc_state_t libvlc_media_player_get_state | ( | libvlc_media_player_t * | p_mi | ) |
Get current movie state.
| p_mi | the Media Player |
| LIBVLC_API libvlc_time_t libvlc_media_player_get_time | ( | libvlc_media_player_t * | p_mi | ) |
Get the current movie time (in ms).
| p_mi | the Media Player |
| LIBVLC_API int libvlc_media_player_get_title | ( | libvlc_media_player_t * | p_mi | ) |
Get movie title.
| p_mi | the Media Player |
| LIBVLC_API int libvlc_media_player_get_title_count | ( | libvlc_media_player_t * | p_mi | ) |
Get movie title count.
| p_mi | the Media Player |
| LIBVLC_API libvlc_media_track_t * libvlc_media_player_get_track_from_id | ( | libvlc_media_player_t * | p_mi, |
| const char * | psz_id | ||
| ) |
| LIBVLC_API libvlc_media_tracklist_t * libvlc_media_player_get_tracklist | ( | libvlc_media_player_t * | p_mi, |
| libvlc_track_type_t | type, | ||
| bool | selected | ||
| ) |
Get the track list for one type.
The track list can be used to get track information and to select specific tracks.
| p_mi | the media player |
| type | type of the track list to request |
| selected | filter only selected tracks if true (return all tracks, even selected ones if false) |
| 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().
Note that this will return the identifier even if VLC is not currently using it (for instance if it is playing an audio-only input).
| p_mi | the Media Player |
| LIBVLC_API unsigned libvlc_media_player_has_vout | ( | libvlc_media_player_t * | p_mi | ) |
How many video outputs does this media player have?
| p_mi | the media player |
| LIBVLC_API bool libvlc_media_player_is_playing | ( | libvlc_media_player_t * | p_mi | ) |
is_playing
| p_mi | the Media Player |
| true | media player is playing |
| false | media player is not playing |
| LIBVLC_API bool libvlc_media_player_is_seekable | ( | libvlc_media_player_t * | p_mi | ) |
Is this media player seekable?
| p_mi | the media player |
| true | media player can seek |
| false | media player cannot seek |
| LIBVLC_API void libvlc_media_player_navigate | ( | libvlc_media_player_t * | p_mi, |
| unsigned | navigate | ||
| ) |
Navigate through DVD Menu.
| p_mi | the Media Player |
| navigate | the Navigation mode |
| LIBVLC_API libvlc_media_player_t * libvlc_media_player_new | ( | libvlc_instance_t * | p_libvlc_instance | ) |
Create an empty Media Player object.
| p_libvlc_instance | the libvlc instance in which the Media Player should be created. |
| LIBVLC_API libvlc_media_player_t * libvlc_media_player_new_from_media | ( | libvlc_instance_t * | inst, |
| libvlc_media_t * | p_md | ||
| ) |
Create a Media Player object from a Media.
| inst | LibVLC instance to create a media player with |
| p_md | the media. Afterwards the p_md can be safely destroyed. |
| LIBVLC_API void libvlc_media_player_next_chapter | ( | libvlc_media_player_t * | p_mi | ) |
Set next chapter (if applicable)
| p_mi | the Media Player |
| LIBVLC_API void libvlc_media_player_next_frame | ( | libvlc_media_player_t * | p_mi | ) |
Display the next frame (if supported)
| p_mi | the media player |
| LIBVLC_API void libvlc_media_player_pause | ( | libvlc_media_player_t * | p_mi | ) |
Toggle pause (no effect if there is no media)
| p_mi | the Media Player |
| LIBVLC_API int libvlc_media_player_play | ( | libvlc_media_player_t * | p_mi | ) |
Play.
| p_mi | the Media Player |
| LIBVLC_API void libvlc_media_player_previous_chapter | ( | libvlc_media_player_t * | p_mi | ) |
Set previous chapter (if applicable)
| p_mi | the Media Player |
| LIBVLC_API bool libvlc_media_player_program_scrambled | ( | libvlc_media_player_t * | p_mi | ) |
Check if the current program is scrambled.
| p_mi | the media player |
| true | current program is scrambled |
| false | current program is not scrambled |
| 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.
If the reference count is 0, then libvlc_media_player_release() will release the media player object. If the media player object has been released, then it should not be used again.
| p_mi | the Media Player to free |
| LIBVLC_API libvlc_media_player_t * libvlc_media_player_retain | ( | libvlc_media_player_t * | p_mi | ) |
Retain a reference to a media player object.
Use libvlc_media_player_release() to decrement reference count.
| p_mi | media player object |
| 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.
| p_mi | opaque media player handle |
| i_group_id | program id |
| LIBVLC_API void libvlc_media_player_select_track | ( | libvlc_media_player_t * | p_mi, |
| const libvlc_media_track_t * | track | ||
| ) |
Select a track.
This will unselected the current track.
| p_mi | the media player |
| track | track to select, can't be NULL |
| 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.
| p_mi | the media player |
| type | type of the selected track |
| tracks | pointer to the track array, or NULL if track_count is 0 |
| track_count | number of tracks in the track array |
| 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.
This function can be used pre-select a list of tracks before starting the player. It has only effect for the current media. It can also be used when the player is already started.
'str_ids' can contain more than one track id, delimited with ','. "" or any invalid track id will cause the player to unselect all tracks of that category. NULL will disable the preference for newer tracks without unselecting any current tracks.
Example:
| p_mi | the media player |
| type | type to select |
| psz_ids | list of string identifier or NULL |
| LIBVLC_API void libvlc_media_player_set_android_context | ( | libvlc_media_player_t * | p_mi, |
| void * | p_awindow_handler | ||
| ) |
Set the android context.
| p_mi | the media player |
| p_awindow_handler | org.videolan.libvlc.AWindow jobject owned by the org.videolan.libvlc.MediaPlayer class from the libvlc-android project. |
| LIBVLC_API void libvlc_media_player_set_chapter | ( | libvlc_media_player_t * | p_mi, |
| int | i_chapter | ||
| ) |
Set movie chapter (if applicable).
| p_mi | the Media Player |
| i_chapter | chapter number to play |
| 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.
If LibVLC was built without Win32/Win64 API output support, then this has no effects.
| p_mi | the Media Player |
| drawable | windows handle of the drawable |
| 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.
If any, previous md will be released.
| p_mi | the Media Player |
| p_md | the Media. Afterwards the p_md can be safely destroyed. |
| 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.
Use the vout called "macosx".
The drawable is an NSObject that follow the VLCVideoViewEmbedding protocol:
Or it can be an NSView object.
If you want to use it along with Qt see the QMacCocoaViewContainer. Then the following code should work:
You can find a live example in VLCVideoView in VLCKit.framework.
| p_mi | the Media Player |
| drawable | the drawable that is either an NSView or an object following the VLCVideoViewEmbedding protocol. |
| 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)
| mp | the Media Player |
| do_pause | play/resume if zero, pause if non-zero |
| LIBVLC_API int libvlc_media_player_set_position | ( | libvlc_media_player_t * | p_mi, |
| double | f_pos, | ||
| bool | b_fast | ||
| ) |
Set movie position as percentage between 0.0 and 1.0.
This has no effect if playback is not enabled. This might not work depending on the underlying input format and protocol.
| p_mi | the Media Player |
| b_fast | prefer fast seeking or precise seeking |
| f_pos | the position |
| LIBVLC_API int libvlc_media_player_set_rate | ( | libvlc_media_player_t * | p_mi, |
| float | rate | ||
| ) |
Set movie play rate.
| p_mi | the Media Player |
| rate | movie play rate to set |
| 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.
| p_mi | the Media Player |
| p_item | an item discovered by libvlc_renderer_discoverer_start() |
| 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).
This has no effect if no media is being played. Not all formats and protocols support this.
| p_mi | the Media Player |
| b_fast | prefer fast seeking or precise seeking |
| i_time | the movie time (in ms). |
| LIBVLC_API void libvlc_media_player_set_title | ( | libvlc_media_player_t * | p_mi, |
| int | i_title | ||
| ) |
Set movie title.
| p_mi | the Media Player |
| i_title | title number to play |
| 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.
| p_mi | the media player |
| position | position at which to display the title, or libvlc_position_disable to prevent the title from being displayed |
| timeout | title display timeout in milliseconds (ignored if libvlc_position_disable) |
| 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.
The call takes effect when the playback starts. If it is already started, it might need to be stopped before changes apply. If LibVLC was built without X11 output support, then this function has no effects.
By default, LibVLC will capture input events on the video rendering area. Use libvlc_video_set_mouse_input() and libvlc_video_set_key_input() to disable that and deliver events to the parent window / to the application instead. By design, the X11 protocol delivers input events to only one recipient.
| p_mi | media player |
| drawable | X11 window ID |
| LIBVLC_API int libvlc_media_player_stop_async | ( | libvlc_media_player_t * | p_mi | ) |
Stop asynchronously.
| p_mi | the Media Player |
| 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.
| p_mi | the media player |
| type | type to unselect |
| LIBVLC_API void libvlc_player_program_delete | ( | libvlc_player_program_t * | program | ) |
Delete a program struct.
| program | returned by libvlc_media_player_get_selected_program() or libvlc_media_player_get_program_from_id() |
| LIBVLC_API libvlc_player_program_t * libvlc_player_programlist_at | ( | libvlc_player_programlist_t * | list, |
| size_t | index | ||
| ) |
Get a program at a specific index.
| list | valid programlist |
| index | valid index in the range [0; count[ |
| LIBVLC_API size_t libvlc_player_programlist_count | ( | const libvlc_player_programlist_t * | list | ) |
Get the number of programs in a programlist.
| list | valid programlist |
| LIBVLC_API void libvlc_player_programlist_delete | ( | libvlc_player_programlist_t * | list | ) |
Release a programlist.
| list | valid programlist |
| LIBVLC_DEPRECATED LIBVLC_API void libvlc_track_description_list_release | ( | libvlc_track_description_t * | p_track_description | ) |
Release (free) libvlc_track_description_t.
| p_track_description | the structure to release |
| 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.
Use libvlc_video_set_format() or libvlc_video_set_format_callbacks() to configure the decoded format.
For optimal perfomances, VLC media player renders into a custom window, and does not use this function and associated callbacks. It is highly recommended that other LibVLC-based application do likewise. To embed video in a window, use libvlc_media_player_set_xwindow() or equivalent depending on the operating system.
If window embedding does not fit the application use case, then a custom LibVLC video output display plugin is required to maintain optimal video rendering performances.
The following limitations affect performance:
| mp | the media player |
| lock | callback to lock video memory (must not be NULL) |
| unlock | callback to unlock video memory (or NULL if not needed) |
| display | callback to display video (or NULL if not needed) |
| opaque | private pointer for the three callbacks (as first parameter) |
| 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.
This only works in combination with libvlc_video_set_callbacks(), and is mutually exclusive with libvlc_video_set_format_callbacks().
| mp | the media player |
| chroma | a four-characters string identifying the chroma (e.g. "RV32" or "YUYV") |
| width | pixel width |
| height | pixel height |
| pitch | line pitch (in bytes) |
| 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.
This only works in combination with libvlc_video_set_callbacks().
| mp | the media player |
| setup | callback to select the video format (cannot be NULL) |
| cleanup | callback to release any allocated resources (or NULL) |
| 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.
| mp | the media player |
| engine | the GPU engine to use |
| setup_cb | callback called to initialize user data |
| cleanup_cb | callback called to clean up user data |
| resize_cb | callback to set the resize callback |
| update_output_cb | callback to get the rendering format of the host (cannot be NULL) |
| swap_cb | callback called after rendering a video frame (cannot be NULL) |
| makeCurrent_cb | callback called to enter/leave the rendering context (cannot be NULL) |
| getProcAddress_cb | opengl function loading callback (cannot be NULL for libvlc_video_engine_opengl and for libvlc_video_engine_gles2) |
| metadata_cb | callback to provide frame metadata (D3D11 only) |
| select_plane_cb | callback to select different D3D11 rendering targets |
| opaque | private pointer passed to callbacks |
setup_cb and cleanup_cb may be called more than once per playback.| true | engine selected and callbacks set |
| false | engine type unknown, callbacks not set |
1.9.4