Collaboration diagram for Player instance:

Data Structures
struct	vlc_player_media_provider
	Callbacks for the owner of the player. More...

Typedefs
typedef struct vlc_player_t	vlc_player_t
	Player opaque structure. More...

Enumerations
enum	vlc_player_lock_type { VLC_PLAYER_LOCK_NORMAL , VLC_PLAYER_LOCK_REENTRANT }
	Player lock type (normal or reentrant) More...

enum	vlc_player_media_stopped_action { VLC_PLAYER_MEDIA_STOPPED_CONTINUE , VLC_PLAYER_MEDIA_STOPPED_PAUSE , VLC_PLAYER_MEDIA_STOPPED_STOP , VLC_PLAYER_MEDIA_STOPPED_EXIT }
	Action when the player is stopped. More...

Functions
vlc_player_t *	vlc_player_New (vlc_object_t parent, enum vlc_player_lock_type lock_type, const struct vlc_player_media_provider media_provider, void *media_provider_data)
	Create a new player instance. More...

void	vlc_player_Delete (vlc_player_t *player)
	Delete a player instance. More...

void	vlc_player_Lock (vlc_player_t *player)
	Lock the player. More...

void	vlc_player_Unlock (vlc_player_t *player)
	Unlock the player. More...

void	vlc_player_CondWait (vlc_player_t player, vlc_cond_t cond)
	Wait on a condition variable. More...

void	vlc_player_SetMediaStoppedAction (vlc_player_t *player, enum vlc_player_media_stopped_action action)
	Setup an action when a media is stopped. More...

void	vlc_player_SetStartPaused (vlc_player_t *player, bool start_paused)
	Ask to start in a paused state. More...

void	vlc_player_SetPauseOnCork (vlc_player_t *player, bool enabled)
	Enable or disable pause on cork event. More...

Detailed Description

Typedef Documentation

◆ vlc_player_t

typedef struct vlc_player_t vlc_player_t

Player opaque structure.

Enumeration Type Documentation

◆ vlc_player_lock_type

enum vlc_player_lock_type

Player lock type (normal or reentrant)

Enumerator

VLC_PLAYER_LOCK_NORMAL

Normal lock.

If the player is already locked, subsequent calls to vlc_player_Lock() will deadlock.

VLC_PLAYER_LOCK_REENTRANT

Reentrant lock.

If the player is already locked, subsequent calls to vlc_player_Lock() will still succeed. To unlock the player, one call to vlc_player_Unlock() per vlc_player_Lock() is necessary.

◆ vlc_player_media_stopped_action

enum vlc_player_media_stopped_action

Action when the player is stopped.

See also: vlc_player_SetMediaStoppedAction()

Enumerator
VLC_PLAYER_MEDIA_STOPPED_CONTINUE	Continue (or stop if there is no next media), default behavior.
VLC_PLAYER_MEDIA_STOPPED_PAUSE	Pause when reaching the end of file.
VLC_PLAYER_MEDIA_STOPPED_STOP	Stop, even if there is a next media to play.
VLC_PLAYER_MEDIA_STOPPED_EXIT	Exit VLC.

Function Documentation

◆ vlc_player_CondWait()

void vlc_player_CondWait	(	vlc_player_t *	player,
		vlc_cond_t *	cond
	)

Wait on a condition variable.

This call allow users to use their own condition with the player mutex.

Parameters

player	locked player instance
cond	external condition

References vlc_player_t::lock, vlc_player_input::player, vlc_cond_wait(), and vlc_player_assert_locked().

◆ vlc_player_Delete()

void vlc_player_Delete ( vlc_player_t * player )

Delete a player instance.

This function stop any playback previously started and wait for their termination.

Warning: Blocking function if the player state is not STOPPED, don't call it from an UI thread in that case.

Parameters

player unlocked player instance created by vlc_player_New()

References vlc_player_t::aout_listeners, vlc_player_t::audio_string_ids, vlc_player_t::deleting, vlc_player_t::destructor, vlc_player_t::input, input_item_Release(), input_resource_Release(), vlc_player_t::listeners, vlc_player_t::lock, vlc_player_t::media, vlc_player_t::metadata_listeners, vlc_player_t::next_media, vlc_player_input::player, vlc_player_t::renderer, vlc_player_t::resource, vlc_player_t::sub_string_ids, vlc_player_t::thread, var_DelCallback(), var_Destroy(), var_GetAddress(), vlc_player_t::video_string_ids, vlc_cond_signal(), vlc_http_cookies_destroy(), vlc_join(), vlc_list_is_empty(), vlc_mutex_held(), vlc_mutex_lock(), vlc_mutex_unlock(), vlc_object_delete, vlc_player_aout_Deinit(), vlc_player_CorkCallback(), vlc_player_DestroyTimer(), vlc_player_destructor_AddInput(), vlc_renderer_item_release(), vlc_player_t::vout_listeners, and vlc_player_t::wait.

Referenced by vlc_playlist_PlayerDestroy(), vlc_playlist_PlayerInit(), vlm_MediaInstanceDelete(), and vlm_MediaInstanceNew().

◆ vlc_player_Lock()

void vlc_player_Lock ( vlc_player_t * player )

Lock the player.

All player functions (except vlc_player_Delete()) need to be called while the player lock is held.

Parameters

player unlocked player instance

References vlc_player_t::aout_listeners_lock, vlc_player_timer::lock, vlc_player_t::lock, vlc_player_t::metadata_listeners_lock, vlc_player_input::player, vlc_player_t::timer, vlc_mutex_held(), vlc_mutex_lock(), and vlc_player_t::vout_listeners_lock.

Referenced by Manage(), vlc_player_CorkCallback(), vlc_player_destructor_Thread(), vlc_playlist_Lock(), vlc_playlist_PlayerDestroy(), vlc_playlist_PlayerInit(), vlm_ControlMediaInstanceGets(), vlm_ControlMediaInstanceGetTimePosition(), vlm_ControlMediaInstancePause(), vlm_ControlMediaInstanceSetTimePosition(), vlm_ControlMediaInstanceStart(), vlm_MediaInstanceDelete(), and vlm_MediaInstanceNew().

◆ vlc_player_New()

vlc_player_t * vlc_player_New	(	vlc_object_t *	parent,
		enum vlc_player_lock_type	lock_type,
		const struct vlc_player_media_provider *	media_provider,
		void *	media_provider_data
	)

Create a new player instance.

Parameters

parent	parent VLC object
media_provider	pointer to a media_provider structure or NULL, the structure must be valid during the lifetime of the player
media_provider_data	opaque data used by provider callbacks