osmscout::VoicePlayer Class Reference

Defines the abstract interface for the voice player. More...

#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
virtual void	clearQueue ()=0
	clear the playlist
virtual int	index () const =0
	returns the current index
virtual void	play ()=0
	start playing from current index
virtual int	queueCount () const =0
	returns the track count in the playlist
virtual void	setCurrentIndex (int index)=0
	set the track index to play
virtual void	stop ()=0
	stop playing
	VoicePlayer (QObject *parent)

Detailed Description

Defines the abstract interface for the voice player.

Member Enumeration Documentation

PlaybackState

enum osmscout::VoicePlayer::PlaybackState

Enumerator
StoppedState
PlayingState

Constructor & Destructor Documentation

VoicePlayer()

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

explicit

Referenced by osmscout::VoiceCorePlayer::VoiceCorePlayer(), and osmscout::VoiceCorePlayer::~VoiceCorePlayer().

Member Function Documentation

addToQueue()

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

pure virtual

add a track to the playlist

Parameters

source

url of the audio track

Implemented in osmscout::VoiceCorePlayer.

clearQueue()

virtual void osmscout::VoicePlayer::clearQueue ( )

pure virtual

clear the playlist

Implemented in osmscout::VoiceCorePlayer.

index()

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

pure virtual

returns the current index

Returns

position in playlist

Implemented in osmscout::VoiceCorePlayer.

Referenced by setCurrentIndex().

play()

virtual void osmscout::VoicePlayer::play ( )

pure virtual

start playing from current index

Implemented in osmscout::VoiceCorePlayer.

playbackStateChanged

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

signal

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

queueCount()

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

pure virtual

returns the track count in the playlist

Returns

count

Implemented in osmscout::VoiceCorePlayer.

setCurrentIndex()

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

pure virtual

set the track index to play

Parameters

index

position in playlist

Implemented in osmscout::VoiceCorePlayer.

References index().

stop()

virtual void osmscout::VoicePlayer::stop ( )

pure virtual

stop playing

Implemented in osmscout::VoiceCorePlayer.

---

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

• VoicePlayer.h
• VoicePlayer.cpp