libosmscout  0.1
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules
osmscout::VoicePlayer Class Referenceabstract

#include <VoicePlayer.h>

+ Inheritance diagram for osmscout::VoicePlayer:

Public Types

enum  PlaybackState { StoppedState = 0, PlayingState }
 

Signals

void playbackStateChanged (VoicePlayer::PlaybackState state)
 

Public Member Functions

virtual void addToQueue (const QUrl &source)=0
 add a track to the playlist More...
 
virtual void clearQueue ()=0
 clear the playlist More...
 
virtual int index () const =0
 returns the current index More...
 
virtual void play ()=0
 start playing from current index More...
 
virtual int queueCount () const =0
 returns the track count in the playlist More...
 
virtual void setCurrentIndex (int index)=0
 set the track index to play More...
 
virtual void stop ()=0
 stop playing More...
 
 VoicePlayer (QObject *parent)
 

Detailed Description

Defines the abstract interface for the voice player

Member Enumeration Documentation

◆ PlaybackState

Enumerator
StoppedState 
PlayingState 

Constructor & Destructor Documentation

◆ VoicePlayer()

osmscout::VoicePlayer::VoicePlayer ( QObject *  parent)
explicit

Member Function Documentation

◆ addToQueue()

virtual void osmscout::VoicePlayer::addToQueue ( const QUrl &  source)
pure virtual

add a track to the playlist

Parameters
sourceurl of the audio track

Implemented in osmscout::VoiceCorePlayer.

Referenced by osmscout::VoiceCorePlayer::addToQueue().

◆ clearQueue()

virtual void osmscout::VoicePlayer::clearQueue ( )
pure virtual

clear the playlist

Implemented in osmscout::VoiceCorePlayer.

Referenced by osmscout::VoiceCorePlayer::clearQueue().

◆ index()

virtual int osmscout::VoicePlayer::index ( ) const
pure virtual

returns the current index

Returns
position in playlist

Implemented in osmscout::VoiceCorePlayer.

Referenced by osmscout::VoiceCorePlayer::index().

◆ play()

virtual void osmscout::VoicePlayer::play ( )
pure virtual

start playing from current index

Implemented in osmscout::VoiceCorePlayer.

Referenced by osmscout::VoiceCorePlayer::play().

◆ playbackStateChanged

void osmscout::VoicePlayer::playbackStateChanged ( VoicePlayer::PlaybackState  state)
signal

◆ queueCount()

virtual int osmscout::VoicePlayer::queueCount ( ) const
pure virtual

returns the track count in the playlist

Returns
count

Implemented in osmscout::VoiceCorePlayer.

Referenced by osmscout::VoiceCorePlayer::queueCount().

◆ setCurrentIndex()

virtual void osmscout::VoicePlayer::setCurrentIndex ( int  index)
pure virtual

set the track index to play

Parameters
indexposition in playlist

Implemented in osmscout::VoiceCorePlayer.

Referenced by osmscout::VoiceCorePlayer::setCurrentIndex().

◆ stop()

virtual void osmscout::VoicePlayer::stop ( )
pure virtual

stop playing

Implemented in osmscout::VoiceCorePlayer.

Referenced by osmscout::VoiceCorePlayer::stop().


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