Music Hub  ..
A session-wide music playback service
Classes | Public Member Functions | Protected Member Functions | List of all members
core::ubuntu::media::Service Class Referenceabstract

#include <service.h>

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

Classes

struct  Client
 

Public Member Functions

 Service (const Service &)=delete
 
virtual ~Service ()=default
 
Service & operator= (const Service &)=delete
 
bool operator== (const Service &) const =delete
 
virtual std::shared_ptr< Player > create_session (const Player::Configuration &)=0
 Creates a session with the media-hub service. More...
 
virtual void detach_session (const std::string &uuid, const Player::Configuration &)=0
 Detaches a UUID-identified session for later resuming. More...
 
virtual std::shared_ptr< Player > reattach_session (const std::string &uuid, const Player::Configuration &)=0
 Reattaches to a UUID-identified session that is in detached state. More...
 
virtual void destroy_session (const std::string &uuid, const Player::Configuration &)=0
 Asks the service to destroy a session. The session is destroyed when the client exits. More...
 
virtual std::shared_ptr< Player > create_fixed_session (const std::string &name, const Player::Configuration &)=0
 Creates a fixed-named session with the media-hub service. More...
 
virtual std::shared_ptr< Player > resume_session (Player::PlayerKey)=0
 Resumes a fixed-name session directly by player key. More...
 
virtual void set_current_player (Player::PlayerKey)=0
 Sets the current player that the MPRIS interface will control. More...
 
virtual void pause_other_sessions (Player::PlayerKey)=0
 Pauses sessions other than the supplied one. More...
 

Protected Member Functions

 Service ()=default
 

Detailed Description

Definition at line 31 of file service.h.

Constructor & Destructor Documentation

core::ubuntu::media::Service::Service ( const Service &  )
delete
virtual core::ubuntu::media::Service::~Service ( )
virtualdefault
core::ubuntu::media::Service::Service ( )
protecteddefault

Member Function Documentation

virtual std::shared_ptr<Player> core::ubuntu::media::Service::create_fixed_session ( const std::string &  name,
const Player::Configuration &   
)
pure virtual

Creates a fixed-named session with the media-hub service.

Implemented in core::ubuntu::media::ServiceImplementation.

virtual std::shared_ptr<Player> core::ubuntu::media::Service::create_session ( const Player::Configuration &  )
pure virtual

Creates a session with the media-hub service.

Implemented in core::ubuntu::media::ServiceImplementation.

virtual void core::ubuntu::media::Service::destroy_session ( const std::string &  uuid,
const Player::Configuration &   
)
pure virtual

Asks the service to destroy a session. The session is destroyed when the client exits.

Implemented in core::ubuntu::media::ServiceImplementation.

virtual void core::ubuntu::media::Service::detach_session ( const std::string &  uuid,
const Player::Configuration &   
)
pure virtual

Detaches a UUID-identified session for later resuming.

Implemented in core::ubuntu::media::ServiceImplementation.

Service& core::ubuntu::media::Service::operator= ( const Service &  )
delete
bool core::ubuntu::media::Service::operator== ( const Service &  ) const
delete
virtual void core::ubuntu::media::Service::pause_other_sessions ( Player::PlayerKey  )
pure virtual

Pauses sessions other than the supplied one.

Implemented in core::ubuntu::media::ServiceImplementation.

virtual std::shared_ptr<Player> core::ubuntu::media::Service::reattach_session ( const std::string &  uuid,
const Player::Configuration &   
)
pure virtual

Reattaches to a UUID-identified session that is in detached state.

Implemented in core::ubuntu::media::ServiceImplementation.

virtual std::shared_ptr<Player> core::ubuntu::media::Service::resume_session ( Player::PlayerKey  )
pure virtual

Resumes a fixed-name session directly by player key.

Implemented in core::ubuntu::media::ServiceImplementation.

virtual void core::ubuntu::media::Service::set_current_player ( Player::PlayerKey  )
pure virtual

Sets the current player that the MPRIS interface will control.

Implemented in core::ubuntu::media::ServiceImplementation.

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