Music Hub  ..
A session-wide music playback service
core::ubuntu::media::TrackListStub Class Reference

#include <track_list_stub.h>

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

Public Member Functions

 TrackListStub (const std::shared_ptr< Player > &parent, const core::dbus::Object::Ptr &object)
 
 ~TrackListStub ()
 
const core::Property< bool > & can_edit_tracks () const
 
const core::Property< Container > & tracks () const
 
Track::MetaData query_meta_data_for_track (const Track::Id &id)
 
Track::UriType query_uri_for_track (const Track::Id &id)
 
void add_track_with_uri_at (const Track::UriType &uri, const Track::Id &position, bool make_current)
 
void add_tracks_with_uri_at (const ContainerURI &uris, const Track::Id &position)
 
bool move_track (const Track::Id &id, const Track::Id &to)
 
void remove_track (const Track::Id &id)
 
void go_to (const Track::Id &track)
 
Track::Id next ()
 
Track::Id previous ()
 
void reset ()
 
const core::Signal< ContainerTrackIdTuple > & on_track_list_replaced () const
 
const core::Signal< Track::Id > & on_track_added () const
 
const core::Signal< ContainerURI > & on_tracks_added () const
 
const core::Signal< TrackIdTuple > & on_track_moved () const
 
const core::Signal< Track::Id > & on_track_removed () const
 
const core::Signal< void > & on_track_list_reset () const
 
const core::Signal< Track::Id > & on_track_changed () const
 
const core::Signal< Track::Id > & on_go_to_track () const
 
const core::Signal< void > & on_end_of_tracklist () const
 
- Public Member Functions inherited from core::ubuntu::media::TrackList
 TrackList (const TrackList &)=delete
 
 ~TrackList ()
 
TrackListoperator= (const TrackList &)=delete
 
bool operator== (const TrackList &) const =delete
 
bool has_next () const
 
bool has_previous () const
 

Additional Inherited Members

- Public Types inherited from core::ubuntu::media::TrackList
typedef std::vector< Track::IdContainer
 
typedef std::vector< Track::UriTypeContainerURI
 
typedef std::tuple< std::vector< Track::Id >, Track::IdContainerTrackIdTuple
 
typedef std::tuple< Track::Id, Track::IdTrackIdTuple
 
typedef Container::iterator Iterator
 
typedef Container::const_iterator ConstIterator
 
- Static Public Member Functions inherited from core::ubuntu::media::TrackList
static const Track::Idafter_empty_track ()
 
- Protected Member Functions inherited from core::ubuntu::media::TrackList
 TrackList ()
 

Detailed Description

Definition at line 36 of file track_list_stub.h.

Constructor & Destructor Documentation

◆ TrackListStub()

core::ubuntu::media::TrackListStub::TrackListStub ( const std::shared_ptr< Player > &  parent,
const core::dbus::Object::Ptr &  object 
)

◆ ~TrackListStub()

core::ubuntu::media::TrackListStub::~TrackListStub ( )

Member Function Documentation

◆ add_track_with_uri_at()

void core::ubuntu::media::TrackListStub::add_track_with_uri_at ( const Track::UriType uri,
const Track::Id position,
bool  make_current 
)
virtual

Adds a URI into the TrackList.

Implements core::ubuntu::media::TrackList.

◆ add_tracks_with_uri_at()

void core::ubuntu::media::TrackListStub::add_tracks_with_uri_at ( const ContainerURI uris,
const Track::Id position 
)
virtual

Adds a list of URIs into the TrackList.

Implements core::ubuntu::media::TrackList.

◆ can_edit_tracks()

const core::Property<bool>& core::ubuntu::media::TrackListStub::can_edit_tracks ( ) const
virtual

If set to false, calling add_track_with_uri_at or remove_track will have no effect.

Implements core::ubuntu::media::TrackList.

◆ go_to()

void core::ubuntu::media::TrackListStub::go_to ( const Track::Id track)
virtual

Skip to the specified TrackId.

Implements core::ubuntu::media::TrackList.

◆ move_track()

bool core::ubuntu::media::TrackListStub::move_track ( const Track::Id id,
const Track::Id to 
)
virtual

Moves track 'id' from its old position in the TrackList to new position.

Implements core::ubuntu::media::TrackList.

◆ next()

Track::Id core::ubuntu::media::TrackListStub::next ( )
virtual

Skip to the next Track in the TrackList if there is one.

Implements core::ubuntu::media::TrackList.

◆ on_end_of_tracklist()

const core::Signal<void>& core::ubuntu::media::TrackListStub::on_end_of_tracklist ( ) const
virtual

Used to notify the Player of when the end of the tracklist has been reached.

Implements core::ubuntu::media::TrackList.

◆ on_go_to_track()

const core::Signal<Track::Id>& core::ubuntu::media::TrackListStub::on_go_to_track ( ) const
virtual

Used to notify the Player of when the client requested that the Player should immediately play a new track.

Implements core::ubuntu::media::TrackList.

◆ on_track_added()

const core::Signal<Track::Id>& core::ubuntu::media::TrackListStub::on_track_added ( ) const
virtual

Indicates that a track has been added to the track list.

Implements core::ubuntu::media::TrackList.

◆ on_track_changed()

const core::Signal<Track::Id>& core::ubuntu::media::TrackListStub::on_track_changed ( ) const
virtual

Indicates that the track list advanced from one track to another.

Implements core::ubuntu::media::TrackList.

◆ on_track_list_replaced()

const core::Signal<ContainerTrackIdTuple>& core::ubuntu::media::TrackListStub::on_track_list_replaced ( ) const
virtual

Indicates that the entire tracklist has been replaced.

Implements core::ubuntu::media::TrackList.

◆ on_track_list_reset()

const core::Signal<void>& core::ubuntu::media::TrackListStub::on_track_list_reset ( ) const
virtual

Indicates that the track list has been reset and there are no tracks now

Implements core::ubuntu::media::TrackList.

◆ on_track_moved()

const core::Signal<TrackIdTuple>& core::ubuntu::media::TrackListStub::on_track_moved ( ) const
virtual

Indicates that a track has been moved within the track list. First template param holds the id of the track being moved. Second param holds the id of the track of the position to move the track to in the TrackList.

Implements core::ubuntu::media::TrackList.

◆ on_track_removed()

const core::Signal<Track::Id>& core::ubuntu::media::TrackListStub::on_track_removed ( ) const
virtual

Indicates that a track has been removed from the track list.

Implements core::ubuntu::media::TrackList.

◆ on_tracks_added()

const core::Signal<ContainerURI>& core::ubuntu::media::TrackListStub::on_tracks_added ( ) const
virtual

Indicates that one or more tracks have been added to the track list.

Implements core::ubuntu::media::TrackList.

◆ previous()

Track::Id core::ubuntu::media::TrackListStub::previous ( )
virtual

Skip to the previous Track in the TrackList if there is one.

Implements core::ubuntu::media::TrackList.

◆ query_meta_data_for_track()

Track::MetaData core::ubuntu::media::TrackListStub::query_meta_data_for_track ( const Track::Id id)
virtual

Gets all the metadata available for a given Track.

Implements core::ubuntu::media::TrackList.

◆ query_uri_for_track()

Track::UriType core::ubuntu::media::TrackListStub::query_uri_for_track ( const Track::Id id)
virtual

Gets the URI for a given Track.

Implements core::ubuntu::media::TrackList.

◆ remove_track()

void core::ubuntu::media::TrackListStub::remove_track ( const Track::Id id)
virtual

Removes a Track from the TrackList.

Implements core::ubuntu::media::TrackList.

◆ reset()

void core::ubuntu::media::TrackListStub::reset ( )
virtual

Clears and resets the TrackList to the same as a newly constructed instance.

Implements core::ubuntu::media::TrackList.

◆ tracks()

const core::Property<Container>& core::ubuntu::media::TrackListStub::tracks ( ) const
virtual

An array which contains the identifier of each track in the tracklist, in order.

Implements core::ubuntu::media::TrackList.


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