<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- phonon-namespace.qdoc -->
<title>Qt 4.8: Phonon Namespace</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="namespaces.html">Namespaces</a></li>
<li>Phonon Namespace</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#namespaces">Namespaces</a></li>
<li class="level1"><a href="#classes">Classes</a></li>
<li class="level1"><a href="#types">Types</a></li>
<li class="level1"><a href="#functions">Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">Phonon Namespace</h1>
<!-- $$$Phonon-brief -->
<p>The Phonon namespace contains classes and functions for multimedia applications. <a href="#details">More...</a></p>
<!-- @@@Phonon -->
<pre class="cpp"> <span class="preprocessor">#include <Phonon></span></pre><p>This namespace was introduced in Qt 4.4.</p>
<ul>
</ul>
<a name="namespaces"></a>
<h2>Namespaces</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> namespace </td><td class="memItemRight bottomAlign"><b><a href="phonon-backendcapabilities.html">BackendCapabilities</a></b></td></tr>
</table>
<a name="classes"></a>
<h2>Classes</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-audiodataoutput.html">AudioDataOutput</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-audiooutput.html">AudioOutput</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-effect.html">Effect</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-effectparameter.html">EffectParameter</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-effectwidget.html">EffectWidget</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-mediacontroller.html">MediaController</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-medianode.html">MediaNode</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-mediaobject.html">MediaObject</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-mediasource.html">MediaSource</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-objectdescription.html">ObjectDescription</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-path.html">Path</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-seekslider.html">SeekSlider</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-videoplayer.html">VideoPlayer</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-videowidget.html">VideoWidget</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-videowidgetinterface44.html">VideoWidgetInterface44</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="phonon-volumeslider.html">VolumeSlider</a></b></td></tr>
</table>
<a name="types"></a>
<h2>Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="phonon-objectdescription.html#AudioOutputDevice-typedef">AudioOutputDevice</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="phonon.html#AudioOutputDeviceModel-typedef">AudioOutputDeviceModel</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="phonon.html#Category-enum">Category</a></b> { NoCategory, NotificationCategory, MusicCategory, VideoCategory, CommunicationCategory, GameCategory }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="phonon.html#DiscType-enum">DiscType</a></b> { NoDisc, Cd, Dvd, Vcd }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="phonon-objectdescription.html#EffectDescription-typedef">EffectDescription</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="phonon.html#EffectDescriptionModel-typedef">EffectDescriptionModel</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="phonon.html#ErrorType-enum">ErrorType</a></b> { NoError, NormalError, FatalError }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="phonon.html#MetaData-enum">MetaData</a></b> { ArtistMetaData, AlbumMetaData, TitleMetaData, DateMetaData, ..., MusicBrainzDiscIdMetaData }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="phonon-objectdescription.html#ObjectDescriptionType-enum">ObjectDescriptionType</a></b> { AudioOutputDeviceType, EffectType }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="phonon.html#State-enum">State</a></b> { LoadingState, StoppedState, PlayingState, BufferingState, PausedState, ErrorState }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="phonon.html#VideoWidgetInterfaceLatest-typedef">VideoWidgetInterfaceLatest</a></b></td></tr>
</table>
<a name="functions"></a>
<h2>Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="phonon.html#categoryToString">categoryToString</a></b> ( Category <i>c</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Path </td><td class="memItemRight bottomAlign"><b><a href="phonon-path.html#createPath">createPath</a></b> ( MediaNode * <i>source</i>, MediaNode * <i>sink</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> MediaObject * </td><td class="memItemRight bottomAlign"><b><a href="phonon.html#createPlayer">createPlayer</a></b> ( Phonon::Category <i>category</i>, const MediaSource & <i>source</i> = MediaSource() )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const char * </td><td class="memItemRight bottomAlign"><b><a href="phonon.html#phononVersion">phononVersion</a></b> ()</td></tr>
</table>
<a name="details"></a>
<!-- $$$Phonon-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The Phonon namespace contains classes and functions for multimedia applications.</p>
<p>This namespace contains classes to access multimedia functions for audio and video playback. Those classes are not dependent on any specific framework, but rather use exchangeable backends to do the work.</p>
<p>See the <a href="phonon-module.html">Phonon Module</a> page for general information about the framework and the <a href="phonon-overview.html#phonon-overview">Phonon Overview</a> for an introductory tour of its features.</p>
</div>
<!-- @@@Phonon -->
<div class="nmspace">
<h2>Namespaces</h2>
<!-- $$$BackendCapabilities -->
<h3 class="fn"><a name=""></a>namespace Phonon::<span class="name">BackendCapabilities</span></h3>
<p>The BackendCapabilities namespace contains functions to describe the capabilities of the multimedia backend.</p>
<p>This namespace was introduced in Qt 4.4.</p>
<!-- @@@BackendCapabilities -->
</div>
<div class="classes">
<h2>Classes</h2>
<h3> class <a href="phonon-audiodataoutput.html">AudioDataOutput</a></h3><!-- $$$AudioDataOutput-brief -->
<p>The AudioDataOutput class provides access to audio data. <a href="phonon-audiodataoutput.html#details">More...</a></p>
<!-- @@@AudioDataOutput -->
<h3> class <a href="phonon-audiooutput.html">AudioOutput</a></h3><!-- $$$AudioOutput-brief -->
<p>The AudioOutput class is used to send data to audio output devices. <a href="phonon-audiooutput.html#details">More...</a></p>
<!-- @@@AudioOutput -->
<h3> class <a href="phonon-effect.html">Effect</a></h3><!-- $$$Effect-brief -->
<p>The Effect class is used to transform audio streams. <a href="phonon-effect.html#details">More...</a></p>
<!-- @@@Effect -->
<h3> class <a href="phonon-effectparameter.html">EffectParameter</a></h3><!-- $$$EffectParameter-brief -->
<p>The EffectParameter class describes one parameter of an effect. <a href="phonon-effectparameter.html#details">More...</a></p>
<!-- @@@EffectParameter -->
<h3> class <a href="phonon-effectwidget.html">EffectWidget</a></h3><!-- $$$EffectWidget-brief -->
<p>The EffectWidget class provides a widget to control the parameters of an Effect. <a href="phonon-effectwidget.html#details">More...</a></p>
<!-- @@@EffectWidget -->
<h3> class <a href="phonon-mediacontroller.html">MediaController</a></h3><!-- $$$MediaController-brief -->
<p>The MediaController class controls optional features of a media file/device. <a href="phonon-mediacontroller.html#details">More...</a></p>
<!-- @@@MediaController -->
<h3> class <a href="phonon-medianode.html">MediaNode</a></h3><!-- $$$MediaNode-brief -->
<p>The MediaNode class is the base class for all nodes in a media graph. <a href="phonon-medianode.html#details">More...</a></p>
<!-- @@@MediaNode -->
<h3> class <a href="phonon-mediaobject.html">MediaObject</a></h3><!-- $$$MediaObject-brief -->
<p>The MediaObject class provides an interface for media playback. <a href="phonon-mediaobject.html#details">More...</a></p>
<!-- @@@MediaObject -->
<h3> class <a href="phonon-mediasource.html">MediaSource</a></h3><!-- $$$MediaSource-brief -->
<p>The MediaSource class provides multimedia data for media objects. <a href="phonon-mediasource.html#details">More...</a></p>
<!-- @@@MediaSource -->
<h3> class <a href="phonon-objectdescription.html">ObjectDescription</a></h3><!-- $$$ObjectDescription-brief -->
<p>The ObjectDescription class provides information about Phonon objects. <a href="phonon-objectdescription.html#details">More...</a></p>
<!-- @@@ObjectDescription -->
<h3> class <a href="phonon-path.html">Path</a></h3><!-- $$$Path-brief -->
<p>The Path class describes connections between media nodes. <a href="phonon-path.html#details">More...</a></p>
<!-- @@@Path -->
<h3> class <a href="phonon-seekslider.html">SeekSlider</a></h3><!-- $$$SeekSlider-brief -->
<p>The SeekSlider class provides a slider for seeking to positions in media streams. <a href="phonon-seekslider.html#details">More...</a></p>
<!-- @@@SeekSlider -->
<h3> class <a href="phonon-videoplayer.html">VideoPlayer</a></h3><!-- $$$VideoPlayer-brief -->
<p>The VideoPlayer widget is used to perform playback of video. <a href="phonon-videoplayer.html#details">More...</a></p>
<!-- @@@VideoPlayer -->
<h3> class <a href="phonon-videowidget.html">VideoWidget</a></h3><!-- $$$VideoWidget-brief -->
<p>The VideoWidget class provides a widget that is used to display video. <a href="phonon-videowidget.html#details">More...</a></p>
<!-- @@@VideoWidget -->
<h3> class <a href="phonon-videowidgetinterface44.html">VideoWidgetInterface44</a></h3><h3> class <a href="phonon-volumeslider.html">VolumeSlider</a></h3><!-- $$$VolumeSlider-brief -->
<p>The VolumeSlider widget provides a slider that is used to control the volume of an audio output device. <a href="phonon-volumeslider.html#details">More...</a></p>
<!-- @@@VolumeSlider -->
</div>
<div class="types">
<h2>Type Documentation</h2>
<!-- $$$AudioOutputDevice -->
<h3 class="fn"><a name="AudioOutputDevice-typedef"></a>typedef Phonon::<span class="name">AudioOutputDevice</span></h3>
<p>This typedef of <a href="phonon-objectdescription.html">ObjectDescription</a> describes an audio output device, such as soundcards (with different drivers), sound servers, or other virtual outputs like playback on a different computer on the network.</p>
<p>A list of available devices is given by the backend with Backendcapabilities::availableAudioOutputDevices()</p>
<pre class="cpp"> <span class="type"><a href="qlist.html">QList</a></span><span class="operator"><</span>Phonon<span class="operator">::</span>AudioOutputDevice<span class="operator">></span> audioOutputDevices <span class="operator">=</span>
Phonon<span class="operator">::</span>BackendCapabilities<span class="operator">::</span>availableAudioOutputDevices();</pre>
<!-- @@@AudioOutputDevice -->
<!-- $$$AudioOutputDeviceModel -->
<h3 class="fn"><a name="AudioOutputDeviceModel-typedef"></a>typedef Phonon::<span class="name">AudioOutputDeviceModel</span></h3>
<p>provides an item view model containing available audio output devices.</p>
<!-- @@@AudioOutputDeviceModel -->
<!-- $$$Category$$$NoCategory$$$NotificationCategory$$$MusicCategory$$$VideoCategory$$$CommunicationCategory$$$GameCategory$$$AccessibilityCategory$$$LastCategory -->
<h3 class="fn"><a name="Category-enum"></a>enum Phonon::<span class="name">Category</span></h3>
<p>Sets the category your program should be listed in in the mixer.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>Phonon::NoCategory</tt></td><td class="topAlign"><tt>-1</tt></td><td class="topAlign">Will make use of the default device.</td></tr>
<tr><td class="topAlign"><tt>Phonon::NotificationCategory</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">If the sounds produced are notifications (ping, beep and such) you should use this category.</td></tr>
<tr><td class="topAlign"><tt>Phonon::MusicCategory</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">If your application is a music player (like a jukebox or media player playing an audio file).</td></tr>
<tr><td class="topAlign"><tt>Phonon::VideoCategory</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">If the sound is the audio channel of a video.</td></tr>
<tr><td class="topAlign"><tt>Phonon::CommunicationCategory</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">If your applications produces sounds from communication with somebody else (VoIP, voice chat).</td></tr>
<tr><td class="topAlign"><tt>Phonon::GameCategory</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">Sound produced by a computer game should go into this category.</td></tr>
<tr><td class="topAlign"><tt>Phonon::AccessibilityCategory</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">Sounds produced for accessibility (e.g., Text-To-Speech) Holds the largest value of categories.</td></tr>
</table>
<p>A Jukebox will set this to Music, a VoIP program to Communication, a DVD player to video, and so on.</p>
<p><b>Note:</b> These categories can also become useful for an application that controls the volumes automatically, like turning down the music when a call comes in, or turning down the notifications when the media player knows it's playing classical music.</p>
<!-- @@@Category -->
<!-- $$$DiscType$$$NoDisc$$$Cd$$$Dvd$$$Vcd -->
<h3 class="fn"><a name="DiscType-enum"></a>enum Phonon::<span class="name">DiscType</span></h3>
<p>Enum to identify the media discs supported by <a href="phonon-mediaobject.html">MediaObject</a>.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>Phonon::NoDisc</tt></td><td class="topAlign"><tt>-1</tt></td><td class="topAlign">No disc was selected. This is only useful as a return value from MediaSource::diskType().</td></tr>
<tr><td class="topAlign"><tt>Phonon::Cd</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">Identifies Audio CDs.</td></tr>
<tr><td class="topAlign"><tt>Phonon::Dvd</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">Identifies DVDs (not arbitrary data DVDs, only movie DVDs).</td></tr>
<tr><td class="topAlign"><tt>Phonon::Vcd</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">Identifies Video CDs.</td></tr>
</table>
<p><b>See also </b><a href="phonon-mediasource.html">MediaSource</a> and <a href="phonon-mediaobject.html">MediaObject</a>.</p>
<!-- @@@DiscType -->
<!-- $$$EffectDescription -->
<h3 class="fn"><a name="EffectDescription-typedef"></a>typedef Phonon::<span class="name">EffectDescription</span></h3>
<p>EffectDescription gives a description of an <a href="phonon-overview.html#processors">audio effect</a>. It is a typedef of the <a href="phonon-objectdescription.html">ObjectDescription</a> class. Please see its class description for details.</p>
<p>EffectDescription is used to create audio <a href="phonon-effect.html">Effect</a>s, which can be inserted into a media graph, altering an audio stream.</p>
<p><b>See also </b><a href="phonon-objectdescription.html">Phonon::ObjectDescription</a>, <a href="phonon-capabilities.html">Capabilities Example</a>, and <a href="demos-qmediaplayer.html">Media Player</a>.</p>
<!-- @@@EffectDescription -->
<!-- $$$EffectDescriptionModel -->
<h3 class="fn"><a name="EffectDescriptionModel-typedef"></a>typedef Phonon::<span class="name">EffectDescriptionModel</span></h3>
<p>provides a item view model containing available audio effects.</p>
<!-- @@@EffectDescriptionModel -->
<!-- $$$ErrorType$$$NoError$$$NormalError$$$FatalError -->
<h3 class="fn"><a name="ErrorType-enum"></a>enum Phonon::<span class="name">ErrorType</span></h3>
<p>This enum describes the severity when an error has occurred during playback.</p>
<p>After a media object has entered the <a href="phonon.html#State-enum">ErrorState</a>, one can query the type of error from <a href="phonon-mediaobject.html#errorType">MediaObject::errorType()</a>. Note that you should query the error when receiving the <a href="phonon-mediaobject.html#stateChanged">MediaObject::stateChanged()</a> signal, because the error type will be lost if the media object leaves the error state.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>Phonon::NoError</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">No error. <a href="phonon-mediaobject.html#errorType">MediaObject::errorType</a>() returns this if <a href="phonon-mediaobject.html#state">MediaObject::state</a>() != <a href="phonon.html#State-enum">Phonon::ErrorState</a>.</td></tr>
<tr><td class="topAlign"><tt>Phonon::NormalError</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">An error has occurred with the playback of the current source. It might be possible to continue playback, for instance, if only the audio stream in a video cannot be played back. The media object will then leave the error state again.</td></tr>
<tr><td class="topAlign"><tt>Phonon::FatalError</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">. Something important does not work. Your program cannot continue the playback of the current source, but it might be possible to try another.</td></tr>
</table>
<p><b>See also </b><a href="phonon-mediaobject.html#errorType">MediaObject::errorType</a>().</p>
<!-- @@@ErrorType -->
<!-- $$$MetaData$$$ArtistMetaData$$$AlbumMetaData$$$TitleMetaData$$$DateMetaData$$$GenreMetaData$$$TracknumberMetaData$$$DescriptionMetaData$$$MusicBrainzDiscIdMetaData -->
<h3 class="fn"><a name="MetaData-enum"></a>enum Phonon::<span class="name">MetaData</span></h3>
<p>Provided as keys for <a href="phonon-mediaobject.html#metaData">Phonon::MediaObject::metaData</a>(). The enum values matches strings defined in the Ogg Vorbis specification</p>
<table class="valuelist"><tr><th class="tblConst">Constant</th><th class="tblVal">Value</th></tr>
<tr><td class="topAlign"><tt>Phonon::ArtistMetaData</tt></td><td class="topAlign"><tt>0</tt></td></tr>
<tr><td class="topAlign"><tt>Phonon::AlbumMetaData</tt></td><td class="topAlign"><tt>1</tt></td></tr>
<tr><td class="topAlign"><tt>Phonon::TitleMetaData</tt></td><td class="topAlign"><tt>2</tt></td></tr>
<tr><td class="topAlign"><tt>Phonon::DateMetaData</tt></td><td class="topAlign"><tt>3</tt></td></tr>
<tr><td class="topAlign"><tt>Phonon::GenreMetaData</tt></td><td class="topAlign"><tt>4</tt></td></tr>
<tr><td class="topAlign"><tt>Phonon::TracknumberMetaData</tt></td><td class="topAlign"><tt>5</tt></td></tr>
<tr><td class="topAlign"><tt>Phonon::DescriptionMetaData</tt></td><td class="topAlign"><tt>6</tt></td></tr>
<tr><td class="topAlign"><tt>Phonon::MusicBrainzDiscIdMetaData</tt></td><td class="topAlign"><tt>7</tt></td></tr>
</table>
<!-- @@@MetaData -->
<!-- $$$ObjectDescriptionType$$$AudioOutputDeviceType$$$EffectType$$$AudioChannelType$$$SubtitleType$$$AudioCaptureDeviceType -->
<h3 class="fn"><a name="ObjectDescriptionType-enum"></a>enum Phonon::<span class="name">ObjectDescriptionType</span></h3>
<p>This enum defines the type of information that is contained in a <a href="phonon-objectdescription.html">ObjectDescription</a> object.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>Phonon::AudioOutputDeviceType</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">An audio output device (<a href="phonon-objectdescription.html#AudioOutputDevice-typedef">AudioOutputDevice</a>). This can be soundcards (with different drivers), sound servers, or other virtual outputs like playback on a different computer on the network.</td></tr>
<tr><td class="topAlign"><tt>Phonon::EffectType</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">An audio effect (<a href="phonon-objectdescription.html#EffectDescription-typedef">EffectDescription</a>).</td></tr>
</table>
<!-- @@@ObjectDescriptionType -->
<!-- $$$State$$$LoadingState$$$StoppedState$$$PlayingState$$$BufferingState$$$PausedState$$$ErrorState -->
<h3 class="fn"><a name="State-enum"></a>enum Phonon::<span class="name">State</span></h3>
<p>The state enum describes the different states a media object can take. Several functions of <a href="phonon-mediaobject.html">MediaObject</a> are asynchronous, so even if a you have requested a state change through a function call, e.g., through <a href="phonon-mediaobject.html#play">play()</a>, you cannot be sure that the change has taken place before you receive the <a href="phonon-mediaobject.html#stateChanged">stateChanged()</a> signal.</p>
<p>A media object can at any time change into any state, regardless of the state it previously had.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>Phonon::LoadingState</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">After construction it might take a while before the media object is ready to <a href="phonon-mediaobject.html#play">play()</a>. This state is commonly used by backends to initialize the <a href="phonon-overview.html#phonon-overview">media graph</a> and loading the source. When the object leaves the loading state, it will enter the StoppedState unless an error occurred or another state is requested through a function call, e.g., <a href="phonon-mediaobject.html#play">MediaObject::play()</a>.</td></tr>
<tr><td class="topAlign"><tt>Phonon::StoppedState</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">In the stopped state, the media object is ready to play its current media source. The current <a href="phonon-mediaobject.html#seek">position</a> in the media stream is then 0.</td></tr>
<tr><td class="topAlign"><tt>Phonon::PlayingState</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The media object is playing back its media source.</td></tr>
<tr><td class="topAlign"><tt>Phonon::BufferingState</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">The Player is waiting for data to be able to start or continue playing. This state is commonly used to wait for media data over a network connection.</td></tr>
<tr><td class="topAlign"><tt>Phonon::PausedState</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">The media player has currently paused its playback, i.e., it stops playing but keeps the current playback position in the stream.</td></tr>
<tr><td class="topAlign"><tt>Phonon::ErrorState</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">When a media object enters the error state a problem with the playback has occurred. The possible errors are grouped into two categories by <a href="phonon.html#ErrorType-enum">Phonon::ErrorType</a>, and the type can be queried through <a href="phonon-mediaobject.html#errorType">errorType()</a>. A <a href="phonon.html#ErrorType-enum">FatalError</a> implies that the playback cannot continue, but one can still try with a new media source. With a <a href="phonon.html#ErrorType-enum">NormalError</a> it might be possible to continue playback, and a media object may therefore change state from the ErrorState.</td></tr>
</table>
<p>This enum was introduced or modified in Qt 4.4.</p>
<p><b>See also </b><a href="phonon-mediaobject.html">MediaObject</a>.</p>
<!-- @@@State -->
<!-- $$$VideoWidgetInterfaceLatest -->
<h3 class="fn"><a name="VideoWidgetInterfaceLatest-typedef"></a>typedef Phonon::<span class="name">VideoWidgetInterfaceLatest</span></h3>
<p>This typedef was introduced in Qt 4.7.</p>
<!-- @@@VideoWidgetInterfaceLatest -->
</div>
<div class="func">
<h2>Function Documentation</h2>
<!-- $$$categoryToString[overload1]$$$categoryToStringCategory -->
<h3 class="fn"><a name="categoryToString"></a><span class="type"><a href="qstring.html">QString</a></span> Phonon::<span class="name">categoryToString</span> ( <span class="type"><a href="phonon.html#Category-enum">Category</a></span> <i>c</i> )</h3>
<p>Returns a (translated) string to show to the user identifying the given Category (<i>c</i>).</p>
<!-- @@@categoryToString -->
<!-- $$$createPath[overload1]$$$createPathMediaNode*MediaNode* -->
<h3 class="fn"><a name="createPath"></a><span class="type"><a href="phonon-path.html">Path</a></span> Phonon::<span class="name">createPath</span> ( <span class="type"><a href="phonon-medianode.html">MediaNode</a></span> * <i>source</i>, <span class="type"><a href="phonon-medianode.html">MediaNode</a></span> * <i>sink</i> )</h3>
<p>Creates a new Path connecting the two MediaNodes <i>source</i> and <i>sink</i>.</p>
<p>The implementation will automatically select the right format and media type. E.g. connecting a <a href="phonon-mediaobject.html">MediaObject</a> and <a href="phonon-audiooutput.html">AudioOutput</a> will create a Path object connecting the audio. This might be represented as PCM or perhaps even AC3 depending on the <a href="phonon-audiooutput.html">AudioOutput</a> object.</p>
<p><i>source</i> The <a href="phonon-medianode.html">MediaNode</a> to connect an output from <i>sink</i> The <a href="phonon-medianode.html">MediaNode</a> to connect to.</p>
<!-- @@@createPath -->
<!-- $$$createPlayer[overload1]$$$createPlayerPhonon::CategoryconstMediaSource& -->
<h3 class="fn"><a name="createPlayer"></a><span class="type"><a href="phonon-mediaobject.html">MediaObject</a></span> * Phonon::<span class="name">createPlayer</span> ( <span class="type"><a href="phonon.html#Category-enum">Phonon::Category</a></span> <i>category</i>, const <span class="type"><a href="phonon-mediasource.html">MediaSource</a></span> & <i>source</i> = MediaSource() )</h3>
<p>Convenience function to create a <a href="phonon-mediaobject.html">MediaObject</a> and <a href="phonon-audiooutput.html">AudioOutput</a> connected by a path. The <a href="phonon-mediaobject.html">MediaObject</a> return will have <i>source</i> set as its current source and the specified <i>category</i>.</p>
<!-- @@@createPlayer -->
<!-- $$$phononVersion[overload1]$$$phononVersion -->
<h3 class="fn"><a name="phononVersion"></a>const <span class="type">char</span> * Phonon::<span class="name">phononVersion</span> ()</h3>
<p>Returns the Phonon version.</p>
<p>This function was introduced in Qt 4.5.</p>
<!-- @@@phononVersion -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Digia, Qt and their respective logos are trademarks of Digia Plc
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
