• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdeedu API Reference
  • KDE Home
  • Contact Us
 

marble

  • Marble
  • AudioOutput
Public Member Functions | List of all members
Marble::AudioOutput Class Reference

#include <AudioOutput.h>

Inheritance diagram for Marble::AudioOutput:
Inheritance graph
[legend]

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)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

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 92 of file AudioOutput.cpp.

Marble::AudioOutput::~AudioOutput ( )

Destructor.

Definition at line 98 of file AudioOutput.cpp.

Member Function Documentation

bool Marble::AudioOutput::isMuted ( ) const

Definition at line 113 of file AudioOutput.cpp.

bool Marble::AudioOutput::isSoundEnabled ( ) const

Definition at line 133 of file AudioOutput.cpp.

void Marble::AudioOutput::setMuted ( bool  muted)

Toggle muting (neither sound nor voice output)

Definition at line 108 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 128 of file AudioOutput.cpp.

void Marble::AudioOutput::setSpeaker ( const QString &  speaker)

Change the speaker to use.

Parameters
speakerA 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 118 of file AudioOutput.cpp.

QString Marble::AudioOutput::speaker ( ) const

Definition at line 123 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
indexThe index of the next turn point
distanceThe distance in meters to the next turn point
turnTypeThe turn type to execute at the next turn point

Definition at line 103 of file AudioOutput.cpp.


The documentation for this class was generated from the following files:
  • AudioOutput.h
  • AudioOutput.cpp
  • NullAudioOutput.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:13:44 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

marble

Skip menu "marble"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdeedu API Reference

Skip menu "kdeedu API Reference"
  • Analitza
  •     lib
  • kalgebra
  • kalzium
  •   libscience
  • kanagram
  • kig
  •   lib
  • klettres
  • marble
  • parley
  • rocs
  •   App
  •   RocsCore
  •   VisualEditor
  •   stepcore

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal