| 1 | |
|---|
| 2 | <!-- Warning: This file has been autogenerated by tools/makedoc.py. Manual edits will be overwritten. --> |
|---|
| 3 | <html> |
|---|
| 4 | <head> |
|---|
| 5 | <title>freesmartphone.org Audio Interface</title> |
|---|
| 6 | <link rel="stylesheet" type="text/css" href="http://git.freesmartphone.org/?p=specs.git;a=blob_plain;f=html/style.css;hb=HEAD" /> |
|---|
| 7 | </head> |
|---|
| 8 | <body> |
|---|
| 9 | <div class="topbox">freesmartphone.org Framework DBus Interface Specification</div> |
|---|
| 10 | |
|---|
| 11 | |
|---|
| 12 | <h1>org.freesmartphone.Device.Audio</h1><h2>Description</h2> |
|---|
| 13 | <p>This interface provides access to notification sounds, sound scenarios, and mixer controls.c</p> |
|---|
| 14 | <h2>Namespace</h2> |
|---|
| 15 | <p><tt>org.freesmartphone.Device.Audio</tt></p> |
|---|
| 16 | <h2>Methods</h2><ul> |
|---|
| 17 | <li><a href="#GetInfo">GetInfo</a></li> |
|---|
| 18 | <li><a href="#GetSupportedFormats">GetSupportedFormats</a></li> |
|---|
| 19 | <li><a href="#GetAvailableScenarios">GetAvailableScenarios</a></li> |
|---|
| 20 | <li><a href="#PlaySound">PlaySound</a></li> |
|---|
| 21 | <li><a href="#StopSound">StopSound</a></li> |
|---|
| 22 | <li><a href="#StopAllSounds">StopAllSounds</a></li> |
|---|
| 23 | <li><a href="#GetScenario">GetScenario</a></li> |
|---|
| 24 | <li><a href="#SetScenario">SetScenario</a></li> |
|---|
| 25 | <li><a href="#PushScenario">PushScenario</a></li> |
|---|
| 26 | <li><a href="#PullScenario">PullScenario</a></li> |
|---|
| 27 | </ul> |
|---|
| 28 | <h2>Signals</h2><ul> |
|---|
| 29 | <li><a href="#SoundStatus">SoundStatus</a></li> |
|---|
| 30 | </ul> |
|---|
| 31 | <h2>Errors</h2><i>None</i> |
|---|
| 32 | <h1>Methods</h1><h3><a name="GetInfo">GetInfo</a> ( ) → a{sv}</h3> |
|---|
| 33 | <p><i>Description:</i> Returns information about the audio hardware.</p><h4>Returns</h4><i>a{sv}: info</i><p>Information about the audio hardware. Expected tuples: <ul> <li>...to be defined...</li> </ul></p> |
|---|
| 34 | <h3><a name="GetSupportedFormats">GetSupportedFormats</a> ( ) → as</h3> |
|---|
| 35 | <p><i>Description:</i> Returns a list of supported audio formats given by extension.</p><h4>Returns</h4><i>as: formats</i><p>The supported audio formats.</p> |
|---|
| 36 | <h3><a name="GetAvailableScenarios">GetAvailableScenarios</a> ( ) → as</h3> |
|---|
| 37 | <p><i>Description:</i> Returns a list of supported audio scenarios.</p><h4>Returns</h4><i>as: scenarios</i><p>The supported audio scenarios.</p> |
|---|
| 38 | <h3><a name="PlaySound">PlaySound</a> ( s )</h3> |
|---|
| 39 | <p><i>Description:</i> Play a sound resource.</p><h4>Parameters</h4><i>s: id</i><p>The identification of the sound resource. Will be treated as filename, if no schema is given.</p> |
|---|
| 40 | <h3><a name="StopSound">StopSound</a> ( s )</h3> |
|---|
| 41 | <p><i>Description:</i> Stop playing a sound resource.</p><h4>Parameters</h4><i>s: id</i><p>The identification of the sound resource. Will be treated as filename, if no schema is given.</p> |
|---|
| 42 | <h3><a name="StopAllSounds">StopAllSounds</a> ( )</h3><p><i>Description:</i> Stop all currently played sound resources.</p> |
|---|
| 43 | <h3><a name="GetScenario">GetScenario</a> ( ) → s</h3> |
|---|
| 44 | <p><i>Description:</i> Get the current audio scenario.</p><h4>Returns</h4><i>s: scenario</i><p>The name of the scenario.</p> |
|---|
| 45 | <h3><a name="SetScenario">SetScenario</a> ( s )</h3> |
|---|
| 46 | <p><i>Description:</i> Set a new audio scenario.</p><h4>Parameters</h4><i>s: scenario</i><p>The name of the scenario.</p> |
|---|
| 47 | <h3><a name="PushScenario">PushScenario</a> ( s )</h3> |
|---|
| 48 | <p><i>Description:</i> Set a new audio scenario and push the previous one on the stack.</p><h4>Parameters</h4><i>s: scenario</i><p>The name of the scenario.</p> |
|---|
| 49 | <h3><a name="PullScenario">PullScenario</a> ( ) → s</h3> |
|---|
| 50 | <p><i>Description:</i> Set the previously active audio scenario.</p><h4>Returns</h4><i>s: scenario</i><p>The current scenario.</p> |
|---|
| 51 | <h1>Signals</h1><h3><h3><a name="SoundStatus">SoundStatus</a> ( ssa{sv} )</h3><p><i>Description:</i> Sent whenever there is any status or property change on a call in the system, no matter whether this is an incoming, active, held, or released call.</p><h4>Parameters</h4><i>s: id</i><p>The identification of sound resource that changed its status.</p><i>s: status</i><p>The new status for the sound resource.</p><i>a{sv}: properties</i><p>An array of property values. Note that properties are optional. Expected tuples are: <ul> <li>...to be defined...</li> </ul></p></h3> |
|---|
| 52 | |
|---|
| 53 | <hr/> |
|---|
| 54 | <small> |
|---|
| 55 | | Specified 2008 by the <a href="http://www.freesmartphone.org">Freesmartphone.org</a> team. | Join us and discuss further drafts smartphones-standards (at) linuxtogo (dot) org |
|---|
| 56 | </small> |
|---|
| 57 | <hr/> |
|---|
| 58 | </body> |
|---|
| 59 | </html> |
|---|
| 60 | |
|---|
