#include <media_player.h>

Inheritance diagram for shaka::media::MediaPlayer::Client:

Public Member Functions
	Client ()

virtual	~ Client ()

	Client (const Client &)=delete

Client &	operator= (const Client &)=delete

	Client (Client &&)=delete

Client &	operator= (Client &&)=delete

virtual void	OnAddAudioTrack (std::shared_ptr< MediaTrack > track)

virtual void	OnRemoveAudioTrack (std::shared_ptr< MediaTrack > track)

virtual void	OnAddVideoTrack (std::shared_ptr< MediaTrack > track)

virtual void	OnRemoveVideoTrack (std::shared_ptr< MediaTrack > track)

virtual void	OnAddTextTrack (std::shared_ptr< TextTrack > track)

virtual void	OnRemoveTextTrack (std::shared_ptr< TextTrack > track)

virtual void	OnReadyStateChanged (VideoReadyState old_state, VideoReadyState new_state)

virtual void	OnPlaybackStateChanged (VideoPlaybackState old_state, VideoPlaybackState new_state)

virtual void	OnPlaybackRateChanged (double old_rate, double new_rate)

virtual void	OnError (const std::string &error)

virtual void	OnAttachMse ()

virtual void	OnAttachSource ()

virtual void	OnDetach ()

virtual void	OnPlay ()

virtual void	OnSeeking ()

virtual void	OnWaitingForKey ()

virtual void	OnUserEvent (const std::string &name, void *user_data)

Detailed Description

Defines an interface for listening for player events. These callbacks are invoked by the MediaPlayer when events happen. These can be called on any thread and can be called concurrently on multiple threads.

These are called synchronously with a lock held on the MediaPlayer, so you can't call back into the MediaPlayer instance from a callback.

Definition at line 194 of file media_player.h.

Constructor & Destructor Documentation

§ Client() [1/3]

shaka::media::MediaPlayer::Client::Client ( )

§ ~ Client()

virtual shaka::media::MediaPlayer::Client::~ Client ( )

virtual

§ Client() [2/3]

shaka::media::MediaPlayer::Client::Client ( const Client & )

delete

§ Client() [3/3]

shaka::media::MediaPlayer::Client::Client ( Client && )

delete

Member Function Documentation

§ OnAddAudioTrack()

Doxygen_Skip void shaka::media::MediaPlayer::Client::OnAddAudioTrack ( std::shared_ptr< MediaTrack > track )

virtual

Called when an AudioTrack is added to the MediaPlayer

Parameters

track The new track that was added.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 77 of file media_player.cc.

§ OnAddTextTrack()

void shaka::media::MediaPlayer::Client::OnAddTextTrack ( std::shared_ptr< TextTrack > track )

virtual

Called when a TextTrack is added to the MediaPlayer. This should be called for both AddTextTrack calls and when the player adds its own objects.

Parameters

track The new track that was added.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 87 of file media_player.cc.

§ OnAddVideoTrack()

void shaka::media::MediaPlayer::Client::OnAddVideoTrack ( std::shared_ptr< MediaTrack > track )

virtual

Called when a VideoTrack is added to the MediaPlayer

Parameters

track The new track that was added.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 82 of file media_player.cc.

§ OnAttachMse()

void shaka::media::MediaPlayer::Client::OnAttachMse ( )

virtual

Called when MSE-based playback has been attached. The media has not been loaded yet, so many of the methods may not be usable yet. But MSE content will be played once loaded.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 103 of file media_player.cc.

§ OnAttachSource()

void shaka::media::MediaPlayer::Client::OnAttachSource ( )

virtual

Called when src= content has been attached. This is called right after starting, so the content may not be loaded yet.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 105 of file media_player.cc.

§ OnDetach()

void shaka::media::MediaPlayer::Client::OnDetach ( )

virtual

Called when playback has stopped and the content has been unloaded.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 107 of file media_player.cc.

§ OnError()

void shaka::media::MediaPlayer::Client::OnError ( const std::string & error )

virtual

Called when an error happens during playback.

Parameters

error Describes what went wrong, can be empty.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 101 of file media_player.cc.

§ OnPlay()

void shaka::media::MediaPlayer::Client::OnPlay ( )

virtual

Called when the video starts playing after startup or a call to Pause. This is different from entering the Playing state since this is only called for autoplay or a call to Pause.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 109 of file media_player.cc.

§ OnPlaybackRateChanged()

void shaka::media::MediaPlayer::Client::OnPlaybackRateChanged	(	double	old_rate,
		double	new_rate
	)

virtual

Called when the playback rate changes.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 98 of file media_player.cc.

§ OnPlaybackStateChanged()

void shaka::media::MediaPlayer::Client::OnPlaybackStateChanged	(	VideoPlaybackState	old_state,
		VideoPlaybackState	new_state
	)

virtual

Called when the VideoPlaybackState of the media changes.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 94 of file media_player.cc.

§ OnReadyStateChanged()

void shaka::media::MediaPlayer::Client::OnReadyStateChanged	(	VideoReadyState	old_state,
		VideoReadyState	new_state
	)

virtual

Called when the VideoReadyState of the media changes.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 91 of file media_player.cc.

§ OnRemoveAudioTrack()

void shaka::media::MediaPlayer::Client::OnRemoveAudioTrack ( std::shared_ptr< MediaTrack > track )

virtual

Called when an AudioTrack is removed from the MediaPlayer

Parameters

track The track that was removed.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 79 of file media_player.cc.

§ OnRemoveTextTrack()

void shaka::media::MediaPlayer::Client::OnRemoveTextTrack ( std::shared_ptr< TextTrack > track )

virtual

Called when a TextTrack is removed from the MediaPlayer.

Parameters

track The track that was removed.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 89 of file media_player.cc.

§ OnRemoveVideoTrack()

void shaka::media::MediaPlayer::Client::OnRemoveVideoTrack ( std::shared_ptr< MediaTrack > track )

virtual

Called when a VideoTrack is removed from the MediaPlayer

Parameters

track The track that was removed.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 84 of file media_player.cc.

§ OnSeeking()

void shaka::media::MediaPlayer::Client::OnSeeking ( )

virtual

Called when the video starts seeking. This may be called multiple times while in the Seeking state, if there are multiple seeks.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 111 of file media_player.cc.

§ OnUserEvent()

void shaka::media::MediaPlayer::Client::OnUserEvent	(	const std::string &	name,
		void *	user_data
	)

virtual

Called when a user-defined event is raised. These may be raised by custom MediaPlayer implementations to pass user data to a listener. Library-defined listeners will ignore these events.

This can also be used by the library to raise new events on minor release branches without breaking ABI. There are currently no such events.

Events that have named methods will not be raised using this method.

Parameters

name	The name of the event.
user_data	Extra user data associated with the event. Unless otherwise stated, it will only remain valid for this call.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 115 of file media_player.cc.

§ OnWaitingForKey()

void shaka::media::MediaPlayer::Client::OnWaitingForKey ( )

virtual

Called when the video stops playing due to lack of an encryption key. This should only be called once for each missing key, but can be called multiple times if new keys arrive but there still isn't the required key.

Reimplemented in shaka::media::MediaPlayer::ClientList.

Definition at line 113 of file media_player.cc.

§ operator=() [1/2]

Client& shaka::media::MediaPlayer::Client::operator= ( const Client & )

delete

§ operator=() [2/2]

Client& shaka::media::MediaPlayer::Client::operator= ( Client && )

delete

The documentation for this class was generated from the following files:

shaka/include/shaka/media/media_player.h
shaka/src/media/media_player.cc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

§ Client() [1/3]

§ ~ Client()

§ Client() [2/3]

§ Client() [3/3]

Member Function Documentation

§ OnAddAudioTrack()

§ OnAddTextTrack()

§ OnAddVideoTrack()

§ OnAttachMse()

§ OnAttachSource()

§ OnDetach()

§ OnError()

§ OnPlay()

§ OnPlaybackRateChanged()

§ OnPlaybackStateChanged()

§ OnReadyStateChanged()

§ OnRemoveAudioTrack()

§ OnRemoveTextTrack()

§ OnRemoveVideoTrack()

§ OnSeeking()

§ OnUserEvent()

§ OnWaitingForKey()

§ operator=() [1/2]

§ operator=() [2/2]