Shaka Player Embedded
Classes | Public Member Functions | List of all members
shaka::media::MediaPlayer::ClientList Class Referencefinal

#include <media_player.h>

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

Classes

class  Impl
 

Public Member Functions

 ClientList ()
 
 ~ClientList () override
 
void AddClient (Client *client)
 
void RemoveClient (Client *client)
 
void OnAddAudioTrack (std::shared_ptr< MediaTrack > track) override
 
void OnRemoveAudioTrack (std::shared_ptr< MediaTrack > track) override
 
void OnAddVideoTrack (std::shared_ptr< MediaTrack > track) override
 
void OnRemoveVideoTrack (std::shared_ptr< MediaTrack > track) override
 
void OnAddTextTrack (std::shared_ptr< TextTrack > track) override
 
void OnRemoveTextTrack (std::shared_ptr< TextTrack > track) override
 
void OnReadyStateChanged (VideoReadyState old_state, VideoReadyState new_state) override
 
void OnPlaybackStateChanged (VideoPlaybackState old_state, VideoPlaybackState new_state) override
 
void OnPlaybackRateChanged (double old_rate, double new_rate) override
 
void OnError (const std::string &error) override
 
void OnAttachMse () override
 
void OnAttachSource () override
 
void OnDetach () override
 
void OnPlay () override
 
void OnSeeking () override
 
void OnWaitingForKey () override
 
void OnUserEvent (const std::string &name, void *user_data) override
 
- Public Member Functions inherited from shaka::media::MediaPlayer::Client
 Client ()
 
virtual ~ Client ()
 
 Client (const Client &)=delete
 
Clientoperator= (const Client &)=delete
 
 Client (Client &&)=delete
 
Clientoperator= (Client &&)=delete
 

Detailed Description

Represents a thread-safe collection of Client instances.

Definition at line 311 of file media_player.h.

Constructor & Destructor Documentation

§ ClientList()

shaka::media::MediaPlayer::ClientList::ClientList ( )

Definition at line 132 of file media_player.cc.

§ ~ClientList()

shaka::media::MediaPlayer::ClientList::~ClientList ( )
override

Definition at line 133 of file media_player.cc.

Member Function Documentation

§ AddClient()

void shaka::media::MediaPlayer::ClientList::AddClient ( Client client)

Definition at line 135 of file media_player.cc.

§ OnAddAudioTrack()

void shaka::media::MediaPlayer::ClientList::OnAddAudioTrack ( std::shared_ptr< MediaTrack track)
overridevirtual

Called when an AudioTrack is added to the MediaPlayer

Parameters
trackThe new track that was added.

Reimplemented from shaka::media::MediaPlayer::Client.

Definition at line 146 of file media_player.cc.

§ OnAddTextTrack()

void shaka::media::MediaPlayer::ClientList::OnAddTextTrack ( std::shared_ptr< TextTrack track)
overridevirtual

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
trackThe new track that was added.

Reimplemented from shaka::media::MediaPlayer::Client.

Definition at line 166 of file media_player.cc.

§ OnAddVideoTrack()

void shaka::media::MediaPlayer::ClientList::OnAddVideoTrack ( std::shared_ptr< MediaTrack track)
overridevirtual

Called when a VideoTrack is added to the MediaPlayer

Parameters
trackThe new track that was added.

Reimplemented from shaka::media::MediaPlayer::Client.

Definition at line 156 of file media_player.cc.

§ OnAttachMse()

void shaka::media::MediaPlayer::ClientList::OnAttachMse ( )
overridevirtual

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 from shaka::media::MediaPlayer::Client.

Definition at line 195 of file media_player.cc.

§ OnAttachSource()

void shaka::media::MediaPlayer::ClientList::OnAttachSource ( )
overridevirtual

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

Reimplemented from shaka::media::MediaPlayer::Client.

Definition at line 199 of file media_player.cc.

§ OnDetach()

void shaka::media::MediaPlayer::ClientList::OnDetach ( )
overridevirtual

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

Reimplemented from shaka::media::MediaPlayer::Client.

Definition at line 203 of file media_player.cc.

§ OnError()

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

Called when an error happens during playback.

Parameters
errorDescribes what went wrong, can be empty.

Reimplemented from shaka::media::MediaPlayer::Client.

Definition at line 191 of file media_player.cc.

§ OnPlay()

void shaka::media::MediaPlayer::ClientList::OnPlay ( )
overridevirtual

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 from shaka::media::MediaPlayer::Client.

Definition at line 207 of file media_player.cc.

§ OnPlaybackRateChanged()

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

Called when the playback rate changes.

Reimplemented from shaka::media::MediaPlayer::Client.

Definition at line 186 of file media_player.cc.

§ OnPlaybackStateChanged()

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

Called when the VideoPlaybackState of the media changes.

Reimplemented from shaka::media::MediaPlayer::Client.

Definition at line 180 of file media_player.cc.

§ OnReadyStateChanged()

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

Called when the VideoReadyState of the media changes.

Reimplemented from shaka::media::MediaPlayer::Client.

Definition at line 175 of file media_player.cc.

§ OnRemoveAudioTrack()

void shaka::media::MediaPlayer::ClientList::OnRemoveAudioTrack ( std::shared_ptr< MediaTrack track)
overridevirtual

Called when an AudioTrack is removed from the MediaPlayer

Parameters
trackThe track that was removed.

Reimplemented from shaka::media::MediaPlayer::Client.

Definition at line 151 of file media_player.cc.

§ OnRemoveTextTrack()

void shaka::media::MediaPlayer::ClientList::OnRemoveTextTrack ( std::shared_ptr< TextTrack track)
overridevirtual

Called when a TextTrack is removed from the MediaPlayer.

Parameters
trackThe track that was removed.

Reimplemented from shaka::media::MediaPlayer::Client.

Definition at line 170 of file media_player.cc.

§ OnRemoveVideoTrack()

void shaka::media::MediaPlayer::ClientList::OnRemoveVideoTrack ( std::shared_ptr< MediaTrack track)
overridevirtual

Called when a VideoTrack is removed from the MediaPlayer

Parameters
trackThe track that was removed.

Reimplemented from shaka::media::MediaPlayer::Client.

Definition at line 161 of file media_player.cc.

§ OnSeeking()

void shaka::media::MediaPlayer::ClientList::OnSeeking ( )
overridevirtual

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

Reimplemented from shaka::media::MediaPlayer::Client.

Definition at line 211 of file media_player.cc.

§ OnUserEvent()

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

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
nameThe name of the event.
user_dataExtra user data associated with the event. Unless otherwise stated, it will only remain valid for this call.

Reimplemented from shaka::media::MediaPlayer::Client.

Definition at line 219 of file media_player.cc.

§ OnWaitingForKey()

void shaka::media::MediaPlayer::ClientList::OnWaitingForKey ( )
overridevirtual

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 from shaka::media::MediaPlayer::Client.

Definition at line 215 of file media_player.cc.

§ RemoveClient()

void shaka::media::MediaPlayer::ClientList::RemoveClient ( Client client)

Definition at line 141 of file media_player.cc.


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