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)
 
void add_track_with_uri_at (const Track::UriType &uri, const Track::Id &position, bool make_current)
 
void remove_track (const Track::Id &id)
 
void go_to (const Track::Id &track, bool toggle_player_state)
 
void shuffle_tracks ()
 
void unshuffle_tracks ()
 
void reset ()
 
const core::Signal< ContainerTrackIdTuple > & on_track_list_replaced () const
 
const core::Signal< Track::Id > & on_track_added () const
 
const core::Signal< Track::Id > & on_track_removed () const
 
const core::Signal< Track::Id > & on_track_changed () const
 
const core::Signal< std::pair< Track::Id, bool > > & on_go_to_track () 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
 

Additional Inherited Members

- Public Types inherited from core::ubuntu::media::TrackList
typedef std::vector< Track::IdContainer
 
typedef std::tuple< std::vector< Track::Id >, Track::IdContainerTrackIdTuple
 
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

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

Member Function Documentation

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 in the TrackList.

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

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.

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

Skip to the specified TrackId. Calls stop() and play() on the player if toggle_player_state is true.

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

const core::Signal<std::pair<Track::Id, bool> >& 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.

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.

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.

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.

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.

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.

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

Removes a Track from the TrackList.

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

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.

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

Reorders the tracks such that they are in a random order.

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

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.

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

Restores the original order of tracks before shuffle mode was turned on.

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


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