Warning: Can't synchronize with repository "(default)" (No changeset 96d22ec3fa3ef6de3ea8dc0d7d398adc9aa071cf in the repository). Look in the Trac log for more information.

source: Dbus API specifications/html/org.freesmartphone.GSM.Call.html @ 9e6994a

Revision 9e6994a, 7.3 KB checked in by Michael 'Mickey' Lauer <mickey@…>, 5 years ago (diff)

minor consistency and spelling fixes
  • Property mode set to 100644
Line 
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 GSM Call 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.GSM.Call</h1><h2>Description</h2>
13<p>The Call interface is used to initiate, accept, release, and otherwise deal  with voice calls. It also allows you to send DTMF tones.</p>
14<h2>Namespace</h2>
15<p><tt>org.freesmartphone.GSM.Call</tt></p>
16<h2>Methods</h2><ul>
17<li><a href="#Emergency">Emergency</a></li>
18<li><a href="#Activate">Activate</a></li>
19<li><a href="#ActivateConference">ActivateConference</a></li>
20<li><a href="#Release">Release</a></li>
21<li><a href="#HoldActive">HoldActive</a></li>
22<li><a href="#Join">Join</a></li>
23<li><a href="#Transfer">Transfer</a></li>
24<li><a href="#ReleaseHeld">ReleaseHeld</a></li>
25<li><a href="#ReleaseAll">ReleaseAll</a></li>
26<li><a href="#Initiate">Initiate</a></li>
27<li><a href="#ListCalls">ListCalls</a></li>
28<li><a href="#SendDtmf">SendDtmf</a></li>
29</ul>
30<h2>Signals</h2><ul>
31<li><a href="#CallStatus">CallStatus</a></li>
32</ul>
33<h2>Errors</h2><ul>
34<li><a href="#NotFound">NotFound</a></li>
35<li><a href="#NotAnEmergencyNumber">NotAnEmergencyNumber</a></li>
36</ul>
37<h1>Methods</h1><h3><a name="Emergency">Emergency</a> ( s )</h3>
38<p><i>Description:</i> Initiate an emergency call.</p><p><div class="rationale"><p>This maps to ATD(number);, see v.250.</p></div></p><h4>Parameters</h4><i>s: number</i><p>The emergency number to dial. National and world-wide restrictions apply.</p>
39<h3><a name="Activate">Activate</a> ( i )</h3>
40<p><i>Description:</i> Activate a call as single active call. All previously active calls are  put on hold. No difference is made whether this is an incoming  call or a call that has been put on hold.</p><p><div class="rationale"><p>This can map to ATA, see v.250. It might also map to GSM 07.07 +CHLD=..., see 3GPP TS 07.07 Chapter 7.12.</p></div></p><h4>Parameters</h4><i>i: id</i><p></p>
41<h3><a name="ActivateConference">ActivateConference</a> ( i )</h3>
42<p><i>Description:</i> Activate a call in addition to all previously active calls.  No difference is made whether this is an incoming  call or a call that has been put on hold.</p><p><div class="rationale"><p>This maps to GSM 07.07 +CHLD=..., see 3GPP TS 07.07 Chapter 7.12.</p></div></p><h4>Parameters</h4><i>i: id</i><p></p>
43<h3><a name="Release">Release</a> ( i )</h3>
44<p><i>Description:</i> Release a call.</p><p><div class="rationale"><p>This can map to ATH, see v.250. It might also map to GSM 07.07 +CHLD=..., see 3GPP TS 07.07 Chapter 7.12. Some implementations might map it to GSM 07.07 +CHUP=, see 3GPP TS 07.07 Chapter 6.5.</p></div></p><h4>Parameters</h4><i>i: id</i><p></p>
45<h3><a name="HoldActive">HoldActive</a> ( )</h3><p><i>Description:</i> Hold the active call.</p><p><div class="rationale"><p>This maps to GSM 07.07 +CHLD=2, see 3GPP TS 07.07 Chapter 7.12.</p></div></p>
46<h3><a name="Join">Join</a> ( )</h3><p><i>Description:</i> Join all active and held calls and release yourself from the conversation.</p><p><div class="rationale"><p>This maps to GSM 07.07 +CHLD=4, see 3GPP TS 07.07 Chapter 7.12.</p></div></p>
47<h3><a name="Transfer">Transfer</a> ( s )</h3>
48<p><i>Description:</i> Transfer an incoming or active call to another number.</p><p><div class="rationale"><p>This maps to GSM 07.07 +CCFC=..., see 3GPP TS 07.07 Chapter 7.10.</p></div></p><h4>Parameters</h4><i>s: number</i><p>The number to transfer the call to.</p>
49<h3><a name="ReleaseHeld">ReleaseHeld</a> ( )</h3><p><i>Description:</i> Release all held calls.</p><p><div class="rationale"><p>This maps to GSM 07.07 +CHLD=, see 3GPP TS 07.07 Chapter 7.12.</p></div></p>
50<h3><a name="ReleaseAll">ReleaseAll</a> ( )</h3><p><i>Description:</i> Release all calls, no matter whether active or put on hold.</p><p><div class="rationale"><p>This maps to ATH, see v.250.</p></div></p>
51<h3><a name="Initiate">Initiate</a> ( ss ) &rarr; i</h3>
52<p><i>Description:</i> Initiate an outgoing call.</p><p><div class="rationale"><p>This maps to ATD(number);, see v.250.</p></div></p><h4>Parameters</h4><i>s: number</i><p>The number to call.</p><i>s: type</i><p>The type of call to made. Valid values are:  <ul>  <li>"voice" - a GSM voice call,</li>  <li>"data" - a GSM data call,</li>  <li>"fax" - a FAX call.</li>  </ul></p><h4>Returns</h4><i>i: id</i><p>The reference id for this call. It will get assigned by the system.</p>
53<h3><a name="ListCalls">ListCalls</a> ( ) &rarr; a(isa{sv})</h3>
54<p><i>Description:</i> Retrieve the status for all calls in the system.</p><h4>Returns</h4><i>a(isa{sv}): call_status</i><p>The call status. This is an array containing a call status record for every single call.  For the format description, please see the CallStatus signal.</p>
55<h3><a name="SendDtmf">SendDtmf</a> ( s )</h3>
56<p><i>Description:</i> Send one or more Dual Tone Multiple Frequency (DTMF) signals during an active call.</p><p><div class="rationale"><p>This maps to the TIA IS 101 command +VTS=(value), see 3GPP TS 07.07 Chapter C.2.11.  Note: DTMF signals are always sent to all active calls, this is a limitation of the underlying protocols.</p></div></p><h4>Parameters</h4><i>s: tones</i><p>The tones to send. Allowed values are: (0-9,#,*,A-D)</p>
57<h1>Signals</h1><h3><h3><a name="CallStatus">CallStatus</a> ( isa{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>i: id</i><p>The index of the call that changed its status or properties.</p><i>s: status</i><p>The new status of the call. Expected values are:  <ul>  <li>"incoming" = The call is incoming (but not yet accepted),</li>  <li>"outgoing" = The call is outgoing (but not yet established),</li>  <li>"active" = The call is the active call (you can talk),</li>  <li>"held" = The call is being held,</li>  <li>"release" = The call has been released.</li>  </ul>  Further information can be part of the properties.</p><i>a{sv}: properties</i><p>An array of property values. Note that some properties are optional. Mandatory tuples are:  <ul>  <li>( "direction", string ) = "incoming" or "outgoing",</li>  <li>( "peer", string ) = The number of the peer (on incoming calls only if we received a CLIP).</li>  </ul>  Optional tuples include:  <ul>  <li>( "reason", string ) = The reason for the status change (on outgoing calls e.g. 'BUSY' or 'NO CARRIER'),</li>  <li>( "auxstatus", string ) = An auxillary connection status (if your modem supports that),</li>  <li>( "line", string ) = The GSM line (0 or 1) this call is taking place (on modems that support multiple lines).</li>  <ul></p></h3>
58<h1>Errors</h1><h3><a name="NotFound">NotFound</a></h3><p><i>Description:</i> Raised, if the specified call is not present.</p>
59<h3><a name="NotAnEmergencyNumber">NotAnEmergencyNumber</a></h3><p><i>Description:</i> Raised, if the number is not allowed to dial as emergency call.</p>
60
61    <hr/>
62    <small>
63    | 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
64    </small>
65    <hr/>
66    </body>
67</html>
68
Note: See TracBrowser for help on using the repository browser.