libvlc_media_player
[libvlc]

Collaboration diagram for libvlc_media_player:

LibVLC Media Player, object that let you play a media in a custom drawable. More...

Modules
	libvlc_video
	LibVLC Video handling.
	libvlc_audio
	LibVLC Audio handling.
Data Structures
struct	libvlc_track_description_t
	Description for video, audio tracks and subtitles. More...
struct	libvlc_audio_output_t
	Description for audio output. More...
struct	libvlc_rectangle_t
	Rectangle type for video geometry. More...
Typedefs
typedef struct libvlc_media_player_t	libvlc_media_player_t
Enumerations
enum	libvlc_video_marquee_int_option_t {   libvlc_marquee_Enabled = 0, 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 int options definition. More...
enum	libvlc_video_marquee_string_option_t { libvlc_marquee_Text = 0 }
	Marq string options definition. More...
Functions
VLC_PUBLIC_API libvlc_media_player_t *	libvlc_media_player_new (libvlc_instance_t *, libvlc_exception_t *)
	Create an empty Media Player object.
VLC_PUBLIC_API libvlc_media_player_t *	libvlc_media_player_new_from_media (libvlc_media_t *, libvlc_exception_t *)
	Create a Media Player object from a Media.
VLC_PUBLIC_API void	libvlc_media_player_release (libvlc_media_player_t *)
	Release a media_player after use Decrement the reference count of a media player object.
VLC_PUBLIC_API void	libvlc_media_player_retain (libvlc_media_player_t *)
	Retain a reference to a media player object.
VLC_PUBLIC_API void	libvlc_media_player_set_media (libvlc_media_player_t *, libvlc_media_t *, libvlc_exception_t *)
	Set the media that will be used by the media_player.
VLC_PUBLIC_API libvlc_media_t *	libvlc_media_player_get_media (libvlc_media_player_t *, libvlc_exception_t *)
	Get the media used by the media_player.
VLC_PUBLIC_API libvlc_event_manager_t *	libvlc_media_player_event_manager (libvlc_media_player_t *, libvlc_exception_t *)
	Get the Event Manager from which the media player send event.
VLC_PUBLIC_API int	libvlc_media_player_is_playing (libvlc_media_player_t *, libvlc_exception_t *)
	is_playing
VLC_PUBLIC_API void	libvlc_media_player_play (libvlc_media_player_t *, libvlc_exception_t *)
	Play.
VLC_PUBLIC_API void	libvlc_media_player_pause (libvlc_media_player_t *, libvlc_exception_t *)
	Pause.
VLC_PUBLIC_API void	libvlc_media_player_stop (libvlc_media_player_t *, libvlc_exception_t *)
	Stop.
VLC_PUBLIC_API void	libvlc_media_player_set_nsobject (libvlc_media_player_t *p_mi, void *drawable, libvlc_exception_t *p_e)
	Set the agl handler where the media player should render its video output.
VLC_PUBLIC_API void *	libvlc_media_player_get_nsobject (libvlc_media_player_t *p_mi)
	Get the agl handler previously set with libvlc_media_player_set_agl().
VLC_PUBLIC_API void	libvlc_media_player_set_agl (libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e)
	Set the agl handler where the media player should render its video output.
VLC_PUBLIC_API uint32_t	libvlc_media_player_get_agl (libvlc_media_player_t *p_mi)
	Get the agl handler previously set with libvlc_media_player_set_agl().
VLC_PUBLIC_API void	libvlc_media_player_set_xwindow (libvlc_media_player_t *p_mi, uint32_t drawable, libvlc_exception_t *p_e)
	Set an X Window System drawable where the media player should render its video output.
VLC_PUBLIC_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().
VLC_PUBLIC_API void	libvlc_media_player_set_hwnd (libvlc_media_player_t *p_mi, void *drawable, libvlc_exception_t *p_e)
	Set a Win32/Win64 API window handle (HWND) where the media player should render its video output.
VLC_PUBLIC_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().
VLC_PUBLIC_API libvlc_time_t	libvlc_media_player_get_length (libvlc_media_player_t *, libvlc_exception_t *)
	Get the current movie length (in ms).
VLC_PUBLIC_API libvlc_time_t	libvlc_media_player_get_time (libvlc_media_player_t *, libvlc_exception_t *)
	Get the current movie time (in ms).
VLC_PUBLIC_API void	libvlc_media_player_set_time (libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *)
	Set the movie time (in ms).
VLC_PUBLIC_API float	libvlc_media_player_get_position (libvlc_media_player_t *, libvlc_exception_t *)
	Get movie position.
VLC_PUBLIC_API void	libvlc_media_player_set_position (libvlc_media_player_t *, float, libvlc_exception_t *)
	Set movie position.
VLC_PUBLIC_API void	libvlc_media_player_set_chapter (libvlc_media_player_t *, int, libvlc_exception_t *)
	Set movie chapter.
VLC_PUBLIC_API int	libvlc_media_player_get_chapter (libvlc_media_player_t *, libvlc_exception_t *)
	Get movie chapter.
VLC_PUBLIC_API int	libvlc_media_player_get_chapter_count (libvlc_media_player_t *, libvlc_exception_t *)
	Get movie chapter count.
VLC_PUBLIC_API int	libvlc_media_player_will_play (libvlc_media_player_t *, libvlc_exception_t *)
	Will the player play.
VLC_PUBLIC_API int	libvlc_media_player_get_chapter_count_for_title (libvlc_media_player_t *, int, libvlc_exception_t *)
	Get title chapter count.
VLC_PUBLIC_API void	libvlc_media_player_set_title (libvlc_media_player_t *, int, libvlc_exception_t *)
	Set movie title.
VLC_PUBLIC_API int	libvlc_media_player_get_title (libvlc_media_player_t *, libvlc_exception_t *)
	Get movie title.
VLC_PUBLIC_API int	libvlc_media_player_get_title_count (libvlc_media_player_t *, libvlc_exception_t *)
	Get movie title count.
VLC_PUBLIC_API void	libvlc_media_player_previous_chapter (libvlc_media_player_t *, libvlc_exception_t *)
	Set previous chapter.
VLC_PUBLIC_API void	libvlc_media_player_next_chapter (libvlc_media_player_t *, libvlc_exception_t *)
	Set next chapter.
VLC_PUBLIC_API float	libvlc_media_player_get_rate (libvlc_media_player_t *, libvlc_exception_t *)
	Get movie play rate.
VLC_PUBLIC_API void	libvlc_media_player_set_rate (libvlc_media_player_t *, float, libvlc_exception_t *)
	Set movie play rate.
VLC_PUBLIC_API libvlc_state_t	libvlc_media_player_get_state (libvlc_media_player_t *, libvlc_exception_t *)
	Get current movie state.
VLC_PUBLIC_API float	libvlc_media_player_get_fps (libvlc_media_player_t *, libvlc_exception_t *)
	Get movie fps rate.
VLC_PUBLIC_API int	libvlc_media_player_has_vout (libvlc_media_player_t *, libvlc_exception_t *)
	end bug
VLC_PUBLIC_API int	libvlc_media_player_is_seekable (libvlc_media_player_t *p_mi, libvlc_exception_t *p_e)
	Is this media player seekable?
VLC_PUBLIC_API int	libvlc_media_player_can_pause (libvlc_media_player_t *p_mi, libvlc_exception_t *p_e)
	Can this media player be paused?
VLC_PUBLIC_API void	libvlc_media_player_next_frame (libvlc_media_player_t *p_input, libvlc_exception_t *p_e)
	Display the next frame.
VLC_PUBLIC_API void	libvlc_track_description_release (libvlc_track_description_t *p_track_description)
	Release (free) libvlc_track_description_t.

---

Detailed Description

LibVLC Media Player, object that let you play a media in a custom drawable.

---

Typedef Documentation

typedef struct libvlc_media_player_t libvlc_media_player_t

---

Enumeration Type Documentation

enum libvlc_video_marquee_int_option_t

Marq int options definition.

Enumerator:

libvlc_marquee_Enabled
libvlc_marquee_Color
libvlc_marquee_Opacity
libvlc_marquee_Position
libvlc_marquee_Refresh
libvlc_marquee_Size
libvlc_marquee_Timeout
libvlc_marquee_X
libvlc_marquee_Y

enum libvlc_video_marquee_string_option_t

Marq string options definition.

Enumerator:

libvlc_marquee_Text

---

Function Documentation

VLC_PUBLIC_API int libvlc_media_player_can_pause	(	libvlc_media_player_t *	p_mi,
		libvlc_exception_t *	p_e
	)

Can this media player be paused?

Parameters:

	p_input	the input
	p_e	an initialized exception pointer

References clear_if_needed(), libvlc_get_input_thread(), var_GetBool, and vlc_object_release.

Referenced by libvlc_media_player_pause().

VLC_PUBLIC_API libvlc_event_manager_t* libvlc_media_player_event_manager	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get the Event Manager from which the media player send event.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

the event manager associated with p_mi

References libvlc_media_player_t::p_event_manager, and VLC_UNUSED.

Referenced by mplayer_em().

VLC_PUBLIC_API uint32_t libvlc_media_player_get_agl

(

libvlc_media_player_t *

p_mi

)

Get the agl handler previously set with libvlc_media_player_set_agl().

Parameters:

p_mi

the Media Player

Returns:

the agl handler or 0 if none where set

References libvlc_media_player_t::agl, and libvlc_media_player_t::drawable.

VLC_PUBLIC_API int libvlc_media_player_get_chapter	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get movie chapter.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

chapter number currently playing

References libvlc_get_input_thread(), var_GetInteger, and vlc_object_release.

VLC_PUBLIC_API int libvlc_media_player_get_chapter_count	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get movie chapter count.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

number of chapters in movie

References vlc_value_t::i_int, libvlc_get_input_thread(), var_Change, vlc_object_release, and VLC_VAR_CHOICESCOUNT.

VLC_PUBLIC_API int libvlc_media_player_get_chapter_count_for_title	(	libvlc_media_player_t *	,
		int	,
		libvlc_exception_t *
	)

Get title chapter count.

Parameters:

	p_mi	the Media Player
	i_title	title
	p_e	an initialized exception pointer

Returns:

number of chapters in title

References asprintf(), vlc_value_t::i_int, libvlc_get_input_thread(), psz_name, var_Change, vlc_object_release, and VLC_VAR_CHOICESCOUNT.

VLC_PUBLIC_API float libvlc_media_player_get_fps	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get movie fps rate.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

frames per second (fps) for this playing movie

References input_Control(), INPUT_GET_VIDEO_FPS, libvlc_get_input_thread(), and vlc_object_release.

VLC_PUBLIC_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.

Parameters:

p_mi

the Media Player

Returns:

a window handle or NULL if there are none.

References libvlc_media_player_t::drawable, and libvlc_media_player_t::hwnd.

VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get the current movie length (in ms).

Bug:

This might go away ... to be replaced by a broader system

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

the movie length (in ms).

References libvlc_get_input_thread(), var_GetTime, and vlc_object_release.

Referenced by mediacontrol_get_stream_information(), and private_mediacontrol_position2microsecond().

VLC_PUBLIC_API libvlc_media_t* libvlc_media_player_get_media	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get the media used by the media_player.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

the media associated with p_mi, or NULL if no media is associated

References libvlc_media_retain(), lock, libvlc_media_player_t::p_md, unlock(), and VLC_UNUSED.

Referenced by mediacontrol_get_mrl(), mediacontrol_get_stream_information(), and mediacontrol_start().

VLC_PUBLIC_API void* libvlc_media_player_get_nsobject

(

libvlc_media_player_t *

p_mi

)

Get the agl handler previously set with libvlc_media_player_set_agl().

Parameters:

p_mi

the Media Player

Returns:

the agl handler or 0 if none where set

References libvlc_media_player_t::drawable, and libvlc_media_player_t::nsobject.

VLC_PUBLIC_API float libvlc_media_player_get_position	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get movie position.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

movie position

References libvlc_get_input_thread(), var_GetFloat, and vlc_object_release.

VLC_PUBLIC_API float libvlc_media_player_get_rate	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get movie play rate.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

movie play rate

References libvlc_get_input_thread(), var_GetBool, var_GetInteger, and vlc_object_release.

Referenced by mediacontrol_get_rate(), and private_mediacontrol_unit_convert().

VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get current movie state.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

current movie state as libvlc_state_t

References clear_if_needed(), libvlc_Buffering, libvlc_Ended, libvlc_get_input_thread(), libvlc_media_get_state(), libvlc_Playing, libvlc_media_player_t::p_md, var_GetFloat, and vlc_object_release.

Referenced by libvlc_media_list_player_get_state(), libvlc_media_list_player_is_playing(), libvlc_media_player_is_playing(), libvlc_media_player_pause(), libvlc_media_player_stop(), and mediacontrol_get_stream_information().

VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get the current movie time (in ms).

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

the movie time (in ms).

References libvlc_get_input_thread(), var_GetTime, and vlc_object_release.

Referenced by mediacontrol_get_media_position(), mediacontrol_get_stream_information(), and private_mediacontrol_position2microsecond().

VLC_PUBLIC_API int libvlc_media_player_get_title	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get movie title.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

title number currently playing

References libvlc_get_input_thread(), var_GetInteger, and vlc_object_release.

VLC_PUBLIC_API int libvlc_media_player_get_title_count	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Get movie title count.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

title number count

References vlc_value_t::i_int, libvlc_get_input_thread(), var_Change, vlc_object_release, and VLC_VAR_CHOICESCOUNT.

VLC_PUBLIC_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).

Parameters:

p_mi

the Media Player

Returns:

an X window ID, or 0 if none where set.

References libvlc_media_player_t::drawable, and libvlc_media_player_t::xid.

VLC_PUBLIC_API int libvlc_media_player_has_vout	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

end bug

Does this media player have a video output?

Parameters:

	p_md	the media player
	p_e	an initialized exception pointer

References input_GetVout(), libvlc_get_input_thread(), and vlc_object_release.

VLC_PUBLIC_API int libvlc_media_player_is_playing	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

is_playing

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

1 if the media player is playing, 0 otherwise

References libvlc_Buffering, libvlc_media_player_get_state(), and libvlc_Playing.

VLC_PUBLIC_API int libvlc_media_player_is_seekable	(	libvlc_media_player_t *	p_mi,
		libvlc_exception_t *	p_e
	)

Is this media player seekable?

Parameters:

	p_input	the input
	p_e	an initialized exception pointer

References clear_if_needed(), libvlc_get_input_thread(), var_GetBool, and vlc_object_release.

VLC_PUBLIC_API libvlc_media_player_t* libvlc_media_player_new	(	libvlc_instance_t *	,
		libvlc_exception_t *
	)

Create an empty Media Player object.

Parameters:

	p_libvlc_instance	the libvlc instance in which the Media Player should be created.
	p_e	an initialized exception pointer

References libvlc_media_player_t::agl, libvlc_media_player_t::drawable, Forward(), libvlc_media_player_t::hwnd, libvlc_media_player_t::i_refcount, libvlc_media_player_t::keyboard_events, libvlc_event_manager_new(), libvlc_exception_raise(), libvlc_exception_raised(), libvlc_printerr(), libvlc_media_player_t::mouse_events, libvlc_media_player_t::nsobject, libvlc_media_player_t::object_lock, libvlc_media_player_t::p_event_manager, libvlc_media_player_t::p_input_resource, libvlc_media_player_t::p_input_thread, libvlc_media_player_t::p_libvlc_instance, libvlc_instance_t::p_libvlc_int, libvlc_media_player_t::p_md, PositionChanged(), register_event, snapshot_was_taken(), var_AddCallback, vlc_mutex_destroy(), vlc_mutex_init(), and libvlc_media_player_t::xid.

Referenced by libvlc_media_player_new_from_media(), mediacontrol_new(), and mediacontrol_new_from_instance().

VLC_PUBLIC_API libvlc_media_player_t* libvlc_media_player_new_from_media	(	libvlc_media_t *	,
		libvlc_exception_t *
	)

Create a Media Player object from a Media.

Parameters:

	p_md	the media. Afterwards the p_md can be safely destroyed.
	p_e	an initialized exception pointer

References libvlc_media_player_new(), libvlc_media_retain(), libvlc_media_t::p_libvlc_instance, and libvlc_media_player_t::p_md.

Referenced by set_current_playing_item().

VLC_PUBLIC_API void libvlc_media_player_next_chapter	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Set next chapter.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

References i_type, libvlc_get_input_thread(), var_SetBool, var_Type, vlc_object_release, and VLC_VAR_TYPE.

VLC_PUBLIC_API void libvlc_media_player_next_frame	(	libvlc_media_player_t *	p_input,
		libvlc_exception_t *	p_e
	)

Display the next frame.

Parameters:

	p_input	the libvlc_media_player_t instance
	p_e	an initialized exception pointer

References libvlc_exception_raise(), libvlc_get_input_thread(), libvlc_printerr(), var_TriggerCallback, and vlc_object_release.

VLC_PUBLIC_API void libvlc_media_player_pause	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Pause.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

References input_Control(), INPUT_SET_STATE, libvlc_Buffering, libvlc_get_input_thread(), libvlc_media_player_can_pause(), libvlc_media_player_get_state(), libvlc_media_player_stop(), libvlc_Playing, PAUSE_S, PLAYING_S, and vlc_object_release.

Referenced by libvlc_media_list_player_pause(), mediacontrol_pause(), and mediacontrol_resume().

VLC_PUBLIC_API void libvlc_media_player_play	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Play.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

References libvlc_media_player_t::agl, libvlc_media_player_t::drawable, libvlc_media_player_t::hwnd, input_Control(), input_Create, input_event_changed(), input_pausable_changed(), input_seekable_changed(), INPUT_SET_STATE, input_Start(), libvlc_media_player_t::keyboard_events, libvlc_exception_clear(), libvlc_exception_raise(), libvlc_get_input_thread(), libvlc_printerr(), lock, libvlc_media_player_t::mouse_events, libvlc_media_player_t::nsobject, libvlc_media_t::p_input_item, libvlc_media_player_t::p_input_resource, libvlc_media_player_t::p_input_thread, libvlc_media_player_t::p_libvlc_instance, libvlc_instance_t::p_libvlc_int, libvlc_media_player_t::p_md, PLAYING_S, unlock(), var_AddCallback, var_Create, var_SetAddress, var_SetBool, var_SetInteger, vlc_object_release, VLC_VAR_ADDRESS, VLC_VAR_BOOL, VLC_VAR_INTEGER, and libvlc_media_player_t::xid.

Referenced by libvlc_media_list_player_play(), libvlc_media_list_player_play_item(), libvlc_media_list_player_play_item_at_index(), mediacontrol_start(), and set_relative_playlist_position_and_play().

VLC_PUBLIC_API void libvlc_media_player_previous_chapter	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Set previous chapter.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

References i_type, libvlc_get_input_thread(), var_SetBool, var_Type, vlc_object_release, and VLC_VAR_TYPE.

VLC_PUBLIC_API void libvlc_media_player_release

(

libvlc_media_player_t *

)

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.

Parameters:

p_mi

the Media Player to free

References libvlc_media_player_t::i_refcount, libvlc_media_player_destroy(), lock, and unlock().

Referenced by libvlc_media_list_player_release(), and libvlc_media_list_player_set_media_player().

VLC_PUBLIC_API void libvlc_media_player_retain

(

libvlc_media_player_t *

)

Retain a reference to a media player object.

Use libvlc_media_player_release() to decrement reference count.

Parameters:

p_mi

media player object

References libvlc_media_player_t::i_refcount, lock, and unlock().

Referenced by libvlc_media_list_player_set_media_player().

VLC_PUBLIC_API void libvlc_media_player_set_agl	(	libvlc_media_player_t *	p_mi,
		uint32_t	drawable,
		libvlc_exception_t *	p_e
	)

Set the agl handler where the media player should render its video output.

Parameters:

	p_mi	the Media Player
	drawable	the agl handler
	p_e	an initialized exception pointer

References libvlc_media_player_t::agl, and libvlc_media_player_t::drawable.

VLC_PUBLIC_API void libvlc_media_player_set_chapter	(	libvlc_media_player_t *	,
		int	,
		libvlc_exception_t *
	)

Set movie chapter.

Parameters:

	p_mi	the Media Player
	i_chapter	chapter number to play
	p_e	an initialized exception pointer

References libvlc_get_input_thread(), var_SetInteger, and vlc_object_release.

VLC_PUBLIC_API void libvlc_media_player_set_hwnd	(	libvlc_media_player_t *	p_mi,
		void *	drawable,
		libvlc_exception_t *	p_e
	)

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.

Parameters:

	p_mi	the Media Player
	drawable	windows handle of the drawable
	p_e	an initialized exception pointer

References libvlc_media_player_t::drawable, and libvlc_media_player_t::hwnd.

Referenced by mediacontrol_set_visual().

VLC_PUBLIC_API void libvlc_media_player_set_media	(	libvlc_media_player_t *	,
		libvlc_media_t *	,
		libvlc_exception_t *
	)

Set the media that will be used by the media_player.

If any, previous md will be released.

Parameters:

	p_mi	the Media Player
	p_md	the Media. Afterwards the p_md can be safely destroyed.
	p_e	an initialized exception pointer

References input_thread_t::b_eof, input_thread_t::b_error, libvlc_media_release(), libvlc_media_retain(), libvlc_media_set_state(), libvlc_NothingSpecial, lock, libvlc_media_player_t::p_input_thread, libvlc_media_t::p_libvlc_instance, libvlc_media_player_t::p_libvlc_instance, libvlc_media_player_t::p_md, release_input_thread(), unlock(), and VLC_UNUSED.

Referenced by mediacontrol_set_mrl(), mediacontrol_start(), and set_current_playing_item().

VLC_PUBLIC_API void libvlc_media_player_set_nsobject	(	libvlc_media_player_t *	p_mi,
		void *	drawable,
		libvlc_exception_t *	p_e
	)

Set the agl handler where the media player should render its video output.

Parameters:

	p_mi	the Media Player
	drawable	the agl handler
	p_e	an initialized exception pointer

References libvlc_media_player_t::drawable, and libvlc_media_player_t::nsobject.

VLC_PUBLIC_API void libvlc_media_player_set_position	(	libvlc_media_player_t *	,
		float	,
		libvlc_exception_t *
	)

Set movie position.

Parameters:

	p_mi	the Media Player
	f_pos	the position
	p_e	an initialized exception pointer

References libvlc_get_input_thread(), var_SetFloat, and vlc_object_release.

VLC_PUBLIC_API void libvlc_media_player_set_rate	(	libvlc_media_player_t *	,
		float	,
		libvlc_exception_t *
	)

Set movie play rate.

Parameters:

	p_mi	the Media Player
	movie	play rate to set
	p_e	an initialized exception pointer

References libvlc_exception_raise(), libvlc_get_input_thread(), libvlc_printerr(), var_GetBool, var_SetInteger, and vlc_object_release.

Referenced by mediacontrol_set_rate().

VLC_PUBLIC_API void libvlc_media_player_set_time	(	libvlc_media_player_t *	,
		libvlc_time_t	,
		libvlc_exception_t *
	)

Set the movie time (in ms).

Parameters:

	p_mi	the Media Player
	the	movie time (in ms).
	p_e	an initialized exception pointer

References libvlc_get_input_thread(), var_SetTime, and vlc_object_release.

Referenced by mediacontrol_set_media_position().

VLC_PUBLIC_API void libvlc_media_player_set_title	(	libvlc_media_player_t *	,
		int	,
		libvlc_exception_t *
	)

Set movie title.

Parameters:

	p_mi	the Media Player
	i_title	title number to play
	p_e	an initialized exception pointer

References libvlc_event_send(), libvlc_get_input_thread(), libvlc_MediaPlayerTitleChanged, libvlc_media_player_t::p_event_manager, var_SetInteger, and vlc_object_release.

VLC_PUBLIC_API void libvlc_media_player_set_xwindow	(	libvlc_media_player_t *	p_mi,
		uint32_t	drawable,
		libvlc_exception_t *	p_e
	)

Set an X Window System drawable where the media player should render its video output.

If LibVLC was built without X11 output support, then this has no effects.

The specified identifier must correspond to an existing Input/Output class X11 window. Pixmaps are not supported. The caller shall ensure that the X11 server is the same as the one the VLC instance has been configured with. If XVideo is not used, it is assumed that the drawable has the following properties in common with the default X11 screen: depth, scan line pad, black pixel. This is a bug.

Parameters:

	p_mi	the Media Player
	drawable	the ID of the X window
	p_e	an initialized exception pointer

References libvlc_media_player_t::drawable, and libvlc_media_player_t::xid.

Referenced by mediacontrol_set_visual().

VLC_PUBLIC_API void libvlc_media_player_stop	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Stop.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

References libvlc_Buffering, libvlc_event_send(), libvlc_media_player_get_state(), libvlc_media_set_state(), libvlc_MediaPlayerStopped, libvlc_Paused, libvlc_Playing, libvlc_Stopped, lock, libvlc_media_player_t::p_event_manager, libvlc_media_player_t::p_md, release_input_thread(), and unlock().

Referenced by libvlc_media_player_pause(), mediacontrol_stop(), and stop().

VLC_PUBLIC_API int libvlc_media_player_will_play	(	libvlc_media_player_t *	,
		libvlc_exception_t *
	)

Will the player play.

Parameters:

	p_mi	the Media Player
	p_e	an initialized exception pointer

Returns:

boolean

References input_thread_t::b_dead, input_thread_t::b_die, libvlc_get_input_thread(), and vlc_object_release.

VLC_PUBLIC_API void libvlc_track_description_release

(

libvlc_track_description_t *

p_track_description

)

Release (free) libvlc_track_description_t.

Parameters:

p_track_description

the structure to release

References libvlc_track_description_t::p_next, and libvlc_track_description_t::psz_name.

Referenced by libvlc_get_track_description().