Music Hub  ..
A session-wide music playback service
core::ubuntu::media::Player Class Referenceabstract

#include <player.h>

+ Inheritance diagram for core::ubuntu::media::Player:
+ Collaboration diagram for core::ubuntu::media::Player:

Classes

struct  Client
 
struct  Configuration
 
struct  Errors
 

Public Types

enum  PlaybackStatus {
  null,
  ready,
  playing,
  paused,
  stopped
}
 
enum  LoopStatus {
  none,
  track,
  playlist
}
 
enum  AudioStreamRole {
  alarm,
  alert,
  multimedia,
  phone
}
 
enum  Orientation {
  rotate0,
  rotate90,
  rotate180,
  rotate270
}
 
enum  Lifetime {
  normal,
  resumable
}
 
enum  Error {
  no_error,
  resource_error,
  format_error,
  network_error,
  access_denied_error,
  service_missing_error
}
 
typedef double PlaybackRate
 
typedef double Volume
 
typedef uint32_t PlayerKey
 
typedef void * GLConsumerWrapperHybris
 
typedef std::map< std::string, std::string > HeadersType
 

Public Member Functions

 Player (const Player &)=delete
 
virtual ~Player ()
 
Playeroperator= (const Player &)=delete
 
bool operator== (const Player &) const =delete
 
virtual std::string uuid () const =0
 
virtual void reconnect ()=0
 
virtual void abandon ()=0
 
virtual std::shared_ptr< TrackListtrack_list ()=0
 
virtual PlayerKey key () const =0
 
virtual video::Sink::Ptr create_gl_texture_video_sink (std::uint32_t texture_id)=0
 
virtual bool open_uri (const Track::UriType &uri)=0
 
virtual bool open_uri (const Track::UriType &uri, const HeadersType &)=0
 
virtual void next ()=0
 
virtual void previous ()=0
 
virtual void play ()=0
 
virtual void pause ()=0
 
virtual void stop ()=0
 
virtual void seek_to (const std::chrono::microseconds &offset)=0
 
virtual const core::Property< bool > & can_play () const =0
 
virtual const core::Property< bool > & can_pause () const =0
 
virtual const core::Property< bool > & can_seek () const =0
 
virtual const core::Property< bool > & can_go_previous () const =0
 
virtual const core::Property< bool > & can_go_next () const =0
 
virtual const core::Property< bool > & is_video_source () const =0
 
virtual const core::Property< bool > & is_audio_source () const =0
 
virtual const core::Property< PlaybackStatus > & playback_status () const =0
 
virtual const core::Property< LoopStatus > & loop_status () const =0
 
virtual const core::Property< PlaybackRate > & playback_rate () const =0
 
virtual const core::Property< bool > & shuffle () const =0
 
virtual const core::Property< Track::MetaData > & meta_data_for_current_track () const =0
 
virtual const core::Property< Volume > & volume () const =0
 
virtual const core::Property< PlaybackRate > & minimum_playback_rate () const =0
 
virtual const core::Property< PlaybackRate > & maximum_playback_rate () const =0
 
virtual const core::Property< int64_t > & position () const =0
 
virtual const core::Property< int64_t > & duration () const =0
 
virtual const core::Property< AudioStreamRole > & audio_stream_role () const =0
 
virtual const core::Property< Orientation > & orientation () const =0
 
virtual const core::Property< Lifetime > & lifetime () const =0
 
virtual core::Property< LoopStatus > & loop_status ()=0
 
virtual core::Property< PlaybackRate > & playback_rate ()=0
 
virtual core::Property< bool > & shuffle ()=0
 
virtual core::Property< Volume > & volume ()=0
 
virtual core::Property< AudioStreamRole > & audio_stream_role ()=0
 
virtual core::Property< Lifetime > & lifetime ()=0
 
virtual const core::Signal< int64_t > & seeked_to () const =0
 
virtual const core::Signal< void > & about_to_finish () const =0
 
virtual const core::Signal< void > & end_of_stream () const =0
 
virtual core::Signal< PlaybackStatus > & playback_status_changed ()=0
 
virtual const core::Signal< video::Dimensions > & video_dimension_changed () const =0
 
virtual const core::Signal< Error > & error () const =0
 

Protected Member Functions

 Player ()
 

Detailed Description

Definition at line 42 of file player.h.

Member Typedef Documentation

Definition at line 48 of file player.h.

typedef std::map<std::string, std::string> core::ubuntu::media::Player::HeadersType

Definition at line 49 of file player.h.

Definition at line 45 of file player.h.

Definition at line 47 of file player.h.

Definition at line 46 of file player.h.

Member Enumeration Documentation

Audio stream role types used to categorize audio playback. multimedia is the default role type and will be automatically paused by media-hub when other types need to play.

Enumerator
alarm 
alert 
multimedia 
phone 

Definition at line 91 of file player.h.

Enumerator
no_error 
resource_error 
format_error 
network_error 
access_denied_error 
service_missing_error 

Definition at line 113 of file player.h.

Enumerator
normal 
resumable 

Definition at line 107 of file player.h.

Enumerator
none 
track 
playlist 

Definition at line 79 of file player.h.

Enumerator
rotate0 
rotate90 
rotate180 
rotate270 

Definition at line 99 of file player.h.

Enumerator
null 
ready 
playing 
paused 
stopped 

Definition at line 70 of file player.h.

Constructor & Destructor Documentation

core::ubuntu::media::Player::Player ( const Player )
delete
core::ubuntu::media::Player::~Player ( )
virtual

Definition at line 45 of file player.cpp.

core::ubuntu::media::Player::Player ( )
protected

Definition at line 41 of file player.cpp.

Member Function Documentation

virtual void core::ubuntu::media::Player::abandon ( )
pure virtual
virtual const core::Signal<void>& core::ubuntu::media::Player::about_to_finish ( ) const
pure virtual
virtual const core::Property<AudioStreamRole>& core::ubuntu::media::Player::audio_stream_role ( ) const
pure virtual
virtual core::Property<AudioStreamRole>& core::ubuntu::media::Player::audio_stream_role ( )
pure virtual
virtual const core::Property<bool>& core::ubuntu::media::Player::can_go_next ( ) const
pure virtual
virtual const core::Property<bool>& core::ubuntu::media::Player::can_go_previous ( ) const
pure virtual
virtual const core::Property<bool>& core::ubuntu::media::Player::can_pause ( ) const
pure virtual
virtual const core::Property<bool>& core::ubuntu::media::Player::can_play ( ) const
pure virtual
virtual const core::Property<bool>& core::ubuntu::media::Player::can_seek ( ) const
pure virtual
virtual video::Sink::Ptr core::ubuntu::media::Player::create_gl_texture_video_sink ( std::uint32_t  texture_id)
pure virtual
virtual const core::Property<int64_t>& core::ubuntu::media::Player::duration ( ) const
pure virtual
virtual const core::Signal<void>& core::ubuntu::media::Player::end_of_stream ( ) const
pure virtual
virtual const core::Signal<Error>& core::ubuntu::media::Player::error ( ) const
pure virtual

Signals all errors and warnings (typically from GStreamer and below)

Implemented in core::ubuntu::media::PlayerSkeleton, and core::ubuntu::media::PlayerStub.

virtual const core::Property<bool>& core::ubuntu::media::Player::is_audio_source ( ) const
pure virtual
virtual const core::Property<bool>& core::ubuntu::media::Player::is_video_source ( ) const
pure virtual
virtual PlayerKey core::ubuntu::media::Player::key ( ) const
pure virtual
virtual const core::Property<Lifetime>& core::ubuntu::media::Player::lifetime ( ) const
pure virtual
virtual core::Property<Lifetime>& core::ubuntu::media::Player::lifetime ( )
pure virtual
virtual const core::Property<LoopStatus>& core::ubuntu::media::Player::loop_status ( ) const
pure virtual
virtual core::Property<LoopStatus>& core::ubuntu::media::Player::loop_status ( )
pure virtual
virtual const core::Property<PlaybackRate>& core::ubuntu::media::Player::maximum_playback_rate ( ) const
pure virtual
virtual const core::Property<Track::MetaData>& core::ubuntu::media::Player::meta_data_for_current_track ( ) const
pure virtual
virtual const core::Property<PlaybackRate>& core::ubuntu::media::Player::minimum_playback_rate ( ) const
pure virtual
virtual void core::ubuntu::media::Player::next ( )
pure virtual
virtual bool core::ubuntu::media::Player::open_uri ( const Track::UriType uri)
pure virtual
virtual bool core::ubuntu::media::Player::open_uri ( const Track::UriType uri,
const HeadersType  
)
pure virtual
Player& core::ubuntu::media::Player::operator= ( const Player )
delete
bool core::ubuntu::media::Player::operator== ( const Player ) const
delete
virtual const core::Property<Orientation>& core::ubuntu::media::Player::orientation ( ) const
pure virtual
virtual void core::ubuntu::media::Player::pause ( )
pure virtual
virtual void core::ubuntu::media::Player::play ( )
pure virtual
virtual const core::Property<PlaybackRate>& core::ubuntu::media::Player::playback_rate ( ) const
pure virtual
virtual core::Property<PlaybackRate>& core::ubuntu::media::Player::playback_rate ( )
pure virtual
virtual const core::Property<PlaybackStatus>& core::ubuntu::media::Player::playback_status ( ) const
pure virtual
virtual core::Signal<PlaybackStatus>& core::ubuntu::media::Player::playback_status_changed ( )
pure virtual
virtual const core::Property<int64_t>& core::ubuntu::media::Player::position ( ) const
pure virtual
virtual void core::ubuntu::media::Player::previous ( )
pure virtual
virtual void core::ubuntu::media::Player::reconnect ( )
pure virtual
virtual void core::ubuntu::media::Player::seek_to ( const std::chrono::microseconds &  offset)
pure virtual
virtual const core::Signal<int64_t>& core::ubuntu::media::Player::seeked_to ( ) const
pure virtual
virtual const core::Property<bool>& core::ubuntu::media::Player::shuffle ( ) const
pure virtual
virtual core::Property<bool>& core::ubuntu::media::Player::shuffle ( )
pure virtual
virtual void core::ubuntu::media::Player::stop ( )
pure virtual
virtual std::shared_ptr<TrackList> core::ubuntu::media::Player::track_list ( )
pure virtual
virtual std::string core::ubuntu::media::Player::uuid ( ) const
pure virtual
virtual const core::Signal<video::Dimensions>& core::ubuntu::media::Player::video_dimension_changed ( ) const
pure virtual
virtual const core::Property<Volume>& core::ubuntu::media::Player::volume ( ) const
pure virtual
virtual core::Property<Volume>& core::ubuntu::media::Player::volume ( )
pure virtual

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