Marble::AudioOutput Class Reference

#include <AudioOutput.h>

Inheritance diagram for Marble::AudioOutput:

Public Member Functions
	AudioOutput (QObject *parent=0)
	~AudioOutput ()
bool	isMuted () const
bool	isSoundEnabled () const
void	setMuted (bool muted)
void	setSoundEnabled (bool enabled)
void	setSpeaker (const QString &speaker)
QString	speaker () const
void	update (const Route &route, qreal distanceManeuver, qreal distanceTarget, bool deviated)

Detailed Description

Audio (mainly voice) output of driving instructions.

Definition at line 24 of file AudioOutput.h.

Constructor & Destructor Documentation

Marble::AudioOutput::AudioOutput ( QObject *  parent = 0 )

explicit

Constructor.

Definition at line 91 of file AudioOutput.cpp.

Marble::AudioOutput::~AudioOutput

(

)

Destructor.

Definition at line 97 of file AudioOutput.cpp.

Member Function Documentation

bool Marble::AudioOutput::isMuted

(

)

const

Definition at line 112 of file AudioOutput.cpp.

bool Marble::AudioOutput::isSoundEnabled

(

)

const

Definition at line 132 of file AudioOutput.cpp.

void Marble::AudioOutput::setMuted

(

bool

muted

)

Toggle muting (neither sound nor voice output)

Definition at line 107 of file AudioOutput.cpp.

void Marble::AudioOutput::setSoundEnabled

(

bool

enabled

)

Toggle whether sound output is used instead of a speaker.

Overridden by setMuted(true).

See also

setMuted

Definition at line 127 of file AudioOutput.cpp.

void Marble::AudioOutput::setSpeaker

(

const QString &

speaker

)

Change the speaker to use.

Parameters

speaker

A directory name in audio/speakers in Marble's data path. This directory is expected to contain ogg files containing the instructions: TurnLeft.ogg, RbExit3.ogg etc. Disabled by setSoundEnabled(true) and overridden by setMuted(true).

See also

setSoundEnabled

setMuted

Definition at line 117 of file AudioOutput.cpp.

QString Marble::AudioOutput::speaker

(

)

const

Definition at line 122 of file AudioOutput.cpp.

void Marble::AudioOutput::update	(	const Route &	route,
		qreal	distanceManeuver,
		qreal	distanceTarget,
		bool	deviated
	)

Generate an audible notification (if needed) after the position on the route has changed.

No notification will be generated if the turn point with the given index is too far away, has been announced previously, if the output is

See also

setMuted or the needed sounds cannot be found in the Marble data path.

Parameters

index	The index of the next turn point
distance	The distance in meters to the next turn point
turnType	The turn type to execute at the next turn point

Definition at line 102 of file AudioOutput.cpp.

---

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

• AudioOutput.h
• AudioOutput.cpp
• NullAudioOutput.cpp