SipCoreApiDocumentation

Version 107 (Anonymous, 11/25/2010 10:16 am)

1 89 Adrian Georgescu
= SIP Core API =
2 1 Adrian Georgescu
3 101 Adrian Georgescu
[[TOC(SipMiddlewareApi, SipConfigurationAPI, SipCoreApiDocumentation, depth=3)]]
4 5 Adrian Georgescu
5 1 Adrian Georgescu
== Introduction ==
6 1 Adrian Georgescu
7 13 Adrian Georgescu
This chapter describes the internal architecture and API of the SIP core of the {{{sipsimple}}} library.
8 71 Adrian Georgescu
{{{sipsimple}}} is a Python package, the core of which wraps the PJSIP C library, which handles SIP signaling and audio media for the SIP SIMPLE client.
9 1 Adrian Georgescu
10 1 Adrian Georgescu
SIP stands for 'Sessions Initiation Protocol', an IETF standard described by [http://tools.ietf.org/html/rfc3261 RFC 3261]. SIP is an application-layer control protocol that can establish,
11 1 Adrian Georgescu
modify and terminate multimedia sessions such as Internet telephony calls
12 1 Adrian Georgescu
(VoIP). Media can be added to (and removed from) an existing session.
13 1 Adrian Georgescu
14 1 Adrian Georgescu
SIP transparently supports name mapping and redirection services, which
15 1 Adrian Georgescu
supports personal mobility, users can maintain a single externally visible
16 1 Adrian Georgescu
address identifier, which can be in the form of a standard email address or
17 1 Adrian Georgescu
E.164 telephone number regardless of their physical network location.
18 1 Adrian Georgescu
19 1 Adrian Georgescu
SIP allows the endpoints to negotiate and combine any type of session they
20 1 Adrian Georgescu
mutually understand like video, instant messaging (IM), file transfer,
21 1 Adrian Georgescu
desktop sharing and provides a generic event notification system with
22 1 Adrian Georgescu
real-time publications and subscriptions about state changes that can be
23 1 Adrian Georgescu
used for asynchronous services like presence, message waiting indicator and
24 1 Adrian Georgescu
busy line appearance.
25 1 Adrian Georgescu
26 1 Adrian Georgescu
For a comprehensive overview of SIP related protocols and use cases visit http://www.tech-invite.com
27 1 Adrian Georgescu
28 30 Adrian Georgescu
== PJSIP library ==
29 1 Adrian Georgescu
30 1 Adrian Georgescu
{{{sipsimple}}} builds on PJSIP [http://www.pjsip.org], a set of static libraries, written in C, which provide SIP signaling and media capabilities.
31 1 Adrian Georgescu
PJSIP is considered to be the most mature and advanced open source SIP stack available.
32 1 Adrian Georgescu
The following diagram, taken from the PJSIP documentation, illustrates the library stack of PJSIP:
33 1 Adrian Georgescu
34 1 Adrian Georgescu
[[Image(http://www.pjsip.org/images/diagram.jpg, nolink)]]
35 1 Adrian Georgescu
36 1 Adrian Georgescu
The diagram shows that there is a common base library, and two more or less independent stacks of libraries, one for SIP signaling and one for SIP media.
37 71 Adrian Georgescu
The latter also includes an abstraction layer for the sound-card.
38 1 Adrian Georgescu
Both of these stracks are integrated in the high level library, called PJSUA.
39 1 Adrian Georgescu
40 1 Adrian Georgescu
PJSIP itself provides a high-level [http://www.pjsip.org/python/pjsua.htm Python wrapper for PJSUA].
41 1 Adrian Georgescu
Despite this, the choice was made to bypass PJSUA and write the SIP core of the {{{sipsimple}}} package as a Python wrapper, which directly uses the PJSIP and PJMEDIA libraries.
42 1 Adrian Georgescu
The main reasons for this are the following:
43 1 Adrian Georgescu
 * PJSUA assumes a session with exactly one audio stream, whilst for the SIP SIMPLE client more advanced (i.e. low-level) manipulation of the SDP is needed.
44 1 Adrian Georgescu
 * What is advertised as SIMPLE functionality, it is minimal and incomplete subset of it. Only page mode messaging using SIP MESSAGE method and basic device status presence are possible, while session mode IM and rich presence are desired.
45 1 Adrian Georgescu
 * PJSUA integrates the decoding and encoding of payloads (e.g. presence related XML documents), while in the SIP SIMPLE client this should be done at a high level, not by the SIP stack.
46 1 Adrian Georgescu
47 1 Adrian Georgescu
PJSIP itself is by nature asynchronous.
48 1 Adrian Georgescu
In the case of PJSIP it means that in general there will be one thread which handles reception and transmission of SIP signaling messages by means of a polling function which is continually called by the application.
49 1 Adrian Georgescu
Whenever the application performs some action through a function, this function will return immediately.
50 1 Adrian Georgescu
If PJSIP has a result for this action, it will notify the application by means of a callback function in the context of the polling function thread.
51 1 Adrian Georgescu
52 1 Adrian Georgescu
> NOTE: Currently the core starts the media handling as a separate C thread to avoid lag caused by the GIL.
53 71 Adrian Georgescu
> The sound-card also has its own C thread.
54 1 Adrian Georgescu
55 1 Adrian Georgescu
== Architecture ==
56 1 Adrian Georgescu
57 1 Adrian Georgescu
The {{{sipsimple}}} core wrapper itself is mostly written using [http://cython.org/ Cython] (formerly [http://www.cosc.canterbury.ac.nz/greg.ewing/python/Pyrex/ Pyrex]).
58 1 Adrian Georgescu
It allows a Python-like file with some added C manipulation statements to be compiled to C.
59 1 Adrian Georgescu
This in turn compiles to a Python C extension module, which links with the PJSIP static libraries.
60 1 Adrian Georgescu
61 90 Luci Stanescu
The SIP core part of the {{{sipsimple}}} Python library resides in the {{{sipsimple.core}}} package. This package aggregates three modules, {{{sipsimple.core._core}}}, {{{sipsimple.core._engine}}} and {{{sipsimple.core._primitives}}}. The former is a Python C extension module which makes wrappers around PJSIP objects available in Python, while the latter two contain SIP core objects written in Python. All core objects should be accessed from the enclosing {{{sipsimple.core}}} module. The following list enumerates the various SIP core objects available:
62 90 Luci Stanescu
 * The {{{Engine}}} class which is a Python wrapper around the low-level {{{PJSIPUA}}} class. The latter represents the SIP endpoint and manages the initialization and destruction of all the PJSIP libraries. It is also the central management point to the SIP core. The application should not use the {{{PJSIPUA}}} class directly, but rather through the wrapping {{{Engine}}}, which is a singleton class.
63 90 Luci Stanescu
 * Utility classes used throughout the core:
64 90 Luci Stanescu
   * {{{frozenlist}}} and {{{frozendict}}}: classes which relate respectively to {{{list}}} and {{{dict}}} similarly to how the standard {{{frozenset}}} relates to {{{set}}}.
65 90 Luci Stanescu
 * Helper classes which represent a structured collection of data which is used throughout the core:
66 90 Luci Stanescu
   * {{{BaseSIPURI}}}, {{{SIPURI}}} and {{{FrozenSIPURI}}}
67 90 Luci Stanescu
   * {{{BaseCredentials}}}, {{{Credentials}}} and {{{FrozenCredentials}}}
68 90 Luci Stanescu
 * SDP manipulation classes, which directly wrap the PJSIP structures representing either the parsed or to be generated SDP:
69 90 Luci Stanescu
   * {{{BaseSDPSession}}}, {{{SDPSession}}} and {{{FrozenSDPSession}}}
70 90 Luci Stanescu
   * {{{BaseSDPMediaStream}}}, {{{SDPMediaStream}}} and {{{FrozenSDPMediaStream}}}
71 90 Luci Stanescu
   * {{{BaseSDPConnection}}}, {{{SDPConnection}}} and {{{FrozenSDPConnection}}}
72 90 Luci Stanescu
   * {{{SDPAttributeList}}} and {{{FrozenSDPAttributeList}}}
73 90 Luci Stanescu
   * {{{BaseSDPAttribute}}}, {{{SDPAttribute}}} and {{{FrozenSDPAttribute}}}
74 90 Luci Stanescu
 * Audio handling classes:
75 90 Luci Stanescu
   * {{{AudioMixer}}}
76 90 Luci Stanescu
   * {{{MixerPort}}}
77 90 Luci Stanescu
   * {{{WaveFile}}}
78 90 Luci Stanescu
   * {{{RecordingWaveFile}}}
79 90 Luci Stanescu
   * {{{ToneGenerator}}}
80 90 Luci Stanescu
 * Media transport handling classes, using the functionality built into PJMEDIA:
81 90 Luci Stanescu
   * {{{RTPTransport}}}
82 90 Luci Stanescu
   * {{{AudioTransport}}}
83 90 Luci Stanescu
 * SIP signalling related classes:
84 90 Luci Stanescu
   * {{{Request}}} and {{{IncomingRequest}}}: low-level transaction support
85 90 Luci Stanescu
   * {{{Invitation}}}: INVITE-dialog support
86 90 Luci Stanescu
   * {{{Subscription}}} and {{{IncomingSubscription}}}: SUBSCRIBE-dialog support (including NOTIFY handling within the SUBSCRIBE dialog)
87 90 Luci Stanescu
   * {{{Registration}}}: Python object based on {{{Request}}} for REGISTER support
88 90 Luci Stanescu
   * {{{Message}}}: Python object based on {{{Request}}} for MESSAGE support
89 90 Luci Stanescu
   * {{{Publication}}}: Python object based on {{{Request}}} for PUBLISH support
90 90 Luci Stanescu
 * Exceptions:
91 90 Luci Stanescu
   * {{{SIPCoreError}}}: generic error used throught the core
92 90 Luci Stanescu
   * {{{PJSIPError}}}: subclass of {{{SIPCoreError}}} which offers more information related to errors from PJSIP
93 90 Luci Stanescu
   * {{{PJSIPTLSError}}}: subclass of {{{PJSIPError}}} to distinguish between TLS-related errors and the rest
94 90 Luci Stanescu
   * {{{SIPCoreInvalidStateError}}}: subclass of {{{SIPCoreError}}} used by objects which are based on a state-machine
95 1 Adrian Georgescu
96 90 Luci Stanescu
Most of the objects cannot be used until the {{{Engine}}} has been started. The following diagram illustrates these classes:
97 1 Adrian Georgescu
98 1 Adrian Georgescu
[[Image(sipsimple-core-classes.png, nolink)]]
99 90 Luci Stanescu
100 90 Luci Stanescu
Most of the SIP core does not allow duck-typing due to the nature of the integration between it and PJSIP. If these checks had not been employed, any errors could have resulted in a segmentation fault and a core dump. This also explains why several objects have a '''Frozen''' counterpart: the frozen objects are simply immutable versions of their non-frozen variants which make sure that low-level data is kept consistent and cannot be modified from Python. The '''Base''' versions are just base classes for the frozen and non-frozen versions provided mostly for convinience: they cannot be instantiated.
101 67 Ruud Klaver
102 11 Adrian Georgescu
== Integration ==
103 1 Adrian Georgescu
104 1 Adrian Georgescu
The core itself has one Python dependency, the [http://pypi.python.org/pypi/python-application application] module, which in turn depends on the [http://pypi.python.org/pypi/zope.interface zope.interface] module.
105 1 Adrian Georgescu
These modules should be present on the system before the core can be used.
106 1 Adrian Georgescu
An application that uses the SIP core must use the notification system provided by the {{{application}}} module in order to receive notifications from it.
107 1 Adrian Georgescu
It does this by creating one or more classes that act as an observer for particular messages and registering it with the {{{NotificationCenter}}}, which is a singleton class.
108 1 Adrian Georgescu
This means that any call to instance an object from this class will result in the same object.
109 1 Adrian Georgescu
As an example, this bit of code will create an observer for logging messages only:
110 1 Adrian Georgescu
111 1 Adrian Georgescu
{{{
112 1 Adrian Georgescu
from zope.interface import implements
113 1 Adrian Georgescu
from application.notification import NotificationCenter, IObserver
114 1 Adrian Georgescu
115 29 Luci Stanescu
class SIPEngineLogObserver(object):
116 1 Adrian Georgescu
    implements(IObserver)
117 1 Adrian Georgescu
118 1 Adrian Georgescu
    def handle_notification(self, notification):
119 1 Adrian Georgescu
        print "%(timestamp)s (%(level)d) %(sender)14s: %(message)s" % notification.data.__dict__
120 1 Adrian Georgescu
121 102 Luci Stanescu
log_observer = SIPEngineLogObserver()
122 1 Adrian Georgescu
notification_center = NotificationCenter()
123 102 Luci Stanescu
notification_center.add_observer(log_observer, name="SIPEngineLog")
124 1 Adrian Georgescu
}}}
125 1 Adrian Georgescu
126 1 Adrian Georgescu
Each notification object has three attributes:
127 99 Adrian Georgescu
128 1 Adrian Georgescu
 '''sender'''::
129 1 Adrian Georgescu
  The object that sent the notification.
130 1 Adrian Georgescu
  For generic notifications the sender will be the {{{Engine}}} instance, otherwise the relevant object.
131 99 Adrian Georgescu
132 1 Adrian Georgescu
 '''name'''::
133 1 Adrian Georgescu
  The name describing the notification.
134 91 Luci Stanescu
  Most of the notifications in the core have the prefix "SIP".
135 99 Adrian Georgescu
136 1 Adrian Georgescu
 '''data'''::
137 1 Adrian Georgescu
  An instance of {{{application.notification.NotificationData}}} or a subclass of it.
138 1 Adrian Georgescu
  The attributes of this object provide additional data about the notification.
139 1 Adrian Georgescu
  Notifications described in this document will also have the data attributes described.
140 1 Adrian Georgescu
141 91 Luci Stanescu
Besides setting up the notification observers, the application should import the relevant objects from the {{{sipsimple.core}}} module.
142 91 Luci Stanescu
It can then instantiate the {{{Engine}}} class, which is also a singleton, and start the PJSIP worker thread by calling {{{Engine.start()}}}, optionally providing a number of initialization options.
143 1 Adrian Georgescu
Most of these options can later be changed at runtime, by setting attributes of the same name on the {{{Engine}}} object.
144 91 Luci Stanescu
The application may then instantiate one of the SIP primitive classes and perform operations on it.
145 1 Adrian Georgescu
146 1 Adrian Georgescu
When starting the {{{Engine}}} class, the application can pass a number of keyword arguments that influence the behaviour of the SIP endpoint.
147 1 Adrian Georgescu
For example, the SIP network ports may be set through the {{{local_udp_port}}}, {{{local_tcp_port}}} and {{{local_tls_port}}} arguments.
148 1 Adrian Georgescu
The UDP/RTP ports are described by a range of ports through {{{rtp_port_range}}}, two of which will be randomly selected for each {{{RTPTransport}}} object and effectively each audio stream.
149 1 Adrian Georgescu
150 1 Adrian Georgescu
The methods called on the SIP primitive objects and the {{{Engine}}} object (proxied to the {{{PJSIPUA}}} instance) may be called from any thread.
151 31 Ruud Klaver
They will return immediately and any delayed result, such as results depending on network traffic, will be returned later using a notification.
152 31 Ruud Klaver
In this manner the SIP core continues the asynchronous pattern of PJSIP.
153 1 Adrian Georgescu
If there is an error in processing the request, an instance of {{{SIPCoreError}}}, or its subclass {{{PJSIPError}}} will be raised.
154 1 Adrian Georgescu
The former will be raised whenever an error occurs inside the core, the latter whenever an underlying PJSIP function returns an error.
155 1 Adrian Georgescu
The {{{PJSIPError}}} object also contains a status attribute, which is the PJSIP errno as an integer.
156 43 Ruud Klaver
157 1 Adrian Georgescu
As a very basic example, one can {{{REGISTER}}} for a sip account by typing the following lines on a Python console:
158 43 Ruud Klaver
{{{
159 91 Luci Stanescu
from sipsimple.core import ContactHeader, Credentials, Engine, Registration, RouteHeader, SIPURI
160 1 Adrian Georgescu
e = Engine()
161 1 Adrian Georgescu
e.start()
162 91 Luci Stanescu
identity = FromHeader(SIPURI(user="alice", host="example.com"), display_name="Alice")
163 43 Ruud Klaver
cred = Credentials("alice", "mypassword")
164 91 Luci Stanescu
reg = Registration(identity, credentials=cred)
165 91 Luci Stanescu
reg.register(ContactHeader(SIPURI("127.0.0.1",port=12345)), RouteHeader(SIPURI("1.2.3.4", port=5060)))
166 1 Adrian Georgescu
}}}
167 1 Adrian Georgescu
Note that in this example no observer for notifications from this {{{Registration}}} object are registered, so the result of the operation cannot be seen.
168 43 Ruud Klaver
Also note that this will not keep the registration registered when it is about to expire, as it is the application's responsibility.
169 43 Ruud Klaver
See the {{{Registration}}} documentation for more details.
170 43 Ruud Klaver
171 43 Ruud Klaver
Another convention that is worth mentioning at this point is that the SIP core will never perform DNS lookups.
172 91 Luci Stanescu
For the sake of flexibility, it is the responsibility of the application to do this and pass the result to SIP core objects using the {{{RouteHeader}}} object, indicating the destination IP address, port and transport the resulting SIP request should be sent to. The [wiki:SipMiddlewareApi#Lookup {{{sipsimple.lookup}}}] module of the middleware can be used to perform DNS lookups according to RFC3263.
173 32 Ruud Klaver
174 1 Adrian Georgescu
== Components ==
175 1 Adrian Georgescu
176 1 Adrian Georgescu
=== Engine ===
177 1 Adrian Georgescu
178 1 Adrian Georgescu
As explained above, this singleton class needs to be instantiated by the application using the SIP core of {{{sipsimple}}} and represents the whole SIP core stack.
179 1 Adrian Georgescu
Once the {{{start()}}} method is called, it instantiates the {{{core.PJSIPUA}}} object and will proxy attribute and methods from it to the application.
180 1 Adrian Georgescu
181 1 Adrian Georgescu
==== attributes ====
182 1 Adrian Georgescu
183 99 Adrian Georgescu
184 1 Adrian Georgescu
 '''default_start_options''' (class attribute)::
185 1 Adrian Georgescu
  This dictionary is a class attribute that describes the default values for the initialization options passed as keyword arguments to the {{{start()}}} method.
186 1 Adrian Georgescu
  Consult this method for documentation of the contents.
187 99 Adrian Georgescu
188 32 Ruud Klaver
 '''is_running'''::
189 32 Ruud Klaver
  A boolean property indicating if the {{{Engine}}} is running and if it is safe to try calling any proxied methods or attributes on it.
190 1 Adrian Georgescu
191 1 Adrian Georgescu
==== methods ====
192 1 Adrian Georgescu
193 99 Adrian Georgescu
194 1 Adrian Georgescu
 '''!__init!__'''(''self'')::
195 71 Adrian Georgescu
  This will either create the {{{Engine}}} if it is called for the first time or return the one {{{Engine}}} instance if it is called subsequently.
196 99 Adrian Georgescu
197 1 Adrian Georgescu
 '''start'''(''self'', '''**kwargs''')::
198 1 Adrian Georgescu
  Initialize all PJSIP libraries based on the keyword parameters provided and start the PJSIP worker thread.
199 1 Adrian Georgescu
  If this fails an appropriate exception is raised.
200 1 Adrian Georgescu
  After the {{{Engine}}} has been started successfully, it can never be started again after being stopped.
201 1 Adrian Georgescu
  The keyword arguments will be discussed here.
202 87 Adrian Georgescu
  Many of these values are also readable as (proxied) attributes on the Engine once the {{{start()}}} method has been called.
203 44 Ruud Klaver
  Many of them can also be set at runtime, either by modifying the attribute or by calling a particular method.
204 1 Adrian Georgescu
  This will also be documented for each argument in the following list of options.
205 87 Adrian Georgescu
  [[BR]]''udp_port'': (Default: {{{0}}})[[BR]]
206 1 Adrian Georgescu
  The local UDP port to listen on for UDP datagrams.
207 1 Adrian Georgescu
  If this is 0, a random port will be chosen.
208 1 Adrian Georgescu
  If it is {{{None}}}, the UDP transport is disabled, both for incoming and outgoing traffic.
209 91 Luci Stanescu
  As an attribute, this value is read-only, but it can be changed at runtime using the {{{set_udp_port()}}} method.
210 87 Adrian Georgescu
  [[BR]]''tcp_port'': (Default: {{{0}}})[[BR]]
211 1 Adrian Georgescu
  The local TCP port to listen on for new TCP connections.
212 1 Adrian Georgescu
  If this is 0, a random port will be chosen.
213 1 Adrian Georgescu
  If it is {{{None}}}, the TCP transport is disabled, both for incoming and outgoing traffic.
214 91 Luci Stanescu
  As an attribute, this value is read-only, but it can be changed at runtime using the {{{set_tcp_port()}}} method.
215 87 Adrian Georgescu
  [[BR]]''tls_port'': (Default: {{{0}}})[[BR]]
216 1 Adrian Georgescu
  The local TCP port to listen on for new TLS over TCP connections.
217 1 Adrian Georgescu
  If this is 0, a random port will be chosen.
218 28 Adrian Georgescu
  If it is {{{None}}}, the TLS transport is disabled, both for incoming and outgoing traffic.
219 87 Adrian Georgescu
  As an attribute, this value is read-only, but it can be changed at runtime using the {{{set_tls_options()}}} method, as internally the TLS transport needs to be restarted for this operation.
220 1 Adrian Georgescu
  [[BR]]''tls_protocol'': (Default: "TLSv1")[[BR]] 
221 35 Ruud Klaver
  This string describes the (minimum) TLS protocol that should be used. 
222 32 Ruud Klaver
  Its values should be either {{{None}}}, "SSLv2", "SSLv23", "SSLv3" or "TLSv1". 
223 32 Ruud Klaver
  If {{{None}}} is specified, the PJSIP default will be used, which is currently "TLSv1". 
224 1 Adrian Georgescu
  [[BR]]''tls_verify_server'': (Default: {{{False}}})[[BR]]
225 32 Ruud Klaver
  This boolean indicates whether PJSIP should verify the certificate of the server against the local CA list when making an outgoing TLS connection.
226 1 Adrian Georgescu
  As an attribute, this value is read-only, but it can be changed at runtime using the {{{set_tls_options()}}} method, as internally the TLS transport needs to be restarted for this operation.
227 28 Adrian Georgescu
  [[BR]]''tls_ca_file'': (Default: {{{None}}})[[BR]]
228 32 Ruud Klaver
  This string indicates the location of the file containing the local list of CA certificates, to be used for TLS connections.
229 1 Adrian Georgescu
  If this is set to {{{None}}}, no CA certificates will be read. 
230 1 Adrian Georgescu
  As an attribute, this value is read-only, but it can be changed at runtime using the {{{set_tls_options()}}} method, as internally the TLS transport needs to be restarted for this operation. 
231 32 Ruud Klaver
  [[BR]]''tls_cert_file'': (Default: {{{None}}})[[BR]] 
232 32 Ruud Klaver
  This string indicates the location of a file containing the TLS certificate to be used for TLS connections. 
233 32 Ruud Klaver
  If this is set to {{{None}}}, no certificate file will be read. 
234 32 Ruud Klaver
  As an attribute, this value is read-only, but it can be changed at runtime using the {{{set_tls_options()}}} method, as internally the TLS transport needs to be restarted for this operation. 
235 32 Ruud Klaver
  [[BR]]''tls_privkey_file'': (Default: {{{None}}})[[BR]] 
236 32 Ruud Klaver
  This string indicates the location of a file containing the TLS private key associated with the above mentioned certificated to be used for TLS connections. 
237 32 Ruud Klaver
  If this is set to {{{None}}}, no private key file will be read. 
238 32 Ruud Klaver
  As an attribute, this value is read-only, but it can be changed at runtime using the {{{set_tls_options()}}} method, as internally the TLS transport needs to be restarted for this operation. 
239 32 Ruud Klaver
  [[BR]]''tls_timeout'': (Default: 1000)[[BR]] 
240 1 Adrian Georgescu
  The timeout value for a TLS negotiation in milliseconds. 
241 32 Ruud Klaver
  Note that this value should be reasonably small, as a TLS negotiation blocks the whole PJSIP polling thread. 
242 32 Ruud Klaver
  As an attribute, this value is read-only, but it can be changed at runtime using the {{{set_tls_options()}}} method, as internally the TLS transport needs to be restarted for this operation.
243 91 Luci Stanescu
  [[BR]]''user_agent'': (Default: {{{"sipsimple-%version-pjsip-%pjsip_version-r%pjsip_svn_revision"}}})[[BR]]
244 32 Ruud Klaver
  This value indicates what should be set in the {{{User-Agent}}} header, which is included in each request or response sent.
245 71 Adrian Georgescu
  It can be read and set directly as an attribute at runtime.
246 1 Adrian Georgescu
  [[BR]]''log_level'': (Default: 5)[[BR]]
247 1 Adrian Georgescu
  This integer dictates the maximum log level that may be reported to the application by PJSIP through the {{{SIPEngineLog}}} notification.
248 1 Adrian Georgescu
  By default the maximum amount of logging information is reported.
249 29 Luci Stanescu
  This value can be read and set directly as an attribute at runtime.
250 1 Adrian Georgescu
  [[BR]]''trace_sip'': (Default: {{{False}}})[[BR]]
251 1 Adrian Georgescu
  This boolean indicates if the SIP core should send the application SIP messages as seen on the wire through the {{{SIPEngineSIPTrace}}} notification.
252 1 Adrian Georgescu
  It can be read and set directly as an attribute at runtime.
253 1 Adrian Georgescu
  [[BR]]''rtp_port_range'': (Default: (40000, 40100))[[BR]]
254 1 Adrian Georgescu
  This tuple of two integers indicates the range to select UDP ports from when creating a new {{{RTPTransport}}} object, which is used to transport media.
255 1 Adrian Georgescu
  It can be read and set directly as an attribute at runtime, but the ports of previously created {{{RTPTransport}}} objects remain unaffected.
256 1 Adrian Georgescu
  [[BR]]''codecs'': (Default: {{{["speex", "G722", "PCMU", "PCMA", "iLBC", "GSM"]}}})[[BR]]
257 71 Adrian Georgescu
  This list specifies the codecs to use for audio sessions and their preferred order.
258 1 Adrian Georgescu
  It can be read and set directly as an attribute at runtime.
259 1 Adrian Georgescu
  Note that this global option can be overridden by an argument passed to {{{AudioTransport.__init__()}}}.
260 40 Ruud Klaver
  The strings in this list is case insensitive.
261 1 Adrian Georgescu
  [[BR]]''events'': (Default: <some sensible events>)[[BR]]
262 1 Adrian Georgescu
  PJSIP needs a mapping between SIP SIMPLE event packages and content types.
263 1 Adrian Georgescu
  This dictionary provides some default packages and their event types.
264 91 Luci Stanescu
  As an attribute, this value is read-only, but it can be changed at runtime using the {{{add_event()}}} method.
265 1 Adrian Georgescu
  [[BR]]''incoming_events'': (Default: {{{set()}}})[[BR]]
266 1 Adrian Georgescu
  A list that specifies for which SIP SIMPLE event packages the application wishes to receive {{{IncomingSubscribe}}} objects.
267 82 Ruud Klaver
  When a {{{SUBSCRIBE}}} request is received containing an event name that is not in this list, a 489 "Bad event" response is internally generated.
268 1 Adrian Georgescu
  When the event is in the list, an {{{IncomingSubscribe}}} object is created based on the request and passed to the application by means of a notification.
269 82 Ruud Klaver
  Note that each of the events specified here should also be a key in the {{{events}}} dictionary argument.
270 82 Ruud Klaver
  As an attribute, this value is read-only, but it can be changed at runtime using the {{{add_incoming_event()}}} and {{{remove_incoming_event()}}} methods.
271 82 Ruud Klaver
  [[BR]]''incoming_requests'': (Default: {{{set()}}})[[BR]]
272 82 Ruud Klaver
  A set of methods for which {{{IncomingRequest}}} objects are created and sent to the application if they are received.
273 85 Ruud Klaver
  Note that receiving requests using the {{{INVITE}}}, {{{SUBSCRIBE}}}, {{{ACK}}} or {{{BYE}}} methods in this way is not allowed.
274 74 Ruud Klaver
  Requests using the {{{OPTIONS}}} or {{{MESSAGE}}} method are handled internally, but may be overridden.
275 99 Adrian Georgescu
276 40 Ruud Klaver
 '''stop'''(''self'')::
277 1 Adrian Georgescu
  Stop the PJSIP worker thread and unload all PJSIP libraries.
278 36 Adrian Georgescu
  Note that after this all references to SIP core objects can no longer be used, these should be properly removed by the application itself before stopping the {{{Engine}}}.
279 32 Ruud Klaver
  Also note that, once stopped the {{{Engine}}} cannot be started again.
280 32 Ruud Klaver
  This method is automatically called when the Python interpreter exits.
281 35 Ruud Klaver
282 1 Adrian Georgescu
==== proxied attributes ====
283 39 Ruud Klaver
284 91 Luci Stanescu
Besides all the proxied attributes described for the {{{__init__}}} method above, thse other attributes are provided once the {{{Engine}}} has been started.
285 1 Adrian Georgescu
286 99 Adrian Georgescu
287 20 Ruud Klaver
 '''input_devices'''::
288 1 Adrian Georgescu
  This read-only attribute is a list of strings, representing all audio input devices on the system that can be used.
289 91 Luci Stanescu
  One of these device names can be passed as the {{{input_device}}} argument when creating a {{{AudioMixer}}} object.
290 99 Adrian Georgescu
291 74 Ruud Klaver
 '''output_devices'''::
292 91 Luci Stanescu
  This read-only attribute is a list of strings, representing all audio output devices on the system that can be used.
293 91 Luci Stanescu
  One of these device names can be passed as the {{{output_device}}} argument when creating a {{{AudioMixer}}} object.
294 99 Adrian Georgescu
295 91 Luci Stanescu
 '''sound_devices'''::
296 91 Luci Stanescu
  This read-only attribute is a list of strings, representing all audio sound devices on the system that can be used.
297 99 Adrian Georgescu
298 1 Adrian Georgescu
 '''available_codecs'''::
299 1 Adrian Georgescu
  A read-only list of codecs available in the core, regardless of the codecs configured through the {{{codecs}}} attribute.
300 1 Adrian Georgescu
301 29 Luci Stanescu
==== proxied methods ====
302 1 Adrian Georgescu
303 99 Adrian Georgescu
304 1 Adrian Georgescu
 '''add_event'''(''self'', '''event''', '''accept_types''')::
305 82 Ruud Klaver
  Couple a certain event package to a list of content types.
306 82 Ruud Klaver
  Once added it cannot be removed or modified.
307 99 Adrian Georgescu
308 82 Ruud Klaver
 '''add_incoming_event'''(''self'', '''event''')::
309 82 Ruud Klaver
  Adds a SIP SIMPLE event package to the set of events for which the {{{Engine}}} should create an {{{IncomingSubscribe}}} object when a {{{SUBSCRIBE}}} request is received.
310 82 Ruud Klaver
  Note that this event should be known to the {{{Engine}}} by means of the {{{events}}} attribute.
311 99 Adrian Georgescu
312 85 Ruud Klaver
 '''remove_incoming_event'''(''self'', '''event''')::
313 85 Ruud Klaver
  Removes an event from the {{{incoming_events}}} attribute.
314 85 Ruud Klaver
  Incoming {{{SUBSCRIBE}}} requests with this event package will automatically be replied to with a 489 "Bad Event" response.
315 99 Adrian Georgescu
316 85 Ruud Klaver
 '''add_incoming_request'''(''self'', '''method''')::
317 1 Adrian Georgescu
  Add a method to the set of methods for which incoming requests should be turned into {{{IncomingRequest}}} objects.
318 1 Adrian Georgescu
  For the rules on which methods are allowed, see the description of the Engine attribute above.
319 99 Adrian Georgescu
320 38 Ruud Klaver
 '''remove_incoming_request'''(''self'', '''method''')::
321 1 Adrian Georgescu
  Removes a method from the set of methods that should be received.
322 99 Adrian Georgescu
323 1 Adrian Georgescu
 '''detect_nat_type'''(''self'', '''stun_server_address''', '''stun_server_port'''=3478, '''user_data'''=None)::
324 38 Ruud Klaver
  Will start a series of STUN requests which detect the type of NAT this host is behind.
325 87 Adrian Georgescu
  The {{{stun_server_address}}} parameter indicates the IP address or hostname of the STUN server to be used and {{{stun_server_port}}} specifies the remote UDP port to use.
326 1 Adrian Georgescu
  When the type of NAT is detected, this will be reported back to the application by means of a {{{SIPEngineDetectedNATType}}} notification, including the user_data object passed with this method.
327 99 Adrian Georgescu
328 87 Adrian Georgescu
 '''set_udp_port'''(''self'', '''value''')::
329 1 Adrian Georgescu
  Update the {{{local_udp_port}}} attribute to the newly specified value.
330 99 Adrian Georgescu
331 44 Ruud Klaver
 '''set_tcp_port'''(''self'', '''value''')::
332 44 Ruud Klaver
  Update the {{{local_tcp_port}}} attribute to the newly specified value.
333 99 Adrian Georgescu
334 44 Ruud Klaver
 '''set_tls_options'''(''self'', '''local_port'''={{{None}}}, '''protocol'''="TLSv1", '''verify_server'''={{{False}}}, '''ca_file'''={{{None}}}, '''cert_file'''={{{None}}}, '''privkey_file'''={{{None}}}, '''timeout'''=1000):: 
335 83 Ruud Klaver
  Calling this method will (re)start the TLS transport with the specified arguments, or stop it in the case that the '''local_port''' argument is set to {{{None}}}. 
336 44 Ruud Klaver
  The semantics of the arguments are the same as on the {{{start()}}} method. 
337 1 Adrian Georgescu
338 1 Adrian Georgescu
==== notifications ====
339 1 Adrian Georgescu
340 1 Adrian Georgescu
Notifications sent by the {{{Engine}}} are notifications that are related to the {{{Engine}}} itself or unrelated to any SIP primitive object.
341 1 Adrian Georgescu
They are described here including the data attributes that is included with them.
342 16 Ruud Klaver
343 99 Adrian Georgescu
344 1 Adrian Georgescu
 '''SIPEngineWillStart'''::
345 1 Adrian Georgescu
  This notification is sent when the {{{Engine}}} is about to start.
346 29 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
347 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
348 99 Adrian Georgescu
349 16 Ruud Klaver
 '''SIPEngineDidStart'''::
350 16 Ruud Klaver
  This notification is sent when the {{{Engine}}} is has just been started.
351 29 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
352 16 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
353 99 Adrian Georgescu
354 16 Ruud Klaver
 '''SIPEngineDidFail'''::
355 16 Ruud Klaver
  This notification is sent whenever the {{{Engine}}} has failed fatally and either cannot start or is about to stop.
356 29 Luci Stanescu
  It is not recommended to call any methods on the {{{Engine}}} at this point.
357 16 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
358 16 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
359 99 Adrian Georgescu
360 16 Ruud Klaver
 '''SIPEngineWillEnd'''::
361 16 Ruud Klaver
  This notification is sent when the {{{Engine}}} is about to stop because the application called the {{{stop()}}} method.
362 1 Adrian Georgescu
  Methods on the {{{Engine}}} can be called at this point, but anything that has a delayed result will probably not return any notification.
363 16 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
364 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
365 99 Adrian Georgescu
366 16 Ruud Klaver
 '''SIPEngineDidEnd'''::
367 16 Ruud Klaver
  This notification is sent when the {{{Engine}}} was running and is now stopped, either because of failure or because the application requested it.
368 29 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
369 16 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
370 99 Adrian Georgescu
371 16 Ruud Klaver
 '''SIPEngineLog'''::
372 16 Ruud Klaver
  This notification is a wrapper for PJSIP logging messages.
373 1 Adrian Georgescu
  It can be used by the application to output PJSIP logging to somewhere meaningful, possibly doing filtering based on log level.
374 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
375 1 Adrian Georgescu
  A {{{datetime.datetime}}} object representing the time when the log message was output by PJSIP.
376 1 Adrian Georgescu
  [[BR]]''sender'':[[BR]]
377 1 Adrian Georgescu
  The PJSIP module that originated this log message.
378 1 Adrian Georgescu
  [[BR]]''level'':[[BR]]
379 1 Adrian Georgescu
  The logging level of the message as an integer.
380 1 Adrian Georgescu
  Currently this is 1 through 5, 1 being the most critical.
381 1 Adrian Georgescu
  [[BR]]''message'':[[BR]]
382 1 Adrian Georgescu
  The actual log message.
383 99 Adrian Georgescu
384 1 Adrian Georgescu
 '''SIPEngineSIPTrace'''::
385 1 Adrian Georgescu
  Will be sent only when the {{{do_siptrace}}} attribute of the {{{Engine}}} instance is set to {{{True}}}.
386 1 Adrian Georgescu
  The notification data attributes will contain the SIP messages as they are sent and received on the wire.
387 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
388 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
389 1 Adrian Georgescu
  [[BR]]''received'':[[BR]]
390 1 Adrian Georgescu
  A boolean indicating if this message was sent from or received by PJSIP (i.e. the direction of the message).
391 1 Adrian Georgescu
  [[BR]]''source_ip'':[[BR]]
392 1 Adrian Georgescu
  The source IP address as a string.
393 1 Adrian Georgescu
  [[BR]]''source_port'':[[BR]]
394 1 Adrian Georgescu
  The source port of the message as an integer.
395 1 Adrian Georgescu
  [[BR]]''destination_ip'':[[BR]]
396 1 Adrian Georgescu
  The destination IP address as a string.
397 1 Adrian Georgescu
  [[BR]]''source_port'':[[BR]]
398 1 Adrian Georgescu
  The source port of the message as an integer.
399 1 Adrian Georgescu
  [[BR]]''data'':[[BR]]
400 1 Adrian Georgescu
  The contents of the message as a string.
401 1 Adrian Georgescu
402 1 Adrian Georgescu
> For received message the destination_ip and for sent messages the source_ip may not be reliable.
403 1 Adrian Georgescu
404 99 Adrian Georgescu
405 1 Adrian Georgescu
 '''SIPEngineDetectedNATType'''::
406 1 Adrian Georgescu
  This notification is sent some time after the application request the NAT type this host behind to be detected using a STUN server.
407 1 Adrian Georgescu
  Note that there is no way to associate a request to do this with a notification, although every call to the {{{detect_nat_type()}}} method will generate exactly one notification.
408 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
409 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
410 1 Adrian Georgescu
  [[BR]]''succeeded'':[[BR]]
411 1 Adrian Georgescu
  A boolean indicating if the NAT detection succeeded.
412 1 Adrian Georgescu
  [[BR]]''user_data'':[[BR]]
413 1 Adrian Georgescu
  The {{{user_data}}} argument passed while calling the {{{detect_nat_type()}}} method.
414 1 Adrian Georgescu
  This can be any object and could be used for matching requests to responses.
415 1 Adrian Georgescu
  [[BR]]''nat_type'':[[BR]]
416 1 Adrian Georgescu
  A string describing the type of NAT found.
417 1 Adrian Georgescu
  This value is only present if NAT detection succeeded.
418 1 Adrian Georgescu
  [[BR]]''error'':[[BR]]
419 1 Adrian Georgescu
  A string indicating the error that occurred while attempting to detect the type of NAT.
420 1 Adrian Georgescu
  This value only present if NAT detection did not succeed.
421 99 Adrian Georgescu
422 1 Adrian Georgescu
 '''SIPEngineGotException'''::
423 1 Adrian Georgescu
  This notification is sent whenever there is an unexpected exception within the PJSIP working thread.
424 1 Adrian Georgescu
  The application should show the traceback to the user somehow.
425 1 Adrian Georgescu
  An exception need not be fatal, but if it is it will be followed by a '''SIPEngineDidFail''' notification.
426 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
427 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
428 1 Adrian Georgescu
  [[BR]]''traceback'':[[BR]]
429 1 Adrian Georgescu
  A string containing the traceback of the exception.
430 1 Adrian Georgescu
  In general this should be printed on the console.
431 1 Adrian Georgescu
432 98 Adrian Georgescu
=== SIPURI ===
433 1 Adrian Georgescu
434 91 Luci Stanescu
These are helper objects for representing a SIP URI.
435 91 Luci Stanescu
This object needs to be used whenever a SIP URI should be specified to the SIP core.
436 91 Luci Stanescu
It supports comparison to other {{{SIPURI}}} objects using the == and != expressions.
437 91 Luci Stanescu
As all of its attributes are set by the {{{__init__}}} method, the individual attributes will not be documented here. The FrozenSIPURI object does not allow any of its attributes to be changed after initialization.
438 91 Luci Stanescu
439 91 Luci Stanescu
==== methods ====
440 91 Luci Stanescu
441 99 Adrian Georgescu
442 91 Luci Stanescu
 '''!__init!__'''(''self'', '''host''', '''user'''={{{None}}}, '''port'''={{{None}}}, '''display'''={{{None}}}, '''secure'''={{{False}}}, '''parameters'''={{{None}}}, '''headers'''={{{None}}})::
443 91 Luci Stanescu
  Creates the SIPURI object with the specified parameters as attributes.
444 91 Luci Stanescu
  {{{host}}} is the only mandatory attribute.
445 91 Luci Stanescu
  [[BR]]''host'':[[BR]]
446 91 Luci Stanescu
  The host part of the SIP URI as a string.
447 91 Luci Stanescu
  [[BR]]''user'':[[BR]]
448 91 Luci Stanescu
  The username part of the SIP URI as a string, or None if not set.
449 91 Luci Stanescu
  [[BR]]''port'':[[BR]]
450 91 Luci Stanescu
  The port part of the SIP URI as an int, or None or 0 if not set.
451 91 Luci Stanescu
  [[BR]]''display'':[[BR]]
452 91 Luci Stanescu
  The optional display name of the SIP URI as a string, or None if not set.
453 91 Luci Stanescu
  [[BR]]''secure'':[[BR]]
454 91 Luci Stanescu
  A boolean indicating whether this is a SIP or SIPS URI, the latter being indicated by a value of {{{True}}}.
455 91 Luci Stanescu
  [[BR]]''parameters'':[[BR]]
456 91 Luci Stanescu
  The URI parameters. represented by a dictionary.
457 91 Luci Stanescu
  [[BR]]''headers'':[[BR]]
458 91 Luci Stanescu
  The URI headers, represented by a dictionary.
459 99 Adrian Georgescu
460 91 Luci Stanescu
 '''!__str!__'''(''self'')::
461 91 Luci Stanescu
  The special Python method to represent this object as a string, the output is the properly formatted SIP URI.
462 99 Adrian Georgescu
463 91 Luci Stanescu
 '''new'''(''cls'', ''sipuri'')::
464 91 Luci Stanescu
  Classmethod that returns an instance of the class on which it has been called which is a copy of the {{{sipuri}}} object (which must be either a SIPURI or a FrozenSIPURI).
465 99 Adrian Georgescu
466 91 Luci Stanescu
 '''parse'''(''cls'', ''uri_str'')::
467 91 Luci Stanescu
  Classmethod that returns an instance of the class on which it has been called which is represents the parsed version of the URI provided as a string. A SIPCoreError is raised if the string is invalid or if the Engine has not been started yet.
468 91 Luci Stanescu
469 104 Luci Stanescu
 '''matches'''(''self'', ''address'')::
470 104 Luci Stanescu
  This method returns {{{True}}} or {{{False}}} depending on whether the string address contains a SIP address whose components are a subset of the components of self. For example, {{{SIPURI.parse('sip:alice@example.org:54321;transport=tls').matches('alice@example.org')}}} returns {{{True}}} while {{{SIPURI.parse('sip:alice@example.org;transport=tls').matches('sips:alice@example.org')}}} returns {{{False}}}.
471 104 Luci Stanescu
472 96 Luci Stanescu
=== Credentials ===
473 91 Luci Stanescu
474 96 Luci Stanescu
The {{{Credentials}}} and {{{FrozenCredentails}}} simple objects represent authentication credentials for a particular SIP account.
475 91 Luci Stanescu
These can be included whenever creating a SIP primitive object that originates SIP requests.
476 96 Luci Stanescu
The attributes of this object are the same as the arguments to the {{{__init__}}} method.
477 91 Luci Stanescu
Note that the domain name of the SIP account is not stored on this object.
478 91 Luci Stanescu
479 91 Luci Stanescu
==== methods ====
480 91 Luci Stanescu
481 99 Adrian Georgescu
482 91 Luci Stanescu
 '''!__init!__'''(''self'', '''username''', '''password''')::
483 91 Luci Stanescu
  Creates the Credentials object with the specified parameters as attributes.
484 91 Luci Stanescu
  Each of these attributes can be accessed and changed on the object once instanced.
485 91 Luci Stanescu
  [[BR]]''username'':[[BR]]
486 91 Luci Stanescu
  A string representing the username of the account for which these are the credentials.
487 91 Luci Stanescu
  [[BR]]''password'':[[BR]]
488 91 Luci Stanescu
  The password for this SIP account as a string.
489 99 Adrian Georgescu
490 91 Luci Stanescu
 '''new'''(''cls'', ''credentials'')::
491 91 Luci Stanescu
  Classmethod that returns an instance of the class on which it has been called which is a copy of the {{{credentials}}} object (which must be either a Credentials or a FrozenCredentials).
492 91 Luci Stanescu
493 103 Adrian Georgescu
=== Invitation ===
494 103 Adrian Georgescu
495 103 Adrian Georgescu
The {{{Invitation}}} class represents an {{{INVITE}}} session, which governs a complete session of media exchange between two SIP endpoints from start to finish.
496 103 Adrian Georgescu
It is implemented to be agnostic to the media stream or streams negotiated, which is achieved by using the {{{SDPSession}}} class and its companion classes, which directly represents the parsed SDP.
497 103 Adrian Georgescu
The {{{Invitation}}} class represents both incoming and outgoing sessions.
498 103 Adrian Georgescu
499 103 Adrian Georgescu
The state machine contained in each {{{Invitation}}} object is based on the one used by the underlying PJSIP [http://www.pjsip.org/pjsip/docs/html/group__PJSIP__INV.htm pjsip_inv_session] object.
500 103 Adrian Georgescu
In order to represent re-{{{INVITE}}}s and user-requested disconnections, three more states have been added to this state machine.
501 103 Adrian Georgescu
The progression through this state machine is fairly linear and is dependent on whether this is an incoming or an outgoing session.
502 103 Adrian Georgescu
State changes are triggered either by incoming or by outgoing SIP requests and responses.
503 103 Adrian Georgescu
The states and the transitions between them are shown in the following diagram:
504 103 Adrian Georgescu
505 103 Adrian Georgescu
[[Image(sipsimple-core-invite-state-machine.png, nolink)]]
506 103 Adrian Georgescu
507 103 Adrian Georgescu
The state changes of this machine are triggered by the following:
508 103 Adrian Georgescu
 1. An {{{Invitation}}} object is newly created, either by the application for an outgoing session, or by the core for an incoming session.
509 103 Adrian Georgescu
 2. The application requested an outgoing session by calling the {{{send_invite()}}} method and and initial {{{INVITE}}} request is sent.
510 103 Adrian Georgescu
 3. A new incoming session is received by the core.
511 103 Adrian Georgescu
    The application should look out for state change to this state in order to be notified of new incoming sessions.
512 103 Adrian Georgescu
 4. A provisional response (1xx) is received from the remove party.
513 103 Adrian Georgescu
 5. A provisional response (1xx) is sent to the remote party, after the application called the {{{respond_to_invite_provisionally()}}} method.
514 103 Adrian Georgescu
 6. A positive final response (2xx) is received from the remote party.
515 103 Adrian Georgescu
 7. A positive final response (2xx) is sent to the remote party, after the application called the {{{accept_invite()}}} method.
516 103 Adrian Georgescu
 8. A positive final response (2xx) is sent or received, depending on the orientation of the session.
517 103 Adrian Georgescu
 9. An {{{ACK}}} is sent or received, depending on the orientation of the session.
518 103 Adrian Georgescu
    If the {{{ACK}}} is sent from the local to the remote party, it is initiated by PJSIP, not by a call from the application.
519 103 Adrian Georgescu
 10. The local party sent a re-{{{INVITE}}} to the remote party by calling the {{{send_reinvite()}}} method.
520 103 Adrian Georgescu
 11. The remote party has sent a final response to the re-{{{INVITE}}}.
521 103 Adrian Georgescu
 12. The remote party has sent a re-{{{INVITE}}}.
522 103 Adrian Georgescu
 13. The local party has responded to the re-{{{INVITE}}} by calling the {{{respond_to_reinvite()}}} method.
523 103 Adrian Georgescu
 14. The application requests that the session ends by calling the {{{end()}}} method.
524 103 Adrian Georgescu
 15. A response is received from the remote party to whichever message was sent by the local party to end the session.
525 103 Adrian Georgescu
 16. A message is received from the remote party which ends the session.
526 103 Adrian Georgescu
527 103 Adrian Georgescu
The application is notified of a state change in either state machine through the {{{SIPInvitationChangedState}}} notification, which has as data the current and previous states.
528 103 Adrian Georgescu
If the event is triggered by and incoming message, extensive data about that message, such as method/code, headers and body, is also included with the notification.
529 103 Adrian Georgescu
The application should compare the previous and current states and perform the appropriate action.
530 103 Adrian Georgescu
531 103 Adrian Georgescu
An {{{Invitiation}}} object also emits the {{{SIPInvitationGotSDPUpdate}}} notification, which indicates that SDP negotiation between the two parties has been completed.
532 103 Adrian Georgescu
This will occur (at least) once during the initial session negotiation steps, during re-{{{INVITE}}}s in both directions and whenever an {{{UPDATE}}} request is received.
533 103 Adrian Georgescu
In the last case, the {{{Invitation}}} object will automatically include the current local SDP in the response.
534 103 Adrian Georgescu
535 103 Adrian Georgescu
==== attributes ====
536 103 Adrian Georgescu
537 103 Adrian Georgescu
538 103 Adrian Georgescu
 '''state'''::
539 103 Adrian Georgescu
  The state the {{{Invitation}}} state machine is currently in.
540 103 Adrian Georgescu
  See the diagram above for possible states.
541 103 Adrian Georgescu
  This attribute is read-only.
542 103 Adrian Georgescu
543 103 Adrian Georgescu
 '''sub_state'''::
544 103 Adrian Georgescu
  The sub-state the {{{Invitation}}} state machine is currently in.
545 103 Adrian Georgescu
  See the diagram above for possible states.
546 103 Adrian Georgescu
  This attribute is read-only.
547 103 Adrian Georgescu
548 103 Adrian Georgescu
 '''directing'''::
549 103 Adrian Georgescu
  A string with the values {{{"incoming"}}} or {{{"outgoing"}}} depending on the direction of the original INVITE request.
550 103 Adrian Georgescu
551 103 Adrian Georgescu
 '''credentials'''::
552 103 Adrian Georgescu
  The SIP credentials needed to authenticate at the SIP proxy in the form of a {{{FrozenCredentials}}} object.
553 103 Adrian Georgescu
  If this {{{Invitation}}} object represents an incoming {{{INVITE}}} session this attribute will be {{{None}}}.
554 103 Adrian Georgescu
  On an outgoing session this attribute will be {{{None}}} if it was not specified when the object was created.
555 103 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
556 103 Adrian Georgescu
557 103 Adrian Georgescu
 '''from_header'''::
558 103 Adrian Georgescu
  The From header of the caller represented by a {{{FrozenFromHeader}}} object.
559 103 Adrian Georgescu
  If this is an outgoing {{{INVITE}}} session, this is the from_header from the {{{send_invite()}}} method.
560 103 Adrian Georgescu
  Otherwise the URI is taken from the {{{From:}}} header of the initial {{{INVITE}}}.
561 103 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
562 103 Adrian Georgescu
563 103 Adrian Georgescu
 '''to_header'''::
564 103 Adrian Georgescu
  The To header of the callee represented by a {{{FrozenToHeader}}} object.
565 103 Adrian Georgescu
  If this is an outgoing {{{INVITE}}} session, this is the to_header from the {{{send_invite()}}} method.
566 103 Adrian Georgescu
  Otherwise the URI is taken from the {{{To:}}} header of the initial {{{INVITE}}}.
567 103 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
568 103 Adrian Georgescu
569 103 Adrian Georgescu
 '''local_identity'''::
570 103 Adrian Georgescu
  The From or To header representing the local identity used in this session.
571 103 Adrian Georgescu
  If the original {{{INVITE}}} was incoming, this is the same as {{{to_header}}}, otherwise it will be the same as {{{from_header}}}.
572 103 Adrian Georgescu
573 103 Adrian Georgescu
 '''remote_identity'''::
574 103 Adrian Georgescu
  The From or To header representing the remote party in this session.
575 103 Adrian Georgescu
  If the original {{{INVITE}}} was incoming, this is the same as {{{from_header}}}, otherwise it will be the same as {{{to_header}}}.
576 103 Adrian Georgescu
577 103 Adrian Georgescu
 '''route_header'''::
578 103 Adrian Georgescu
  The outbound proxy that was requested to be used in the form of a {{{FrozenRouteHeader}}} object, including the desired transport.
579 103 Adrian Georgescu
  If this {{{Invitation}}} object represents an incoming {{{INVITE}}} session this attribute will always be {{{None}}}.
580 103 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
581 103 Adrian Georgescu
582 103 Adrian Georgescu
 '''call_id'''::
583 103 Adrian Georgescu
  The call ID of the {{{INVITE}}} session as a read-only string.
584 103 Adrian Georgescu
  In the {{{NULL}}} and {{{DISCONNECTED}}} states, this attribute is {{{None}}}.
585 103 Adrian Georgescu
586 103 Adrian Georgescu
 '''transport'''::
587 103 Adrian Georgescu
  A string indicating the transport used for the application.
588 103 Adrian Georgescu
  This can be "udp", "tcp" or "tls".
589 103 Adrian Georgescu
590 103 Adrian Georgescu
 '''local_contact_header'''::
591 103 Adrian Georgescu
  The Contact header that the local side provided to the remote side within this {{{INVITE}}} session as a {{{FrozenContactHeader}}} object.
592 103 Adrian Georgescu
  Note that this can either be set on object creation or updated using the {{{send_reinvite()}}} method.
593 103 Adrian Georgescu
594 103 Adrian Georgescu
 '''call_id'''::
595 103 Adrian Georgescu
  A string representing the Call-Id header value of this INVITE dialog.
596 103 Adrian Georgescu
597 103 Adrian Georgescu
 '''remote_user_agent'''::
598 103 Adrian Georgescu
  A string representing the remote user agent taken from the User-Agent or Server headers (depending on the direction of the original INVITE).
599 103 Adrian Georgescu
600 103 Adrian Georgescu
 '''sdp.proposed_local'''::
601 103 Adrian Georgescu
  The currently proposed sdp by the local party in the form of a {{{FrozenSDPSession}}} object. This attribute is None when an SDP proposal is not in progress.
602 103 Adrian Georgescu
603 103 Adrian Georgescu
 '''sdp.proposed_remote'''::
604 103 Adrian Georgescu
  The currently proposed sdp by the remote party in the form of a {{{FrozenSDPSession}}} object. This attribute is None when an SDP proposal is not in progress.
605 103 Adrian Georgescu
606 103 Adrian Georgescu
 '''sdp.active_local'''::
607 103 Adrian Georgescu
  The currently active sdp of the local party in the form of a {{{FrozenSDPSession}}} object. This attribute is None if no SDP proposal has succeeded before.
608 103 Adrian Georgescu
609 103 Adrian Georgescu
 '''sdp.active_remote'''::
610 103 Adrian Georgescu
  The currently active sdp of the remote party in the form of a {{{FrozenSDPSession}}} object. This attribute is None if no SDP proposal has succeeded before.
611 103 Adrian Georgescu
612 103 Adrian Georgescu
==== methods ====
613 103 Adrian Georgescu
614 103 Adrian Georgescu
615 103 Adrian Georgescu
 '''!__init!__'''(''self'')::
616 103 Adrian Georgescu
  Creates a new {{{Invitation}}} object.
617 103 Adrian Georgescu
618 103 Adrian Georgescu
 '''send_invite'''(''self'', '''from_header''', '''to_header''', '''route_header''', '''contact_header''', '''sdp''', '''credentials'''={{{None}}}, '''extra_headers'''={{{[]}}}, '''timeout'''=None)::
619 103 Adrian Georgescu
  [[BR]]''from_header'':[[BR]]
620 103 Adrian Georgescu
  The identity of the local account in the form of a {{{FromHeader}}} object.
621 103 Adrian Georgescu
  [[BR]]''to_header'':[[BR]]
622 103 Adrian Georgescu
  The identity we want to send the {{{INVITE}}} to, represented as a {{{ToHeader}}} object.
623 103 Adrian Georgescu
  [[BR]]''route_header'':[[BR]]
624 103 Adrian Georgescu
  The outbound proxy to use in the form of a {{{RouteHeader}}} object.
625 103 Adrian Georgescu
  This includes the desired transport to use.
626 103 Adrian Georgescu
  [[BR]]''contact_header'':[[BR]]
627 103 Adrian Georgescu
  The Contact header to include in the {{{INVITE}}} request, a {{{ContactHeader}}} object.
628 103 Adrian Georgescu
  [[BR]]''sdp'':[[BR]]
629 103 Adrian Georgescu
  The SDP to send as offer to the remote party.
630 103 Adrian Georgescu
  [[BR]]''credentials'':[[BR]]
631 103 Adrian Georgescu
  The optional SIP credentials needed to authenticate at the SIP proxy in the form of a {{{Credentials}}} object.
632 103 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
633 103 Adrian Georgescu
  Any extra headers that should be included in the {{{INVITE}}} request in the form of a list of header objects.
634 103 Adrian Georgescu
  [[BR]]''timeout'':[[BR]]
635 103 Adrian Georgescu
  How many seconds to wait for the remote party to reply before changing the state to {{{DISCONNECTED}}} and internally replying with a 408, as an int or a float.
636 103 Adrian Georgescu
  If this is set to {{{None}}}, the default PJSIP timeout will be used, which appears to be slightly longer than 30 seconds.
637 103 Adrian Georgescu
638 103 Adrian Georgescu
 '''send_response'''(''self'', '''code''', '''reason''', '''contact_header''', '''sdp''', '''extra_headers''')::
639 103 Adrian Georgescu
  Send a response to a INVITE request. 
640 103 Adrian Georgescu
  [[BR]]''code'':[[BR]]
641 103 Adrian Georgescu
  The code of the response to use as an int.
642 103 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
643 103 Adrian Georgescu
  The reason of the response as a str.
644 103 Adrian Georgescu
  [[BR]]''contact_header'':[[BR]]
645 103 Adrian Georgescu
  The Contact header to include in the response, a {{{ContactHeader}}} object.
646 103 Adrian Georgescu
  [[BR]]''sdp'':[[BR]]
647 103 Adrian Georgescu
  The SDP to send as offer/response to the remote party.
648 103 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
649 103 Adrian Georgescu
  Any extra headers that should be included in the response in the form of a list of header objects.
650 103 Adrian Georgescu
651 103 Adrian Georgescu
 '''send_reinvite'''(''self'', '''contact_header'''={{{None}}}, '''sdp'''={{{None}}}, '''extra_header'''={{{[]}}})::
652 103 Adrian Georgescu
  [[BR]]''contact_header'':[[BR]]
653 103 Adrian Georgescu
  The Contact header if it needs to be changed by the re-INVITE or None if it shouldn't be changed; a {{{BaseContactHeader}}} object.
654 103 Adrian Georgescu
  [[BR]]''sdp'':[[BR]]
655 103 Adrian Georgescu
  The SDP to send as offer to the remote party or None if the re-INVITE should not change the SDP; a {{{BaseSDPSession}}} object.
656 103 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
657 103 Adrian Georgescu
  Any extra headers that should be included in the response in the form of a list of header objects.
658 103 Adrian Georgescu
659 103 Adrian Georgescu
 '''cancel_reinvite'''(''self'')::
660 103 Adrian Georgescu
  Send a CANCEL after a re-INVITE has been sent to cancel the action of the re-INVITE.
661 103 Adrian Georgescu
662 103 Adrian Georgescu
 '''end'''(''self'', '''extra_headers'''={{{[]}}}, '''timeout'''={{{None}}})::
663 103 Adrian Georgescu
  This moves the {{{INVITE}}} state machine into the {{{DISCONNECTING}}} state by sending the necessary SIP request.
664 103 Adrian Georgescu
  When a response from the remote party is received, the state machine will go into the {{{DISCONNECTED}}} state.
665 103 Adrian Georgescu
  Depending on the current state, this could be a CANCEL or a BYE request.
666 103 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
667 103 Adrian Georgescu
  Any extra headers that should be included in the request or response in the form of a dict.
668 103 Adrian Georgescu
  [[BR]]''timeout'':[[BR]]
669 103 Adrian Georgescu
  How many seconds to wait for the remote party to reply before changing the state to {{{DISCONNECTED}}}, as an int or a float.
670 103 Adrian Georgescu
  If this is set to {{{None}}}, the default PJSIP timeout will be used, which currently appears to be 3.5 seconds for an established session.
671 103 Adrian Georgescu
672 103 Adrian Georgescu
==== notifications ====
673 103 Adrian Georgescu
674 103 Adrian Georgescu
675 103 Adrian Georgescu
 '''SIPInvitationChangedState'''::
676 103 Adrian Georgescu
  This notification is sent by an {{{Invitation}}} object whenever its state machine changes state.
677 103 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
678 103 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
679 103 Adrian Georgescu
  [[BR]]''prev_state'':[[BR]]
680 103 Adrian Georgescu
  The previous state of the INVITE state machine.
681 103 Adrian Georgescu
  [[BR]]''prev_sub_state'':[[BR]]
682 103 Adrian Georgescu
  THe previous sub-state of the INVITE state machine.
683 103 Adrian Georgescu
  [[BR]]''state'':[[BR]]
684 103 Adrian Georgescu
  The new state of the INVITE state machine, which may be the same as the previous state.
685 103 Adrian Georgescu
  [[BR]]''sub_state'':[[BR]]
686 103 Adrian Georgescu
  The new sub-state of teh INVITE state machine, which may be the same as the previous sub-state.
687 103 Adrian Georgescu
  [[BR]]''method'': (only if the state change got triggered by an incoming SIP request)[[BR]]
688 103 Adrian Georgescu
  The method of the SIP request as a string.
689 103 Adrian Georgescu
  [[BR]]''request_uri'': (only if the state change got triggered by an incoming SIP request)[[BR]]
690 103 Adrian Georgescu
  The request URI of the SIP request as a {{{SIPURI}}} object.
691 103 Adrian Georgescu
  [[BR]]''code'': (only if the state change got triggered by an incoming SIP response or internal timeout or error)[[BR]]
692 103 Adrian Georgescu
  The code of the SIP response or error as an int.
693 103 Adrian Georgescu
  [[BR]]''reason'': (only if the state change got triggered by an incoming SIP response or internal timeout or error)[[BR]]
694 103 Adrian Georgescu
  The reason text of the SIP response or error as a string.
695 103 Adrian Georgescu
  [[BR]]''headers'': (only if the state change got triggered by an incoming SIP request or response)[[BR]]
696 103 Adrian Georgescu
  The headers of the SIP request or response as a dict.
697 103 Adrian Georgescu
  Each SIP header is represented in its parsed for as long as PJSIP supports it.
698 103 Adrian Georgescu
  The format of the parsed value depends on the header.
699 103 Adrian Georgescu
  [[BR]]''body'': (only if the state change got triggered by an incoming SIP request or response)[[BR]]
700 103 Adrian Georgescu
  The body of the SIP request or response as a string, or {{{None}}} if no body was included.
701 103 Adrian Georgescu
  The content type of the body can be learned from the {{{Content-Type:}}} header in the headers argument.
702 103 Adrian Georgescu
703 103 Adrian Georgescu
 '''SIPInvitationGotSDPUpdate'''::
704 103 Adrian Georgescu
  This notification is sent by an {{{Invitation}}} object whenever SDP negotiation has been performed.
705 103 Adrian Georgescu
  It should be used by the application as an indication to start, change or stop any associated media streams.
706 103 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
707 103 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
708 103 Adrian Georgescu
  [[BR]]''succeeded'':[[BR]]
709 103 Adrian Georgescu
  A boolean indicating if the SDP negotiation has succeeded.
710 103 Adrian Georgescu
  [[BR]]''error'': (only if SDP negotiation did not succeed)[[BR]]
711 103 Adrian Georgescu
  A string indicating why SDP negotiation failed.
712 103 Adrian Georgescu
  [[BR]]''local_sdp'': (only if SDP negotiation succeeded)[[BR]]
713 103 Adrian Georgescu
  A SDPSession object indicating the local SDP that was negotiated.
714 103 Adrian Georgescu
  [[BR]]''remote_sdp'': (only if SDP negotiation succeeded)[[BR]]
715 103 Adrian Georgescu
  A SDPSession object indicating the remote SDP that was negotiated.
716 103 Adrian Georgescu
717 103 Adrian Georgescu
718 92 Luci Stanescu
=== SDPSession ===
719 92 Luci Stanescu
720 92 Luci Stanescu
SDP stands for Session Description Protocol. Session Description Protocol (SDP) is a format for describing streaming media initialization parameters in an ASCII string. SDP is intended for describing multimedia communication sessions for the purposes of session announcement, session invitation, and other forms of multimedia session initiation. It is an IETF standard described by [http://tools.ietf.org/html/rfc4566 RFC 4566]. [http://tools.ietf.org/html/rfc3264 RFC 3264] defines an Offer/Answer Model with the Session Description Protocol (SDP), a mechanism by which two entities can make use of the Session Description Protocol (SDP) to arrive at a common view of a multimedia session between them. 
721 92 Luci Stanescu
722 92 Luci Stanescu
{{{SDPSession}}} and {{{FrozenSDPSession}}} objects directly represent the contents of a SDP body, as carried e.g. in an INVITE request, and is a simple wrapper for the PJSIP [http://www.pjsip.org/pjmedia/docs/html/structpjmedia__sdp__session.htm pjmedia_sdp_session] structure.
723 92 Luci Stanescu
They can be passed to those methods of an {{{Invitation}}} object that result in transmission of a message that includes SDP, or are passed to the application through a notification that is triggered by reception of a message that includes SDP.
724 92 Luci Stanescu
A {{{(Frozen)SDPSession}}} object may contain {{{(Frozen)SDPMediaStream}}}, {{{(Frozen)SDPConnection}}} and {{{(Frozen)SDPAttribute}}} objects.
725 92 Luci Stanescu
It supports comparison to other {{{(Frozen)SDPSession}}} objects using the == and != expressions.
726 92 Luci Stanescu
As all the attributes of the {{{(Frozen)SDPSession}}} class are set by attributes of the {{{__init__}}} method, they will be documented along with that method.
727 99 Adrian Georgescu
728 92 Luci Stanescu
==== methods ====
729 92 Luci Stanescu
730 92 Luci Stanescu
731 92 Luci Stanescu
 '''!__init!__'''(''self'', '''address''', '''id'''={{{None}}}, '''version'''={{{None}}}, '''user='''"-", net_type="IN", '''address_type'''="IP4", '''name'''=" ", '''info'''={{{None}}}, '''connection'''={{{None}}}, '''start_time'''=0, '''stop_time'''=0, '''attributes'''={{{None}}}, '''media'''={{{None}}})::
732 92 Luci Stanescu
  Creates the SDPSession object with the specified parameters as attributes.
733 92 Luci Stanescu
  Each of these attributes can be accessed and changed on the object once instanced.
734 92 Luci Stanescu
  [[BR]]''address'':[[BR]]
735 99 Adrian Georgescu
  The address that is contained in the "o" (origin) line of the SDP as a string.
736 92 Luci Stanescu
  [[BR]]''id'':[[BR]]
737 92 Luci Stanescu
  The session identifier contained in the "o" (origin) line of the SDP as an int.
738 99 Adrian Georgescu
  If this is set to {{{None}}} on init, a session identifier will be generated.
739 92 Luci Stanescu
  [[BR]]''version'':[[BR]]
740 92 Luci Stanescu
  The version identifier contained in the "o" (origin) line of the SDP as an int.
741 92 Luci Stanescu
  If this is set to {{{None}}} on init, a version identifier will be generated.
742 92 Luci Stanescu
  [[BR]]''user'':[[BR]]
743 92 Luci Stanescu
  The user name contained in the "o" (origin) line of the SDP as a string.
744 99 Adrian Georgescu
  [[BR]]''net_type'':[[BR]]
745 92 Luci Stanescu
  The network type contained in the "o" (origin) line of the SDP as a string.
746 92 Luci Stanescu
  [[BR]]''address_type'':[[BR]]
747 92 Luci Stanescu
  The address type contained in the "o" (origin) line of the SDP as a string.
748 99 Adrian Georgescu
  [[BR]]''name'':[[BR]]
749 92 Luci Stanescu
  The contents of the "s" (session name) line of the SDP as a string.
750 92 Luci Stanescu
  [[BR]]''info'':[[BR]]
751 92 Luci Stanescu
  The contents of the session level "i" (information) line of the SDP as a string.
752 99 Adrian Georgescu
  If this is {{{None}}} or an empty string, the SDP has no "i" line.
753 92 Luci Stanescu
  [[BR]]''connection'':[[BR]]
754 92 Luci Stanescu
  The contents of the "c" (connection) line of the SDP as a {{{(Frozen)SDPConnection}}} object.
755 92 Luci Stanescu
  If this is set to {{{None}}}, the SDP has no session level "c" line.
756 99 Adrian Georgescu
  [[BR]]''start_time'':[[BR]]
757 92 Luci Stanescu
  The first value of the "t" (time) line of the SDP as an int.
758 92 Luci Stanescu
  [[BR]]''stop_time'':[[BR]]
759 92 Luci Stanescu
  The second value of the "t" (time) line of the SDP as an int.
760 99 Adrian Georgescu
  [[BR]]''attributes'':[[BR]]
761 92 Luci Stanescu
  The session level "a" lines (attributes) in the SDP represented by a list of {{{(Frozen)SDPAttribute}}} objects.
762 92 Luci Stanescu
  [[BR]]''media'':[[BR]]
763 92 Luci Stanescu
  The media sections of the SDP represented by a list of {{{(Frozen)SDPMediaStream}}} objects.
764 92 Luci Stanescu
765 92 Luci Stanescu
 '''new'''(''cls'', ''sdp_session'')::
766 99 Adrian Georgescu
  Classmethod that returns an instance of the class on which it has been called which is a copy of the {{{sdp_session}}} object (which must be either a SDPSession or a FrozenSDPSession).
767 92 Luci Stanescu
768 92 Luci Stanescu
==== attributes ====
769 92 Luci Stanescu
770 92 Luci Stanescu
771 92 Luci Stanescu
 '''has_ice_proposal'''::
772 92 Luci Stanescu
  This read-only attribute returns {{{True}}} if the SDP contains any attributes which indicate the existence of an ice proposal and {{{False}}} otherwise.
773 92 Luci Stanescu
774 92 Luci Stanescu
=== SDPMediaStream ===
775 92 Luci Stanescu
776 92 Luci Stanescu
The {{{SDPMediaStream}}} and {{{FrozenSDPMediaStream}}} objects represent the contents of a media section of a SDP body, i.e. a "m" line and everything under it until the next "m" line.
777 92 Luci Stanescu
It is a simple wrapper for the PJSIP [http://www.pjsip.org/pjmedia/docs/html/structpjmedia__sdp__media.htm pjmedia_sdp_media] structure.
778 92 Luci Stanescu
One or more {{{(Frozen)SDPMediaStream}}} objects are usually contained in a {{{(Frozen)SDPSession}}} object.
779 92 Luci Stanescu
It supports comparison to other {{{(Frozen)SDPMedia}}} objects using the == and != expressions.
780 92 Luci Stanescu
As all the attributes of this class are set by attributes of the {{{__init__}}} method, they will be documented along with that method.
781 92 Luci Stanescu
782 92 Luci Stanescu
==== methods ====
783 92 Luci Stanescu
784 92 Luci Stanescu
785 99 Adrian Georgescu
 '''!__init!__'''(''self'', '''media''', '''port''', '''transport''', '''port_count'''=1, '''formats'''={{{None}}}, '''info'''={{{None}}}, '''connection'''={{{None}}}, '''attributes'''={{{None}}})::
786 92 Luci Stanescu
  Creates the SDPMedia object with the specified parameters as attributes.
787 92 Luci Stanescu
  Each of these attributes can be accessed and changed on the object once instanced.
788 92 Luci Stanescu
  [[BR]]''media'':[[BR]]
789 92 Luci Stanescu
  The media type contained in the "m" (media) line as a string.
790 92 Luci Stanescu
  [[BR]]''port'':[[BR]]
791 92 Luci Stanescu
  The transport port contained in the "m" (media) line as an int.
792 92 Luci Stanescu
  [[BR]]''transport'':[[BR]]
793 99 Adrian Georgescu
  The transport protocol in the "m" (media) line as a string.
794 92 Luci Stanescu
  [[BR]]''port_count'':[[BR]]
795 92 Luci Stanescu
  The port count in the "m" (media) line as an int.
796 99 Adrian Georgescu
  If this is set to 1, it is not included in the SDP.
797 92 Luci Stanescu
  [[BR]]''formats'':[[BR]]
798 92 Luci Stanescu
  The media formats in the "m" (media) line represented by a list of strings.
799 92 Luci Stanescu
  [[BR]]''info'':[[BR]]
800 92 Luci Stanescu
  The contents of the "i" (information) line of this media section as a string.
801 92 Luci Stanescu
  If this is {{{None}}} or an empty string, the media section has no "i" line.
802 99 Adrian Georgescu
  [[BR]]''connection'':[[BR]]
803 92 Luci Stanescu
  The contents of the "c" (connection) line that is somewhere below the "m" line of this section as a {{{(Frozen)SDPConnection}}} object.
804 92 Luci Stanescu
  If this is set to {{{None}}}, this media section has no "c" line.
805 92 Luci Stanescu
  [[BR]]''attributes'':[[BR]]
806 99 Adrian Georgescu
  The "a" lines (attributes) that are somewhere below the "m" line of this section represented by a list of {{{(Frozen)SDPAttribute}}} objects.
807 92 Luci Stanescu
808 92 Luci Stanescu
 '''new'''(''cls'', ''sdp_media'')::
809 92 Luci Stanescu
  Classmethod that returns an instance of the class on which it has been called which is a copy of the {{{sdp_media}}} object (which must be either a SDPMediaStream or a FrozenSDPMediaStream).
810 99 Adrian Georgescu
811 92 Luci Stanescu
==== attributes ====
812 92 Luci Stanescu
813 92 Luci Stanescu
814 99 Adrian Georgescu
 '''direction'''::
815 92 Luci Stanescu
  This is a convenience read-only attribute that goes through all the attributes of the media section and returns the direction, which is either "sendrecv", "sendonly", "recvonly" or "inactive".
816 92 Luci Stanescu
  If none of these attributes is present, the default direction is "sendrecv".
817 92 Luci Stanescu
818 92 Luci Stanescu
=== SDPConnection ===
819 92 Luci Stanescu
820 92 Luci Stanescu
The {{{SDPConnection}}} and {{{FrozenSDPConnection}}} objects represents the contents of a "c" (connection) line of a SDP body, either at the session level or for an individual media stream.
821 92 Luci Stanescu
It is a simple wrapper for the PJSIP [http://www.pjsip.org/pjmedia/docs/html/structpjmedia__sdp__conn.htm pjmedia_sdp_conn] structure.
822 92 Luci Stanescu
A {{{(Frozen)SDPConnection}}} object can be contained in a {{{(Frozen)SDPSession}}} object or {{{(Frozen)SDPMediaStream}}} object.
823 92 Luci Stanescu
It supports comparison to other {{{(Frozen)SDPConnection}}} objects using the == and != expressions.
824 92 Luci Stanescu
As all the attributes of this class are set by attributes of the {{{__init__}}} method, they will be documented along with that method.
825 92 Luci Stanescu
826 92 Luci Stanescu
==== methods ====
827 92 Luci Stanescu
828 92 Luci Stanescu
829 99 Adrian Georgescu
 '''!__init!__'''(''self'', '''address''', '''net_type'''="IN", '''address_type'''="IP4")::
830 92 Luci Stanescu
  Creates the SDPConnection object with the specified parameters as attributes.
831 92 Luci Stanescu
  Each of these attributes can be accessed and changed on the object once instanced.
832 92 Luci Stanescu
  [[BR]]''address'':[[BR]]
833 92 Luci Stanescu
  The address part of the connection line as a string.
834 99 Adrian Georgescu
  [[BR]]''net_type'':[[BR]]
835 92 Luci Stanescu
  The network type part of the connection line as a string.
836 92 Luci Stanescu
  [[BR]]''address_type'':[[BR]]
837 99 Adrian Georgescu
  The address type part of the connection line as a string.
838 92 Luci Stanescu
839 92 Luci Stanescu
 '''new'''(''cls'', ''sdp_connection'')::
840 99 Adrian Georgescu
  Classmethod that returns an instance of the class on which it has been called which is a copy of the {{{sdp_connection}}} object (which must be either a SDPConnection or a FrozenSDPConnection).
841 92 Luci Stanescu
842 92 Luci Stanescu
=== SDPAttributeList ===
843 92 Luci Stanescu
844 92 Luci Stanescu
{{{SDPAttributeList}}} and {{{FrozenSDPAttributeList}}} are subclasses of {{{list}}} and {{{frozenlist}}} respectively and are used as the types of the {{{attributes}}} attributes of {{{(Frozen)SDPSession}}} and {{{(Frozen)SDPMediaStream}}}. They provide convinience methods for accessing SDP attributes. Apart from the standard {{{list}}} and {{{frozenlist}}} methods, they also provide the following:
845 92 Luci Stanescu
846 92 Luci Stanescu
847 99 Adrian Georgescu
 '''!__contains!__'''(''self'', ''item'')::
848 92 Luci Stanescu
  If ''item'' is an instance of BaseSDPAttribute, the normal {{{(frozen)list}}} method is called. Otherwise, the method returns whether or not ''item'' is in the list of the names of the attributes. This allows tests such as the following to be possible:
849 92 Luci Stanescu
  {{{
850 92 Luci Stanescu
  'ice-pwd' in sdp_session.attributes
851 92 Luci Stanescu
  }}}
852 92 Luci Stanescu
853 92 Luci Stanescu
 '''getall'''(''self'', ''name'')::
854 92 Luci Stanescu
  Returns all the values of the attributes with the given name in a list.
855 99 Adrian Georgescu
856 92 Luci Stanescu
 '''getfirst'''(''self'', ''name'', ''default''={{{None}}})::
857 92 Luci Stanescu
  Return the first value of the attribute with the given name, or ''default'' is no such attribute exists.
858 92 Luci Stanescu
859 99 Adrian Georgescu
=== SDPAttribute ===
860 92 Luci Stanescu
861 92 Luci Stanescu
The {{{SDPAttribute}}} and {{{FrozenSDPAttribute}}} objects represent the contents of a "a" (attribute) line of a SDP body, either at the session level or for an individual media stream.
862 92 Luci Stanescu
It is a simple wrapper for the PJSIP [http://www.pjsip.org/pjmedia/docs/html/structpjmedia__sdp__attr.htm pjmedia_sdp_attr] structure.
863 99 Adrian Georgescu
One or more {{{(Frozen)SDPAttribute}}} objects can be contained in a {{{(Frozen)SDPSession}}} object or {{{(Frozen)SDPMediaStream}}} object.
864 92 Luci Stanescu
It supports comparison to other {{{(Frozen)SDPAttribute}}} objects using the == and != expressions.
865 92 Luci Stanescu
As all the attributes of this class are set by attributes of the {{{__init__}}} method, they will be documented along with that method.
866 92 Luci Stanescu
867 99 Adrian Georgescu
==== methods ====
868 92 Luci Stanescu
869 92 Luci Stanescu
870 99 Adrian Georgescu
 '''!__init!__'''(''self'', '''name''', '''value''')::
871 92 Luci Stanescu
  Creates the SDPAttribute object with the specified parameters as attributes.
872 92 Luci Stanescu
  Each of these attributes can be accessed and changed on the object once instanced.
873 92 Luci Stanescu
  [[BR]]''name'':[[BR]]
874 92 Luci Stanescu
  The name part of the attribute line as a string.
875 92 Luci Stanescu
  [[BR]]''value'':[[BR]]
876 99 Adrian Georgescu
  The value part of the attribute line as a string.
877 92 Luci Stanescu
878 92 Luci Stanescu
 '''new'''(''cls'', ''sdp_attribute'')::
879 92 Luci Stanescu
  Classmethod that returns an instance of the class on which it has been called which is a copy of the {{{sdp_attribute}}} object (which must be either a SDPAttribute or a FrozenSDPAttribute).
880 92 Luci Stanescu
881 92 Luci Stanescu
882 93 Luci Stanescu
=== RTPTransport ===
883 93 Luci Stanescu
884 93 Luci Stanescu
This object represents a transport for RTP media, the basis of which is a pair of UDP sockets, one for RTP and one for RTCP.
885 93 Luci Stanescu
Internally it wraps a [http://www.pjsip.org/pjmedia/docs/html/group__PJMEDIA__TRANSPORT.htm pjmedia_transport] object.
886 93 Luci Stanescu
Initially this object will only be used by the {{{AudioTransport}}} object, but in the future it can also be used for video and [wiki:RTTProposal Real-Time Text].
887 93 Luci Stanescu
For this reason the {{{AudioTransport}}} and {{{RTPTransport}}} are two distinct objects.
888 93 Luci Stanescu
889 93 Luci Stanescu
The {{{RTPTransport}}} object also allows support for ICE and SRTP functionality from PJSIP.
890 93 Luci Stanescu
Because these features are related to both the UDP transport and the SDP formatting, the SDP carried in SIP signaling message will need to "pass through" this object during the SDP negotiation.
891 93 Luci Stanescu
The code using this object, which in most cases will be the {{{AudioTransport}}} object, will need to call certain methods on the object at appropriate times.
892 93 Luci Stanescu
This process of SDP negotiation is represented by the internal state machine of the object, as shown in the following diagram:
893 93 Luci Stanescu
894 93 Luci Stanescu
> The Real-time Transport Protocol (or RTP) defines a standardized packet format for delivering audio and video over the Internet.
895 93 Luci Stanescu
> It was developed by the Audio-Video Transport Working Group of the IETF and published in [http://tools.ietf.org/html/rfc3550 RFC 3550].
896 93 Luci Stanescu
> RTP is used in streaming media systems (together with the RTSP) as well as in videoconferencing and push to talk systems.
897 93 Luci Stanescu
> For these it carries media streams controlled by Session Initiation Protocol (SIP) signaling protocols, making it the technical foundation of the Voice over IP industry.
898 93 Luci Stanescu
899 93 Luci Stanescu
[[Image(sipsimple-rtp-transport-state-machine.png, nolink)]]
900 93 Luci Stanescu
901 93 Luci Stanescu
State changes are triggered by the following events:
902 93 Luci Stanescu
 1. The application calls the {{{set_INIT()}}} method after object creation and ICE+STUN is not used.
903 93 Luci Stanescu
 2. The application calls the {{{set_INIT()}}} method after object creation and ICE+STUN is used.
904 93 Luci Stanescu
 3. A successful STUN response is received from the STUN server.
905 93 Luci Stanescu
 4. The {{{set_LOCAL()}}} method is called.
906 93 Luci Stanescu
 5. The {{{set_ESTABLISHED()}}} method is called.
907 93 Luci Stanescu
 6. The {{{set_INIT()}}} method is called while the object is in the {{{LOCAL}}} or {{{ESTABLISHED}}} state.
908 93 Luci Stanescu
 7. A method is called on the application, but in the meantime the {{{Engine}}} has stopped.
909 93 Luci Stanescu
    The object can no longer be used.
910 93 Luci Stanescu
 8. There was an error in getting the STUN candidates from the STUN server.
911 93 Luci Stanescu
912 93 Luci Stanescu
> It would make sense to be able to use the object even if the STUN request fails (and have ICE not include a STUN candidate), but for some reason the pjmedia_transport is unusable once STUN negotiation has failed.
913 93 Luci Stanescu
> This means that the RTPTransport object is also unusable once it has reached the STUN_FAILED state.
914 93 Luci Stanescu
> A workaround would be destroy the RTPTransport object and create a new one that uses ICE without STUN.
915 93 Luci Stanescu
916 93 Luci Stanescu
These states allow for two SDP negotiation scenarios to occur, represented by two paths that can be followed through the state machine.
917 93 Luci Stanescu
In this example we will assume that ICE with STUN is not used, as it is independent of the SDP negotiation procedure.
918 93 Luci Stanescu
 * The first scenario is where the local party generates the SDP offer.
919 93 Luci Stanescu
   For a stream that it wishes to include in this SDP offer, it instantiates a {{{RTPTransport}}} object.
920 93 Luci Stanescu
   After instantiation the object is initialized by calling the {{{set_INIT()}}} method and the local RTP address and port can be fetched from it using the {{{local_rtp_address}}} and {{{local_rtp_port}}} attributes respectively, which can be used to generate the local SDP in the form of a {{{SDPSession}}} object.
921 93 Luci Stanescu
   This local SDP then needs to be passed to the {{{set_LOCAL()}}} method, which moves the state machine into the {{{LOCAL}}} state (note that it needs the full object, not just the relevant {{{SDPMediaStream}}} object).
922 93 Luci Stanescu
   Depending on the options used for the {{{RTPTransport}}} instantiation (such as ICE and SRTP), this may change the {{{SDPSession}}} object.
923 93 Luci Stanescu
   This (possibly changed) {{{SDPSession}}} object then needs to be passed to the {{{Invitation}}} object.
924 93 Luci Stanescu
   After SDP negotiation is completed, the application needs to pass both the local and remote SDP, in the form of {{{(Frozen)SDPSession}}} objects, to the {{{RTPTransport}}} object using the {{{set_ESTABLISHED()}}} method, moving the state machine into the {{{ESTABLISHED}}} state.
925 93 Luci Stanescu
   This will not change either of the {{{(Frozen)SDPSession}}} objects (which is why they can also be frozen).
926 93 Luci Stanescu
 * The second scenario is where the local party is offered a media stream in SDP and wants to accept it.
927 93 Luci Stanescu
   In this case a {{{RTPTransport}}} is also instantiated and initialized using the {{{set_INIT()}}} method, and the application can generate the local SDP in response to the remote SDP, using the {{{local_rtp_address}}} and {{{local_rtp_port}}} attributes.
928 93 Luci Stanescu
   Directly after this it should pass the generated local SDP and received remote SDP, in the form of {{{SDPSession}}} objects, to the {{{set_ESTABLISHED()}}} method.
929 93 Luci Stanescu
   In this case the local SDP object may be changed, after which it can be passed to the {{{Invitation}}} object.
930 93 Luci Stanescu
931 93 Luci Stanescu
Whenever the {{{RTPTransport}}} object is in the {{{LOCAL}}} or {{{ESTABLISHED}}} states, it may be reset to the {{{INIT}}} state to facilitate re-use of the existing transport and its features.
932 93 Luci Stanescu
Before doing this however, the internal transport object must no longer be in use.
933 93 Luci Stanescu
934 93 Luci Stanescu
==== methods ====
935 93 Luci Stanescu
936 99 Adrian Georgescu
937 93 Luci Stanescu
 '''!__init!__'''(''self'', '''local_rtp_address'''={{{None}}}, '''use_srtp'''={{{False}}}, '''srtp_forced'''={{{False}}}, '''use_ice'''={{{False}}}, '''ice_stun_address'''={{{None}}}, '''ice_stun_port'''=3478)::
938 93 Luci Stanescu
  Creates a new {{{RTPTransport}}} object and opens the RTP and RTCP UDP sockets.
939 93 Luci Stanescu
  If additional features are requested, they will be initialized.
940 93 Luci Stanescu
  After object instantiation, it is either in the {{{INIT}}} or the {{{WAIT_STUN}}} state, depending on the values of the {{{use_ice}}} and {{{ice_stun_address}}} arguments.
941 93 Luci Stanescu
  [[BR]]''local_rtp_address'':[[BR]]
942 93 Luci Stanescu
  Optionally contains the local IPv4 address to listen on.
943 93 Luci Stanescu
  If this is not specified, PJSIP will listen on all network interfaces.
944 93 Luci Stanescu
  [[BR]]''use_srtp'':[[BR]]
945 93 Luci Stanescu
  A boolean indicating if SRTP should be used.
946 93 Luci Stanescu
  If this is set to {{{True}}}, SRTP information will be added to the SDP when it passes this object.
947 93 Luci Stanescu
  [[BR]]''srtp_forced'':[[BR]]
948 93 Luci Stanescu
  A boolean indicating if use of SRTP is set to mandatory in the SDP.
949 93 Luci Stanescu
  If this is set to {{{True}}} and the remote party does not support SRTP, the SDP negotiation for this stream will fail.
950 93 Luci Stanescu
  This argument is relevant only if {{{use_srtp}}} is set to {{{True}}}.
951 93 Luci Stanescu
  [[BR]]''use_ice'':[[BR]]
952 93 Luci Stanescu
  A boolean indicating if ICE should be used.
953 93 Luci Stanescu
  If this is set to {{{True}}}, ICE candidates will be added to the SDP when it passes this object.
954 93 Luci Stanescu
  [[BR]]''ice_stun_address'':[[BR]]
955 93 Luci Stanescu
  A string indicating the address (IP address or hostname) of the STUN server that should be used to add a STUN candidate to the ICE candidates.
956 93 Luci Stanescu
  If this is set to {{{None}}} no STUN candidate will be added, otherwise the object will be put into the {{{WAIT_STUN}}} state until a reply, either positive or negative, is received from the specified STUN server.
957 93 Luci Stanescu
  When this happens a {{{RTPTransportGotSTUNResponse}}} notification is sent.
958 93 Luci Stanescu
  This argument is relevant only if {{{use_ice}}} is set to {{{True}}}.
959 93 Luci Stanescu
  [[BR]]''ice_stun_address'':[[BR]]
960 93 Luci Stanescu
  An int indicating the UDP port of the STUN server that should be used to add a STUN candidate to the ICE candidates.
961 93 Luci Stanescu
  This argument is relevant only if {{{use_ice}}} is set to {{{True}}} and {{{ice_stun_address}}} is not {{{None}}}.
962 99 Adrian Georgescu
963 93 Luci Stanescu
 '''set_INIT'''(''self'')::
964 93 Luci Stanescu
  This moves the internal state machine into the {{{INIT}}} state.
965 93 Luci Stanescu
  If the state machine is in the {{{LOCAL}}} or {{{ESTABLISHED}}} states, this effectively resets the {{{RTPTransport}}} object for re-use.
966 99 Adrian Georgescu
967 93 Luci Stanescu
 '''set_LOCAL'''(''self'', '''local_sdp''', '''sdp_index''')::
968 93 Luci Stanescu
  This moves the the internal state machine into the {{{LOCAL}}} state.
969 93 Luci Stanescu
  [[BR]]''local_sdp'':[[BR]]
970 93 Luci Stanescu
  The local SDP to be proposed in the form of a {{{SDPSession}}} object.
971 93 Luci Stanescu
  Note that this object may be modified by this method.
972 93 Luci Stanescu
  [[BR]]''sdp_index'':[[BR]]
973 93 Luci Stanescu
  The index in the SDP for the media stream for which this object was created.
974 99 Adrian Georgescu
975 93 Luci Stanescu
 '''set_ESTABLISHED'''(''self'', '''local_sdp''', '''remote_sdp''', '''sdp_index''')::
976 93 Luci Stanescu
  This moves the the internal state machine into the {{{ESTABLISHED}}} state.
977 93 Luci Stanescu
  [[BR]]''local_sdp'':[[BR]]
978 93 Luci Stanescu
  The local SDP to be proposed in the form of a {{{SDPSession}}} object.
979 93 Luci Stanescu
  Note that this object may be modified by this method, but only when moving from the {{{LOCAL}}} to the {{{ESTABLISHED}}} state.
980 93 Luci Stanescu
  [[BR]]''remote_sdp'':[[BR]]
981 93 Luci Stanescu
  The remote SDP that was received in in the form of a {{{SDPSession}}} object.
982 93 Luci Stanescu
  [[BR]]''sdp_index'':[[BR]]
983 93 Luci Stanescu
  The index in the SDP for the media stream for which this object was created.
984 93 Luci Stanescu
985 93 Luci Stanescu
==== attributes ====
986 93 Luci Stanescu
987 99 Adrian Georgescu
988 93 Luci Stanescu
 '''state'''::
989 93 Luci Stanescu
  Indicates which state the internal state machine is in.
990 93 Luci Stanescu
  See the previous section for a list of states the state machine can be in.
991 93 Luci Stanescu
  This attribute is read-only.
992 99 Adrian Georgescu
993 93 Luci Stanescu
 '''local_rtp_address'''::
994 93 Luci Stanescu
  The local IPv4 address of the interface the {{{RTPTransport}}} object is listening on and the address that should be included in the SDP.
995 93 Luci Stanescu
  If no address was specified during object instantiation, PJSIP will take guess out of the IP addresses of all interfaces.
996 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} if PJSIP is not listening on the transport.
997 99 Adrian Georgescu
998 93 Luci Stanescu
 '''local_rtp_port'''::
999 93 Luci Stanescu
  The UDP port PJSIP is listening on for RTP traffic.
1000 93 Luci Stanescu
  RTCP traffic will always be this port plus one.
1001 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} if PJSIP is not listening on the transport.
1002 99 Adrian Georgescu
1003 93 Luci Stanescu
 '''remote_rtp_address_sdp'''::
1004 93 Luci Stanescu
  The remote IP address that was seen in the SDP.
1005 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} unless the object is in the {{{ESTABLISHED}}} state.
1006 99 Adrian Georgescu
1007 93 Luci Stanescu
 '''remote_rtp_port_sdp'''::
1008 93 Luci Stanescu
  The remote UDP port for RTP that was seen in the SDP.
1009 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} unless the object is in the {{{ESTABLISHED}}} state.
1010 99 Adrian Georgescu
1011 93 Luci Stanescu
 '''remote_rtp_address_ice'''::
1012 93 Luci Stanescu
  The remote IP address that was selected by the ICE negotation.
1013 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} until the ICE negotation succeeds.
1014 99 Adrian Georgescu
1015 93 Luci Stanescu
 '''remote_rtp_port_ice'''::
1016 93 Luci Stanescu
  The remote port that was selected by the ICE negotation.
1017 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} until the ICE negotation succeeds.
1018 99 Adrian Georgescu
1019 93 Luci Stanescu
 '''remote_rtp_address_received'''::
1020 93 Luci Stanescu
  The remote IP address from which RTP data was received.
1021 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} unless RTP was actually received.
1022 99 Adrian Georgescu
1023 93 Luci Stanescu
 '''remote_rtp_port_received'''::
1024 93 Luci Stanescu
  The remote UDP port from which RTP data was received.
1025 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} unless RTP was actually received.
1026 99 Adrian Georgescu
1027 93 Luci Stanescu
 '''use_srtp'''::
1028 93 Luci Stanescu
  A boolean indicating if the use of SRTP was requested when the object was instantiated.
1029 93 Luci Stanescu
  This attribute is read-only.
1030 99 Adrian Georgescu
1031 93 Luci Stanescu
 '''force_srtp'''::
1032 93 Luci Stanescu
  A boolean indicating if SRTP being mandatory for this transport if it is enabled was requested when the object was instantiated.
1033 93 Luci Stanescu
  This attribute is read-only.
1034 99 Adrian Georgescu
1035 93 Luci Stanescu
 '''srtp_active'''::
1036 93 Luci Stanescu
  A boolean indicating if SRTP encryption and decryption is running.
1037 93 Luci Stanescu
  Querying this attribute only makes sense once the object is in the {{{ESTABLISHED}}} state and use of SRTP was requested.
1038 93 Luci Stanescu
  This attribute is read-only.
1039 99 Adrian Georgescu
1040 93 Luci Stanescu
 '''use_ice'''::
1041 93 Luci Stanescu
  A boolean indicating if the use of ICE was requested when the object was instantiated.
1042 93 Luci Stanescu
  This attribute is read-only.
1043 99 Adrian Georgescu
1044 93 Luci Stanescu
 '''ice_active''::
1045 93 Luci Stanescu
  A boolean indicating if ICE is being used.
1046 93 Luci Stanescu
  This attribute is read-only.
1047 99 Adrian Georgescu
1048 93 Luci Stanescu
 '''ice_stun_address'''::
1049 93 Luci Stanescu
  A string indicating the IP address of the STUN server that was requested to be used.
1050 93 Luci Stanescu
  This attribute is read-only.
1051 99 Adrian Georgescu
1052 93 Luci Stanescu
 '''ice_stun_port'''::
1053 93 Luci Stanescu
  A string indicating the UDP port of the STUN server that was requested to be used.
1054 93 Luci Stanescu
  This attribute is read-only.
1055 99 Adrian Georgescu
1056 93 Luci Stanescu
 '''local_rtp_candidate_type'''::
1057 93 Luci Stanescu
  Returns the ICE candidate type which has been selected for the local endpoint.
1058 99 Adrian Georgescu
1059 93 Luci Stanescu
 '''remote_rtp_candidate_type'''::
1060 93 Luci Stanescu
  Returns the ICE candidate type which has been selected for the remote endpoint.
1061 93 Luci Stanescu
1062 93 Luci Stanescu
==== notifications ====
1063 93 Luci Stanescu
1064 99 Adrian Georgescu
1065 93 Luci Stanescu
 '''RTPTransportDidInitialize'''::
1066 93 Luci Stanescu
  This notification is sent when a {{{RTPTransport}}} object has successfully initialized.
1067 93 Luci Stanescu
  If STUN+ICE is not requested, this is sent immediately on {{{set_INIT()}}}, otherwise it is sent after the STUN query has succeeded.
1068 93 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1069 93 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1070 99 Adrian Georgescu
1071 93 Luci Stanescu
 '''RTPTransportDidFail'''::
1072 93 Luci Stanescu
  This notification is sent by a {{{RTPTransport}}} object that fails to retrieve ICE candidates from the STUN server after {{{set_INIT()}}} is called.
1073 93 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1074 93 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1075 93 Luci Stanescu
  [[BR]]''reason'':[[BR]]
1076 93 Luci Stanescu
  A string describing the failure reason.
1077 99 Adrian Georgescu
1078 93 Luci Stanescu
 '''RTPTransportICENegotiationStateDidChange'''::
1079 93 Luci Stanescu
  This notification is sent to indicate the progress of the ICE negotiation.
1080 93 Luci Stanescu
  [[BR]]''state'':[[BR]]
1081 93 Luci Stanescu
  A string describing the current ICE negotiation state.
1082 99 Adrian Georgescu
1083 93 Luci Stanescu
 '''RTPTransportICENegotiationDidFail'''::
1084 93 Luci Stanescu
  This notification is sent when the ICE negotiation fails.
1085 93 Luci Stanescu
  [[BR]]''reason'':[[BR]]
1086 93 Luci Stanescu
  A string describing the failure reason of ICE negotation.
1087 99 Adrian Georgescu
1088 93 Luci Stanescu
 '''RTPTransportICENegotiationDidSucceed'''::
1089 93 Luci Stanescu
  This notification is sent when the ICE negotation succeeds.
1090 93 Luci Stanescu
  [[BR]]''chosen_local_candidates'' and ''chosen_remote_candidates'':[[BR]]
1091 93 Luci Stanescu
  Dictionaries with the following keys:
1092 93 Luci Stanescu
   * rtp_cand_type: the type of the RTP candidate
1093 93 Luci Stanescu
   * rtp_cand_ip: the IP address of the RTP candidate
1094 93 Luci Stanescu
   * rtcp_cand_type: the type of the RTCP candidate
1095 93 Luci Stanescu
   * rtcp_cand_ip: the IP address of teh RTCP candidate
1096 93 Luci Stanescu
  [[BR]]''duration'':[[BR]]
1097 93 Luci Stanescu
  The amount of time the ICE negotiation took.
1098 93 Luci Stanescu
  [[BR]]''local_candidates'' and ''remote_candidates'':[[BR]]
1099 93 Luci Stanescu
  Lists of tuples with the following elements:
1100 93 Luci Stanescu
   * Item ID
1101 93 Luci Stanescu
   * Component ID
1102 93 Luci Stanescu
   * Address
1103 93 Luci Stanescu
   * Component Type
1104 93 Luci Stanescu
  [[BR]]''connectivity_checks_results'':[[BR]]
1105 93 Luci Stanescu
  A list of tuples with the following elements:
1106 93 Luci Stanescu
   * Item ID
1107 93 Luci Stanescu
   * Component ID
1108 93 Luci Stanescu
   * Source
1109 93 Luci Stanescu
   * Destination
1110 93 Luci Stanescu
   * Nomination
1111 93 Luci Stanescu
   * State
1112 93 Luci Stanescu
1113 93 Luci Stanescu
=== AudioTransport ===
1114 93 Luci Stanescu
1115 93 Luci Stanescu
This object represent an audio stream as it is transported over the network.
1116 93 Luci Stanescu
It contains an instance of {{{RTPTransport}}} and wraps a [http://www.pjsip.org/pjmedia/docs/html/group__PJMED__STRM.htm pjmedia_stream] object, which in turn manages the RTP encapsulation, RTCP session, audio codec and adaptive jitter buffer.
1117 93 Luci Stanescu
It also generates a {{{SDPMediaStream}}} object to be included in the local SDP.
1118 93 Luci Stanescu
1119 93 Luci Stanescu
The {{{AudioTransport}}} is an object that, once started, is connected to a {{{AudioMixer}}} instance, and both produces and consumes sound.
1120 93 Luci Stanescu
1121 93 Luci Stanescu
Like the {{{RTPTransport}}} object there are two usage scenarios.
1122 93 Luci Stanescu
 * In the first scenario, only the {{{RTPTransport}}} instance to be used is passed to the AudioTransport object.
1123 93 Luci Stanescu
   The application can then generate the {{{SDPMediaStream}}} object by calling the {{{get_local_media()}}} method and should include it in the SDP offer.
1124 93 Luci Stanescu
   Once the remote SDP is received, it should be set along with the complete local SDP by calling the {{{start()}}} method, which will start the audio stream.
1125 93 Luci Stanescu
   The stream can then be connected to the conference bridge.
1126 93 Luci Stanescu
 * In the other scenario the remote SDP is already known because it was received in an SDP offer and can be passed directly on object instantiation.
1127 93 Luci Stanescu
   The local {{{SDPMediaStream}}} object can again be generated by calling the {{{get_local_media()}}} method and is to be included in the SDP answer.
1128 93 Luci Stanescu
   The audio stream is started directly when the object is created.
1129 93 Luci Stanescu
1130 93 Luci Stanescu
Unlike the {{{RTPTransport}}} object, this object cannot be reused.
1131 93 Luci Stanescu
1132 93 Luci Stanescu
==== methods ====
1133 93 Luci Stanescu
1134 99 Adrian Georgescu
1135 93 Luci Stanescu
 '''!__init!__'''(''self'', '''mixer''', '''transport''', '''remote_sdp'''={{{None}}}, '''sdp_index'''=0, '''enable_silence_detection'''=True, '''codecs'''={{{None}}})::
1136 93 Luci Stanescu
  Creates a new {{{AudioTransport}}} object and start the underlying stream if the remote SDP is already known.
1137 93 Luci Stanescu
  [[BR]]''mixer'':[[BR]]
1138 93 Luci Stanescu
  The {{{AudioMixer}}} object that this object is to be connected to.
1139 93 Luci Stanescu
  [[BR]]''transport'':[[BR]]
1140 93 Luci Stanescu
  The transport to use in the form of a {{{RTPTransport}}} object.
1141 93 Luci Stanescu
  [[BR]]''remote_sdp'':[[BR]]
1142 93 Luci Stanescu
  The remote SDP that was received in the form of a {{{SDPSession}}} object.
1143 93 Luci Stanescu
  [[BR]]''sdp_index'':[[BR]]
1144 93 Luci Stanescu
  The index within the SDP of the audio stream that should be created.
1145 93 Luci Stanescu
  [[BR]]''enable_silence_detection''[[BR]]
1146 93 Luci Stanescu
  Boolean that indicates if silence detection should be used for this audio stream.
1147 93 Luci Stanescu
  When enabled, this {{{AudioTransport}}} object will stop sending audio to the remote party if the input volume is below a certain threshold.
1148 93 Luci Stanescu
  [[BR]]''codecs''[[BR]]
1149 93 Luci Stanescu
  A list of strings indicating the codecs that should be proposed in the SDP of this {{{AudioTransport}}}, in order of preference.
1150 93 Luci Stanescu
  This overrides the global codecs list set on the {{{Engine}}}.
1151 93 Luci Stanescu
  The values of this list are case insensitive.
1152 99 Adrian Georgescu
1153 93 Luci Stanescu
 '''get_local_media'''(''self'', '''is_offer''', '''direction'''="sendrecv")::
1154 93 Luci Stanescu
  Generates a {{{SDPMediaStream}}} object which describes the audio stream.
1155 93 Luci Stanescu
  This object should be included in a {{{SDPSession}}} object that gets passed to the {{{Invitation}}} object.
1156 93 Luci Stanescu
  This method should also be used to obtain the SDP to include in re-INVITEs and replies to re-INVITEs.
1157 93 Luci Stanescu
  [[BR]]''is_offer'':[[BR]]
1158 93 Luci Stanescu
  A boolean indicating if the SDP requested is to be included in an offer.
1159 93 Luci Stanescu
  If this is {{{False}}} it is to be included in an answer.
1160 93 Luci Stanescu
  [[BR]]''direction'':[[BR]]
1161 93 Luci Stanescu
  The direction attribute to put in the SDP.
1162 99 Adrian Georgescu
1163 93 Luci Stanescu
 '''start'''(''self'', '''local_sdp''', '''remote_sdp''', '''sdp_index''', '''no_media_timeout'''=10, '''media_check_interval'''=30)::
1164 93 Luci Stanescu
  This method should only be called once, when the application has previously sent an SDP offer and the answer has been received.
1165 93 Luci Stanescu
  [[BR]]''local_sdp'':[[BR]]
1166 93 Luci Stanescu
  The full local SDP that was included in the SDP negotiation in the form of a {{{SDPSession}}} object.
1167 93 Luci Stanescu
  [[BR]]''remote_sdp'':[[BR]]
1168 93 Luci Stanescu
  The remote SDP that was received in the form of a {{{SDPSession}}} object.
1169 93 Luci Stanescu
  [[BR]]''sdp_index'':[[BR]]
1170 93 Luci Stanescu
  The index within the SDP of the audio stream.
1171 93 Luci Stanescu
  [[BR]]''no_media_timeout'':[[BR]]
1172 93 Luci Stanescu
  This argument indicates after how many seconds after starting the {{{AudioTransport}}} the {{{RTPAudioTransportDidNotGetRTP}}} notification should be sent, if no RTP has been received at all.
1173 93 Luci Stanescu
  Setting this to 0 disables this an all subsequent RTP checks.
1174 93 Luci Stanescu
  [[BR]]''media_check_interval'':[[BR]]
1175 93 Luci Stanescu
  This indicates the interval at which the RTP stream should be checked, after it has initially received RTP at after {{{no_media_timeout}}} seconds.
1176 93 Luci Stanescu
  It means that if between two of these interval checks no RTP has been received, a {{{RTPAudioTransportDidNotGetRTP}}} notification will be sent.
1177 93 Luci Stanescu
  Setting this to 0 will disable checking the RTP at intervals.
1178 93 Luci Stanescu
  The initial check may still be performed if its timeout is non-zero.
1179 99 Adrian Georgescu
1180 93 Luci Stanescu
 '''stop'''(''self'')::
1181 93 Luci Stanescu
  This method stops and destroys the audio stream encapsulated by this object.
1182 93 Luci Stanescu
  After this it can no longer be used and should be deleted, while the {{{RTPTransport}}} object used by it can be re-used for something else.
1183 93 Luci Stanescu
  This method will be called automatically when the object is deleted after it was started, but this should not be relied on because of possible reference counting issues.
1184 99 Adrian Georgescu
1185 93 Luci Stanescu
 '''send_dtmf'''(''self'', '''digit''')::
1186 93 Luci Stanescu
  For a negotiated audio transport this sends one DTMF digit to the other party
1187 93 Luci Stanescu
  [[BR]]''digit'':[[BR]]
1188 93 Luci Stanescu
  A string of length one indicating the DTMF digit to send.
1189 93 Luci Stanescu
  This can be either a digit, the pound sign (#), the asterisk sign (*) or the letters A through D.
1190 99 Adrian Georgescu
1191 93 Luci Stanescu
 '''update_direction'''(''self'', '''direction''')::
1192 93 Luci Stanescu
  This method should be called after SDP negotiation has completed to update the direction of the media stream.
1193 93 Luci Stanescu
  [[BR]]''direction'':[[BR]]
1194 93 Luci Stanescu
  The direction that has been negotiated.
1195 93 Luci Stanescu
1196 93 Luci Stanescu
==== attributes ====
1197 93 Luci Stanescu
1198 99 Adrian Georgescu
1199 93 Luci Stanescu
 '''mixer'''::
1200 93 Luci Stanescu
  The {{{AudioMixer}}} object that was passed when the object got instantiated.
1201 93 Luci Stanescu
  This attribute is read-only.
1202 99 Adrian Georgescu
1203 93 Luci Stanescu
 '''transport'''::
1204 93 Luci Stanescu
  The {{{RTPTransport}}} object that was passed when the object got instantiated.
1205 93 Luci Stanescu
  This attribute is read-only.
1206 99 Adrian Georgescu
1207 93 Luci Stanescu
 '''slot'''::
1208 93 Luci Stanescu
  A read-only property indicating the slot number at which this object is attached to the associated conference bridge.
1209 93 Luci Stanescu
  If the {{{AudioTransport}}} is not active (i.e. has not been started), this attribute will be {{{None}}}.
1210 99 Adrian Georgescu
1211 93 Luci Stanescu
 '''volume'''::
1212 93 Luci Stanescu
  A writable property indicating the % of volume at which this object contributes audio to the conference bridge.
1213 93 Luci Stanescu
  By default this is set to 100.
1214 99 Adrian Georgescu
1215 93 Luci Stanescu
 '''is_active'''::
1216 93 Luci Stanescu
  A boolean indicating if the object is currently sending and receiving audio.
1217 93 Luci Stanescu
  This attribute is read-only.
1218 99 Adrian Georgescu
1219 93 Luci Stanescu
 '''is_started'''::
1220 93 Luci Stanescu
  A boolean indicating if the object has been started.
1221 93 Luci Stanescu
  Both this attribute and the {{{is_active}}} attribute get set to {{{True}}} once the {{{start()}}} method is called, but unlike the {{{is_active}}} attribute this attribute does not get set to {{{False}}} once {{{stop()}}} is called.
1222 93 Luci Stanescu
  This is to prevent the object from being re-used.
1223 93 Luci Stanescu
  This attribute is read-only.
1224 99 Adrian Georgescu
1225 93 Luci Stanescu
 '''codec'''::
1226 93 Luci Stanescu
  Once the SDP negotiation is complete, this attribute indicates the audio codec that was negotiated, otherwise it will be {{{None}}}.
1227 93 Luci Stanescu
  This attribute is read-only.
1228 99 Adrian Georgescu
1229 93 Luci Stanescu
 '''sample_rate'''::
1230 93 Luci Stanescu
  Once the SDP negotiation is complete, this attribute indicates the sample rate of the audio codec that was negotiated, otherwise it will be {{{None}}}.
1231 93 Luci Stanescu
  This attribute is read-only.
1232 99 Adrian Georgescu
1233 93 Luci Stanescu
 '''direction'''::
1234 93 Luci Stanescu
  The current direction of the audio transport, which is one of "sendrecv", "sendonly", "recvonly" or "inactive".
1235 93 Luci Stanescu
  This attribute is read-only, although it can be set using the {{{update_direction()}}} method.
1236 93 Luci Stanescu
1237 93 Luci Stanescu
==== notifications ====
1238 93 Luci Stanescu
1239 99 Adrian Georgescu
1240 93 Luci Stanescu
 '''RTPAudioTransportGotDTMF'''::
1241 93 Luci Stanescu
  This notification will be sent when an incoming DTMF digit is received from the remote party.
1242 93 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1243 93 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1244 93 Luci Stanescu
  [[BR]]''digit'':[[BR]]
1245 93 Luci Stanescu
  The DTMF digit that was received, in the form of a string of length one.
1246 93 Luci Stanescu
  This can be either a number or letters A through D.
1247 99 Adrian Georgescu
1248 93 Luci Stanescu
 '''RTPAudioTransportDidNotGetRTP'''::
1249 93 Luci Stanescu
  This notification will be sent when no RTP packets have been received from the remote party for some time.
1250 93 Luci Stanescu
  See the {{{start()}}} method for a more exact description.
1251 93 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1252 93 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1253 93 Luci Stanescu
  [[BR]]''got_any'':[[BR]]
1254 93 Luci Stanescu
  A boolean data attribute indicating if the {{{AudioTransport}}} every saw any RTP packets from the remote party.
1255 93 Luci Stanescu
  In effect, if no RTP was received after {{{no_media_timeout}}} seconds, its value will be {{{False}}}.
1256 93 Luci Stanescu
1257 46 Ruud Klaver
=== Request ===
1258 46 Ruud Klaver
1259 46 Ruud Klaver
The {{{sipsimple.core.Request}}} object encapsulates a single SIP request transaction from the client side, which includes sending the request, receiving the response and possibly waiting for the result of the request to expire.
1260 94 Luci Stanescu
Although this class can be used by the application to construct and send an arbitrary SIP request, most applications will use the classes for primitive requests provided in the {{{sipsimple.core}}} module, which are built on top of one or several {{{Request}}} objects and deal with instances of specific SIP methods (REGISTER, MESSAGE and PUBLISH).
1261 46 Ruud Klaver
1262 46 Ruud Klaver
The lifetime of this object is linear and is described by the following diagram:
1263 46 Ruud Klaver
1264 46 Ruud Klaver
[[Image(sipsimple-request-lifetime.png, nolink)]]
1265 46 Ruud Klaver
1266 46 Ruud Klaver
The bar denotes which state the object is in and at the top are the notifications which may be emitted at certain points in time.
1267 46 Ruud Klaver
Directly after the object is instantiated, it will be in the {{{INIT}}} state.
1268 46 Ruud Klaver
The request will be sent over the network once its {{{send()}}} method is called, moving the object into the {{{IN_PROGRESS}}} state.
1269 46 Ruud Klaver
On each provisional response that is received in reply to this request, the {{{SIPRequestGotProvisionalResponse}}} notification is sent, with data describing the response.
1270 46 Ruud Klaver
Note that this may not occur at all if not provisional responses are received.
1271 46 Ruud Klaver
When the {{{send()}}} method has been called and it does not return an exception, the object will send either a {{{SIPRequestDidSucceed}}} or a {{{SIPRequestDidFail}}} notification.
1272 46 Ruud Klaver
Both of these notifications include data on the response that triggered it.
1273 46 Ruud Klaver
Note that a SIP response that requests authentication (401 or 407) will be handled internally the first time, if a {{{Credentials}}} object was supplied.
1274 46 Ruud Klaver
If this is the sort of request that expires (detected by a {{{Expires}}} header in the response or a {{{expires}}} parameter in the {{{Contact}}} header of the response), and the request was successful, the object will go into the {{{EXPIRING}}} state.
1275 46 Ruud Klaver
A certain amount of time before the result of the request will expire, governed by the {{{expire_warning_time}}} class attribute and the actual returned expiration time, a {{{SIPRequestWillExpire}}} notification will be sent.
1276 46 Ruud Klaver
This should usually trigger whomever is using this {{{Request}}} object to construct a new {{{Request}}} for a refreshing operation.
1277 49 Ruud Klaver
When the {{{Request}}} actually expires, or when the {{{EXPIRING}}} state is skipped directly after sending {{{SIPRequestDidSucceed}}} or {{{SIPRequestDidFail}}}, a {{{SIPRequestDidEnd}}} notification will be sent.
1278 1 Adrian Georgescu
1279 94 Luci Stanescu
==== methods ====
1280 94 Luci Stanescu
1281 99 Adrian Georgescu
1282 94 Luci Stanescu
 '''!__init!__'''(''self'', '''method''', '''from_header''', '''to_header''', '''request_uri''', '''route_header''', '''credentials'''={{{None}}}, '''contact_header'''={{{None}}}, '''call_id'''={{{None}}}, '''cseq'''={{{None}}}, '''extra_headers'''={{{None}}}, '''content_type'''={{{None}}}, '''body'''={{{None}}})::
1283 94 Luci Stanescu
  Creates a new {{{Request}}} object in the {{{INIT}}} state.
1284 94 Luci Stanescu
  The arguments to this method are documented in the attributes section.
1285 99 Adrian Georgescu
1286 94 Luci Stanescu
 '''send'''(''self'', '''timeout'''={{{None}}})::
1287 94 Luci Stanescu
   Compose the SIP request and send it to the destination.
1288 94 Luci Stanescu
   This moves the {{{Request}}} object into the {{{IN_PROGRESS}}} state.
1289 94 Luci Stanescu
  [[BR]]''timeout'':[[BR]]
1290 94 Luci Stanescu
  This can be either an int or a float, indicating in how many seconds the request should timeout with an internally generated 408 response.
1291 94 Luci Stanescu
  This is is {{{None}}}, the internal 408 is only triggered by the internal PJSIP transaction timeout.
1292 94 Luci Stanescu
  Note that, even if the timeout is specified, the PJSIP timeout is also still valid.
1293 99 Adrian Georgescu
1294 94 Luci Stanescu
 '''end'''(''self'')::
1295 94 Luci Stanescu
  Terminate the transaction, whichever state it is in, sending the appropriate notifications.
1296 94 Luci Stanescu
  Note that calling this method while in the {{{INIT}}} state does nothing.
1297 94 Luci Stanescu
1298 47 Ruud Klaver
==== attributes ====
1299 47 Ruud Klaver
1300 99 Adrian Georgescu
1301 62 Ruud Klaver
 '''expire_warning_time''' (class attribute)::
1302 47 Ruud Klaver
  The {{{SIPRequestWillExpire}}} notification will be sent halfway between the positive response and the actual expiration time, but at least this amount of seconds before.
1303 47 Ruud Klaver
  The default value is 30 seconds.
1304 99 Adrian Georgescu
1305 47 Ruud Klaver
 '''state'''::
1306 47 Ruud Klaver
  Indicates the state the {{{Request}}} object is in, in the form of a string.
1307 1 Adrian Georgescu
  Refer to the diagram above for possible states.
1308 1 Adrian Georgescu
  This attribute is read-only.
1309 99 Adrian Georgescu
1310 1 Adrian Georgescu
 '''method'''::
1311 1 Adrian Georgescu
  The method of the SIP request as a string.
1312 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1313 99 Adrian Georgescu
1314 94 Luci Stanescu
 '''from_header'''::
1315 94 Luci Stanescu
  The {{{FrozenFromHeader}}} object to put in the {{{From}}} header of the request.
1316 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1317 99 Adrian Georgescu
1318 94 Luci Stanescu
 '''to_header'''::
1319 94 Luci Stanescu
  The {{{FrozenToHeader}}} object to put in the {{{To}}} header of the request.
1320 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1321 99 Adrian Georgescu
1322 1 Adrian Georgescu
 '''request_uri'''::
1323 94 Luci Stanescu
  The SIP URI to put as request URI in the request, in the form of a {{{FrozenSIPURI}}} object.
1324 62 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1325 99 Adrian Georgescu
1326 94 Luci Stanescu
 '''route_header'''::
1327 94 Luci Stanescu
  Where to send the SIP request to, including IP, port and transport, in the form of a {{{FrozenRouteHeader}}} object.
1328 47 Ruud Klaver
  This will also be included in the {{{Route}}} header of the request.
1329 47 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1330 99 Adrian Georgescu
1331 47 Ruud Klaver
 '''credentials'''::
1332 94 Luci Stanescu
  The credentials to be used when challenged for authentication, represented by a {{{FrozenCredentials}}} object.
1333 47 Ruud Klaver
  If no credentials were supplied when the object was created this attribute is {{{None}}}.
1334 47 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1335 99 Adrian Georgescu
1336 94 Luci Stanescu
 '''contact_header'''::
1337 94 Luci Stanescu
  The {{{FrozenContactHeader}}} object to put in the {{{Contact}}} header of the request.
1338 1 Adrian Georgescu
  If this was not specified, this attribute is {{{None}}}.
1339 1 Adrian Georgescu
  It is set on instantiation and is read-only.
1340 99 Adrian Georgescu
1341 47 Ruud Klaver
 '''call_id'''::
1342 47 Ruud Klaver
  The {{{Call-ID}}} to be used for this transaction as a string.
1343 46 Ruud Klaver
  If no call id was specified on instantiation, this attribute contains the generated id.
1344 46 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1345 99 Adrian Georgescu
1346 62 Ruud Klaver
 '''cseq'''::
1347 48 Ruud Klaver
  The sequence number to use in the request as an int.
1348 48 Ruud Klaver
  If no sequence number was specified on instantiation, this attribute contains the generated sequence number.
1349 48 Ruud Klaver
  Note that this number may be increased by one if an authentication challenge is received and a {{{Credentials}}} object is given.
1350 48 Ruud Klaver
  This attribute is read-only.
1351 99 Adrian Georgescu
1352 48 Ruud Klaver
 '''extra_headers'''::
1353 94 Luci Stanescu
  Extra headers to include in the request as a frozenlist of header objects.
1354 48 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1355 99 Adrian Georgescu
1356 48 Ruud Klaver
 '''content_type'''::
1357 48 Ruud Klaver
  What string to put as content type in the {{{Content-Type}}} headers, if the request contains a body.
1358 57 Ruud Klaver
  If no body was specified, this attribute is {{{None}}}
1359 48 Ruud Klaver
  It is set on instantiation and is read-only.
1360 99 Adrian Georgescu
1361 48 Ruud Klaver
 '''body'''::
1362 48 Ruud Klaver
  The body of the request as a string.
1363 46 Ruud Klaver
  If no body was specified, this attribute is {{{None}}}
1364 49 Ruud Klaver
  It is set on instantiation and is read-only.
1365 99 Adrian Georgescu
1366 49 Ruud Klaver
 '''expires_in'''::
1367 49 Ruud Klaver
  This read-only property indicates in how many seconds from now this {{{Request}}} will expire, if it is in the {{{EXPIRING}}} state.
1368 49 Ruud Klaver
  If this is not the case, this property is 0.
1369 49 Ruud Klaver
1370 49 Ruud Klaver
==== notifications ====
1371 49 Ruud Klaver
1372 99 Adrian Georgescu
1373 49 Ruud Klaver
 '''SIPRequestGotProvisionalResponse'''::
1374 49 Ruud Klaver
  This notification will be sent on every provisional response received in reply to the sent request.
1375 49 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
1376 49 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1377 49 Ruud Klaver
  [[BR]]''code'':[[BR]]
1378 49 Ruud Klaver
  The SIP response code of the received provisional response as an int, which will be in the 1xx range.
1379 49 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1380 49 Ruud Klaver
  The reason text string included with the SIP response code.
1381 49 Ruud Klaver
  [[BR]]''headers'':[[BR]]
1382 94 Luci Stanescu
  The headers included in the provisional response as a dict, the values of which are header objects.
1383 49 Ruud Klaver
  [[BR]]''body'':[[BR]]
1384 49 Ruud Klaver
  The body of the provisional response as a string, or {{{None}}} if there was no body.
1385 99 Adrian Georgescu
1386 49 Ruud Klaver
 '''SIPRequestDidSucceed'''::
1387 49 Ruud Klaver
  This notification will be sent when a positive final response was received in reply to the request.
1388 49 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
1389 49 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1390 49 Ruud Klaver
  [[BR]]''code'':[[BR]]
1391 49 Ruud Klaver
  The SIP response code of the received positive final response as an int, which will be in the 2xx range.
1392 49 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1393 49 Ruud Klaver
  The reason text string included with the SIP response code.
1394 49 Ruud Klaver
  [[BR]]''headers'':[[BR]]
1395 94 Luci Stanescu
  The headers included in the positive final response as a dict, the values of which are header objects.
1396 1 Adrian Georgescu
  [[BR]]''body'':[[BR]]
1397 1 Adrian Georgescu
  The body of the positive final response as a string, or {{{None}}} if there was no body.
1398 1 Adrian Georgescu
  [[BR]]''expires'':[[BR]]
1399 1 Adrian Georgescu
  Indicates in how many seconds the {{{Request}}} will expire as an int.
1400 1 Adrian Georgescu
  If it does not expire and the {{{EXPIRING}}} state is skipped, this attribute is 0.
1401 99 Adrian Georgescu
1402 1 Adrian Georgescu
 '''SIPRequestDidFail'''::
1403 1 Adrian Georgescu
  This notification will be sent when a negative final response is received in reply to the request or if an internal error occurs.
1404 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
1405 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1406 1 Adrian Georgescu
  [[BR]]''code'':[[BR]]
1407 1 Adrian Georgescu
  The SIP response code of the received negative final response as an int.
1408 1 Adrian Georgescu
  This could also be a response code generated by PJSIP internally, or 0 when an internal error occurs.
1409 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
1410 1 Adrian Georgescu
  The reason text string included with the SIP response code or error.
1411 1 Adrian Georgescu
  [[BR]]''headers'': (only if a negative final response was received)[[BR]]
1412 94 Luci Stanescu
  The headers included in the negative final response as a dict, the values of which are header objects, if this is what triggered the notification.
1413 1 Adrian Georgescu
  [[BR]]''body'': (only if a negative final response was received)[[BR]]
1414 1 Adrian Georgescu
  The body of the negative final response as a string, or {{{None}}} if there was no body.
1415 1 Adrian Georgescu
  This attribute is absent if no response was received.
1416 99 Adrian Georgescu
1417 1 Adrian Georgescu
 '''SIPRequestWillExpire'''::
1418 1 Adrian Georgescu
  This notification will be sent when a {{{Request}}} in the {{{EXPIRING}}} state will expire soon.
1419 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
1420 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1421 1 Adrian Georgescu
  [[BR]]''expires'':[[BR]]
1422 1 Adrian Georgescu
  An int indicating in how many seconds from now the {{{Request}}} will actually expire.
1423 99 Adrian Georgescu
1424 1 Adrian Georgescu
 '''SIPRequestDidEnd'''::
1425 1 Adrian Georgescu
  This notification will be sent when a {{{Request}}} object enters the {{{TERMINATED}}} state and can no longer be used.
1426 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
1427 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1428 1 Adrian Georgescu
1429 94 Luci Stanescu
=== IncomingRequest ===
1430 94 Luci Stanescu
1431 94 Luci Stanescu
This is a relatively simple object that can manage responding to incoming requests in a single transaction.
1432 94 Luci Stanescu
For this reason it does not handle requests that create a dialog.
1433 94 Luci Stanescu
To register methods for which requests should be formed into an {{{IncomingRequest}}} object, the application should set the {{{incoming_requests}}} set attribute on the {{{Engine}}}.
1434 94 Luci Stanescu
Receiving {{{INVITE}}}, {{{SUBSCRIBE}}}, {{{ACK}}} and {{{BYE}}} through this object is not supported.
1435 94 Luci Stanescu
1436 94 Luci Stanescu
The application is notified of an incoming request through the {{{SIPIncomingRequestGotRequest}}} notification.
1437 94 Luci Stanescu
It can answer this request by calling the {{{answer}}} method on the sender of this notification.
1438 94 Luci Stanescu
Note that if the {{{IncomingRequest}}} object gets destroyed before it is answered, a 500 response is automatically sent.
1439 94 Luci Stanescu
1440 94 Luci Stanescu
==== attributes ====
1441 94 Luci Stanescu
1442 99 Adrian Georgescu
1443 94 Luci Stanescu
 '''state'''::
1444 94 Luci Stanescu
  This read-only attribute indicates the state the object is in.
1445 94 Luci Stanescu
  This can be {{{None}}} if the object was created by the application, essentially meaning the object is inert, {{{"incoming"}}} or {{{"answered"}}}.
1446 94 Luci Stanescu
1447 94 Luci Stanescu
==== methods ====
1448 94 Luci Stanescu
1449 99 Adrian Georgescu
1450 94 Luci Stanescu
 '''answer'''(''self'', '''code''', '''reason'''={{{None}}}, '''extra_headers'''={{{None}}})::
1451 94 Luci Stanescu
  Reply to the received request with a final response.
1452 94 Luci Stanescu
  [[BR]]''code'':[[BR]]
1453 94 Luci Stanescu
  The SIP response code to send.
1454 94 Luci Stanescu
  This should be 200 or higher.
1455 94 Luci Stanescu
  [[BR]]''reason'':[[BR]]
1456 94 Luci Stanescu
  The reason text to include in the response.
1457 94 Luci Stanescu
  If this is {{{None}}}, the default text for the given response code is used.
1458 94 Luci Stanescu
  [[BR]]''extra_headers'':[[BR]]
1459 94 Luci Stanescu
  The extra headers to include in the response as an iterable of header objects.
1460 94 Luci Stanescu
1461 94 Luci Stanescu
==== notifications ====
1462 94 Luci Stanescu
1463 99 Adrian Georgescu
1464 94 Luci Stanescu
 '''SIPIncomingRequestGotRequest'''::
1465 94 Luci Stanescu
  This notification will be sent when a new {{{IncomingRequest}}} is created as result of a received request.
1466 94 Luci Stanescu
  The application should listen for this notification, retain a reference to the object that sent it and answer it.
1467 94 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1468 94 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1469 94 Luci Stanescu
  [[BR]]''method'':[[BR]]
1470 94 Luci Stanescu
  The method of the SIP request as a string.
1471 94 Luci Stanescu
  [[BR]]''request_uri'':[[BR]]
1472 94 Luci Stanescu
  The request URI of the request as a {{{FrozenSIPURI}}} object.
1473 94 Luci Stanescu
  [[BR]]''headers'':[[BR]]
1474 94 Luci Stanescu
  The headers of the request as a dict, the values of which are the relevant header objects.
1475 94 Luci Stanescu
  [[BR]]''body'':[[BR]]
1476 94 Luci Stanescu
  The body of the request as a string, or {{{None}}} if no body was included.
1477 99 Adrian Georgescu
1478 94 Luci Stanescu
 '''SIPIncomingRequestSentResponse'''::
1479 94 Luci Stanescu
  This notification is sent when a response to the request is sent by the object.
1480 94 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1481 94 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1482 94 Luci Stanescu
  [[BR]]''code'':[[BR]]
1483 94 Luci Stanescu
  The code of the SIP response as an int.
1484 94 Luci Stanescu
  [[BR]]''reason'':[[BR]]
1485 94 Luci Stanescu
  The reason text of the SIP response as an int.
1486 94 Luci Stanescu
  [[BR]]''headers'':[[BR]]
1487 94 Luci Stanescu
  The headers of the response as a dict, the values of which are the relevant header objects.
1488 94 Luci Stanescu
  [[BR]]''body'':[[BR]]
1489 94 Luci Stanescu
  This will be {{{None}}}.
1490 94 Luci Stanescu
1491 51 Ruud Klaver
=== Message ===
1492 1 Adrian Georgescu
1493 94 Luci Stanescu
The {{{Message}}} class is a simple wrapper for the {{{Request}}} class, with the purpose of sending {{{MESSAGE}}} requests, as described in [http://tools.ietf.org/html/rfc3428 RFC 3428].
1494 51 Ruud Klaver
It is a one-shot object that manages only one {{{Request}}} object.
1495 51 Ruud Klaver
1496 94 Luci Stanescu
==== methods ====
1497 94 Luci Stanescu
1498 99 Adrian Georgescu
1499 94 Luci Stanescu
 '''!__init!__'''(''self'', '''from_header''', '''to_header''', '''route_header''', '''content_type''', '''body''', '''credentials'''={{{None}}}, '''extra_headers'''={{{[]}}})::
1500 94 Luci Stanescu
  Creates a new {{{Message}}} object with the specified arguments.
1501 94 Luci Stanescu
  These arguments are documented in the attributes section for this class.
1502 99 Adrian Georgescu
1503 94 Luci Stanescu
 '''send'''(''self'', '''timeout'''={{{None}}})::
1504 94 Luci Stanescu
  Send the {{{MESSAGE}}} request to the remote party.
1505 94 Luci Stanescu
  [[BR]]''timeout'':[[BR]]
1506 94 Luci Stanescu
  This argument as the same meaning as it does for {{{Request.send()}}}.
1507 99 Adrian Georgescu
1508 94 Luci Stanescu
 '''end'''(''self'')::
1509 94 Luci Stanescu
  Stop trying to send the {{{MESSAGE}}} request.
1510 94 Luci Stanescu
  If it was not sent yet, calling this method does nothing.
1511 94 Luci Stanescu
1512 1 Adrian Georgescu
==== attributes ====
1513 1 Adrian Georgescu
1514 99 Adrian Georgescu
1515 94 Luci Stanescu
 '''from_header'''::
1516 94 Luci Stanescu
  The {{{FrozenFromHeader}}} to put in the {{{From}}} header of the {{{MESSAGE}}} request.
1517 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1518 99 Adrian Georgescu
1519 94 Luci Stanescu
 '''to_header'''::
1520 94 Luci Stanescu
  The {{{FrozenToHeader}}} to put in the {{{To}}} header of the {{{MESSAGE}}} request.
1521 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1522 99 Adrian Georgescu
1523 94 Luci Stanescu
 '''route_header'''::
1524 94 Luci Stanescu
  Where to send the {{{MESSAGE}}} request to, including IP, port and transport, in the form of a {{{FrozenRouteHeader}}} object.
1525 1 Adrian Georgescu
  This will also be included in the {{{Route}}} header of the request.
1526 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1527 99 Adrian Georgescu
1528 1 Adrian Georgescu
 '''content_type'''::
1529 1 Adrian Georgescu
  What string to put as content type in the {{{Content-Type}}} headers.
1530 1 Adrian Georgescu
  It is set on instantiation and is read-only.
1531 99 Adrian Georgescu
1532 1 Adrian Georgescu
 '''body'''::
1533 1 Adrian Georgescu
  The body of the {{{MESSAGE}}} request as a string.
1534 52 Ruud Klaver
  If no body was specified, this attribute is {{{None}}}
1535 52 Ruud Klaver
  It is set on instantiation and is read-only.
1536 99 Adrian Georgescu
1537 52 Ruud Klaver
 '''credentials'''::
1538 94 Luci Stanescu
  The credentials to be used when challenged for authentication, represented by a {{{FrozenCredentials}}} object.
1539 52 Ruud Klaver
  If no credentials were specified, this attribute is {{{None}}}.
1540 52 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1541 99 Adrian Georgescu
1542 1 Adrian Georgescu
 '''is_sent'''::
1543 1 Adrian Georgescu
  A boolean read-only property indicating if the {{{MESSAGE}}} request was sent.
1544 99 Adrian Georgescu
1545 1 Adrian Georgescu
 '''in_progress'''::
1546 52 Ruud Klaver
  A boolean read-only property indicating if the object is waiting for the response from the remote party.
1547 52 Ruud Klaver
1548 52 Ruud Klaver
==== notifications ====
1549 52 Ruud Klaver
1550 99 Adrian Georgescu
1551 52 Ruud Klaver
 '''SIPMessageDidSucceed'''::
1552 52 Ruud Klaver
  This notification will be sent when the remote party acknowledged the reception of the {{{MESSAGE}}} request.
1553 52 Ruud Klaver
  It has not data attributes.
1554 99 Adrian Georgescu
1555 52 Ruud Klaver
 '''SIPMessageDidFail'''::
1556 52 Ruud Klaver
  This notification will be sent when transmission of the {{{MESSAGE}}} request fails for whatever reason.
1557 52 Ruud Klaver
  [[BR]]''code'':[[BR]]
1558 52 Ruud Klaver
  An int indicating the SIP or internal PJSIP code that was given in response to the {{{MESSAGE}}} request.
1559 1 Adrian Georgescu
  This is 0 if the failure is caused by an internal error.
1560 58 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1561 1 Adrian Georgescu
  A status string describing the failure, either taken from the SIP response or the internal error.
1562 52 Ruud Klaver
1563 52 Ruud Klaver
=== Registration ===
1564 52 Ruud Klaver
1565 94 Luci Stanescu
The {{{Registration}}} class wraps a series of {{{Request}}} objects, managing the registration of a particular contact URI at a SIP registrar through the sending of {{{REGISTER}}} requests.
1566 86 Ruud Klaver
For details, see [http://tools.ietf.org/html/rfc3261 RFC 3261].
1567 1 Adrian Georgescu
This object is designed in such a way that it will not initiate sending a refreshing {{{REGISTER}}} itself, rather it will inform the application that a registration is about to expire.
1568 1 Adrian Georgescu
The application should then perform a DNS lookup to find the relevant SIP registrar and call the {{{register()}}} method on this object.
1569 52 Ruud Klaver
1570 52 Ruud Klaver
==== methods ====
1571 52 Ruud Klaver
1572 99 Adrian Georgescu
1573 94 Luci Stanescu
 '''!__init!__'''(''self'', '''from_header''', '''credentials'''={{{None}}}, '''duration'''=300)::
1574 52 Ruud Klaver
  Creates a new {{{Registration}}} object with the specified arguments.
1575 52 Ruud Klaver
  These arguments are documented in the attributes section for this class.
1576 99 Adrian Georgescu
1577 94 Luci Stanescu
 '''register'''(''self'', '''contact_header''', '''route_header''', '''timeout'''={{{None}}})::
1578 52 Ruud Klaver
  Calling this method will attempt to send a new {{{REGISTER}}} request to the registrar provided, whatever state the object is in.
1579 52 Ruud Klaver
  If the object is currently busy sending a {{{REGISTER}}}, this request will be preempted for the new one.
1580 52 Ruud Klaver
  Once sent, the {{{Registration}}} object will send either a {{{SIPRegistrationDidSucceed}}} or a {{{SIPRegistrationDidFail}}} notification.
1581 94 Luci Stanescu
  The {{{contact_header}}} argument is mentioned in the attributes section of this class.
1582 94 Luci Stanescu
  The {{{route_header}}} argument specifies the IP address, port and transport of the SIP registrar in the form of a {{{RouteHeader}}} object and {{{timeout}}} has the same meaning as it does for {{{Request.send()}}}.
1583 99 Adrian Georgescu
1584 1 Adrian Georgescu
 '''end'''(''self'', '''timeout'''={{{None}}})::
1585 1 Adrian Georgescu
  Calling this method while the object is registered will attempt to send a {{{REGISTER}}} request with the {{{Expires}}} headers set to 0, effectively unregistering the contact URI at the registrar.
1586 94 Luci Stanescu
  The {{{RouteHeader}}} used for this will be the same as the last successfully sent {{{REGISTER}}} request.
1587 1 Adrian Georgescu
  If another {{{REGISTER}}} is currently being sent, it will be preempted.
1588 1 Adrian Georgescu
  When the unregistering {{{REGISTER}}} request is sent, a {{{SIPRegistrationWillEnd}}} notification is sent.
1589 1 Adrian Georgescu
  After this, either a {{{SIPRegistrationDidEnd}}} with the {{{expired}}} data attribute set to {{{False}}} will be sent, indicating a successful unregister, or a {{{SIPRegistrationDidNotEnd}}} notification is sent if unregistering fails for some reason.
1590 1 Adrian Georgescu
  Calling this method when the object is not registered will do nothing.
1591 1 Adrian Georgescu
  The {{{timeout}}} argument has the same meaning as for the {{{register()}}} method.
1592 1 Adrian Georgescu
1593 94 Luci Stanescu
==== attributes ====
1594 94 Luci Stanescu
1595 99 Adrian Georgescu
1596 94 Luci Stanescu
 '''from_header''::
1597 94 Luci Stanescu
  The {{{(Frozen)FromHeader}}} the {{{Registration}}} was sent with.
1598 99 Adrian Georgescu
1599 94 Luci Stanescu
 '''credentials'''::
1600 94 Luci Stanescu
  The credentials to be used when challenged for authentication by the registrar, represented by a {{{(Frozen)Credentials}}} object. 
1601 94 Luci Stanescu
  This attribute is set at instantiation, can be {{{None}}} if it was not specified and can be updated to be used for the next {{{REGISTER}}} request.
1602 94 Luci Stanescu
  Note that, in contrast to other classes mentioned in this document, the {{{Registration}}} class does not make a copy of the {{{Credentials}}} object on instantiation, but instead retains a reference to it.
1603 99 Adrian Georgescu
1604 94 Luci Stanescu
 '''duration'''::
1605 94 Luci Stanescu
  The amount of time in seconds to request the registration for at the registrar.
1606 94 Luci Stanescu
  This attribute is set at object instantiation and can be updated for subsequent {{{REGISTER}}} requests.
1607 99 Adrian Georgescu
1608 94 Luci Stanescu
 '''is_registered'''::
1609 94 Luci Stanescu
  A boolean read-only property indicating if this object is currently registered.
1610 99 Adrian Georgescu
1611 94 Luci Stanescu
 '''contact_header'''::
1612 94 Luci Stanescu
  If the {{{Registration}}} object is registered, this attribute contains the latest contact header that was sent to the registrar as a {{{FrozenContactHeader}}} object.
1613 94 Luci Stanescu
  Otherwise, this attribute is {{{None}}}
1614 99 Adrian Georgescu
1615 94 Luci Stanescu
 '''expires_in'''::
1616 94 Luci Stanescu
  If registered, this read-only property indicates in how many seconds from now this {{{Registration}}} will expire.
1617 94 Luci Stanescu
  If this is not the case, this property is 0.
1618 94 Luci Stanescu
1619 69 Ruud Klaver
==== notifications ====
1620 69 Ruud Klaver
1621 99 Adrian Georgescu
1622 69 Ruud Klaver
 '''SIPRegistrationDidSucceed'''::
1623 69 Ruud Klaver
  This notification will be sent when the {{{register()}}} method was called and the registration succeeded.
1624 69 Ruud Klaver
  [[BR]]''code'':[[BR]]
1625 69 Ruud Klaver
  The SIP response code as received from the registrar as an int.
1626 69 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1627 1 Adrian Georgescu
  The reason string received from the SIP registrar.
1628 94 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
1629 94 Luci Stanescu
  The {{{(Frozen)RouteHeader}}} object passed as an argument to the {{{register()}}} method.
1630 94 Luci Stanescu
  [[BR]]''contact_header'':[[BR]]
1631 94 Luci Stanescu
  The contact header that was sent to the registrar as a {{{FrozenContactHeader}}} object.
1632 94 Luci Stanescu
  [[BR]]''contact_header_list'':[[BR]]
1633 94 Luci Stanescu
  A full list of contact headers that are registered for this SIP account, including the one used for this registration.
1634 94 Luci Stanescu
  The format of this data attribute is a list of FrozenContactHeader objects.
1635 1 Adrian Georgescu
  [[BR]]''expires_in'':[[BR]]
1636 69 Ruud Klaver
  The number of seconds before this registration expires
1637 99 Adrian Georgescu
1638 69 Ruud Klaver
 '''SIPRegistrationDidFail'''::
1639 69 Ruud Klaver
  This notification will be sent when the {{{register()}}} method was called and the registration failed, for whatever reason.
1640 69 Ruud Klaver
  [[BR]]''code'':[[BR]]
1641 69 Ruud Klaver
  The SIP response code as received from the registrar as an int.
1642 69 Ruud Klaver
  This can also be a PJSIP generated response code, or 0 if the failure was because of an internal error.
1643 69 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1644 69 Ruud Klaver
  The reason string received from the SIP registrar or the error string.
1645 94 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
1646 94 Luci Stanescu
  The {{{(Frozen)RouteHeader}}} object passed as an argument to the {{{register()}}} method.
1647 99 Adrian Georgescu
1648 69 Ruud Klaver
 '''SIPRegistrationWillExpire'''::
1649 1 Adrian Georgescu
  This notification will be sent when a registration will expire soon.
1650 69 Ruud Klaver
  It should be used as an indication to re-perform DNS lookup of the registrar and call the {{{register()}}} method.
1651 69 Ruud Klaver
  [[BR]]''expires'':[[BR]]
1652 69 Ruud Klaver
  The number of seconds in which the registration will expire.
1653 99 Adrian Georgescu
1654 69 Ruud Klaver
 '''SIPRegistrationWillEnd'''::
1655 69 Ruud Klaver
  Will be sent whenever the {{{end()}}} method was called and an unregistering {{{REGISTER}}} is sent.
1656 99 Adrian Georgescu
1657 69 Ruud Klaver
 '''SIPRegistrationDidNotEnd'''::
1658 69 Ruud Klaver
  This notification will be sent when the unregistering {{{REGISTER}}} request failed for some reason.
1659 69 Ruud Klaver
  [[BR]]''code'':[[BR]]
1660 69 Ruud Klaver
  The SIP response code as received from the registrar as an int.
1661 69 Ruud Klaver
  This can also be a PJSIP generated response code, or 0 if the failure was because of an internal error.
1662 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
1663 1 Adrian Georgescu
  The reason string received from the SIP registrar or the error string.
1664 99 Adrian Georgescu
1665 1 Adrian Georgescu
 '''SIPRegistrationDidEnd'''::
1666 69 Ruud Klaver
  This notification will be sent when a {{{Registration}}} has become unregistered.
1667 69 Ruud Klaver
  [[BR]]''expired'':[[BR]]
1668 69 Ruud Klaver
  This boolean indicates if the object is unregistered because the registration expired, in which case it will be set to {{{True}}}.
1669 69 Ruud Klaver
  If this data attribute is {{{False}}}, it means that unregistration was explicitly requested through the {{{end()}}} method.
1670 69 Ruud Klaver
1671 69 Ruud Klaver
==== example code ====
1672 69 Ruud Klaver
1673 69 Ruud Klaver
For an example on how to use this object, see the Integration section.
1674 69 Ruud Klaver
1675 69 Ruud Klaver
=== Publication ===
1676 69 Ruud Klaver
1677 69 Ruud Klaver
Publication of SIP events is an Internet standard published at [http://tools.ietf.org/html/rfc3903 RFC 3903]. 
1678 69 Ruud Klaver
{{{PUBLISH}}} is similar to {{{REGISTER}}} in that it allows a user to create, modify, and remove state in another entity which manages this state on behalf of the user.
1679 69 Ruud Klaver
1680 69 Ruud Klaver
A {{{Publication}}} object represents publishing some content for a particular SIP account and a particular event type at the SIP presence agent through a series of {{{PUBLISH}}} request.
1681 69 Ruud Klaver
This object is similar in behaviour to the {{{Registration}}} object, as it is also based on a sequence of {{{Request}}} objects.
1682 69 Ruud Klaver
As with this other object, the {{{Publication}}} object will notify the application when a published item is about to expire and it is the applications responsibility to perform a DNS lookup and call the {{{publish()}}} method in order to send the {{{PUBLISH}}} request.
1683 69 Ruud Klaver
1684 69 Ruud Klaver
==== methods ====
1685 69 Ruud Klaver
1686 99 Adrian Georgescu
1687 94 Luci Stanescu
 '''!__init!__'''(''self'', '''from_header''', '''event''', '''content_type''', '''credentials'''={{{None}}}, '''duration'''=300)::
1688 69 Ruud Klaver
  Creates a new {{{Publication}}} object with the specified arguments.
1689 69 Ruud Klaver
  These arguments are documented in the attributes section for this class.
1690 99 Adrian Georgescu
1691 94 Luci Stanescu
 '''publish'''(''self'', '''body''', '''route_header''', '''timeout'''={{{None}}})::
1692 69 Ruud Klaver
  Send an actual {{{PUBLISH}}} request to the specified presence agent.
1693 69 Ruud Klaver
  [[BR]]''body'':[[BR]]
1694 69 Ruud Klaver
  The body to place in the {{{PUBLISH}}} request as a string.
1695 69 Ruud Klaver
  This body needs to be of the content type specified at object creation.
1696 69 Ruud Klaver
  For the initial request, a body will need to be specified.
1697 69 Ruud Klaver
  For subsequent refreshing {{{PUBLISH}}} requests, the body can be {{{None}}} to indicate that the last published body should be refreshed.
1698 69 Ruud Klaver
  If there was an ETag error with the previous refreshing {{{PUBLISH}}}, calling this method with a body of {{{None}}} will throw a {{{PublicationError}}}.
1699 94 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
1700 94 Luci Stanescu
  The host where the request should be sent to in the form of a {{{(Frozen)RouteHeader}}} object.
1701 69 Ruud Klaver
  [[BR]]''timeout'':[[BR]]
1702 69 Ruud Klaver
  This can be either an int or a float, indicating in how many seconds the {{{SUBSCRIBE}}} request should timeout with an internally generated 408 response.
1703 69 Ruud Klaver
  This is is {{{None}}}, the internal 408 is only triggered by the internal PJSIP transaction timeout.
1704 69 Ruud Klaver
  Note that, even if the timeout is specified, the PJSIP timeout is also still valid.
1705 99 Adrian Georgescu
1706 69 Ruud Klaver
 '''end'''(''self'', '''timeout'''={{{None}}})::
1707 1 Adrian Georgescu
  End the publication by sending a {{{PUBLISH}}} request with an {{{Expires}}} header of 0.
1708 86 Ruud Klaver
  If the object is not published, this will result in a {{{PublicationError}}} being thrown.
1709 86 Ruud Klaver
  [[BR]]''timeout'':[[BR]]
1710 86 Ruud Klaver
  The meaning of this argument is the same as it is for the {{{publish()}}} method.
1711 86 Ruud Klaver
1712 94 Luci Stanescu
==== attributes ====
1713 94 Luci Stanescu
1714 99 Adrian Georgescu
1715 94 Luci Stanescu
 '''from_header''::
1716 94 Luci Stanescu
  The {{{(Frozen)FromHeader}}} the {{{Publication}}} was sent with.
1717 99 Adrian Georgescu
1718 94 Luci Stanescu
 '''event''::
1719 94 Luci Stanescu
  The name of the event this object is publishing for the specified SIP URI, as a string.
1720 99 Adrian Georgescu
1721 94 Luci Stanescu
 '''content_type''::
1722 94 Luci Stanescu
  The {{{Content-Type}}} of the body that will be in the {{{PUBLISH}}} requests.
1723 94 Luci Stanescu
  Typically this will remain the same throughout the publication session, but the attribute may be updated by the application if needed.
1724 94 Luci Stanescu
  Note that this attribute needs to be in the typical MIME type form, containing a "/" character.
1725 99 Adrian Georgescu
1726 94 Luci Stanescu
 '''credentials'''::
1727 94 Luci Stanescu
  The credentials to be used when challenged for authentication by the presence agent, represented by a {{{(Frozen)Credentials}}} object. 
1728 94 Luci Stanescu
  This attribute is set at instantiation, can be {{{None}}} if it was not specified and can be updated to be used for the next {{{PUBLISH}}} request.
1729 94 Luci Stanescu
  Note that, in contrast to most other classes mentioned in this document, the {{{Publication}}} class does not make a copy of the {{{(Frozen)Credentials}}} object on instantiation, but instead retains a reference to it.
1730 99 Adrian Georgescu
1731 94 Luci Stanescu
 '''duration'''::
1732 94 Luci Stanescu
  The amount of time in seconds that the publication should be valid for.
1733 94 Luci Stanescu
  This attribute is set at object instantiation and can be updated for subsequent {{{PUBLISH}}} requests.
1734 99 Adrian Georgescu
1735 94 Luci Stanescu
 '''is_published'''::
1736 94 Luci Stanescu
  A boolean read-only property indicating if this object is currently published.
1737 99 Adrian Georgescu
1738 94 Luci Stanescu
 '''expires_in'''::
1739 94 Luci Stanescu
  If published, this read-only property indicates in how many seconds from now this {{{Publication}}} will expire.
1740 94 Luci Stanescu
  If this is not the case, this property is 0.
1741 94 Luci Stanescu
1742 86 Ruud Klaver
==== notifications ====
1743 86 Ruud Klaver
1744 99 Adrian Georgescu
1745 86 Ruud Klaver
 '''SIPPublicationDidSucceed'''::
1746 86 Ruud Klaver
  This notification will be sent when the {{{publish()}}} method was called and the publication succeeded.
1747 86 Ruud Klaver
  [[BR]]''code'':[[BR]]
1748 86 Ruud Klaver
  The SIP response code as received from the SIP presence agent as an int.
1749 86 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1750 86 Ruud Klaver
  The reason string received from the SIP presence agent.
1751 94 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
1752 94 Luci Stanescu
  The {{{(Frozen)RouteHeader}}} object passed as an argument to the {{{publish()}}} method.
1753 86 Ruud Klaver
  [[BR]]''expires_in'':[[BR]]
1754 86 Ruud Klaver
  The number of seconds before this publication expires
1755 99 Adrian Georgescu
1756 86 Ruud Klaver
 '''SIPPublicationDidFail'''::
1757 86 Ruud Klaver
  This notification will be sent when the {{{publish()}}} method was called and the publication failed, for whatever reason.
1758 86 Ruud Klaver
  [[BR]]''code'':[[BR]]
1759 86 Ruud Klaver
  The SIP response code as received from the presence agent as an int.
1760 86 Ruud Klaver
  This can also be a PJSIP generated response code, or 0 if the failure was because of an internal error.
1761 86 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1762 86 Ruud Klaver
  The reason string received from the presence agent or the error string.
1763 94 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
1764 94 Luci Stanescu
  The {{{(Frozen)RouteHeader}}} object passed as an argument to the {{{publish()}}} method.
1765 99 Adrian Georgescu
1766 86 Ruud Klaver
 '''SIPPublicationWillExpire'''::
1767 86 Ruud Klaver
  This notification will be sent when a publication will expire soon.
1768 86 Ruud Klaver
  It should be used as an indication to re-perform DNS lookup of the presence agent and call the {{{publish()}}} method.
1769 86 Ruud Klaver
  [[BR]]''expires'':[[BR]]
1770 86 Ruud Klaver
  The number of seconds in which the publication will expire.
1771 99 Adrian Georgescu
1772 86 Ruud Klaver
 '''SIPPublicationWillEnd'''::
1773 86 Ruud Klaver
  Will be sent whenever the {{{end()}}} method was called and an unpublishing {{{PUBLISH}}} is sent.
1774 99 Adrian Georgescu
1775 86 Ruud Klaver
 '''SIPPublicationDidNotEnd'''::
1776 86 Ruud Klaver
  This notification will be sent when the unpublishing {{{PUBLISH}}} request failed for some reason.
1777 86 Ruud Klaver
  [[BR]]''code'':[[BR]]
1778 1 Adrian Georgescu
  The SIP response code as received from the presence agent as an int.
1779 1 Adrian Georgescu
  This can also be a PJSIP generated response code, or 0 if the failure was because of an internal error.
1780 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
1781 1 Adrian Georgescu
  The reason string received from the presence agent or the error string.
1782 99 Adrian Georgescu
1783 59 Ruud Klaver
 '''SIPPublicationDidEnd'''::
1784 1 Adrian Georgescu
  This notification will be sent when a {{{Publication}}} has become unpublished.
1785 1 Adrian Georgescu
  [[BR]]''expired'':[[BR]]
1786 1 Adrian Georgescu
  This boolean indicates if the object is unpublished because the publication expired, in which case it will be set to {{{True}}}.
1787 1 Adrian Georgescu
  If this data attribute is {{{False}}}, it means that unpublication was explicitly requested through the {{{end()}}} method.
1788 1 Adrian Georgescu
1789 59 Ruud Klaver
=== Subscription ===
1790 59 Ruud Klaver
1791 1 Adrian Georgescu
Subscription and notifications for SIP events is an Internet standard published at [http://tools.ietf.org/html/rfc3856 RFC 3856].
1792 1 Adrian Georgescu
1793 1 Adrian Georgescu
This SIP primitive class represents a subscription to a specific event type of a particular SIP URI.
1794 1 Adrian Georgescu
This means that the application should instance this class for each combination of event and SIP URI that it wishes to subscribe to.
1795 1 Adrian Georgescu
The event type and the content types that are acceptable for it need to be registered first, either through the {{{init_options}}} attribute of {{{Engine}}} (before starting it), or by calling the {{{add_event()}}} method of the {{{Engine}}} instance.
1796 1 Adrian Georgescu
Whenever a {{{NOTIFY}}} is received, the application will receive the {{{SIPSubscriptionGotNotify}}} event.
1797 59 Ruud Klaver
1798 59 Ruud Klaver
Internally a {{{Subscription}}} object has a state machine, which reflects the state of the subscription.
1799 1 Adrian Georgescu
It is a direct mirror of the state machine of the underlying {{{pjsip_evsub}}} object, whose possible states are at least {{{NULL}}}, {{{SENT}}}, {{{ACCEPTED}}}, {{{PENDING}}}, {{{ACTIVE}}} or {{{TERMINATED}}}.
1800 1 Adrian Georgescu
The last three states are directly copied from the contents of the {{{Subscription-State}}} header of the received {{{NOTIFY}}} request.
1801 71 Adrian Georgescu
Also, the state can be an arbitrary string if the contents of the {{{Subscription-State}}} header are not one of the three above.
1802 1 Adrian Georgescu
The state of the object is presented in the {{{state}}} attribute and changes of the state are indicated by means of the {{{SIPSubscriptionChangedState}}} notification.
1803 59 Ruud Klaver
This notification is only informational, an application using this object should take actions based on the other notifications sent by this object.
1804 59 Ruud Klaver
1805 1 Adrian Georgescu
==== methods ====
1806 1 Adrian Georgescu
1807 99 Adrian Georgescu
1808 95 Luci Stanescu
 '''!__init!__'''(''self'', '''from_header''', '''to_header''', '''contact_header, '''event''', '''route_header''', '''credentials'''={{{None}}}, '''refresh'''=300)::
1809 1 Adrian Georgescu
  Creates a new {{{Subscription}}} object which will be in the {{{NULL}}} state.
1810 1 Adrian Georgescu
  The arguments for this method are documented in the attributes section above.
1811 99 Adrian Georgescu
1812 1 Adrian Georgescu
 '''subscribe'''(''self'', '''extra_headers'''={{{None}}}, '''content_type'''={{{None}}}, '''body'''={{{None}}}, '''timeout'''={{{None}}})::
1813 1 Adrian Georgescu
  Calling this method triggers sending a {{{SUBSCRIBE}}} request to the presence agent.
1814 1 Adrian Georgescu
  The arguments passed will be stored and used for subsequent refreshing {{{SUBSCRIBE}}} requests.
1815 1 Adrian Georgescu
  This method may be used both to send the initial request and to update the arguments while the subscription is ongoing.
1816 1 Adrian Georgescu
  It may not be called when the object is in the {{{TERMINATED}}} state.
1817 1 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
1818 1 Adrian Georgescu
  A dictionary of additional headers to include in the {{{SUBSCRIBE}}} requests.
1819 1 Adrian Georgescu
  [[BR]]''content_type'':[[BR]]
1820 1 Adrian Georgescu
  The {{{Content-Type}}} of the supplied {{{body}}} argument as a string.
1821 1 Adrian Georgescu
  If this argument is supplied, the {{{body}}} argument cannot be {{{None}}}.
1822 1 Adrian Georgescu
  [[BR]]''body'':[[BR]]
1823 1 Adrian Georgescu
  The optional body to include in the {{{SUBSCRIBE}}} request as a string.
1824 1 Adrian Georgescu
  If this argument is supplied, the {{{content_type}}} argument cannot be {{{None}}}.
1825 1 Adrian Georgescu
  [[BR]]''timeout'':[[BR]]
1826 1 Adrian Georgescu
  This can be either an int or a float, indicating in how many seconds the request should timeout with an internally generated 408 response.
1827 1 Adrian Georgescu
  If this is {{{None}}}, the internal 408 is only triggered by the internal PJSIP transaction timeout.
1828 1 Adrian Georgescu
  Note that, even if the timeout is specified, the PJSIP timeout is also still valid.
1829 99 Adrian Georgescu
1830 1 Adrian Georgescu
 '''end'''(''self'', '''timeout'''={{{None}}})::
1831 1 Adrian Georgescu
  This will end the subscription by sending a {{{SUBSCRIBE}}} request with an {{{Expires}}} value of 0.
1832 1 Adrian Georgescu
  If this object is no longer subscribed, this method will return without performing any action.
1833 1 Adrian Georgescu
  This method cannot be called when the object is in the {{{NULL}}} state.
1834 1 Adrian Georgescu
  The {{{timeout}}} argument has the same meaning as it does for the {{{subscribe()}}} method.
1835 59 Ruud Klaver
1836 95 Luci Stanescu
==== attributes ====
1837 95 Luci Stanescu
1838 99 Adrian Georgescu
1839 95 Luci Stanescu
 '''state'''::
1840 95 Luci Stanescu
  Indicates which state the internal state machine is in.
1841 95 Luci Stanescu
  See the previous section for a list of states the state machine can be in.
1842 99 Adrian Georgescu
1843 95 Luci Stanescu
 '''from_header'''::
1844 1 Adrian Georgescu
  The {{{FrozenFromHeader}}} to be put in the {{{From}}} header of the {{{SUBSCRIBE}}} requests.
1845 95 Luci Stanescu
  This attribute is set on object instantiation and is read-only.
1846 1 Adrian Georgescu
1847 1 Adrian Georgescu
 '''to_header'''::
1848 1 Adrian Georgescu
  The {{{FrozenToHeader}}} that is the target for the subscription.
1849 1 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
1850 1 Adrian Georgescu
1851 95 Luci Stanescu
 '''contact_header'''::
1852 1 Adrian Georgescu
  The {{{FrozenContactHeader}}} to be put in the {{{Contact}}} header of the {{{SUBSCRIBE}}} requests.
1853 99 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
1854 95 Luci Stanescu
1855 1 Adrian Georgescu
 '''event'''::
1856 1 Adrian Georgescu
  The event package for which the subscription is as a string.
1857 1 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
1858 1 Adrian Georgescu
1859 1 Adrian Georgescu
 '''route_header'''::
1860 1 Adrian Georgescu
  The outbound proxy to use in the form of a {{{FrozenRouteHeader}}} object.
1861 1 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
1862 1 Adrian Georgescu
1863 1 Adrian Georgescu
 '''credentials'''::
1864 1 Adrian Georgescu
  The SIP credentials needed to authenticate at the SIP proxy in the form of a {{{FrozenCredentials}}} object.
1865 1 Adrian Georgescu
  If none was specified when creating the {{{Subscription}}} object, this attribute is {{{None}}}.
1866 1 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
1867 1 Adrian Georgescu
1868 1 Adrian Georgescu
 '''refresh'''::
1869 1 Adrian Georgescu
  The refresh interval in seconds that was requested on object instantiation as an int.
1870 1 Adrian Georgescu
  This attribute is set on object instantiation and is read-only.
1871 1 Adrian Georgescu
1872 1 Adrian Georgescu
 '''extra_headers'''::
1873 1 Adrian Georgescu
  This contains the {{{frozenlist}}} of extra headers that was last passed to a successful call to the {{{subscribe()}}} method.
1874 1 Adrian Georgescu
  If the argument was not provided, this attribute is an empty list.
1875 1 Adrian Georgescu
  This attribute is read-only.
1876 95 Luci Stanescu
1877 1 Adrian Georgescu
 '''content_type'''::
1878 1 Adrian Georgescu
  This attribute contains the {{{Content-Type}}} of the body that was last passed to a successful call to the {{{subscribe()}}} method.
1879 1 Adrian Georgescu
  If the argument was not provided, this attribute is {{{None}}}.
1880 95 Luci Stanescu
1881 1 Adrian Georgescu
 '''body'''::
1882 1 Adrian Georgescu
  This attribute contains the {{{body}}} string argument that was last passed to a successful call to the {{{subscribe()}}} method.
1883 99 Adrian Georgescu
  If the argument was not provided, this attribute is {{{None}}}.
1884 1 Adrian Georgescu
1885 1 Adrian Georgescu
==== notifications ====
1886 1 Adrian Georgescu
1887 1 Adrian Georgescu
1888 95 Luci Stanescu
 '''SIPSubscriptionChangedState'''::
1889 95 Luci Stanescu
  This notification will be sent every time the internal state machine of a {{{Subscription}}} object changes state.
1890 95 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1891 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1892 1 Adrian Georgescu
  [[BR]]''prev_state'':[[BR]]
1893 1 Adrian Georgescu
  The previous state that the sate machine was in.
1894 1 Adrian Georgescu
  [[BR]]''state'':[[BR]]
1895 99 Adrian Georgescu
  The new state the state machine moved into.
1896 1 Adrian Georgescu
1897 1 Adrian Georgescu
 '''SIPSubscriptionWillStart'''::
1898 1 Adrian Georgescu
  This notification will be emitted when the initial {{{SUBSCRIBE}}} request is sent.
1899 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
1900 95 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1901 1 Adrian Georgescu
1902 1 Adrian Georgescu
 '''SIPSubscriptionDidStart'''::
1903 1 Adrian Georgescu
  This notification will be sent when the initial {{{SUBSCRIBE}}} was accepted by the presence agent.
1904 95 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1905 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1906 1 Adrian Georgescu
1907 1 Adrian Georgescu
 '''SIPSubscriptionGotNotify'''::
1908 1 Adrian Georgescu
  This notification will be sent when a {{{NOTIFY}}} is received that corresponds to a particular {{{Subscription}}} object.
1909 95 Luci Stanescu
  Note that this notification could be sent when a {{{NOTIFY}}} without a body is received.
1910 1 Adrian Georgescu
  [[BR]]''request_uri'':[[BR]]
1911 1 Adrian Georgescu
  The request URI of the {{{NOTIFY}}} request as a {{{SIPURI}}} object.
1912 107 Adrian Georgescu
  [[BR]]''from_header'':[[BR]]
1913 107 Adrian Georgescu
  The From header of the {{{NOTIFY}}} request as a {{{FrozenFromHeader}}} object.
1914 107 Adrian Georgescu
  [[BR]]''to_header'':[[BR]]
1915 107 Adrian Georgescu
  The To header of the {{{NOTIFY}}} request as a {{{FrozenToHeader}}} object.
1916 107 Adrian Georgescu
  [[BR]]''content_type'':[[BR]]
1917 107 Adrian Georgescu
  The Content-Type header value of the {{{NOTIFY}}} request as a {{{ContentType}}} object.
1918 107 Adrian Georgescu
  [[BR]]''event'':[[BR]]
1919 107 Adrian Georgescu
  The Event header value of the {{{NOTIFY}}} request as a string object.
1920 1 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
1921 1 Adrian Georgescu
  The headers of the {{{NOTIFY}}} request as a dict.
1922 1 Adrian Georgescu
  Each SIP header is represented in its parsed for as long as PJSIP supports it.
1923 1 Adrian Georgescu
  The format of the parsed value depends on the header.
1924 1 Adrian Georgescu
  [[BR]]''body'':[[BR]]
1925 1 Adrian Georgescu
  The body of the {{{NOTIFY}}} request as a string, or {{{None}}} if no body was included.
1926 107 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
1927 107 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.  
1928 95 Luci Stanescu
1929 1 Adrian Georgescu
 '''SIPSubscriptionDidFail'''::
1930 95 Luci Stanescu
  This notification will be sent whenever there is a failure, such as a rejected initial or refreshing {{{SUBSCRIBE}}}.
1931 1 Adrian Georgescu
  After this notification the {{{Subscription}}} object is in the {{{TERMINATED}}} state and can no longer be used.
1932 95 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1933 99 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1934 1 Adrian Georgescu
  [[BR]]''code'':[[BR]]
1935 1 Adrian Georgescu
  An integer SIP code from the fatal response that was received from the remote party of generated by PJSIP.
1936 1 Adrian Georgescu
  If the error is internal to the SIP core, this attribute will have a value of 0.
1937 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
1938 95 Luci Stanescu
  An text string describing the failure that occurred.
1939 106 Adrian Georgescu
  [[BR]]''min_expires'':[[BR]]
1940 106 Adrian Georgescu
  An integer containing the value from the Min-Expires header. Will be None if the response doesn't contain the header.
1941 1 Adrian Georgescu
1942 59 Ruud Klaver
 '''SIPSubscriptionDidEnd'''::
1943 1 Adrian Georgescu
  This notification will be sent when the subscription ends normally, i.e. the {{{end()}}} method was called and the remote party sent a positive response.
1944 1 Adrian Georgescu
  After this notification the {{{Subscription}}} object is in the {{{TERMINATED}}} state and can no longer be used.
1945 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
1946 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1947 1 Adrian Georgescu
1948 1 Adrian Georgescu
=== IncomingSubscription ===
1949 1 Adrian Georgescu
1950 1 Adrian Georgescu
Subscription and notifications for SIP events is an Internet standard published at [http://tools.ietf.org/html/rfc3856 RFC 3856].
1951 1 Adrian Georgescu
1952 1 Adrian Georgescu
This SIP primitive class is the mirror companion to the {{{Subscription}}} class and allows the application to take on the server role in a {{{SUBSCRIBE}}} session.
1953 1 Adrian Georgescu
This means that it can accept a {{{SUBSCRIBE}}} request and subsequent refreshing {{{SUBSCRIBE}}}s and sent {{{NOTIFY}}} requests containing event state.
1954 1 Adrian Georgescu
1955 1 Adrian Georgescu
In order to be able to receive {{{SUBSCRIBE}}} requests for a particular event package, the application needs to add the name of this event package to the {{{incoming_events}}} set attribute on the {{{Engine}}}, either at startup or at a later time, using the {{{add_incoming_event()}}} method.
1956 1 Adrian Georgescu
This event needs to be known by the {{{Engine}}}, i.e. it should already be present in the {{{events}}} dictionary attribute.
1957 1 Adrian Georgescu
Once the event package name is in the {{{incoming_events}}} set attribute, any incoming {{{SUBSCRIBE}}} request containing this name in the {{{Event}}} header causes the creation of a {{{IncomingSubscribe}}} object.
1958 1 Adrian Georgescu
This will be indicated to the application through a {{{SIPIncomingSubscriptionGotSubscribe}}} notification.
1959 1 Adrian Georgescu
It is then up to the application to check if the {{{SUBSCRIBE}}} request was valid, e.g. if it was actually directed at the correct SIP URI, and respond to it in a timely fashion.
1960 1 Adrian Georgescu
1961 1 Adrian Georgescu
The application can either reject the subscription by calling the {{{reject()}}} method or accept it through the {{{accept()}}} method, optionally first accepting it in the {{{pending}}} state by calling the {{{accept_pending()}}} method.
1962 1 Adrian Georgescu
After the {{{IncomingSubscription}}} is accepted, the application can trigger sending a {{{NOTIFY}}} request with a body reflecting the event state through the {{{push_content()}}} method.
1963 1 Adrian Georgescu
Whenever a refreshing {{{SUBSCRIBE}}} is received, the latest contents to be set are sent in the resulting {{{NOTIFY}}} request.
1964 1 Adrian Georgescu
The subscription can be ended by using the {{{end()}}} method.
1965 1 Adrian Georgescu
1966 1 Adrian Georgescu
==== methods ====
1967 1 Adrian Georgescu
1968 1 Adrian Georgescu
1969 99 Adrian Georgescu
 '''!__init!__'''(''self'')::
1970 59 Ruud Klaver
  An application should never create an {{{IncomingSubscription}}} object itself.
1971 59 Ruud Klaver
  Doing this will create a useless object in the {{{None}}} state.
1972 59 Ruud Klaver
1973 59 Ruud Klaver
 '''reject'''(''self'', '''code''')::
1974 99 Adrian Georgescu
  Will reply to the initial {{{SUBSCRIBE}}} with a negative response.
1975 59 Ruud Klaver
  This method can only be called in the {{{"incoming"}}} state and sets the subscription to the {{{"terminated"}}} state.
1976 59 Ruud Klaver
  [[BR]]''code'':[[BR]]
1977 59 Ruud Klaver
  The SIP response code to use.
1978 59 Ruud Klaver
  This should be a negative response, i.e. in the 3xx, 4xx, 5xx or 6xx range.
1979 99 Adrian Georgescu
1980 59 Ruud Klaver
 '''accept_pending'''(''self'')::
1981 1 Adrian Georgescu
  Accept the initial incoming {{{SUBSCRIBE}}}, but put the subscription in the {{{"pending"}}} state and reply with a 202, followed by a {{{NOTIFY}}} request indicating the state.
1982 59 Ruud Klaver
  The application can later decide to fully accept the subscription or terminate it.
1983 59 Ruud Klaver
  This method can only be called in the {{{"incoming"}}} state.
1984 59 Ruud Klaver
1985 59 Ruud Klaver
 '''accept'''(''self'', '''content_type'''={{{None}}}, '''content'''={{{None}}})::
1986 59 Ruud Klaver
  Accept the initial incoming {{{SUBSCRIBE}}} and respond to it with a 200 OK, or fully accept an {{{IncomingSubscription}}} that is in the {{{"pending"}}} state.
1987 59 Ruud Klaver
  In either case, a {{{NOTIFY}}} will be sent to update the state to "active", optionally with the content specified in the arguments.
1988 59 Ruud Klaver
  This method can only be called in the {{{"incoming"}}} or {{{"pending"}}} state.
1989 59 Ruud Klaver
  [[BR]]''content_type'':[[BR]]
1990 59 Ruud Klaver
  The Content-Type of the content to be set supplied as a string containing a {{{"/"}}} character.
1991 59 Ruud Klaver
  Note that if this argument is set, the {{{content}}} argument should also be set.
1992 84 Ruud Klaver
  [[BR]]''content'':[[BR]]
1993 84 Ruud Klaver
  The body of the {{{NOTIFY}}} to send when accepting the subscription, as a string.
1994 84 Ruud Klaver
  Note that if this argument is set, the {{{content_type}}} argument should also be set.
1995 84 Ruud Klaver
1996 84 Ruud Klaver
 '''push_content'''(''self'', '''content_type''', '''content''')::
1997 99 Adrian Georgescu
  Sets or updates the body of the {{{NOTIFY}}}s to be sent within this subscription and causes a {{{NOTIFY}}} to be sent to the subscriber.
1998 84 Ruud Klaver
  This method can only be called in the {{{"active"}}} state.
1999 84 Ruud Klaver
  [[BR]]''content_type'':[[BR]]
2000 84 Ruud Klaver
  The Content-Type of the content to be set supplied as a string containing a {{{"/"}}} character.
2001 84 Ruud Klaver
  [[BR]]''content'':[[BR]]
2002 84 Ruud Klaver
  The body of the {{{NOTIFY}}} as a string.
2003 84 Ruud Klaver
2004 84 Ruud Klaver
==== attributes ====
2005 84 Ruud Klaver
2006 84 Ruud Klaver
2007 84 Ruud Klaver
 '''state'''::
2008 99 Adrian Georgescu
  Indicates which state the incoming subscription session is in.
2009 84 Ruud Klaver
  This can be one of {{{None}}}, {{{"incoming"}}}, {{{"pending"}}}, {{{"active"}}} or {{{"terminated"}}}.
2010 84 Ruud Klaver
  This attribute is read-only.
2011 1 Adrian Georgescu
2012 1 Adrian Georgescu
 '''event'''::
2013 1 Adrian Georgescu
  The name of the event package that this {{{IncomingSubscription}}} relates to.
2014 1 Adrian Georgescu
  This attribute is a read-only string.
2015 1 Adrian Georgescu
2016 1 Adrian Georgescu
 '''content_type'''::
2017 1 Adrian Georgescu
  The {{{Content-Type}}} of the last set content in this subscription session.
2018 1 Adrian Georgescu
  Inititally this will be {{{None}}}.
2019 1 Adrian Georgescu
  This attribute is a read-only string.
2020 1 Adrian Georgescu
2021 1 Adrian Georgescu
 '''content'''::
2022 1 Adrian Georgescu
  The last set content in this subscription session as a read-only string.
2023 1 Adrian Georgescu
2024 1 Adrian Georgescu
==== notifications ====
2025 1 Adrian Georgescu
2026 1 Adrian Georgescu
2027 84 Ruud Klaver
 '''SIPIncomingSubscriptionChangedState'''::
2028 84 Ruud Klaver
  This notification will be sent every time the an {{{IncomingSubscription}}} object changes state.
2029 84 Ruud Klaver
  This notification is mostly indicative, an application should not let its logic depend on it.
2030 84 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
2031 84 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2032 84 Ruud Klaver
  [[BR]]''prev_state'':[[BR]]
2033 84 Ruud Klaver
  The previous state that the subscription was in.
2034 84 Ruud Klaver
  [[BR]]''state'':[[BR]]
2035 99 Adrian Georgescu
  The new state the subscription has.
2036 84 Ruud Klaver
2037 84 Ruud Klaver
 '''SIPIncomingSubscriptionGotSubscribe'''::
2038 84 Ruud Klaver
  This notification will be sent when a new {{{IncomingSubscription}}} is created as result of an incoming {{{SUBSCRIBE}}} request.
2039 99 Adrian Georgescu
  The application should listen for this notification, retain a reference to the object that sent it and either accept or reject it.
2040 84 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
2041 84 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2042 84 Ruud Klaver
  [[BR]]''method'':[[BR]]
2043 84 Ruud Klaver
  The method of the SIP request as a string, which will be {{{SUBSCRIBE}}}.
2044 84 Ruud Klaver
  [[BR]]''request_uri'':[[BR]]
2045 84 Ruud Klaver
  The request URI of the {{{SUBSCRIBE}}} request as a {{{FrozenSIPURI}}} object.
2046 99 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
2047 84 Ruud Klaver
  The headers of the {{{SUBSCRIBE}}} request as a dict, the values of which are the relevant header objects.
2048 84 Ruud Klaver
  [[BR]]''body'':[[BR]]
2049 84 Ruud Klaver
  The body of the {{{SUBSCRIBE}}} request as a string, or {{{None}}} if no body was included.
2050 84 Ruud Klaver
2051 99 Adrian Georgescu
 '''SIPIncomingSubscriptionGotRefreshingSubscribe'''::
2052 84 Ruud Klaver
  This notification indicates that a refreshing {{{SUBSCRIBE}}} request was received from the subscriber.
2053 84 Ruud Klaver
  It is purely informative, no action needs to be taken by the application as a result of it.
2054 84 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
2055 84 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2056 84 Ruud Klaver
  [[BR]]''method'':[[BR]]
2057 84 Ruud Klaver
  The method of the SIP request as a string, which will be {{{SUBSCRIBE}}}.
2058 84 Ruud Klaver
  [[BR]]''request_uri'':[[BR]]
2059 84 Ruud Klaver
  The request URI of the {{{SUBSCRIBE}}} request as a {{{FrozenSIPURI}}} object.
2060 84 Ruud Klaver
  [[BR]]''headers'':[[BR]]
2061 84 Ruud Klaver
  The headers of the {{{SUBSCRIBE}}} request as a dict, the values of which are the relevant header objects.
2062 99 Adrian Georgescu
  [[BR]]''body'':[[BR]]
2063 84 Ruud Klaver
  The body of the {{{SUBSCRIBE}}} request as a string, or {{{None}}} if no body was included.
2064 84 Ruud Klaver
2065 84 Ruud Klaver
 '''SIPIncomingSubscriptionGotUnsubscribe'''::
2066 84 Ruud Klaver
  This notification indicates that a {{{SUBSCRIBE}}} request with an {{{Expires}}} header of 0 was received from the subscriber, effectively requesting to unsubscribe.
2067 84 Ruud Klaver
  It is purely informative, no action needs to be taken by the application as a result of it.
2068 84 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
2069 84 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2070 84 Ruud Klaver
  [[BR]]''method'':[[BR]]
2071 95 Luci Stanescu
  The method of the SIP request as a string, which will be {{{SUBSCRIBE}}}.
2072 95 Luci Stanescu
  [[BR]]''request_uri'':[[BR]]
2073 99 Adrian Georgescu
  The request URI of the {{{SUBSCRIBE}}} request as a {{{FrozenSIPURI}}} object.
2074 95 Luci Stanescu
  [[BR]]''headers'':[[BR]]
2075 95 Luci Stanescu
  The headers of the {{{SUBSCRIBE}}} request as a dict, the values of which are the relevant header objects.
2076 95 Luci Stanescu
  [[BR]]''body'':[[BR]]
2077 95 Luci Stanescu
  The body of the {{{SUBSCRIBE}}} request or response as a string, or {{{None}}} if no body was included.
2078 99 Adrian Georgescu
2079 95 Luci Stanescu
 '''SIPIncomingSubscriptionAnsweredSubscribe'''::
2080 95 Luci Stanescu
  This notification is sent whenever a response to a {{{SUBSCRIBE}}} request is sent by the object, including an unsubscribing {{{SUBSCRIBE}}}.
2081 95 Luci Stanescu
  It is purely informative, no action needs to be taken by the application as a result of it.
2082 99 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2083 95 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2084 95 Luci Stanescu
  [[BR]]''code'':[[BR]]
2085 95 Luci Stanescu
  The code of the SIP response as an int.
2086 95 Luci Stanescu
  [[BR]]''reason'':[[BR]]
2087 99 Adrian Georgescu
  The reason text of the SIP response as an int.
2088 95 Luci Stanescu
  [[BR]]''headers'':[[BR]]
2089 95 Luci Stanescu
  The headers of the response as a dict, the values of which are the relevant header objects.
2090 95 Luci Stanescu
  [[BR]]''body'':[[BR]]
2091 1 Adrian Georgescu
  This will be {{{None}}}.
2092 1 Adrian Georgescu
2093 99 Adrian Georgescu
 '''SIPIncomingSubscriptionSentNotify'''::
2094 1 Adrian Georgescu
  This notification indicates that a {{{NOTIFY}}} request was sent to the subscriber.
2095 1 Adrian Georgescu
  It is purely informative, no action needs to be taken by the application as a result of it.
2096 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2097 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2098 1 Adrian Georgescu
  [[BR]]''method'':[[BR]]
2099 1 Adrian Georgescu
  The method of the SIP request as a string, which will be {{{NOTIFY}}}.
2100 1 Adrian Georgescu
  [[BR]]''request_uri'':[[BR]]
2101 1 Adrian Georgescu
  The request URI of the {{{NOTIFY}}} request as a {{{FrozenSIPURI}}} object.
2102 1 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
2103 99 Adrian Georgescu
  The headers of the {{{NOTIFY}}} request as a dict, the values of which are the relevant header objects.
2104 1 Adrian Georgescu
  [[BR]]''body'':[[BR]]
2105 1 Adrian Georgescu
  The body of the {{{NOTIFY}}} request or response as a string, or {{{None}}} if no body was included.
2106 1 Adrian Georgescu
2107 1 Adrian Georgescu
 '''SIPIncomingSubscriptionNotifyDidSucceed'''::
2108 1 Adrian Georgescu
  This indicates that a positive final response was received from the subscriber in reply to a sent {{{NOTIFY}}} request.
2109 18 Adrian Georgescu
  The notification is purely informative, no action needs to be taken by the application as a result of it.
2110 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2111 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2112 17 Ruud Klaver
  [[BR]]''code'':[[BR]]
2113 17 Ruud Klaver
  The code of the SIP response as an int.
2114 17 Ruud Klaver
  [[BR]]''reason'':[[BR]]
2115 17 Ruud Klaver
  The reason text of the SIP response as a string.
2116 17 Ruud Klaver
  [[BR]]''headers'':[[BR]]
2117 99 Adrian Georgescu
  The headers of the response as a dict, the values of which are the relevant header objects.
2118 17 Ruud Klaver
  [[BR]]''body'':[[BR]]
2119 17 Ruud Klaver
  This will be {{{None}}}.
2120 17 Ruud Klaver
2121 17 Ruud Klaver
 '''SIPIncomingSubscriptionNotifyDidFail'''::
2122 1 Adrian Georgescu
  This indicates that a negative response was received from the subscriber in reply to a sent {{{NOTIFY}}} request or that the {{{NOTIFY}}} failed to send.
2123 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2124 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2125 1 Adrian Georgescu
  [[BR]]''code'':[[BR]]
2126 1 Adrian Georgescu
  The code of the SIP response as an int.
2127 1 Adrian Georgescu
  If this is 0, the notification was sent as a result of an internal error.
2128 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
2129 1 Adrian Georgescu
  The reason text of the SIP response as a string or the internal error if the code attribute is 0.
2130 1 Adrian Georgescu
  [[BR]]''headers'': (if the notification was caused by a negative response)[[BR]]
2131 99 Adrian Georgescu
  The headers of the response as a dict, the values of which are the relevant header objects.
2132 17 Ruud Klaver
  [[BR]]''body'': (if the notification was caused by a negative response)[[BR]]
2133 1 Adrian Georgescu
  This will be {{{None}}}.
2134 1 Adrian Georgescu
2135 1 Adrian Georgescu
 '''SIPIncomingSubscriptionNotifyDidEnd'''::
2136 1 Adrian Georgescu
  This notification is sent whenever the {{{IncomingSubscription}}} object reaches the {{{"terminated"}}} state and is no longer valid.
2137 1 Adrian Georgescu
  After receiving this notification, the application should not longer try to use the object.
2138 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2139 17 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2140 1 Adrian Georgescu
2141 103 Adrian Georgescu
=== AudioMixer ===
2142 1 Adrian Georgescu
2143 103 Adrian Georgescu
A {{{AudioMixer}}} manages two audio devices, on for input and one for output, and is able to route audio data for a number of sources.
2144 103 Adrian Georgescu
It wraps a [http://www.pjsip.org/pjmedia/docs/html/group__PJMEDIA__CONF.htm PJSIP conference bridge], the concept of which is explained in the [http://trac.pjsip.org/repos/wiki/Python_SIP/Media PJSIP documentation].
2145 103 Adrian Georgescu
Any component in the core that either produces or consumes sound, i.e. {{{AudioTransport}}}, {{{ToneGenerator}}}, {{{WaveFile}}} and {{{RecordingWaveFile}}} objects, has a {{{ConferenceBridge}}} associated with it and a corresponding slot on that conference bridge.
2146 103 Adrian Georgescu
The sound devices, both input and output, together always occupy slot 0.
2147 103 Adrian Georgescu
It is up to the application to setup the desired routing between these components. Note that the middleware provides an abstracted API which hides the complexity of using the low-level PJSIP concepts. This is mainly provided in the [wiki:SipMiddlewareApi#Audio {{{sipsimple.audio}}}] module, but also consists of other audio-enabled objects (such as the AudioStream).
2148 1 Adrian Georgescu
2149 103 Adrian Georgescu
==== methods ====
2150 1 Adrian Georgescu
2151 1 Adrian Georgescu
2152 103 Adrian Georgescu
 '''!__init!__'''(''self'', '''input_device''', '''output_device''', '''sample_rate''', '''ec_tail_length'''=200, '''slot_count'''=254)::
2153 103 Adrian Georgescu
  Creates a new {{{ConferenceBridge}}} object.
2154 103 Adrian Georgescu
  [[BR]]''input_device'':[[BR]]
2155 103 Adrian Georgescu
  The name of the audio input device to use as a string, or {{{None}}} if no input device is to be used.
2156 103 Adrian Georgescu
  A list of known input devices can be queried through the {{{Engine.input_devices}}} attribute.
2157 105 Luci Stanescu
  If {{{"system_default"}}} is used, PJSIP will select the system default output device, or {{{None}}} if no audio input device is present.
2158 103 Adrian Georgescu
  The device that was selected can be queried afterwards through the {{{input_device}}} attribute.
2159 103 Adrian Georgescu
  [[BR]]''output_device'':[[BR]]
2160 103 Adrian Georgescu
  The name of the audio output device to use as a string, or {{{None}}} if no output device is to be used.
2161 103 Adrian Georgescu
  A list of known output devices can be queried through the {{{Engine.output_devices}}} attribute.
2162 105 Luci Stanescu
  If {{{"system_default"}}} is used, PJSIP will select the system default output device, or {{{None}}} if no audio output device is present.
2163 103 Adrian Georgescu
  The device that was selected can be queried afterwards through the {{{output_device}}} attribute.
2164 103 Adrian Georgescu
  [[BR]]''sample_rate'':[[BR]]
2165 103 Adrian Georgescu
  The sample rate on which the conference bridge and sound devices should operate in Hz.
2166 103 Adrian Georgescu
  This must be a multiple of 50.
2167 103 Adrian Georgescu
  [[BR]]''ec_tail_length'':[[BR]]
2168 103 Adrian Georgescu
  The echo cancellation tail length in ms.
2169 103 Adrian Georgescu
  If this value is 0, no echo cancellation is used.
2170 103 Adrian Georgescu
  [[BR]]''slot_count'':[[BR]]
2171 103 Adrian Georgescu
  The number of slots to allocate on the conference bridge.
2172 103 Adrian Georgescu
  Not that this includes the slot that is occupied by the sound devices.
2173 99 Adrian Georgescu
2174 103 Adrian Georgescu
 '''set_sound_devices'''(''self'', '''input_device''', '''output_device''', '''ec_tail_length''')::
2175 103 Adrian Georgescu
  Change the sound devices used (including echo cancellation) by the conference bridge.
2176 103 Adrian Georgescu
  The meaning of the parameters is that same as for {{{__init__()}}}.
2177 1 Adrian Georgescu
2178 103 Adrian Georgescu
 '''connect_slots'''(''self'', '''src_slot''', '''dst_slot''')::
2179 103 Adrian Georgescu
  Connect two slots on the conference bridge, making audio flow from {{{src_slot}}} to {{{dst_slot}}}.
2180 1 Adrian Georgescu
2181 103 Adrian Georgescu
 '''disconnect_slots'''(''self'', '''src_slot''', '''dst_slot''')::
2182 103 Adrian Georgescu
  Break the connection between the specified slots.
2183 103 Adrian Georgescu
  Note that when an audio object is stopped or destroyed, its connections on the conference bridge will automatically be removed.
2184 103 Adrian Georgescu
2185 1 Adrian Georgescu
==== attributes ====
2186 1 Adrian Georgescu
2187 99 Adrian Georgescu
2188 103 Adrian Georgescu
 '''input_device'''::
2189 103 Adrian Georgescu
  A string specifying the audio input device that is currently being used.
2190 103 Adrian Georgescu
  If there is no input device, this attribute will be {{{None}}}.
2191 103 Adrian Georgescu
  This attribute is read-only, but may be updated by calling the {{{set_sound_devices()}}} method.
2192 1 Adrian Georgescu
2193 103 Adrian Georgescu
 '''output_device'''::
2194 103 Adrian Georgescu
  A string specifying the audio output device that is currently being used.
2195 103 Adrian Georgescu
  If there is no output device, this attribute will be {{{None}}}.
2196 103 Adrian Georgescu
  This attribute is read-only, but may be updated by calling the {{{set_sound_devices()}}} method.
2197 1 Adrian Georgescu
2198 103 Adrian Georgescu
 '''sample_rate'''::
2199 103 Adrian Georgescu
  The sample rate in Hz that the conference bridge is currently operating on.
2200 103 Adrian Georgescu
  This read-only attribute is passed when the object is created.
2201 99 Adrian Georgescu
2202 103 Adrian Georgescu
 '''ec_tail_length'''::
2203 103 Adrian Georgescu
  The current echo cancellation tail length in ms.
2204 103 Adrian Georgescu
  If this value is 0, no echo cancellation is used.
2205 103 Adrian Georgescu
  This attribute is read-only, but may be updated by calling the {{{set_sound_devices()}}} method.
2206 1 Adrian Georgescu
2207 103 Adrian Georgescu
 '''slot_count'''::
2208 103 Adrian Georgescu
  The total number of slots that is available on the conference bridge
2209 103 Adrian Georgescu
  This read-only attribute is passed when the object is created.
2210 1 Adrian Georgescu
2211 103 Adrian Georgescu
 '''used_slot_count'''::
2212 103 Adrian Georgescu
  A read-only attribute indicating the number of slots that are used by objects.
2213 1 Adrian Georgescu
2214 103 Adrian Georgescu
 '''input_volume'''::
2215 103 Adrian Georgescu
  This writable property indicates the % of volume that is read from the audio input device.
2216 103 Adrian Georgescu
  By default this value is 100.
2217 1 Adrian Georgescu
2218 103 Adrian Georgescu
 '''output_volume'''::
2219 103 Adrian Georgescu
  This writable property indicates the % of volume that is sent to the audio output device.
2220 103 Adrian Georgescu
  By default this value is 100.
2221 1 Adrian Georgescu
2222 103 Adrian Georgescu
 '''muted'''::
2223 103 Adrian Georgescu
  This writable boolean property indicates if the input audio device is muted.
2224 1 Adrian Georgescu
2225 103 Adrian Georgescu
 '''connected_slots'''::
2226 103 Adrian Georgescu
  A read-only list of tupples indicating which slot is connected to which.
2227 103 Adrian Georgescu
  Connections are directional.
2228 1 Adrian Georgescu
2229 103 Adrian Georgescu
=== MixerPort ===
2230 1 Adrian Georgescu
2231 103 Adrian Georgescu
This a simple object which simply copies all the audio data it gets as input to it output. It's main purpose is that of facilitating the creation the of the middleware {{{AudioBridge}}} object.
2232 1 Adrian Georgescu
2233 103 Adrian Georgescu
==== methods ====
2234 1 Adrian Georgescu
2235 1 Adrian Georgescu
2236 103 Adrian Georgescu
 '''!__init!__'''(''self'', ''mixer'')::
2237 103 Adrian Georgescu
  Create a new MixerPort which is associated with the specified AudioMixer.
2238 1 Adrian Georgescu
2239 103 Adrian Georgescu
 '''start'''(''self'')::
2240 103 Adrian Georgescu
  Activate the mixer port. This will reserve a slot on the AudioMixer and allow it to be connected to other slots.
2241 78 Ruud Klaver
2242 103 Adrian Georgescu
 '''stop'''(''self'')::
2243 103 Adrian Georgescu
  Deactivate the mixer port. This will release the slot previously allocated on the AudioMixer and all connections which it had will be discarded.
2244 78 Ruud Klaver
2245 103 Adrian Georgescu
==== attributes ====
2246 78 Ruud Klaver
2247 103 Adrian Georgescu
2248 103 Adrian Georgescu
 '''mixer'''::
2249 103 Adrian Georgescu
  The AudioMixer this MixerPort is associated with
2250 103 Adrian Georgescu
  This attribute is read-only.
2251 103 Adrian Georgescu
2252 103 Adrian Georgescu
 '''is_active'''::
2253 103 Adrian Georgescu
  Whether or not this MixerPort has a slot associated in its AudioMixer.
2254 103 Adrian Georgescu
  This attribute is read-only.
2255 103 Adrian Georgescu
2256 103 Adrian Georgescu
 '''slot'''::
2257 103 Adrian Georgescu
  The slot this MixerPort has reserved on AudioMixer or {{{None}}} if it is not active.
2258 103 Adrian Georgescu
  This attribute is read-only.
2259 103 Adrian Georgescu
2260 103 Adrian Georgescu
2261 103 Adrian Georgescu
=== WaveFile ===
2262 103 Adrian Georgescu
2263 103 Adrian Georgescu
This is a simple object that allows playing back of a {{{.wav}}} file over the PJSIP conference bridge.
2264 103 Adrian Georgescu
Only 16-bit PCM and A-law/U-law formats are supported.
2265 103 Adrian Georgescu
Its main purpose is the playback of ringtones or previously recorded conversations.
2266 103 Adrian Georgescu
2267 103 Adrian Georgescu
This object is associated with a {{{AudioMixer}}} instance and, once the {{{start()}}} method is called, connects to it and sends the sound to all its connections.
2268 103 Adrian Georgescu
Note that the slot of the {{{WaveFile}}} object will not start playing until it is connected to another slot on the AudioMixer.
2269 103 Adrian Georgescu
If the {{{stop()}}} method is called or the end of the {{{.wav}}} file is reached, a {{{WaveFileDidFinishPlaying}}} notification is sent by the object.
2270 103 Adrian Georgescu
After this the {{{start()}}} method may be called again in order to re-use the object.
2271 103 Adrian Georgescu
2272 103 Adrian Georgescu
It is the application's responsibility to keep a reference to the {{{WaveFile}}} object for the duration of playback.
2273 103 Adrian Georgescu
If the reference count of the object reaches 0, playback will be stopped automatically.
2274 103 Adrian Georgescu
In this case no notification will be sent.
2275 103 Adrian Georgescu
2276 78 Ruud Klaver
==== methods ====
2277 99 Adrian Georgescu
2278 95 Luci Stanescu
2279 103 Adrian Georgescu
 '''!__init!__'''(''self'', '''mixer''', '''filename''')::
2280 103 Adrian Georgescu
  Creates a new {{{WaveFile}}} object.
2281 103 Adrian Georgescu
  [[BR]]''mixer'':[[BR]]
2282 103 Adrian Georgescu
  The {{{AudioMixer}}} object that this object is to be connected to.
2283 103 Adrian Georgescu
  [[BR]]''filename'':[[BR]]
2284 103 Adrian Georgescu
  The name of the {{{.wav}}} file to be played back as a string.
2285 103 Adrian Georgescu
  This should include the full path to the file.
2286 95 Luci Stanescu
2287 103 Adrian Georgescu
 '''start'''(''self'')::
2288 103 Adrian Georgescu
  Start playback of the {{{.wav}}} file.
2289 95 Luci Stanescu
2290 103 Adrian Georgescu
 '''stop'''(''self'')::
2291 103 Adrian Georgescu
  Stop playback of the file.
2292 95 Luci Stanescu
2293 103 Adrian Georgescu
==== attributes ====
2294 78 Ruud Klaver
2295 78 Ruud Klaver
2296 103 Adrian Georgescu
 '''mixer'''::
2297 103 Adrian Georgescu
  The {{{AudioMixer}}} this object is associated with.
2298 103 Adrian Georgescu
  This attribute is read-only.
2299 1 Adrian Georgescu
2300 103 Adrian Georgescu
 '''filename'''::
2301 103 Adrian Georgescu
  The name of the {{{.wav}}} file, as specified when the object was created.
2302 103 Adrian Georgescu
  This attribute is read-only.
2303 103 Adrian Georgescu
2304 103 Adrian Georgescu
 '''slot'''::
2305 103 Adrian Georgescu
  A read-only property indicating the slot number at which this object is attached to the associated AudioMixer.
2306 103 Adrian Georgescu
  If the {{{WaveFile}}} is not active, this attribute will be {{{None}}}.
2307 103 Adrian Georgescu
2308 103 Adrian Georgescu
 '''volume'''::
2309 103 Adrian Georgescu
  A writable property indicating the % of volume at which this object contributes audio to the AudioMixer.
2310 103 Adrian Georgescu
  By default this is set to 100.
2311 103 Adrian Georgescu
2312 103 Adrian Georgescu
 '''is_active'''::
2313 103 Adrian Georgescu
  A boolean read-only property that indicates if the file is currently being played.
2314 103 Adrian Georgescu
2315 95 Luci Stanescu
==== notifications ====
2316 95 Luci Stanescu
2317 99 Adrian Georgescu
2318 103 Adrian Georgescu
 '''WaveFileDidFinishPlaying'''::
2319 103 Adrian Georgescu
  This notification will be sent whenever playing of the {{{.wav}}} has stopped.
2320 103 Adrian Georgescu
  After sending this event, the playback may be re-started.
2321 95 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
2322 95 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2323 99 Adrian Georgescu
2324 103 Adrian Georgescu
=== RecordingWaveFile ===
2325 103 Adrian Georgescu
2326 103 Adrian Georgescu
This is a simple object that allows recording audio to a PCM {{{.wav}}} file.
2327 103 Adrian Georgescu
2328 103 Adrian Georgescu
This object is associated with a {{{AudioMixer}}} instance and, once the {{{start()}}} method is called, crecords sound from its connections.
2329 103 Adrian Georgescu
Note that the {{{RecordingWaveFile}}} will not record anything if it does not have any connections.
2330 103 Adrian Georgescu
Recording to the file can be stopped either by calling the {{{stop()}}} method or by removing all references to the object.
2331 103 Adrian Georgescu
Once the {{{stop()}}} method has been called, the {{{start()}}} method may not be called again.
2332 103 Adrian Georgescu
It is the application's responsibility to keep a reference to the {{{RecordingWaveFile}}} object for the duration of the recording, it will be stopped automatically when the reference count reaches 0.
2333 103 Adrian Georgescu
2334 103 Adrian Georgescu
==== methods ====
2335 103 Adrian Georgescu
2336 103 Adrian Georgescu
2337 103 Adrian Georgescu
 '''!__init!__'''(''self'', '''mixer''', '''filename''')::
2338 103 Adrian Georgescu
  Creates a new {{{RecordingWaveFile}}} object.
2339 103 Adrian Georgescu
  [[BR]]''mixer'':[[BR]]
2340 103 Adrian Georgescu
  The {{{AudioMixer}}} object that this object is to be associated with.
2341 103 Adrian Georgescu
  [[BR]]''filename'':[[BR]]
2342 103 Adrian Georgescu
  The name of the {{{.wav}}} file to record to as a string.
2343 103 Adrian Georgescu
  This should include the full path to the file.
2344 103 Adrian Georgescu
2345 103 Adrian Georgescu
 '''start'''(''self'')::
2346 103 Adrian Georgescu
  Start recording the sound to the {{{.wav}}} file.
2347 103 Adrian Georgescu
2348 103 Adrian Georgescu
 '''stop'''(''self'')::
2349 103 Adrian Georgescu
  Stop recording to the file.
2350 103 Adrian Georgescu
2351 103 Adrian Georgescu
==== attributes ====
2352 103 Adrian Georgescu
2353 103 Adrian Georgescu
2354 103 Adrian Georgescu
 '''mixer'''::
2355 103 Adrian Georgescu
  The {{{AudioMixer}}} this object is associated with.
2356 103 Adrian Georgescu
  This attribute is read-only.
2357 103 Adrian Georgescu
2358 103 Adrian Georgescu
 '''filename'''::
2359 103 Adrian Georgescu
  The name of the {{{.wav}}} file, as specified when the object was created.
2360 103 Adrian Georgescu
  This attribute is read-only.
2361 103 Adrian Georgescu
2362 103 Adrian Georgescu
 '''slot'''::
2363 103 Adrian Georgescu
  A read-only property indicating the slot number at which this object is attached to the associated AudioMixer.
2364 103 Adrian Georgescu
  If the {{{RecordingWaveFile}}} is not active, this attribute will be {{{None}}}.
2365 103 Adrian Georgescu
2366 103 Adrian Georgescu
 '''is_active'''::
2367 103 Adrian Georgescu
  A boolean read-only attribute that indicates if the file is currently being written to.
2368 103 Adrian Georgescu
2369 103 Adrian Georgescu
=== ToneGenerator ===
2370 103 Adrian Georgescu
2371 103 Adrian Georgescu
A {{{ToneGenerator}}} can generate a series of dual frequency tones and has a shortcut method for generating valid DTMF tones.
2372 103 Adrian Georgescu
Each instance of this object is associated with a {{{AudioMixer}}} object, which it will connect to once started.
2373 103 Adrian Georgescu
The tones will be sent to the slots on the AudioMixer its slot is connected to.
2374 103 Adrian Georgescu
Once started, a {{{ToneGenerator}}} can be stopped by calling the {{{stop()}}} method and is automatically destroyed when the reference count reaches 0.
2375 103 Adrian Georgescu
2376 103 Adrian Georgescu
> Note: this object has threading issues when the application uses multiple AudioMixers. It should not be used.
2377 103 Adrian Georgescu
2378 103 Adrian Georgescu
==== methods ====
2379 103 Adrian Georgescu
2380 103 Adrian Georgescu
2381 103 Adrian Georgescu
 '''!__init!__'''(''self'', '''mixer''')::
2382 103 Adrian Georgescu
  Creates a new {{{ToneGenerator}}} object.
2383 103 Adrian Georgescu
  [[BR]]''mixer'':[[BR]]
2384 103 Adrian Georgescu
  The {{{AudioMixer}}} object that this object is to be connected to.
2385 103 Adrian Georgescu
2386 103 Adrian Georgescu
 '''start'''(''self'')::
2387 103 Adrian Georgescu
  Start the tone generator and connect it to its associated {{{AudioMixer}}}.
2388 103 Adrian Georgescu
2389 103 Adrian Georgescu
 '''stop'''(''self'')::
2390 103 Adrian Georgescu
  Stop the tone generator and remove it from the conference bridge.
2391 103 Adrian Georgescu
2392 103 Adrian Georgescu
 '''play_tones(''self'', '''tones''')::
2393 103 Adrian Georgescu
  Play a sequence of single or dual frequency tones over the audio device.
2394 103 Adrian Georgescu
  [[BR]]''tones'':[[BR]]
2395 103 Adrian Georgescu
  This should be a list of 3-item tuples, in the form of {{{[(<freq1>, <freq2>, <duration>), ...]}}}, with Hz as unit for the frequencies and ms as unit for the duration.
2396 103 Adrian Georgescu
  If {{{freq2}}} is 0, this indicates that only {{{freq1}}} should be used for the tone.
2397 103 Adrian Georgescu
  If {{{freq1}}} is 0, this indicates a pause when no tone should be played for the set duration.
2398 103 Adrian Georgescu
2399 103 Adrian Georgescu
 '''play_dtmf(''self'', '''digit''')::
2400 103 Adrian Georgescu
  Play a single DTMF digit.
2401 103 Adrian Georgescu
  [[BR]]''digit'':[[BR]]
2402 103 Adrian Georgescu
  A string of length 1 containing a valid DTMF digit, i.e. 0 through 9, #, * or A through D.
2403 103 Adrian Georgescu
2404 103 Adrian Georgescu
==== attributes ====
2405 103 Adrian Georgescu
2406 103 Adrian Georgescu
2407 103 Adrian Georgescu
 '''mixer'''::
2408 103 Adrian Georgescu
  The {{{AudioMixer}}} this object is associated with.
2409 103 Adrian Georgescu
  This attribute is read-only.
2410 103 Adrian Georgescu
2411 103 Adrian Georgescu
 '''slot'''::
2412 103 Adrian Georgescu
  A read-only property indicating the slot number at which this object is attached to the associated AudioMixer.
2413 103 Adrian Georgescu
  If the {{{ToneGenerator}}} has not been started, this attribute will be {{{None}}}.
2414 103 Adrian Georgescu
2415 103 Adrian Georgescu
 '''volume'''::
2416 103 Adrian Georgescu
  A writable property indicating the % of volume at which this object contributes audio.
2417 103 Adrian Georgescu
  By default this is set to 100.
2418 103 Adrian Georgescu
2419 103 Adrian Georgescu
 '''is_active'''::
2420 103 Adrian Georgescu
  A boolean read-only property that indicates if the object has been started.
2421 103 Adrian Georgescu
2422 103 Adrian Georgescu
 '''is_busy'''::
2423 103 Adrian Georgescu
  A boolean read-only property indicating if the {{{ToneGenerator}}} is busy playing tones.
2424 103 Adrian Georgescu
2425 103 Adrian Georgescu
==== notifications ====
2426 103 Adrian Georgescu
2427 103 Adrian Georgescu
 '''ToneGeneratorDidFinishPlaying'''::
2428 103 Adrian Georgescu
  This notification will be sent whenever playing of the queued tones has finished.
2429 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2430 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.