PlayerController Class Reference

It is a definition of the player controlling interface. More...

#include <player_controller.h>

Inheritance diagram for PlayerController:

Public Types
enum	PlayerState {   PlayerState::kUnitialized, PlayerState::kReady, PlayerState::kPaused, PlayerState::kPlaying,   PlayerState::kError }

Public Member Functions
	PlayerController ()
	Creates a PlayerController object. More...
virtual	~PlayerController ()
	Destroys the PlayerController object. More...
virtual void	Play ()=0
	Orders the player to start/resume playback of the loaded content. More...
virtual void	Pause ()=0
	Orders the player to pause playback of the content. More...
virtual void	Seek (Samsung::NaClPlayer::TimeTicks to_time)=0
virtual void	ChangeRepresentation (StreamType stream_type, int32_t id)=0
virtual void	SetViewRect (const Samsung::NaClPlayer::Rect &view_rect)=0
virtual void	PostTextTrackInfo ()=0
virtual void	ChangeSubtitles (int32_t id)=0
virtual void	ChangeSubtitleVisibility ()=0
	Orders the player to start or stop generating events related to subtitles. More...
virtual PlayerState	GetState ()=0

Detailed Description

It is a definition of the player controlling interface.

Definition at line 42 of file player_controller.h.

Member Enumeration Documentation

enum PlayerController::PlayerState

strong

Enum which defines PlayerController possible states.

Enumerator
kUnitialized	In this state PlayerController is not ready to use. This state is set right after creation.
kReady	In this state PlayerController is ready to use.
kPaused	In this state PlayerController pause playing the content and is waiting for resume or close order.
kPlaying	In this state PlayerController plays the content.
kError	This state means that PlayerController has caught an error and playback is not possible.

Definition at line 46 of file player_controller.h.

Constructor & Destructor Documentation

PlayerController::PlayerController ( )

inline

Creates a PlayerController object.

Definition at line 67 of file player_controller.h.

virtual PlayerController::~PlayerController ( )

inlinevirtual

Destroys the PlayerController object.

Definition at line 70 of file player_controller.h.

Member Function Documentation

virtual void PlayerController::ChangeRepresentation ( StreamType  stream_type, int32_t  id  )

pure virtual

Orders the player to change a stream representation to a defined one.

Parameters

[in]	stream_type	A definition which stream representation should be changed.
[in]	id	An id of the new stream representation which should be used.

Implemented in EsDashPlayerController, and UrlPlayerController.

virtual void PlayerController::ChangeSubtitles ( int32_t  id )

pure virtual

Orders the player to change a subtitles set from current to the specified one.

Parameters

[in]

id

An id of a subtitles set which should be used.

Implemented in EsDashPlayerController, and UrlPlayerController.

virtual void PlayerController::ChangeSubtitleVisibility ( )

pure virtual

Orders the player to start or stop generating events related to subtitles.

Implemented in EsDashPlayerController, and UrlPlayerController.

virtual PlayerState PlayerController::GetState ( )

pure virtual

Provides information about PlayerController state.

Returns

A current state of the player.

Implemented in EsDashPlayerController, and UrlPlayerController.

virtual void PlayerController::Pause ( )

pure virtual

Orders the player to pause playback of the content.

Implemented in EsDashPlayerController, and UrlPlayerController.

virtual void PlayerController::Play ( )

pure virtual

Orders the player to start/resume playback of the loaded content.

Implemented in EsDashPlayerController, and UrlPlayerController.

virtual void PlayerController::PostTextTrackInfo ( )

pure virtual

Orders the player to send a message about all available subtitles text track's information.

Implemented in EsDashPlayerController, and UrlPlayerController.

virtual void PlayerController::Seek ( Samsung::NaClPlayer::TimeTicks  to_time )

pure virtual

Orders the player to change the current playback time to the defined one.

param[in] to_time Time from which playback should continue when seek operation completes.

Implemented in EsDashPlayerController, and UrlPlayerController.

virtual void PlayerController::SetViewRect ( const Samsung::NaClPlayer::Rect &  view_rect )

pure virtual

Sets a player display area.

Parameters

[in]

view_rect

A size and position of a player display area.

Implemented in EsDashPlayerController, and UrlPlayerController.

---

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

• player/player_controller.h