SipCoreApiDocumentation

Version 100 (Adrian Georgescu, 03/31/2010 10:09 am)

1 89 Adrian Georgescu
= SIP Core API =
2 1 Adrian Georgescu
3 100 Adrian Georgescu
[[TOC(SipCoreApiDocumentation, SipMiddlewareApi, SipConfigurationAPI, 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 1 Adrian Georgescu
notification_center = NotificationCenter()
122 1 Adrian Georgescu
log_observer = EngineLogObserver()
123 29 Luci Stanescu
notification_center.add_observer(self, 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 96 Luci Stanescu
=== Credentials ===
470 91 Luci Stanescu
471 96 Luci Stanescu
The {{{Credentials}}} and {{{FrozenCredentails}}} simple objects represent authentication credentials for a particular SIP account.
472 91 Luci Stanescu
These can be included whenever creating a SIP primitive object that originates SIP requests.
473 96 Luci Stanescu
The attributes of this object are the same as the arguments to the {{{__init__}}} method.
474 91 Luci Stanescu
Note that the domain name of the SIP account is not stored on this object.
475 91 Luci Stanescu
476 91 Luci Stanescu
==== methods ====
477 91 Luci Stanescu
478 99 Adrian Georgescu
479 91 Luci Stanescu
 '''!__init!__'''(''self'', '''username''', '''password''')::
480 91 Luci Stanescu
  Creates the Credentials object with the specified parameters as attributes.
481 91 Luci Stanescu
  Each of these attributes can be accessed and changed on the object once instanced.
482 91 Luci Stanescu
  [[BR]]''username'':[[BR]]
483 91 Luci Stanescu
  A string representing the username of the account for which these are the credentials.
484 91 Luci Stanescu
  [[BR]]''password'':[[BR]]
485 91 Luci Stanescu
  The password for this SIP account as a string.
486 99 Adrian Georgescu
487 91 Luci Stanescu
 '''new'''(''cls'', ''credentials'')::
488 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).
489 91 Luci Stanescu
490 96 Luci Stanescu
=== SDPSession ===
491 91 Luci Stanescu
492 91 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. 
493 91 Luci Stanescu
494 96 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.
495 91 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.
496 91 Luci Stanescu
A {{{(Frozen)SDPSession}}} object may contain {{{(Frozen)SDPMediaStream}}}, {{{(Frozen)SDPConnection}}} and {{{(Frozen)SDPAttribute}}} objects.
497 91 Luci Stanescu
It supports comparison to other {{{(Frozen)SDPSession}}} objects using the == and != expressions.
498 91 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.
499 91 Luci Stanescu
500 91 Luci Stanescu
==== methods ====
501 91 Luci Stanescu
502 99 Adrian Georgescu
503 91 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}}})::
504 91 Luci Stanescu
  Creates the SDPSession object with the specified parameters as attributes.
505 91 Luci Stanescu
  Each of these attributes can be accessed and changed on the object once instanced.
506 91 Luci Stanescu
  [[BR]]''address'':[[BR]]
507 91 Luci Stanescu
  The address that is contained in the "o" (origin) line of the SDP as a string.
508 91 Luci Stanescu
  [[BR]]''id'':[[BR]]
509 91 Luci Stanescu
  The session identifier contained in the "o" (origin) line of the SDP as an int.
510 91 Luci Stanescu
  If this is set to {{{None}}} on init, a session identifier will be generated.
511 91 Luci Stanescu
  [[BR]]''version'':[[BR]]
512 91 Luci Stanescu
  The version identifier contained in the "o" (origin) line of the SDP as an int.
513 91 Luci Stanescu
  If this is set to {{{None}}} on init, a version identifier will be generated.
514 91 Luci Stanescu
  [[BR]]''user'':[[BR]]
515 91 Luci Stanescu
  The user name contained in the "o" (origin) line of the SDP as a string.
516 91 Luci Stanescu
  [[BR]]''net_type'':[[BR]]
517 91 Luci Stanescu
  The network type contained in the "o" (origin) line of the SDP as a string.
518 91 Luci Stanescu
  [[BR]]''address_type'':[[BR]]
519 91 Luci Stanescu
  The address type contained in the "o" (origin) line of the SDP as a string.
520 91 Luci Stanescu
  [[BR]]''name'':[[BR]]
521 91 Luci Stanescu
  The contents of the "s" (session name) line of the SDP as a string.
522 91 Luci Stanescu
  [[BR]]''info'':[[BR]]
523 91 Luci Stanescu
  The contents of the session level "i" (information) line of the SDP as a string.
524 91 Luci Stanescu
  If this is {{{None}}} or an empty string, the SDP has no "i" line.
525 91 Luci Stanescu
  [[BR]]''connection'':[[BR]]
526 91 Luci Stanescu
  The contents of the "c" (connection) line of the SDP as a {{{(Frozen)SDPConnection}}} object.
527 91 Luci Stanescu
  If this is set to {{{None}}}, the SDP has no session level "c" line.
528 91 Luci Stanescu
  [[BR]]''start_time'':[[BR]]
529 91 Luci Stanescu
  The first value of the "t" (time) line of the SDP as an int.
530 91 Luci Stanescu
  [[BR]]''stop_time'':[[BR]]
531 91 Luci Stanescu
  The second value of the "t" (time) line of the SDP as an int.
532 91 Luci Stanescu
  [[BR]]''attributes'':[[BR]]
533 91 Luci Stanescu
  The session level "a" lines (attributes) in the SDP represented by a list of {{{(Frozen)SDPAttribute}}} objects.
534 91 Luci Stanescu
  [[BR]]''media'':[[BR]]
535 91 Luci Stanescu
  The media sections of the SDP represented by a list of {{{(Frozen)SDPMediaStream}}} objects.
536 99 Adrian Georgescu
537 91 Luci Stanescu
 '''new'''(''cls'', ''sdp_session'')::
538 91 Luci Stanescu
  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).
539 91 Luci Stanescu
540 91 Luci Stanescu
==== attributes ====
541 91 Luci Stanescu
542 99 Adrian Georgescu
543 91 Luci Stanescu
 '''has_ice_proposal'''::
544 91 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.
545 91 Luci Stanescu
546 96 Luci Stanescu
=== SDPMediaStream ===
547 91 Luci Stanescu
548 96 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.
549 91 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.
550 91 Luci Stanescu
One or more {{{(Frozen)SDPMediaStream}}} objects are usually contained in a {{{(Frozen)SDPSession}}} object.
551 91 Luci Stanescu
It supports comparison to other {{{(Frozen)SDPMedia}}} objects using the == and != expressions.
552 91 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.
553 91 Luci Stanescu
554 91 Luci Stanescu
==== methods ====
555 91 Luci Stanescu
556 99 Adrian Georgescu
557 91 Luci Stanescu
 '''!__init!__'''(''self'', '''media''', '''port''', '''transport''', '''port_count'''=1, '''formats'''={{{None}}}, '''info'''={{{None}}}, '''connection'''={{{None}}}, '''attributes'''={{{None}}})::
558 91 Luci Stanescu
  Creates the SDPMedia object with the specified parameters as attributes.
559 91 Luci Stanescu
  Each of these attributes can be accessed and changed on the object once instanced.
560 91 Luci Stanescu
  [[BR]]''media'':[[BR]]
561 91 Luci Stanescu
  The media type contained in the "m" (media) line as a string.
562 91 Luci Stanescu
  [[BR]]''port'':[[BR]]
563 91 Luci Stanescu
  The transport port contained in the "m" (media) line as an int.
564 91 Luci Stanescu
  [[BR]]''transport'':[[BR]]
565 91 Luci Stanescu
  The transport protocol in the "m" (media) line as a string.
566 91 Luci Stanescu
  [[BR]]''port_count'':[[BR]]
567 91 Luci Stanescu
  The port count in the "m" (media) line as an int.
568 91 Luci Stanescu
  If this is set to 1, it is not included in the SDP.
569 91 Luci Stanescu
  [[BR]]''formats'':[[BR]]
570 91 Luci Stanescu
  The media formats in the "m" (media) line represented by a list of strings.
571 91 Luci Stanescu
  [[BR]]''info'':[[BR]]
572 91 Luci Stanescu
  The contents of the "i" (information) line of this media section as a string.
573 91 Luci Stanescu
  If this is {{{None}}} or an empty string, the media section has no "i" line.
574 91 Luci Stanescu
  [[BR]]''connection'':[[BR]]
575 91 Luci Stanescu
  The contents of the "c" (connection) line that is somewhere below the "m" line of this section as a {{{(Frozen)SDPConnection}}} object.
576 91 Luci Stanescu
  If this is set to {{{None}}}, this media section has no "c" line.
577 91 Luci Stanescu
  [[BR]]''attributes'':[[BR]]
578 91 Luci Stanescu
  The "a" lines (attributes) that are somewhere below the "m" line of this section represented by a list of {{{(Frozen)SDPAttribute}}} objects.
579 99 Adrian Georgescu
580 91 Luci Stanescu
 '''new'''(''cls'', ''sdp_media'')::
581 91 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).
582 91 Luci Stanescu
583 91 Luci Stanescu
==== attributes ====
584 91 Luci Stanescu
585 99 Adrian Georgescu
586 91 Luci Stanescu
 '''direction'''::
587 91 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".
588 91 Luci Stanescu
  If none of these attributes is present, the default direction is "sendrecv".
589 91 Luci Stanescu
590 96 Luci Stanescu
=== SDPConnection ===
591 91 Luci Stanescu
592 96 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.
593 91 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.
594 91 Luci Stanescu
A {{{(Frozen)SDPConnection}}} object can be contained in a {{{(Frozen)SDPSession}}} object or {{{(Frozen)SDPMediaStream}}} object.
595 91 Luci Stanescu
It supports comparison to other {{{(Frozen)SDPConnection}}} objects using the == and != expressions.
596 91 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.
597 91 Luci Stanescu
598 91 Luci Stanescu
==== methods ====
599 91 Luci Stanescu
600 99 Adrian Georgescu
601 91 Luci Stanescu
 '''!__init!__'''(''self'', '''address''', '''net_type'''="IN", '''address_type'''="IP4")::
602 91 Luci Stanescu
  Creates the SDPConnection object with the specified parameters as attributes.
603 91 Luci Stanescu
  Each of these attributes can be accessed and changed on the object once instanced.
604 91 Luci Stanescu
  [[BR]]''address'':[[BR]]
605 91 Luci Stanescu
  The address part of the connection line as a string.
606 91 Luci Stanescu
  [[BR]]''net_type'':[[BR]]
607 91 Luci Stanescu
  The network type part of the connection line as a string.
608 91 Luci Stanescu
  [[BR]]''address_type'':[[BR]]
609 91 Luci Stanescu
  The address type part of the connection line as a string.
610 99 Adrian Georgescu
611 91 Luci Stanescu
 '''new'''(''cls'', ''sdp_connection'')::
612 91 Luci Stanescu
  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).
613 91 Luci Stanescu
614 96 Luci Stanescu
=== SDPAttributeList ===
615 91 Luci Stanescu
616 96 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:
617 91 Luci Stanescu
618 99 Adrian Georgescu
619 91 Luci Stanescu
 '''!__contains!__'''(''self'', ''item'')::
620 91 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:
621 91 Luci Stanescu
  {{{
622 91 Luci Stanescu
  'ice-pwd' in sdp_session.attributes
623 91 Luci Stanescu
  }}}
624 99 Adrian Georgescu
625 91 Luci Stanescu
 '''getall'''(''self'', ''name'')::
626 91 Luci Stanescu
  Returns all the values of the attributes with the given name in a list.
627 99 Adrian Georgescu
628 91 Luci Stanescu
 '''getfirst'''(''self'', ''name'', ''default''={{{None}}})::
629 91 Luci Stanescu
  Return the first value of the attribute with the given name, or ''default'' is no such attribute exists.
630 91 Luci Stanescu
631 96 Luci Stanescu
=== SDPAttribute ===
632 91 Luci Stanescu
633 96 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.
634 91 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.
635 91 Luci Stanescu
One or more {{{(Frozen)SDPAttribute}}} objects can be contained in a {{{(Frozen)SDPSession}}} object or {{{(Frozen)SDPMediaStream}}} object.
636 91 Luci Stanescu
It supports comparison to other {{{(Frozen)SDPAttribute}}} objects using the == and != expressions.
637 91 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.
638 91 Luci Stanescu
639 91 Luci Stanescu
==== methods ====
640 91 Luci Stanescu
641 99 Adrian Georgescu
642 91 Luci Stanescu
 '''!__init!__'''(''self'', '''name''', '''value''')::
643 91 Luci Stanescu
  Creates the SDPAttribute object with the specified parameters as attributes.
644 91 Luci Stanescu
  Each of these attributes can be accessed and changed on the object once instanced.
645 91 Luci Stanescu
  [[BR]]''name'':[[BR]]
646 91 Luci Stanescu
  The name part of the attribute line as a string.
647 91 Luci Stanescu
  [[BR]]''value'':[[BR]]
648 91 Luci Stanescu
  The value part of the attribute line as a string.
649 99 Adrian Georgescu
650 91 Luci Stanescu
 '''new'''(''cls'', ''sdp_attribute'')::
651 91 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).
652 91 Luci Stanescu
653 91 Luci Stanescu
=== AudioMixer ===
654 91 Luci Stanescu
655 91 Luci Stanescu
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.
656 1 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].
657 1 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.
658 1 Adrian Georgescu
The sound devices, both input and output, together always occupy slot 0.
659 91 Luci Stanescu
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).
660 1 Adrian Georgescu
661 92 Luci Stanescu
==== methods ====
662 92 Luci Stanescu
663 99 Adrian Georgescu
664 92 Luci Stanescu
 '''!__init!__'''(''self'', '''input_device''', '''output_device''', '''sample_rate''', '''ec_tail_length'''=200, '''slot_count'''=254)::
665 92 Luci Stanescu
  Creates a new {{{ConferenceBridge}}} object.
666 92 Luci Stanescu
  [[BR]]''input_device'':[[BR]]
667 92 Luci Stanescu
  The name of the audio input device to use as a string, or {{{None}}} if no input device is to be used.
668 92 Luci Stanescu
  A list of known input devices can be queried through the {{{Engine.input_devices}}} attribute.
669 92 Luci Stanescu
  If {{{"default"}}} is used, PJSIP will select the system default output device, or {{{None}}} if no audio input device is present.
670 92 Luci Stanescu
  The device that was selected can be queried afterwards through the {{{input_device}}} attribute.
671 92 Luci Stanescu
  [[BR]]''output_device'':[[BR]]
672 92 Luci Stanescu
  The name of the audio output device to use as a string, or {{{None}}} if no output device is to be used.
673 92 Luci Stanescu
  A list of known output devices can be queried through the {{{Engine.output_devices}}} attribute.
674 92 Luci Stanescu
  If {{{"default"}}} is used, PJSIP will select the system default output device, or {{{None}}} if no audio output device is present.
675 92 Luci Stanescu
  The device that was selected can be queried afterwards through the {{{output_device}}} attribute.
676 92 Luci Stanescu
  [[BR]]''sample_rate'':[[BR]]
677 92 Luci Stanescu
  The sample rate on which the conference bridge and sound devices should operate in Hz.
678 92 Luci Stanescu
  This must be a multiple of 50.
679 92 Luci Stanescu
  [[BR]]''ec_tail_length'':[[BR]]
680 92 Luci Stanescu
  The echo cancellation tail length in ms.
681 92 Luci Stanescu
  If this value is 0, no echo cancellation is used.
682 92 Luci Stanescu
  [[BR]]''slot_count'':[[BR]]
683 92 Luci Stanescu
  The number of slots to allocate on the conference bridge.
684 92 Luci Stanescu
  Not that this includes the slot that is occupied by the sound devices.
685 99 Adrian Georgescu
686 92 Luci Stanescu
 '''set_sound_devices'''(''self'', '''input_device''', '''output_device''', '''ec_tail_length''')::
687 92 Luci Stanescu
  Change the sound devices used (including echo cancellation) by the conference bridge.
688 92 Luci Stanescu
  The meaning of the parameters is that same as for {{{__init__()}}}.
689 99 Adrian Georgescu
690 92 Luci Stanescu
 '''connect_slots'''(''self'', '''src_slot''', '''dst_slot''')::
691 92 Luci Stanescu
  Connect two slots on the conference bridge, making audio flow from {{{src_slot}}} to {{{dst_slot}}}.
692 99 Adrian Georgescu
693 92 Luci Stanescu
 '''disconnect_slots'''(''self'', '''src_slot''', '''dst_slot''')::
694 92 Luci Stanescu
  Break the connection between the specified slots.
695 92 Luci Stanescu
  Note that when an audio object is stopped or destroyed, its connections on the conference bridge will automatically be removed.
696 92 Luci Stanescu
697 1 Adrian Georgescu
==== attributes ====
698 1 Adrian Georgescu
699 99 Adrian Georgescu
700 1 Adrian Georgescu
 '''input_device'''::
701 23 Ruud Klaver
  A string specifying the audio input device that is currently being used.
702 1 Adrian Georgescu
  If there is no input device, this attribute will be {{{None}}}.
703 1 Adrian Georgescu
  This attribute is read-only, but may be updated by calling the {{{set_sound_devices()}}} method.
704 99 Adrian Georgescu
705 61 Ruud Klaver
 '''output_device'''::
706 1 Adrian Georgescu
  A string specifying the audio output device that is currently being used.
707 1 Adrian Georgescu
  If there is no output device, this attribute will be {{{None}}}.
708 61 Ruud Klaver
  This attribute is read-only, but may be updated by calling the {{{set_sound_devices()}}} method.
709 99 Adrian Georgescu
710 61 Ruud Klaver
 '''sample_rate'''::
711 1 Adrian Georgescu
  The sample rate in Hz that the conference bridge is currently operating on.
712 1 Adrian Georgescu
  This read-only attribute is passed when the object is created.
713 99 Adrian Georgescu
714 1 Adrian Georgescu
 '''ec_tail_length'''::
715 1 Adrian Georgescu
  The current echo cancellation tail length in ms.
716 1 Adrian Georgescu
  If this value is 0, no echo cancellation is used.
717 1 Adrian Georgescu
  This attribute is read-only, but may be updated by calling the {{{set_sound_devices()}}} method.
718 99 Adrian Georgescu
719 1 Adrian Georgescu
 '''slot_count'''::
720 1 Adrian Georgescu
  The total number of slots that is available on the conference bridge
721 1 Adrian Georgescu
  This read-only attribute is passed when the object is created.
722 99 Adrian Georgescu
723 1 Adrian Georgescu
 '''used_slot_count'''::
724 1 Adrian Georgescu
  A read-only attribute indicating the number of slots that are used by objects.
725 99 Adrian Georgescu
726 1 Adrian Georgescu
 '''input_volume'''::
727 1 Adrian Georgescu
  This writable property indicates the % of volume that is read from the audio input device.
728 1 Adrian Georgescu
  By default this value is 100.
729 99 Adrian Georgescu
730 1 Adrian Georgescu
 '''output_volume'''::
731 1 Adrian Georgescu
  This writable property indicates the % of volume that is sent to the audio output device.
732 1 Adrian Georgescu
  By default this value is 100.
733 99 Adrian Georgescu
734 1 Adrian Georgescu
 '''muted'''::
735 1 Adrian Georgescu
  This writable boolean property indicates if the input audio device is muted.
736 99 Adrian Georgescu
737 1 Adrian Georgescu
 '''connected_slots'''::
738 1 Adrian Georgescu
  A read-only list of tupples indicating which slot is connected to which.
739 1 Adrian Georgescu
  Connections are directional.
740 1 Adrian Georgescu
741 92 Luci Stanescu
=== MixerPort ===
742 92 Luci Stanescu
743 92 Luci Stanescu
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.
744 92 Luci Stanescu
745 1 Adrian Georgescu
==== methods ====
746 1 Adrian Georgescu
747 99 Adrian Georgescu
748 92 Luci Stanescu
 '''!__init!__'''(''self'', ''mixer'')::
749 92 Luci Stanescu
  Create a new MixerPort which is associated with the specified AudioMixer.
750 99 Adrian Georgescu
751 92 Luci Stanescu
 '''start'''(''self'')::
752 92 Luci Stanescu
  Activate the mixer port. This will reserve a slot on the AudioMixer and allow it to be connected to other slots.
753 99 Adrian Georgescu
754 92 Luci Stanescu
 '''stop'''(''self'')::
755 92 Luci Stanescu
  Deactivate the mixer port. This will release the slot previously allocated on the AudioMixer and all connections which it had will be discarded.
756 1 Adrian Georgescu
757 92 Luci Stanescu
==== attributes ====
758 92 Luci Stanescu
759 99 Adrian Georgescu
760 92 Luci Stanescu
 '''mixer'''::
761 92 Luci Stanescu
  The AudioMixer this MixerPort is associated with
762 92 Luci Stanescu
  This attribute is read-only.
763 99 Adrian Georgescu
764 92 Luci Stanescu
 '''is_active'''::
765 92 Luci Stanescu
  Whether or not this MixerPort has a slot associated in its AudioMixer.
766 92 Luci Stanescu
  This attribute is read-only.
767 99 Adrian Georgescu
768 92 Luci Stanescu
 '''slot'''::
769 92 Luci Stanescu
  The slot this MixerPort has reserved on AudioMixer or {{{None}}} if it is not active.
770 92 Luci Stanescu
  This attribute is read-only.
771 92 Luci Stanescu
772 92 Luci Stanescu
773 92 Luci Stanescu
=== WaveFile ===
774 92 Luci Stanescu
775 92 Luci Stanescu
This is a simple object that allows playing back of a {{{.wav}}} file over the PJSIP conference bridge.
776 92 Luci Stanescu
Only 16-bit PCM and A-law/U-law formats are supported.
777 92 Luci Stanescu
Its main purpose is the playback of ringtones or previously recorded conversations.
778 92 Luci Stanescu
779 92 Luci Stanescu
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.
780 92 Luci Stanescu
Note that the slot of the {{{WaveFile}}} object will not start playing until it is connected to another slot on the AudioMixer.
781 92 Luci Stanescu
If the {{{stop()}}} method is called or the end of the {{{.wav}}} file is reached, a {{{WaveFileDidFinishPlaying}}} notification is sent by the object.
782 92 Luci Stanescu
After this the {{{start()}}} method may be called again in order to re-use the object.
783 92 Luci Stanescu
784 92 Luci Stanescu
It is the application's responsibility to keep a reference to the {{{WaveFile}}} object for the duration of playback.
785 92 Luci Stanescu
If the reference count of the object reaches 0, playback will be stopped automatically.
786 92 Luci Stanescu
In this case no notification will be sent.
787 92 Luci Stanescu
788 92 Luci Stanescu
==== methods ====
789 92 Luci Stanescu
790 99 Adrian Georgescu
791 92 Luci Stanescu
 '''!__init!__'''(''self'', '''mixer''', '''filename''')::
792 92 Luci Stanescu
  Creates a new {{{WaveFile}}} object.
793 92 Luci Stanescu
  [[BR]]''mixer'':[[BR]]
794 92 Luci Stanescu
  The {{{AudioMixer}}} object that this object is to be connected to.
795 92 Luci Stanescu
  [[BR]]''filename'':[[BR]]
796 92 Luci Stanescu
  The name of the {{{.wav}}} file to be played back as a string.
797 92 Luci Stanescu
  This should include the full path to the file.
798 99 Adrian Georgescu
799 92 Luci Stanescu
 '''start'''(''self'')::
800 92 Luci Stanescu
  Start playback of the {{{.wav}}} file.
801 99 Adrian Georgescu
802 92 Luci Stanescu
 '''stop'''(''self'')::
803 92 Luci Stanescu
  Stop playback of the file.
804 92 Luci Stanescu
805 92 Luci Stanescu
==== attributes ====
806 92 Luci Stanescu
807 99 Adrian Georgescu
808 92 Luci Stanescu
 '''mixer'''::
809 92 Luci Stanescu
  The {{{AudioMixer}}} this object is associated with.
810 92 Luci Stanescu
  This attribute is read-only.
811 99 Adrian Georgescu
812 92 Luci Stanescu
 '''filename'''::
813 92 Luci Stanescu
  The name of the {{{.wav}}} file, as specified when the object was created.
814 92 Luci Stanescu
  This attribute is read-only.
815 99 Adrian Georgescu
816 92 Luci Stanescu
 '''slot'''::
817 92 Luci Stanescu
  A read-only property indicating the slot number at which this object is attached to the associated AudioMixer.
818 92 Luci Stanescu
  If the {{{WaveFile}}} is not active, this attribute will be {{{None}}}.
819 99 Adrian Georgescu
820 92 Luci Stanescu
 '''volume'''::
821 92 Luci Stanescu
  A writable property indicating the % of volume at which this object contributes audio to the AudioMixer.
822 92 Luci Stanescu
  By default this is set to 100.
823 99 Adrian Georgescu
824 92 Luci Stanescu
 '''is_active'''::
825 92 Luci Stanescu
  A boolean read-only property that indicates if the file is currently being played.
826 92 Luci Stanescu
827 92 Luci Stanescu
==== notifications ====
828 92 Luci Stanescu
829 99 Adrian Georgescu
830 92 Luci Stanescu
 '''WaveFileDidFinishPlaying'''::
831 92 Luci Stanescu
  This notification will be sent whenever playing of the {{{.wav}}} has stopped.
832 92 Luci Stanescu
  After sending this event, the playback may be re-started.
833 92 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
834 92 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
835 92 Luci Stanescu
836 92 Luci Stanescu
=== RecordingWaveFile ===
837 92 Luci Stanescu
838 92 Luci Stanescu
This is a simple object that allows recording audio to a PCM {{{.wav}}} file.
839 92 Luci Stanescu
840 92 Luci Stanescu
This object is associated with a {{{AudioMixer}}} instance and, once the {{{start()}}} method is called, crecords sound from its connections.
841 92 Luci Stanescu
Note that the {{{RecordingWaveFile}}} will not record anything if it does not have any connections.
842 92 Luci Stanescu
Recording to the file can be stopped either by calling the {{{stop()}}} method or by removing all references to the object.
843 92 Luci Stanescu
Once the {{{stop()}}} method has been called, the {{{start()}}} method may not be called again.
844 92 Luci Stanescu
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.
845 92 Luci Stanescu
846 92 Luci Stanescu
==== methods ====
847 92 Luci Stanescu
848 99 Adrian Georgescu
849 92 Luci Stanescu
 '''!__init!__'''(''self'', '''mixer''', '''filename''')::
850 92 Luci Stanescu
  Creates a new {{{RecordingWaveFile}}} object.
851 92 Luci Stanescu
  [[BR]]''mixer'':[[BR]]
852 92 Luci Stanescu
  The {{{AudioMixer}}} object that this object is to be associated with.
853 92 Luci Stanescu
  [[BR]]''filename'':[[BR]]
854 92 Luci Stanescu
  The name of the {{{.wav}}} file to record to as a string.
855 92 Luci Stanescu
  This should include the full path to the file.
856 99 Adrian Georgescu
857 92 Luci Stanescu
 '''start'''(''self'')::
858 92 Luci Stanescu
  Start recording the sound to the {{{.wav}}} file.
859 99 Adrian Georgescu
860 92 Luci Stanescu
 '''stop'''(''self'')::
861 92 Luci Stanescu
  Stop recording to the file.
862 92 Luci Stanescu
863 92 Luci Stanescu
==== attributes ====
864 92 Luci Stanescu
865 99 Adrian Georgescu
866 92 Luci Stanescu
 '''mixer'''::
867 92 Luci Stanescu
  The {{{AudioMixer}}} this object is associated with.
868 92 Luci Stanescu
  This attribute is read-only.
869 99 Adrian Georgescu
870 92 Luci Stanescu
 '''filename'''::
871 92 Luci Stanescu
  The name of the {{{.wav}}} file, as specified when the object was created.
872 92 Luci Stanescu
  This attribute is read-only.
873 99 Adrian Georgescu
874 92 Luci Stanescu
 '''slot'''::
875 92 Luci Stanescu
  A read-only property indicating the slot number at which this object is attached to the associated AudioMixer.
876 92 Luci Stanescu
  If the {{{RecordingWaveFile}}} is not active, this attribute will be {{{None}}}.
877 99 Adrian Georgescu
878 92 Luci Stanescu
 '''is_active'''::
879 92 Luci Stanescu
  A boolean read-only attribute that indicates if the file is currently being written to.
880 92 Luci Stanescu
881 92 Luci Stanescu
=== ToneGenerator ===
882 92 Luci Stanescu
883 92 Luci Stanescu
A {{{ToneGenerator}}} can generate a series of dual frequency tones and has a shortcut method for generating valid DTMF tones.
884 92 Luci Stanescu
Each instance of this object is associated with a {{{AudioMixer}}} object, which it will connect to once started.
885 92 Luci Stanescu
The tones will be sent to the slots on the AudioMixer its slot is connected to.
886 92 Luci Stanescu
Once started, a {{{ToneGenerator}}} can be stopped by calling the {{{stop()}}} method and is automatically destroyed when the reference count reaches 0.
887 92 Luci Stanescu
888 92 Luci Stanescu
> Note: this object has threading issues when the application uses multiple AudioMixers. It should not be used.
889 92 Luci Stanescu
890 92 Luci Stanescu
==== methods ====
891 92 Luci Stanescu
892 99 Adrian Georgescu
893 92 Luci Stanescu
 '''!__init!__'''(''self'', '''mixer''')::
894 92 Luci Stanescu
  Creates a new {{{ToneGenerator}}} object.
895 92 Luci Stanescu
  [[BR]]''mixer'':[[BR]]
896 92 Luci Stanescu
  The {{{AudioMixer}}} object that this object is to be connected to.
897 99 Adrian Georgescu
898 92 Luci Stanescu
 '''start'''(''self'')::
899 92 Luci Stanescu
  Start the tone generator and connect it to its associated {{{AudioMixer}}}.
900 99 Adrian Georgescu
901 92 Luci Stanescu
 '''stop'''(''self'')::
902 92 Luci Stanescu
  Stop the tone generator and remove it from the conference bridge.
903 99 Adrian Georgescu
904 92 Luci Stanescu
 '''play_tones(''self'', '''tones''')::
905 92 Luci Stanescu
  Play a sequence of single or dual frequency tones over the audio device.
906 92 Luci Stanescu
  [[BR]]''tones'':[[BR]]
907 92 Luci Stanescu
  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.
908 92 Luci Stanescu
  If {{{freq2}}} is 0, this indicates that only {{{freq1}}} should be used for the tone.
909 92 Luci Stanescu
  If {{{freq1}}} is 0, this indicates a pause when no tone should be played for the set duration.
910 99 Adrian Georgescu
911 92 Luci Stanescu
 '''play_dtmf(''self'', '''digit''')::
912 92 Luci Stanescu
  Play a single DTMF digit.
913 92 Luci Stanescu
  [[BR]]''digit'':[[BR]]
914 92 Luci Stanescu
  A string of length 1 containing a valid DTMF digit, i.e. 0 through 9, #, * or A through D.
915 92 Luci Stanescu
916 92 Luci Stanescu
==== attributes ====
917 92 Luci Stanescu
918 99 Adrian Georgescu
919 92 Luci Stanescu
 '''mixer'''::
920 92 Luci Stanescu
  The {{{AudioMixer}}} this object is associated with.
921 92 Luci Stanescu
  This attribute is read-only.
922 99 Adrian Georgescu
923 92 Luci Stanescu
 '''slot'''::
924 92 Luci Stanescu
  A read-only property indicating the slot number at which this object is attached to the associated AudioMixer.
925 92 Luci Stanescu
  If the {{{ToneGenerator}}} has not been started, this attribute will be {{{None}}}.
926 99 Adrian Georgescu
927 92 Luci Stanescu
 '''volume'''::
928 92 Luci Stanescu
  A writable property indicating the % of volume at which this object contributes audio.
929 92 Luci Stanescu
  By default this is set to 100.
930 99 Adrian Georgescu
931 92 Luci Stanescu
 '''is_active'''::
932 92 Luci Stanescu
  A boolean read-only property that indicates if the object has been started.
933 99 Adrian Georgescu
934 92 Luci Stanescu
 '''is_busy'''::
935 92 Luci Stanescu
  A boolean read-only property indicating if the {{{ToneGenerator}}} is busy playing tones.
936 92 Luci Stanescu
937 92 Luci Stanescu
==== notifications ====
938 92 Luci Stanescu
939 99 Adrian Georgescu
940 92 Luci Stanescu
 '''ToneGeneratorDidFinishPlaying'''::
941 92 Luci Stanescu
  This notification will be sent whenever playing of the queued tones has finished.
942 92 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
943 92 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
944 92 Luci Stanescu
945 93 Luci Stanescu
=== RTPTransport ===
946 93 Luci Stanescu
947 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.
948 93 Luci Stanescu
Internally it wraps a [http://www.pjsip.org/pjmedia/docs/html/group__PJMEDIA__TRANSPORT.htm pjmedia_transport] object.
949 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].
950 93 Luci Stanescu
For this reason the {{{AudioTransport}}} and {{{RTPTransport}}} are two distinct objects.
951 93 Luci Stanescu
952 93 Luci Stanescu
The {{{RTPTransport}}} object also allows support for ICE and SRTP functionality from PJSIP.
953 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.
954 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.
955 93 Luci Stanescu
This process of SDP negotiation is represented by the internal state machine of the object, as shown in the following diagram:
956 93 Luci Stanescu
957 93 Luci Stanescu
> The Real-time Transport Protocol (or RTP) defines a standardized packet format for delivering audio and video over the Internet.
958 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].
959 93 Luci Stanescu
> RTP is used in streaming media systems (together with the RTSP) as well as in videoconferencing and push to talk systems.
960 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.
961 93 Luci Stanescu
962 93 Luci Stanescu
[[Image(sipsimple-rtp-transport-state-machine.png, nolink)]]
963 93 Luci Stanescu
964 93 Luci Stanescu
State changes are triggered by the following events:
965 93 Luci Stanescu
 1. The application calls the {{{set_INIT()}}} method after object creation and ICE+STUN is not used.
966 93 Luci Stanescu
 2. The application calls the {{{set_INIT()}}} method after object creation and ICE+STUN is used.
967 93 Luci Stanescu
 3. A successful STUN response is received from the STUN server.
968 93 Luci Stanescu
 4. The {{{set_LOCAL()}}} method is called.
969 93 Luci Stanescu
 5. The {{{set_ESTABLISHED()}}} method is called.
970 93 Luci Stanescu
 6. The {{{set_INIT()}}} method is called while the object is in the {{{LOCAL}}} or {{{ESTABLISHED}}} state.
971 93 Luci Stanescu
 7. A method is called on the application, but in the meantime the {{{Engine}}} has stopped.
972 93 Luci Stanescu
    The object can no longer be used.
973 93 Luci Stanescu
 8. There was an error in getting the STUN candidates from the STUN server.
974 93 Luci Stanescu
975 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.
976 93 Luci Stanescu
> This means that the RTPTransport object is also unusable once it has reached the STUN_FAILED state.
977 93 Luci Stanescu
> A workaround would be destroy the RTPTransport object and create a new one that uses ICE without STUN.
978 93 Luci Stanescu
979 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.
980 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.
981 93 Luci Stanescu
 * The first scenario is where the local party generates the SDP offer.
982 93 Luci Stanescu
   For a stream that it wishes to include in this SDP offer, it instantiates a {{{RTPTransport}}} object.
983 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.
984 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).
985 93 Luci Stanescu
   Depending on the options used for the {{{RTPTransport}}} instantiation (such as ICE and SRTP), this may change the {{{SDPSession}}} object.
986 93 Luci Stanescu
   This (possibly changed) {{{SDPSession}}} object then needs to be passed to the {{{Invitation}}} object.
987 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.
988 93 Luci Stanescu
   This will not change either of the {{{(Frozen)SDPSession}}} objects (which is why they can also be frozen).
989 93 Luci Stanescu
 * The second scenario is where the local party is offered a media stream in SDP and wants to accept it.
990 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.
991 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.
992 93 Luci Stanescu
   In this case the local SDP object may be changed, after which it can be passed to the {{{Invitation}}} object.
993 93 Luci Stanescu
994 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.
995 93 Luci Stanescu
Before doing this however, the internal transport object must no longer be in use.
996 93 Luci Stanescu
997 93 Luci Stanescu
==== methods ====
998 93 Luci Stanescu
999 99 Adrian Georgescu
1000 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)::
1001 93 Luci Stanescu
  Creates a new {{{RTPTransport}}} object and opens the RTP and RTCP UDP sockets.
1002 93 Luci Stanescu
  If additional features are requested, they will be initialized.
1003 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.
1004 93 Luci Stanescu
  [[BR]]''local_rtp_address'':[[BR]]
1005 93 Luci Stanescu
  Optionally contains the local IPv4 address to listen on.
1006 93 Luci Stanescu
  If this is not specified, PJSIP will listen on all network interfaces.
1007 93 Luci Stanescu
  [[BR]]''use_srtp'':[[BR]]
1008 93 Luci Stanescu
  A boolean indicating if SRTP should be used.
1009 93 Luci Stanescu
  If this is set to {{{True}}}, SRTP information will be added to the SDP when it passes this object.
1010 93 Luci Stanescu
  [[BR]]''srtp_forced'':[[BR]]
1011 93 Luci Stanescu
  A boolean indicating if use of SRTP is set to mandatory in the SDP.
1012 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.
1013 93 Luci Stanescu
  This argument is relevant only if {{{use_srtp}}} is set to {{{True}}}.
1014 93 Luci Stanescu
  [[BR]]''use_ice'':[[BR]]
1015 93 Luci Stanescu
  A boolean indicating if ICE should be used.
1016 93 Luci Stanescu
  If this is set to {{{True}}}, ICE candidates will be added to the SDP when it passes this object.
1017 93 Luci Stanescu
  [[BR]]''ice_stun_address'':[[BR]]
1018 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.
1019 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.
1020 93 Luci Stanescu
  When this happens a {{{RTPTransportGotSTUNResponse}}} notification is sent.
1021 93 Luci Stanescu
  This argument is relevant only if {{{use_ice}}} is set to {{{True}}}.
1022 93 Luci Stanescu
  [[BR]]''ice_stun_address'':[[BR]]
1023 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.
1024 93 Luci Stanescu
  This argument is relevant only if {{{use_ice}}} is set to {{{True}}} and {{{ice_stun_address}}} is not {{{None}}}.
1025 99 Adrian Georgescu
1026 93 Luci Stanescu
 '''set_INIT'''(''self'')::
1027 93 Luci Stanescu
  This moves the internal state machine into the {{{INIT}}} state.
1028 93 Luci Stanescu
  If the state machine is in the {{{LOCAL}}} or {{{ESTABLISHED}}} states, this effectively resets the {{{RTPTransport}}} object for re-use.
1029 99 Adrian Georgescu
1030 93 Luci Stanescu
 '''set_LOCAL'''(''self'', '''local_sdp''', '''sdp_index''')::
1031 93 Luci Stanescu
  This moves the the internal state machine into the {{{LOCAL}}} state.
1032 93 Luci Stanescu
  [[BR]]''local_sdp'':[[BR]]
1033 93 Luci Stanescu
  The local SDP to be proposed in the form of a {{{SDPSession}}} object.
1034 93 Luci Stanescu
  Note that this object may be modified by this method.
1035 93 Luci Stanescu
  [[BR]]''sdp_index'':[[BR]]
1036 93 Luci Stanescu
  The index in the SDP for the media stream for which this object was created.
1037 99 Adrian Georgescu
1038 93 Luci Stanescu
 '''set_ESTABLISHED'''(''self'', '''local_sdp''', '''remote_sdp''', '''sdp_index''')::
1039 93 Luci Stanescu
  This moves the the internal state machine into the {{{ESTABLISHED}}} state.
1040 93 Luci Stanescu
  [[BR]]''local_sdp'':[[BR]]
1041 93 Luci Stanescu
  The local SDP to be proposed in the form of a {{{SDPSession}}} object.
1042 93 Luci Stanescu
  Note that this object may be modified by this method, but only when moving from the {{{LOCAL}}} to the {{{ESTABLISHED}}} state.
1043 93 Luci Stanescu
  [[BR]]''remote_sdp'':[[BR]]
1044 93 Luci Stanescu
  The remote SDP that was received in in the form of a {{{SDPSession}}} object.
1045 93 Luci Stanescu
  [[BR]]''sdp_index'':[[BR]]
1046 93 Luci Stanescu
  The index in the SDP for the media stream for which this object was created.
1047 93 Luci Stanescu
1048 93 Luci Stanescu
==== attributes ====
1049 93 Luci Stanescu
1050 99 Adrian Georgescu
1051 93 Luci Stanescu
 '''state'''::
1052 93 Luci Stanescu
  Indicates which state the internal state machine is in.
1053 93 Luci Stanescu
  See the previous section for a list of states the state machine can be in.
1054 93 Luci Stanescu
  This attribute is read-only.
1055 99 Adrian Georgescu
1056 93 Luci Stanescu
 '''local_rtp_address'''::
1057 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.
1058 93 Luci Stanescu
  If no address was specified during object instantiation, PJSIP will take guess out of the IP addresses of all interfaces.
1059 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} if PJSIP is not listening on the transport.
1060 99 Adrian Georgescu
1061 93 Luci Stanescu
 '''local_rtp_port'''::
1062 93 Luci Stanescu
  The UDP port PJSIP is listening on for RTP traffic.
1063 93 Luci Stanescu
  RTCP traffic will always be this port plus one.
1064 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} if PJSIP is not listening on the transport.
1065 99 Adrian Georgescu
1066 93 Luci Stanescu
 '''remote_rtp_address_sdp'''::
1067 93 Luci Stanescu
  The remote IP address that was seen in the SDP.
1068 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} unless the object is in the {{{ESTABLISHED}}} state.
1069 99 Adrian Georgescu
1070 93 Luci Stanescu
 '''remote_rtp_port_sdp'''::
1071 93 Luci Stanescu
  The remote UDP port for RTP that was seen in the SDP.
1072 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} unless the object is in the {{{ESTABLISHED}}} state.
1073 99 Adrian Georgescu
1074 93 Luci Stanescu
 '''remote_rtp_address_ice'''::
1075 93 Luci Stanescu
  The remote IP address that was selected by the ICE negotation.
1076 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} until the ICE negotation succeeds.
1077 99 Adrian Georgescu
1078 93 Luci Stanescu
 '''remote_rtp_port_ice'''::
1079 93 Luci Stanescu
  The remote port that was selected by the ICE negotation.
1080 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} until the ICE negotation succeeds.
1081 99 Adrian Georgescu
1082 93 Luci Stanescu
 '''remote_rtp_address_received'''::
1083 93 Luci Stanescu
  The remote IP address from which RTP data was received.
1084 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} unless RTP was actually received.
1085 99 Adrian Georgescu
1086 93 Luci Stanescu
 '''remote_rtp_port_received'''::
1087 93 Luci Stanescu
  The remote UDP port from which RTP data was received.
1088 93 Luci Stanescu
  This attribute is read-only and will be {{{None}}} unless RTP was actually received.
1089 99 Adrian Georgescu
1090 93 Luci Stanescu
 '''use_srtp'''::
1091 93 Luci Stanescu
  A boolean indicating if the use of SRTP was requested when the object was instantiated.
1092 93 Luci Stanescu
  This attribute is read-only.
1093 99 Adrian Georgescu
1094 93 Luci Stanescu
 '''force_srtp'''::
1095 93 Luci Stanescu
  A boolean indicating if SRTP being mandatory for this transport if it is enabled was requested when the object was instantiated.
1096 93 Luci Stanescu
  This attribute is read-only.
1097 99 Adrian Georgescu
1098 93 Luci Stanescu
 '''srtp_active'''::
1099 93 Luci Stanescu
  A boolean indicating if SRTP encryption and decryption is running.
1100 93 Luci Stanescu
  Querying this attribute only makes sense once the object is in the {{{ESTABLISHED}}} state and use of SRTP was requested.
1101 93 Luci Stanescu
  This attribute is read-only.
1102 99 Adrian Georgescu
1103 93 Luci Stanescu
 '''use_ice'''::
1104 93 Luci Stanescu
  A boolean indicating if the use of ICE was requested when the object was instantiated.
1105 93 Luci Stanescu
  This attribute is read-only.
1106 99 Adrian Georgescu
1107 93 Luci Stanescu
 '''ice_active''::
1108 93 Luci Stanescu
  A boolean indicating if ICE is being used.
1109 93 Luci Stanescu
  This attribute is read-only.
1110 99 Adrian Georgescu
1111 93 Luci Stanescu
 '''ice_stun_address'''::
1112 93 Luci Stanescu
  A string indicating the IP address of the STUN server that was requested to be used.
1113 93 Luci Stanescu
  This attribute is read-only.
1114 99 Adrian Georgescu
1115 93 Luci Stanescu
 '''ice_stun_port'''::
1116 93 Luci Stanescu
  A string indicating the UDP port of the STUN server that was requested to be used.
1117 93 Luci Stanescu
  This attribute is read-only.
1118 99 Adrian Georgescu
1119 93 Luci Stanescu
 '''local_rtp_candidate_type'''::
1120 93 Luci Stanescu
  Returns the ICE candidate type which has been selected for the local endpoint.
1121 99 Adrian Georgescu
1122 93 Luci Stanescu
 '''remote_rtp_candidate_type'''::
1123 93 Luci Stanescu
  Returns the ICE candidate type which has been selected for the remote endpoint.
1124 93 Luci Stanescu
1125 93 Luci Stanescu
==== notifications ====
1126 93 Luci Stanescu
1127 99 Adrian Georgescu
1128 93 Luci Stanescu
 '''RTPTransportDidInitialize'''::
1129 93 Luci Stanescu
  This notification is sent when a {{{RTPTransport}}} object has successfully initialized.
1130 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.
1131 93 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1132 93 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1133 99 Adrian Georgescu
1134 93 Luci Stanescu
 '''RTPTransportDidFail'''::
1135 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.
1136 93 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1137 93 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1138 93 Luci Stanescu
  [[BR]]''reason'':[[BR]]
1139 93 Luci Stanescu
  A string describing the failure reason.
1140 99 Adrian Georgescu
1141 93 Luci Stanescu
 '''RTPTransportICENegotiationStateDidChange'''::
1142 93 Luci Stanescu
  This notification is sent to indicate the progress of the ICE negotiation.
1143 93 Luci Stanescu
  [[BR]]''state'':[[BR]]
1144 93 Luci Stanescu
  A string describing the current ICE negotiation state.
1145 99 Adrian Georgescu
1146 93 Luci Stanescu
 '''RTPTransportICENegotiationDidFail'''::
1147 93 Luci Stanescu
  This notification is sent when the ICE negotiation fails.
1148 93 Luci Stanescu
  [[BR]]''reason'':[[BR]]
1149 93 Luci Stanescu
  A string describing the failure reason of ICE negotation.
1150 99 Adrian Georgescu
1151 93 Luci Stanescu
 '''RTPTransportICENegotiationDidSucceed'''::
1152 93 Luci Stanescu
  This notification is sent when the ICE negotation succeeds.
1153 93 Luci Stanescu
  [[BR]]''chosen_local_candidates'' and ''chosen_remote_candidates'':[[BR]]
1154 93 Luci Stanescu
  Dictionaries with the following keys:
1155 93 Luci Stanescu
   * rtp_cand_type: the type of the RTP candidate
1156 93 Luci Stanescu
   * rtp_cand_ip: the IP address of the RTP candidate
1157 93 Luci Stanescu
   * rtcp_cand_type: the type of the RTCP candidate
1158 93 Luci Stanescu
   * rtcp_cand_ip: the IP address of teh RTCP candidate
1159 93 Luci Stanescu
  [[BR]]''duration'':[[BR]]
1160 93 Luci Stanescu
  The amount of time the ICE negotiation took.
1161 93 Luci Stanescu
  [[BR]]''local_candidates'' and ''remote_candidates'':[[BR]]
1162 93 Luci Stanescu
  Lists of tuples with the following elements:
1163 93 Luci Stanescu
   * Item ID
1164 93 Luci Stanescu
   * Component ID
1165 93 Luci Stanescu
   * Address
1166 93 Luci Stanescu
   * Component Type
1167 93 Luci Stanescu
  [[BR]]''connectivity_checks_results'':[[BR]]
1168 93 Luci Stanescu
  A list of tuples with the following elements:
1169 93 Luci Stanescu
   * Item ID
1170 93 Luci Stanescu
   * Component ID
1171 93 Luci Stanescu
   * Source
1172 93 Luci Stanescu
   * Destination
1173 93 Luci Stanescu
   * Nomination
1174 93 Luci Stanescu
   * State
1175 93 Luci Stanescu
1176 93 Luci Stanescu
=== AudioTransport ===
1177 93 Luci Stanescu
1178 93 Luci Stanescu
This object represent an audio stream as it is transported over the network.
1179 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.
1180 93 Luci Stanescu
It also generates a {{{SDPMediaStream}}} object to be included in the local SDP.
1181 93 Luci Stanescu
1182 93 Luci Stanescu
The {{{AudioTransport}}} is an object that, once started, is connected to a {{{AudioMixer}}} instance, and both produces and consumes sound.
1183 93 Luci Stanescu
1184 93 Luci Stanescu
Like the {{{RTPTransport}}} object there are two usage scenarios.
1185 93 Luci Stanescu
 * In the first scenario, only the {{{RTPTransport}}} instance to be used is passed to the AudioTransport object.
1186 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.
1187 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.
1188 93 Luci Stanescu
   The stream can then be connected to the conference bridge.
1189 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.
1190 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.
1191 93 Luci Stanescu
   The audio stream is started directly when the object is created.
1192 93 Luci Stanescu
1193 93 Luci Stanescu
Unlike the {{{RTPTransport}}} object, this object cannot be reused.
1194 93 Luci Stanescu
1195 93 Luci Stanescu
==== methods ====
1196 93 Luci Stanescu
1197 99 Adrian Georgescu
1198 93 Luci Stanescu
 '''!__init!__'''(''self'', '''mixer''', '''transport''', '''remote_sdp'''={{{None}}}, '''sdp_index'''=0, '''enable_silence_detection'''=True, '''codecs'''={{{None}}})::
1199 93 Luci Stanescu
  Creates a new {{{AudioTransport}}} object and start the underlying stream if the remote SDP is already known.
1200 93 Luci Stanescu
  [[BR]]''mixer'':[[BR]]
1201 93 Luci Stanescu
  The {{{AudioMixer}}} object that this object is to be connected to.
1202 93 Luci Stanescu
  [[BR]]''transport'':[[BR]]
1203 93 Luci Stanescu
  The transport to use in the form of a {{{RTPTransport}}} object.
1204 93 Luci Stanescu
  [[BR]]''remote_sdp'':[[BR]]
1205 93 Luci Stanescu
  The remote SDP that was received in the form of a {{{SDPSession}}} object.
1206 93 Luci Stanescu
  [[BR]]''sdp_index'':[[BR]]
1207 93 Luci Stanescu
  The index within the SDP of the audio stream that should be created.
1208 93 Luci Stanescu
  [[BR]]''enable_silence_detection''[[BR]]
1209 93 Luci Stanescu
  Boolean that indicates if silence detection should be used for this audio stream.
1210 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.
1211 93 Luci Stanescu
  [[BR]]''codecs''[[BR]]
1212 93 Luci Stanescu
  A list of strings indicating the codecs that should be proposed in the SDP of this {{{AudioTransport}}}, in order of preference.
1213 93 Luci Stanescu
  This overrides the global codecs list set on the {{{Engine}}}.
1214 93 Luci Stanescu
  The values of this list are case insensitive.
1215 99 Adrian Georgescu
1216 93 Luci Stanescu
 '''get_local_media'''(''self'', '''is_offer''', '''direction'''="sendrecv")::
1217 93 Luci Stanescu
  Generates a {{{SDPMediaStream}}} object which describes the audio stream.
1218 93 Luci Stanescu
  This object should be included in a {{{SDPSession}}} object that gets passed to the {{{Invitation}}} object.
1219 93 Luci Stanescu
  This method should also be used to obtain the SDP to include in re-INVITEs and replies to re-INVITEs.
1220 93 Luci Stanescu
  [[BR]]''is_offer'':[[BR]]
1221 93 Luci Stanescu
  A boolean indicating if the SDP requested is to be included in an offer.
1222 93 Luci Stanescu
  If this is {{{False}}} it is to be included in an answer.
1223 93 Luci Stanescu
  [[BR]]''direction'':[[BR]]
1224 93 Luci Stanescu
  The direction attribute to put in the SDP.
1225 99 Adrian Georgescu
1226 93 Luci Stanescu
 '''start'''(''self'', '''local_sdp''', '''remote_sdp''', '''sdp_index''', '''no_media_timeout'''=10, '''media_check_interval'''=30)::
1227 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.
1228 93 Luci Stanescu
  [[BR]]''local_sdp'':[[BR]]
1229 93 Luci Stanescu
  The full local SDP that was included in the SDP negotiation in the form of a {{{SDPSession}}} object.
1230 93 Luci Stanescu
  [[BR]]''remote_sdp'':[[BR]]
1231 93 Luci Stanescu
  The remote SDP that was received in the form of a {{{SDPSession}}} object.
1232 93 Luci Stanescu
  [[BR]]''sdp_index'':[[BR]]
1233 93 Luci Stanescu
  The index within the SDP of the audio stream.
1234 93 Luci Stanescu
  [[BR]]''no_media_timeout'':[[BR]]
1235 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.
1236 93 Luci Stanescu
  Setting this to 0 disables this an all subsequent RTP checks.
1237 93 Luci Stanescu
  [[BR]]''media_check_interval'':[[BR]]
1238 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.
1239 93 Luci Stanescu
  It means that if between two of these interval checks no RTP has been received, a {{{RTPAudioTransportDidNotGetRTP}}} notification will be sent.
1240 93 Luci Stanescu
  Setting this to 0 will disable checking the RTP at intervals.
1241 93 Luci Stanescu
  The initial check may still be performed if its timeout is non-zero.
1242 99 Adrian Georgescu
1243 93 Luci Stanescu
 '''stop'''(''self'')::
1244 93 Luci Stanescu
  This method stops and destroys the audio stream encapsulated by this object.
1245 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.
1246 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.
1247 99 Adrian Georgescu
1248 93 Luci Stanescu
 '''send_dtmf'''(''self'', '''digit''')::
1249 93 Luci Stanescu
  For a negotiated audio transport this sends one DTMF digit to the other party
1250 93 Luci Stanescu
  [[BR]]''digit'':[[BR]]
1251 93 Luci Stanescu
  A string of length one indicating the DTMF digit to send.
1252 93 Luci Stanescu
  This can be either a digit, the pound sign (#), the asterisk sign (*) or the letters A through D.
1253 99 Adrian Georgescu
1254 93 Luci Stanescu
 '''update_direction'''(''self'', '''direction''')::
1255 93 Luci Stanescu
  This method should be called after SDP negotiation has completed to update the direction of the media stream.
1256 93 Luci Stanescu
  [[BR]]''direction'':[[BR]]
1257 93 Luci Stanescu
  The direction that has been negotiated.
1258 93 Luci Stanescu
1259 93 Luci Stanescu
==== attributes ====
1260 93 Luci Stanescu
1261 99 Adrian Georgescu
1262 93 Luci Stanescu
 '''mixer'''::
1263 93 Luci Stanescu
  The {{{AudioMixer}}} object that was passed when the object got instantiated.
1264 93 Luci Stanescu
  This attribute is read-only.
1265 99 Adrian Georgescu
1266 93 Luci Stanescu
 '''transport'''::
1267 93 Luci Stanescu
  The {{{RTPTransport}}} object that was passed when the object got instantiated.
1268 93 Luci Stanescu
  This attribute is read-only.
1269 99 Adrian Georgescu
1270 93 Luci Stanescu
 '''slot'''::
1271 93 Luci Stanescu
  A read-only property indicating the slot number at which this object is attached to the associated conference bridge.
1272 93 Luci Stanescu
  If the {{{AudioTransport}}} is not active (i.e. has not been started), this attribute will be {{{None}}}.
1273 99 Adrian Georgescu
1274 93 Luci Stanescu
 '''volume'''::
1275 93 Luci Stanescu
  A writable property indicating the % of volume at which this object contributes audio to the conference bridge.
1276 93 Luci Stanescu
  By default this is set to 100.
1277 99 Adrian Georgescu
1278 93 Luci Stanescu
 '''is_active'''::
1279 93 Luci Stanescu
  A boolean indicating if the object is currently sending and receiving audio.
1280 93 Luci Stanescu
  This attribute is read-only.
1281 99 Adrian Georgescu
1282 93 Luci Stanescu
 '''is_started'''::
1283 93 Luci Stanescu
  A boolean indicating if the object has been started.
1284 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.
1285 93 Luci Stanescu
  This is to prevent the object from being re-used.
1286 93 Luci Stanescu
  This attribute is read-only.
1287 99 Adrian Georgescu
1288 93 Luci Stanescu
 '''codec'''::
1289 93 Luci Stanescu
  Once the SDP negotiation is complete, this attribute indicates the audio codec that was negotiated, otherwise it will be {{{None}}}.
1290 93 Luci Stanescu
  This attribute is read-only.
1291 99 Adrian Georgescu
1292 93 Luci Stanescu
 '''sample_rate'''::
1293 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}}}.
1294 93 Luci Stanescu
  This attribute is read-only.
1295 99 Adrian Georgescu
1296 93 Luci Stanescu
 '''direction'''::
1297 93 Luci Stanescu
  The current direction of the audio transport, which is one of "sendrecv", "sendonly", "recvonly" or "inactive".
1298 93 Luci Stanescu
  This attribute is read-only, although it can be set using the {{{update_direction()}}} method.
1299 93 Luci Stanescu
1300 93 Luci Stanescu
==== notifications ====
1301 93 Luci Stanescu
1302 99 Adrian Georgescu
1303 93 Luci Stanescu
 '''RTPAudioTransportGotDTMF'''::
1304 93 Luci Stanescu
  This notification will be sent when an incoming DTMF digit is received from the remote party.
1305 93 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1306 93 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1307 93 Luci Stanescu
  [[BR]]''digit'':[[BR]]
1308 93 Luci Stanescu
  The DTMF digit that was received, in the form of a string of length one.
1309 93 Luci Stanescu
  This can be either a number or letters A through D.
1310 99 Adrian Georgescu
1311 93 Luci Stanescu
 '''RTPAudioTransportDidNotGetRTP'''::
1312 93 Luci Stanescu
  This notification will be sent when no RTP packets have been received from the remote party for some time.
1313 93 Luci Stanescu
  See the {{{start()}}} method for a more exact description.
1314 93 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1315 93 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1316 93 Luci Stanescu
  [[BR]]''got_any'':[[BR]]
1317 93 Luci Stanescu
  A boolean data attribute indicating if the {{{AudioTransport}}} every saw any RTP packets from the remote party.
1318 93 Luci Stanescu
  In effect, if no RTP was received after {{{no_media_timeout}}} seconds, its value will be {{{False}}}.
1319 93 Luci Stanescu
1320 46 Ruud Klaver
=== Request ===
1321 46 Ruud Klaver
1322 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.
1323 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).
1324 46 Ruud Klaver
1325 46 Ruud Klaver
The lifetime of this object is linear and is described by the following diagram:
1326 46 Ruud Klaver
1327 46 Ruud Klaver
[[Image(sipsimple-request-lifetime.png, nolink)]]
1328 46 Ruud Klaver
1329 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.
1330 46 Ruud Klaver
Directly after the object is instantiated, it will be in the {{{INIT}}} state.
1331 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.
1332 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.
1333 46 Ruud Klaver
Note that this may not occur at all if not provisional responses are received.
1334 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.
1335 46 Ruud Klaver
Both of these notifications include data on the response that triggered it.
1336 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.
1337 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.
1338 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.
1339 46 Ruud Klaver
This should usually trigger whomever is using this {{{Request}}} object to construct a new {{{Request}}} for a refreshing operation.
1340 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.
1341 1 Adrian Georgescu
1342 94 Luci Stanescu
==== methods ====
1343 94 Luci Stanescu
1344 99 Adrian Georgescu
1345 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}}})::
1346 94 Luci Stanescu
  Creates a new {{{Request}}} object in the {{{INIT}}} state.
1347 94 Luci Stanescu
  The arguments to this method are documented in the attributes section.
1348 99 Adrian Georgescu
1349 94 Luci Stanescu
 '''send'''(''self'', '''timeout'''={{{None}}})::
1350 94 Luci Stanescu
   Compose the SIP request and send it to the destination.
1351 94 Luci Stanescu
   This moves the {{{Request}}} object into the {{{IN_PROGRESS}}} state.
1352 94 Luci Stanescu
  [[BR]]''timeout'':[[BR]]
1353 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.
1354 94 Luci Stanescu
  This is is {{{None}}}, the internal 408 is only triggered by the internal PJSIP transaction timeout.
1355 94 Luci Stanescu
  Note that, even if the timeout is specified, the PJSIP timeout is also still valid.
1356 99 Adrian Georgescu
1357 94 Luci Stanescu
 '''end'''(''self'')::
1358 94 Luci Stanescu
  Terminate the transaction, whichever state it is in, sending the appropriate notifications.
1359 94 Luci Stanescu
  Note that calling this method while in the {{{INIT}}} state does nothing.
1360 94 Luci Stanescu
1361 47 Ruud Klaver
==== attributes ====
1362 47 Ruud Klaver
1363 99 Adrian Georgescu
1364 62 Ruud Klaver
 '''expire_warning_time''' (class attribute)::
1365 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.
1366 47 Ruud Klaver
  The default value is 30 seconds.
1367 99 Adrian Georgescu
1368 47 Ruud Klaver
 '''state'''::
1369 47 Ruud Klaver
  Indicates the state the {{{Request}}} object is in, in the form of a string.
1370 1 Adrian Georgescu
  Refer to the diagram above for possible states.
1371 1 Adrian Georgescu
  This attribute is read-only.
1372 99 Adrian Georgescu
1373 1 Adrian Georgescu
 '''method'''::
1374 1 Adrian Georgescu
  The method of the SIP request as a string.
1375 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1376 99 Adrian Georgescu
1377 94 Luci Stanescu
 '''from_header'''::
1378 94 Luci Stanescu
  The {{{FrozenFromHeader}}} object to put in the {{{From}}} header of the request.
1379 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1380 99 Adrian Georgescu
1381 94 Luci Stanescu
 '''to_header'''::
1382 94 Luci Stanescu
  The {{{FrozenToHeader}}} object to put in the {{{To}}} header of the request.
1383 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1384 99 Adrian Georgescu
1385 1 Adrian Georgescu
 '''request_uri'''::
1386 94 Luci Stanescu
  The SIP URI to put as request URI in the request, in the form of a {{{FrozenSIPURI}}} object.
1387 62 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1388 99 Adrian Georgescu
1389 94 Luci Stanescu
 '''route_header'''::
1390 94 Luci Stanescu
  Where to send the SIP request to, including IP, port and transport, in the form of a {{{FrozenRouteHeader}}} object.
1391 47 Ruud Klaver
  This will also be included in the {{{Route}}} header of the request.
1392 47 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1393 99 Adrian Georgescu
1394 47 Ruud Klaver
 '''credentials'''::
1395 94 Luci Stanescu
  The credentials to be used when challenged for authentication, represented by a {{{FrozenCredentials}}} object.
1396 47 Ruud Klaver
  If no credentials were supplied when the object was created this attribute is {{{None}}}.
1397 47 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1398 99 Adrian Georgescu
1399 94 Luci Stanescu
 '''contact_header'''::
1400 94 Luci Stanescu
  The {{{FrozenContactHeader}}} object to put in the {{{Contact}}} header of the request.
1401 1 Adrian Georgescu
  If this was not specified, this attribute is {{{None}}}.
1402 1 Adrian Georgescu
  It is set on instantiation and is read-only.
1403 99 Adrian Georgescu
1404 47 Ruud Klaver
 '''call_id'''::
1405 47 Ruud Klaver
  The {{{Call-ID}}} to be used for this transaction as a string.
1406 46 Ruud Klaver
  If no call id was specified on instantiation, this attribute contains the generated id.
1407 46 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1408 99 Adrian Georgescu
1409 62 Ruud Klaver
 '''cseq'''::
1410 48 Ruud Klaver
  The sequence number to use in the request as an int.
1411 48 Ruud Klaver
  If no sequence number was specified on instantiation, this attribute contains the generated sequence number.
1412 48 Ruud Klaver
  Note that this number may be increased by one if an authentication challenge is received and a {{{Credentials}}} object is given.
1413 48 Ruud Klaver
  This attribute is read-only.
1414 99 Adrian Georgescu
1415 48 Ruud Klaver
 '''extra_headers'''::
1416 94 Luci Stanescu
  Extra headers to include in the request as a frozenlist of header objects.
1417 48 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1418 99 Adrian Georgescu
1419 48 Ruud Klaver
 '''content_type'''::
1420 48 Ruud Klaver
  What string to put as content type in the {{{Content-Type}}} headers, if the request contains a body.
1421 57 Ruud Klaver
  If no body was specified, this attribute is {{{None}}}
1422 48 Ruud Klaver
  It is set on instantiation and is read-only.
1423 99 Adrian Georgescu
1424 48 Ruud Klaver
 '''body'''::
1425 48 Ruud Klaver
  The body of the request as a string.
1426 46 Ruud Klaver
  If no body was specified, this attribute is {{{None}}}
1427 49 Ruud Klaver
  It is set on instantiation and is read-only.
1428 99 Adrian Georgescu
1429 49 Ruud Klaver
 '''expires_in'''::
1430 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.
1431 49 Ruud Klaver
  If this is not the case, this property is 0.
1432 49 Ruud Klaver
1433 49 Ruud Klaver
==== notifications ====
1434 49 Ruud Klaver
1435 99 Adrian Georgescu
1436 49 Ruud Klaver
 '''SIPRequestGotProvisionalResponse'''::
1437 49 Ruud Klaver
  This notification will be sent on every provisional response received in reply to the sent request.
1438 49 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
1439 49 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1440 49 Ruud Klaver
  [[BR]]''code'':[[BR]]
1441 49 Ruud Klaver
  The SIP response code of the received provisional response as an int, which will be in the 1xx range.
1442 49 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1443 49 Ruud Klaver
  The reason text string included with the SIP response code.
1444 49 Ruud Klaver
  [[BR]]''headers'':[[BR]]
1445 94 Luci Stanescu
  The headers included in the provisional response as a dict, the values of which are header objects.
1446 49 Ruud Klaver
  [[BR]]''body'':[[BR]]
1447 49 Ruud Klaver
  The body of the provisional response as a string, or {{{None}}} if there was no body.
1448 99 Adrian Georgescu
1449 49 Ruud Klaver
 '''SIPRequestDidSucceed'''::
1450 49 Ruud Klaver
  This notification will be sent when a positive final response was received in reply to the request.
1451 49 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
1452 49 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1453 49 Ruud Klaver
  [[BR]]''code'':[[BR]]
1454 49 Ruud Klaver
  The SIP response code of the received positive final response as an int, which will be in the 2xx range.
1455 49 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1456 49 Ruud Klaver
  The reason text string included with the SIP response code.
1457 49 Ruud Klaver
  [[BR]]''headers'':[[BR]]
1458 94 Luci Stanescu
  The headers included in the positive final response as a dict, the values of which are header objects.
1459 1 Adrian Georgescu
  [[BR]]''body'':[[BR]]
1460 1 Adrian Georgescu
  The body of the positive final response as a string, or {{{None}}} if there was no body.
1461 1 Adrian Georgescu
  [[BR]]''expires'':[[BR]]
1462 1 Adrian Georgescu
  Indicates in how many seconds the {{{Request}}} will expire as an int.
1463 1 Adrian Georgescu
  If it does not expire and the {{{EXPIRING}}} state is skipped, this attribute is 0.
1464 99 Adrian Georgescu
1465 1 Adrian Georgescu
 '''SIPRequestDidFail'''::
1466 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.
1467 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
1468 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1469 1 Adrian Georgescu
  [[BR]]''code'':[[BR]]
1470 1 Adrian Georgescu
  The SIP response code of the received negative final response as an int.
1471 1 Adrian Georgescu
  This could also be a response code generated by PJSIP internally, or 0 when an internal error occurs.
1472 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
1473 1 Adrian Georgescu
  The reason text string included with the SIP response code or error.
1474 1 Adrian Georgescu
  [[BR]]''headers'': (only if a negative final response was received)[[BR]]
1475 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.
1476 1 Adrian Georgescu
  [[BR]]''body'': (only if a negative final response was received)[[BR]]
1477 1 Adrian Georgescu
  The body of the negative final response as a string, or {{{None}}} if there was no body.
1478 1 Adrian Georgescu
  This attribute is absent if no response was received.
1479 99 Adrian Georgescu
1480 1 Adrian Georgescu
 '''SIPRequestWillExpire'''::
1481 1 Adrian Georgescu
  This notification will be sent when a {{{Request}}} in the {{{EXPIRING}}} state will expire soon.
1482 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
1483 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1484 1 Adrian Georgescu
  [[BR]]''expires'':[[BR]]
1485 1 Adrian Georgescu
  An int indicating in how many seconds from now the {{{Request}}} will actually expire.
1486 99 Adrian Georgescu
1487 1 Adrian Georgescu
 '''SIPRequestDidEnd'''::
1488 1 Adrian Georgescu
  This notification will be sent when a {{{Request}}} object enters the {{{TERMINATED}}} state and can no longer be used.
1489 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
1490 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1491 1 Adrian Georgescu
1492 94 Luci Stanescu
=== IncomingRequest ===
1493 94 Luci Stanescu
1494 94 Luci Stanescu
This is a relatively simple object that can manage responding to incoming requests in a single transaction.
1495 94 Luci Stanescu
For this reason it does not handle requests that create a dialog.
1496 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}}}.
1497 94 Luci Stanescu
Receiving {{{INVITE}}}, {{{SUBSCRIBE}}}, {{{ACK}}} and {{{BYE}}} through this object is not supported.
1498 94 Luci Stanescu
1499 94 Luci Stanescu
The application is notified of an incoming request through the {{{SIPIncomingRequestGotRequest}}} notification.
1500 94 Luci Stanescu
It can answer this request by calling the {{{answer}}} method on the sender of this notification.
1501 94 Luci Stanescu
Note that if the {{{IncomingRequest}}} object gets destroyed before it is answered, a 500 response is automatically sent.
1502 94 Luci Stanescu
1503 94 Luci Stanescu
==== attributes ====
1504 94 Luci Stanescu
1505 99 Adrian Georgescu
1506 94 Luci Stanescu
 '''state'''::
1507 94 Luci Stanescu
  This read-only attribute indicates the state the object is in.
1508 94 Luci Stanescu
  This can be {{{None}}} if the object was created by the application, essentially meaning the object is inert, {{{"incoming"}}} or {{{"answered"}}}.
1509 94 Luci Stanescu
1510 94 Luci Stanescu
==== methods ====
1511 94 Luci Stanescu
1512 99 Adrian Georgescu
1513 94 Luci Stanescu
 '''answer'''(''self'', '''code''', '''reason'''={{{None}}}, '''extra_headers'''={{{None}}})::
1514 94 Luci Stanescu
  Reply to the received request with a final response.
1515 94 Luci Stanescu
  [[BR]]''code'':[[BR]]
1516 94 Luci Stanescu
  The SIP response code to send.
1517 94 Luci Stanescu
  This should be 200 or higher.
1518 94 Luci Stanescu
  [[BR]]''reason'':[[BR]]
1519 94 Luci Stanescu
  The reason text to include in the response.
1520 94 Luci Stanescu
  If this is {{{None}}}, the default text for the given response code is used.
1521 94 Luci Stanescu
  [[BR]]''extra_headers'':[[BR]]
1522 94 Luci Stanescu
  The extra headers to include in the response as an iterable of header objects.
1523 94 Luci Stanescu
1524 94 Luci Stanescu
==== notifications ====
1525 94 Luci Stanescu
1526 99 Adrian Georgescu
1527 94 Luci Stanescu
 '''SIPIncomingRequestGotRequest'''::
1528 94 Luci Stanescu
  This notification will be sent when a new {{{IncomingRequest}}} is created as result of a received request.
1529 94 Luci Stanescu
  The application should listen for this notification, retain a reference to the object that sent it and answer it.
1530 94 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1531 94 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1532 94 Luci Stanescu
  [[BR]]''method'':[[BR]]
1533 94 Luci Stanescu
  The method of the SIP request as a string.
1534 94 Luci Stanescu
  [[BR]]''request_uri'':[[BR]]
1535 94 Luci Stanescu
  The request URI of the request as a {{{FrozenSIPURI}}} object.
1536 94 Luci Stanescu
  [[BR]]''headers'':[[BR]]
1537 94 Luci Stanescu
  The headers of the request as a dict, the values of which are the relevant header objects.
1538 94 Luci Stanescu
  [[BR]]''body'':[[BR]]
1539 94 Luci Stanescu
  The body of the request as a string, or {{{None}}} if no body was included.
1540 99 Adrian Georgescu
1541 94 Luci Stanescu
 '''SIPIncomingRequestSentResponse'''::
1542 94 Luci Stanescu
  This notification is sent when a response to the request is sent by the object.
1543 94 Luci Stanescu
  [[BR]]''timestamp'':[[BR]]
1544 94 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1545 94 Luci Stanescu
  [[BR]]''code'':[[BR]]
1546 94 Luci Stanescu
  The code of the SIP response as an int.
1547 94 Luci Stanescu
  [[BR]]''reason'':[[BR]]
1548 94 Luci Stanescu
  The reason text of the SIP response as an int.
1549 94 Luci Stanescu
  [[BR]]''headers'':[[BR]]
1550 94 Luci Stanescu
  The headers of the response as a dict, the values of which are the relevant header objects.
1551 94 Luci Stanescu
  [[BR]]''body'':[[BR]]
1552 94 Luci Stanescu
  This will be {{{None}}}.
1553 94 Luci Stanescu
1554 51 Ruud Klaver
=== Message ===
1555 1 Adrian Georgescu
1556 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].
1557 51 Ruud Klaver
It is a one-shot object that manages only one {{{Request}}} object.
1558 51 Ruud Klaver
1559 94 Luci Stanescu
==== methods ====
1560 94 Luci Stanescu
1561 99 Adrian Georgescu
1562 94 Luci Stanescu
 '''!__init!__'''(''self'', '''from_header''', '''to_header''', '''route_header''', '''content_type''', '''body''', '''credentials'''={{{None}}}, '''extra_headers'''={{{[]}}})::
1563 94 Luci Stanescu
  Creates a new {{{Message}}} object with the specified arguments.
1564 94 Luci Stanescu
  These arguments are documented in the attributes section for this class.
1565 99 Adrian Georgescu
1566 94 Luci Stanescu
 '''send'''(''self'', '''timeout'''={{{None}}})::
1567 94 Luci Stanescu
  Send the {{{MESSAGE}}} request to the remote party.
1568 94 Luci Stanescu
  [[BR]]''timeout'':[[BR]]
1569 94 Luci Stanescu
  This argument as the same meaning as it does for {{{Request.send()}}}.
1570 99 Adrian Georgescu
1571 94 Luci Stanescu
 '''end'''(''self'')::
1572 94 Luci Stanescu
  Stop trying to send the {{{MESSAGE}}} request.
1573 94 Luci Stanescu
  If it was not sent yet, calling this method does nothing.
1574 94 Luci Stanescu
1575 1 Adrian Georgescu
==== attributes ====
1576 1 Adrian Georgescu
1577 99 Adrian Georgescu
1578 94 Luci Stanescu
 '''from_header'''::
1579 94 Luci Stanescu
  The {{{FrozenFromHeader}}} to put in the {{{From}}} header of the {{{MESSAGE}}} request.
1580 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1581 99 Adrian Georgescu
1582 94 Luci Stanescu
 '''to_header'''::
1583 94 Luci Stanescu
  The {{{FrozenToHeader}}} to put in the {{{To}}} header of the {{{MESSAGE}}} request.
1584 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1585 99 Adrian Georgescu
1586 94 Luci Stanescu
 '''route_header'''::
1587 94 Luci Stanescu
  Where to send the {{{MESSAGE}}} request to, including IP, port and transport, in the form of a {{{FrozenRouteHeader}}} object.
1588 1 Adrian Georgescu
  This will also be included in the {{{Route}}} header of the request.
1589 1 Adrian Georgescu
  This attribute is set on instantiation and is read-only.
1590 99 Adrian Georgescu
1591 1 Adrian Georgescu
 '''content_type'''::
1592 1 Adrian Georgescu
  What string to put as content type in the {{{Content-Type}}} headers.
1593 1 Adrian Georgescu
  It is set on instantiation and is read-only.
1594 99 Adrian Georgescu
1595 1 Adrian Georgescu
 '''body'''::
1596 1 Adrian Georgescu
  The body of the {{{MESSAGE}}} request as a string.
1597 52 Ruud Klaver
  If no body was specified, this attribute is {{{None}}}
1598 52 Ruud Klaver
  It is set on instantiation and is read-only.
1599 99 Adrian Georgescu
1600 52 Ruud Klaver
 '''credentials'''::
1601 94 Luci Stanescu
  The credentials to be used when challenged for authentication, represented by a {{{FrozenCredentials}}} object.
1602 52 Ruud Klaver
  If no credentials were specified, this attribute is {{{None}}}.
1603 52 Ruud Klaver
  This attribute is set on instantiation and is read-only.
1604 99 Adrian Georgescu
1605 1 Adrian Georgescu
 '''is_sent'''::
1606 1 Adrian Georgescu
  A boolean read-only property indicating if the {{{MESSAGE}}} request was sent.
1607 99 Adrian Georgescu
1608 1 Adrian Georgescu
 '''in_progress'''::
1609 52 Ruud Klaver
  A boolean read-only property indicating if the object is waiting for the response from the remote party.
1610 52 Ruud Klaver
1611 52 Ruud Klaver
==== notifications ====
1612 52 Ruud Klaver
1613 99 Adrian Georgescu
1614 52 Ruud Klaver
 '''SIPMessageDidSucceed'''::
1615 52 Ruud Klaver
  This notification will be sent when the remote party acknowledged the reception of the {{{MESSAGE}}} request.
1616 52 Ruud Klaver
  It has not data attributes.
1617 99 Adrian Georgescu
1618 52 Ruud Klaver
 '''SIPMessageDidFail'''::
1619 52 Ruud Klaver
  This notification will be sent when transmission of the {{{MESSAGE}}} request fails for whatever reason.
1620 52 Ruud Klaver
  [[BR]]''code'':[[BR]]
1621 52 Ruud Klaver
  An int indicating the SIP or internal PJSIP code that was given in response to the {{{MESSAGE}}} request.
1622 1 Adrian Georgescu
  This is 0 if the failure is caused by an internal error.
1623 58 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1624 1 Adrian Georgescu
  A status string describing the failure, either taken from the SIP response or the internal error.
1625 52 Ruud Klaver
1626 52 Ruud Klaver
=== Registration ===
1627 52 Ruud Klaver
1628 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.
1629 86 Ruud Klaver
For details, see [http://tools.ietf.org/html/rfc3261 RFC 3261].
1630 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.
1631 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.
1632 52 Ruud Klaver
1633 52 Ruud Klaver
==== methods ====
1634 52 Ruud Klaver
1635 99 Adrian Georgescu
1636 94 Luci Stanescu
 '''!__init!__'''(''self'', '''from_header''', '''credentials'''={{{None}}}, '''duration'''=300)::
1637 52 Ruud Klaver
  Creates a new {{{Registration}}} object with the specified arguments.
1638 52 Ruud Klaver
  These arguments are documented in the attributes section for this class.
1639 99 Adrian Georgescu
1640 94 Luci Stanescu
 '''register'''(''self'', '''contact_header''', '''route_header''', '''timeout'''={{{None}}})::
1641 52 Ruud Klaver
  Calling this method will attempt to send a new {{{REGISTER}}} request to the registrar provided, whatever state the object is in.
1642 52 Ruud Klaver
  If the object is currently busy sending a {{{REGISTER}}}, this request will be preempted for the new one.
1643 52 Ruud Klaver
  Once sent, the {{{Registration}}} object will send either a {{{SIPRegistrationDidSucceed}}} or a {{{SIPRegistrationDidFail}}} notification.
1644 94 Luci Stanescu
  The {{{contact_header}}} argument is mentioned in the attributes section of this class.
1645 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()}}}.
1646 99 Adrian Georgescu
1647 1 Adrian Georgescu
 '''end'''(''self'', '''timeout'''={{{None}}})::
1648 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.
1649 94 Luci Stanescu
  The {{{RouteHeader}}} used for this will be the same as the last successfully sent {{{REGISTER}}} request.
1650 1 Adrian Georgescu
  If another {{{REGISTER}}} is currently being sent, it will be preempted.
1651 1 Adrian Georgescu
  When the unregistering {{{REGISTER}}} request is sent, a {{{SIPRegistrationWillEnd}}} notification is sent.
1652 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.
1653 1 Adrian Georgescu
  Calling this method when the object is not registered will do nothing.
1654 1 Adrian Georgescu
  The {{{timeout}}} argument has the same meaning as for the {{{register()}}} method.
1655 1 Adrian Georgescu
1656 94 Luci Stanescu
==== attributes ====
1657 94 Luci Stanescu
1658 99 Adrian Georgescu
1659 94 Luci Stanescu
 '''from_header''::
1660 94 Luci Stanescu
  The {{{(Frozen)FromHeader}}} the {{{Registration}}} was sent with.
1661 99 Adrian Georgescu
1662 94 Luci Stanescu
 '''credentials'''::
1663 94 Luci Stanescu
  The credentials to be used when challenged for authentication by the registrar, represented by a {{{(Frozen)Credentials}}} object. 
1664 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.
1665 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.
1666 99 Adrian Georgescu
1667 94 Luci Stanescu
 '''duration'''::
1668 94 Luci Stanescu
  The amount of time in seconds to request the registration for at the registrar.
1669 94 Luci Stanescu
  This attribute is set at object instantiation and can be updated for subsequent {{{REGISTER}}} requests.
1670 99 Adrian Georgescu
1671 94 Luci Stanescu
 '''is_registered'''::
1672 94 Luci Stanescu
  A boolean read-only property indicating if this object is currently registered.
1673 99 Adrian Georgescu
1674 94 Luci Stanescu
 '''contact_header'''::
1675 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.
1676 94 Luci Stanescu
  Otherwise, this attribute is {{{None}}}
1677 99 Adrian Georgescu
1678 94 Luci Stanescu
 '''expires_in'''::
1679 94 Luci Stanescu
  If registered, this read-only property indicates in how many seconds from now this {{{Registration}}} will expire.
1680 94 Luci Stanescu
  If this is not the case, this property is 0.
1681 94 Luci Stanescu
1682 69 Ruud Klaver
==== notifications ====
1683 69 Ruud Klaver
1684 99 Adrian Georgescu
1685 69 Ruud Klaver
 '''SIPRegistrationDidSucceed'''::
1686 69 Ruud Klaver
  This notification will be sent when the {{{register()}}} method was called and the registration succeeded.
1687 69 Ruud Klaver
  [[BR]]''code'':[[BR]]
1688 69 Ruud Klaver
  The SIP response code as received from the registrar as an int.
1689 69 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1690 1 Adrian Georgescu
  The reason string received from the SIP registrar.
1691 94 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
1692 94 Luci Stanescu
  The {{{(Frozen)RouteHeader}}} object passed as an argument to the {{{register()}}} method.
1693 94 Luci Stanescu
  [[BR]]''contact_header'':[[BR]]
1694 94 Luci Stanescu
  The contact header that was sent to the registrar as a {{{FrozenContactHeader}}} object.
1695 94 Luci Stanescu
  [[BR]]''contact_header_list'':[[BR]]
1696 94 Luci Stanescu
  A full list of contact headers that are registered for this SIP account, including the one used for this registration.
1697 94 Luci Stanescu
  The format of this data attribute is a list of FrozenContactHeader objects.
1698 1 Adrian Georgescu
  [[BR]]''expires_in'':[[BR]]
1699 69 Ruud Klaver
  The number of seconds before this registration expires
1700 99 Adrian Georgescu
1701 69 Ruud Klaver
 '''SIPRegistrationDidFail'''::
1702 69 Ruud Klaver
  This notification will be sent when the {{{register()}}} method was called and the registration failed, for whatever reason.
1703 69 Ruud Klaver
  [[BR]]''code'':[[BR]]
1704 69 Ruud Klaver
  The SIP response code as received from the registrar as an int.
1705 69 Ruud Klaver
  This can also be a PJSIP generated response code, or 0 if the failure was because of an internal error.
1706 69 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1707 69 Ruud Klaver
  The reason string received from the SIP registrar or the error string.
1708 94 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
1709 94 Luci Stanescu
  The {{{(Frozen)RouteHeader}}} object passed as an argument to the {{{register()}}} method.
1710 99 Adrian Georgescu
1711 69 Ruud Klaver
 '''SIPRegistrationWillExpire'''::
1712 1 Adrian Georgescu
  This notification will be sent when a registration will expire soon.
1713 69 Ruud Klaver
  It should be used as an indication to re-perform DNS lookup of the registrar and call the {{{register()}}} method.
1714 69 Ruud Klaver
  [[BR]]''expires'':[[BR]]
1715 69 Ruud Klaver
  The number of seconds in which the registration will expire.
1716 99 Adrian Georgescu
1717 69 Ruud Klaver
 '''SIPRegistrationWillEnd'''::
1718 69 Ruud Klaver
  Will be sent whenever the {{{end()}}} method was called and an unregistering {{{REGISTER}}} is sent.
1719 99 Adrian Georgescu
1720 69 Ruud Klaver
 '''SIPRegistrationDidNotEnd'''::
1721 69 Ruud Klaver
  This notification will be sent when the unregistering {{{REGISTER}}} request failed for some reason.
1722 69 Ruud Klaver
  [[BR]]''code'':[[BR]]
1723 69 Ruud Klaver
  The SIP response code as received from the registrar as an int.
1724 69 Ruud Klaver
  This can also be a PJSIP generated response code, or 0 if the failure was because of an internal error.
1725 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
1726 1 Adrian Georgescu
  The reason string received from the SIP registrar or the error string.
1727 99 Adrian Georgescu
1728 1 Adrian Georgescu
 '''SIPRegistrationDidEnd'''::
1729 69 Ruud Klaver
  This notification will be sent when a {{{Registration}}} has become unregistered.
1730 69 Ruud Klaver
  [[BR]]''expired'':[[BR]]
1731 69 Ruud Klaver
  This boolean indicates if the object is unregistered because the registration expired, in which case it will be set to {{{True}}}.
1732 69 Ruud Klaver
  If this data attribute is {{{False}}}, it means that unregistration was explicitly requested through the {{{end()}}} method.
1733 69 Ruud Klaver
1734 69 Ruud Klaver
==== example code ====
1735 69 Ruud Klaver
1736 69 Ruud Klaver
For an example on how to use this object, see the Integration section.
1737 69 Ruud Klaver
1738 69 Ruud Klaver
=== Publication ===
1739 69 Ruud Klaver
1740 69 Ruud Klaver
Publication of SIP events is an Internet standard published at [http://tools.ietf.org/html/rfc3903 RFC 3903]. 
1741 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.
1742 69 Ruud Klaver
1743 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.
1744 69 Ruud Klaver
This object is similar in behaviour to the {{{Registration}}} object, as it is also based on a sequence of {{{Request}}} objects.
1745 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.
1746 69 Ruud Klaver
1747 69 Ruud Klaver
==== methods ====
1748 69 Ruud Klaver
1749 99 Adrian Georgescu
1750 94 Luci Stanescu
 '''!__init!__'''(''self'', '''from_header''', '''event''', '''content_type''', '''credentials'''={{{None}}}, '''duration'''=300)::
1751 69 Ruud Klaver
  Creates a new {{{Publication}}} object with the specified arguments.
1752 69 Ruud Klaver
  These arguments are documented in the attributes section for this class.
1753 99 Adrian Georgescu
1754 94 Luci Stanescu
 '''publish'''(''self'', '''body''', '''route_header''', '''timeout'''={{{None}}})::
1755 69 Ruud Klaver
  Send an actual {{{PUBLISH}}} request to the specified presence agent.
1756 69 Ruud Klaver
  [[BR]]''body'':[[BR]]
1757 69 Ruud Klaver
  The body to place in the {{{PUBLISH}}} request as a string.
1758 69 Ruud Klaver
  This body needs to be of the content type specified at object creation.
1759 69 Ruud Klaver
  For the initial request, a body will need to be specified.
1760 69 Ruud Klaver
  For subsequent refreshing {{{PUBLISH}}} requests, the body can be {{{None}}} to indicate that the last published body should be refreshed.
1761 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}}}.
1762 94 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
1763 94 Luci Stanescu
  The host where the request should be sent to in the form of a {{{(Frozen)RouteHeader}}} object.
1764 69 Ruud Klaver
  [[BR]]''timeout'':[[BR]]
1765 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.
1766 69 Ruud Klaver
  This is is {{{None}}}, the internal 408 is only triggered by the internal PJSIP transaction timeout.
1767 69 Ruud Klaver
  Note that, even if the timeout is specified, the PJSIP timeout is also still valid.
1768 99 Adrian Georgescu
1769 69 Ruud Klaver
 '''end'''(''self'', '''timeout'''={{{None}}})::
1770 1 Adrian Georgescu
  End the publication by sending a {{{PUBLISH}}} request with an {{{Expires}}} header of 0.
1771 86 Ruud Klaver
  If the object is not published, this will result in a {{{PublicationError}}} being thrown.
1772 86 Ruud Klaver
  [[BR]]''timeout'':[[BR]]
1773 86 Ruud Klaver
  The meaning of this argument is the same as it is for the {{{publish()}}} method.
1774 86 Ruud Klaver
1775 94 Luci Stanescu
==== attributes ====
1776 94 Luci Stanescu
1777 99 Adrian Georgescu
1778 94 Luci Stanescu
 '''from_header''::
1779 94 Luci Stanescu
  The {{{(Frozen)FromHeader}}} the {{{Publication}}} was sent with.
1780 99 Adrian Georgescu
1781 94 Luci Stanescu
 '''event''::
1782 94 Luci Stanescu
  The name of the event this object is publishing for the specified SIP URI, as a string.
1783 99 Adrian Georgescu
1784 94 Luci Stanescu
 '''content_type''::
1785 94 Luci Stanescu
  The {{{Content-Type}}} of the body that will be in the {{{PUBLISH}}} requests.
1786 94 Luci Stanescu
  Typically this will remain the same throughout the publication session, but the attribute may be updated by the application if needed.
1787 94 Luci Stanescu
  Note that this attribute needs to be in the typical MIME type form, containing a "/" character.
1788 99 Adrian Georgescu
1789 94 Luci Stanescu
 '''credentials'''::
1790 94 Luci Stanescu
  The credentials to be used when challenged for authentication by the presence agent, represented by a {{{(Frozen)Credentials}}} object. 
1791 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.
1792 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.
1793 99 Adrian Georgescu
1794 94 Luci Stanescu
 '''duration'''::
1795 94 Luci Stanescu
  The amount of time in seconds that the publication should be valid for.
1796 94 Luci Stanescu
  This attribute is set at object instantiation and can be updated for subsequent {{{PUBLISH}}} requests.
1797 99 Adrian Georgescu
1798 94 Luci Stanescu
 '''is_published'''::
1799 94 Luci Stanescu
  A boolean read-only property indicating if this object is currently published.
1800 99 Adrian Georgescu
1801 94 Luci Stanescu
 '''expires_in'''::
1802 94 Luci Stanescu
  If published, this read-only property indicates in how many seconds from now this {{{Publication}}} will expire.
1803 94 Luci Stanescu
  If this is not the case, this property is 0.
1804 94 Luci Stanescu
1805 86 Ruud Klaver
==== notifications ====
1806 86 Ruud Klaver
1807 99 Adrian Georgescu
1808 86 Ruud Klaver
 '''SIPPublicationDidSucceed'''::
1809 86 Ruud Klaver
  This notification will be sent when the {{{publish()}}} method was called and the publication succeeded.
1810 86 Ruud Klaver
  [[BR]]''code'':[[BR]]
1811 86 Ruud Klaver
  The SIP response code as received from the SIP presence agent as an int.
1812 86 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1813 86 Ruud Klaver
  The reason string received from the SIP presence agent.
1814 94 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
1815 94 Luci Stanescu
  The {{{(Frozen)RouteHeader}}} object passed as an argument to the {{{publish()}}} method.
1816 86 Ruud Klaver
  [[BR]]''expires_in'':[[BR]]
1817 86 Ruud Klaver
  The number of seconds before this publication expires
1818 99 Adrian Georgescu
1819 86 Ruud Klaver
 '''SIPPublicationDidFail'''::
1820 86 Ruud Klaver
  This notification will be sent when the {{{publish()}}} method was called and the publication failed, for whatever reason.
1821 86 Ruud Klaver
  [[BR]]''code'':[[BR]]
1822 86 Ruud Klaver
  The SIP response code as received from the presence agent as an int.
1823 86 Ruud Klaver
  This can also be a PJSIP generated response code, or 0 if the failure was because of an internal error.
1824 86 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1825 86 Ruud Klaver
  The reason string received from the presence agent or the error string.
1826 94 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
1827 94 Luci Stanescu
  The {{{(Frozen)RouteHeader}}} object passed as an argument to the {{{publish()}}} method.
1828 99 Adrian Georgescu
1829 86 Ruud Klaver
 '''SIPPublicationWillExpire'''::
1830 86 Ruud Klaver
  This notification will be sent when a publication will expire soon.
1831 86 Ruud Klaver
  It should be used as an indication to re-perform DNS lookup of the presence agent and call the {{{publish()}}} method.
1832 86 Ruud Klaver
  [[BR]]''expires'':[[BR]]
1833 86 Ruud Klaver
  The number of seconds in which the publication will expire.
1834 99 Adrian Georgescu
1835 86 Ruud Klaver
 '''SIPPublicationWillEnd'''::
1836 86 Ruud Klaver
  Will be sent whenever the {{{end()}}} method was called and an unpublishing {{{PUBLISH}}} is sent.
1837 99 Adrian Georgescu
1838 86 Ruud Klaver
 '''SIPPublicationDidNotEnd'''::
1839 86 Ruud Klaver
  This notification will be sent when the unpublishing {{{PUBLISH}}} request failed for some reason.
1840 86 Ruud Klaver
  [[BR]]''code'':[[BR]]
1841 1 Adrian Georgescu
  The SIP response code as received from the presence agent as an int.
1842 1 Adrian Georgescu
  This can also be a PJSIP generated response code, or 0 if the failure was because of an internal error.
1843 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
1844 1 Adrian Georgescu
  The reason string received from the presence agent or the error string.
1845 99 Adrian Georgescu
1846 59 Ruud Klaver
 '''SIPPublicationDidEnd'''::
1847 1 Adrian Georgescu
  This notification will be sent when a {{{Publication}}} has become unpublished.
1848 1 Adrian Georgescu
  [[BR]]''expired'':[[BR]]
1849 1 Adrian Georgescu
  This boolean indicates if the object is unpublished because the publication expired, in which case it will be set to {{{True}}}.
1850 1 Adrian Georgescu
  If this data attribute is {{{False}}}, it means that unpublication was explicitly requested through the {{{end()}}} method.
1851 1 Adrian Georgescu
1852 59 Ruud Klaver
=== Subscription ===
1853 59 Ruud Klaver
1854 1 Adrian Georgescu
Subscription and notifications for SIP events is an Internet standard published at [http://tools.ietf.org/html/rfc3856 RFC 3856].
1855 1 Adrian Georgescu
1856 1 Adrian Georgescu
This SIP primitive class represents a subscription to a specific event type of a particular SIP URI.
1857 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.
1858 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.
1859 1 Adrian Georgescu
Whenever a {{{NOTIFY}}} is received, the application will receive the {{{SIPSubscriptionGotNotify}}} event.
1860 59 Ruud Klaver
1861 59 Ruud Klaver
Internally a {{{Subscription}}} object has a state machine, which reflects the state of the subscription.
1862 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}}}.
1863 1 Adrian Georgescu
The last three states are directly copied from the contents of the {{{Subscription-State}}} header of the received {{{NOTIFY}}} request.
1864 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.
1865 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.
1866 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.
1867 59 Ruud Klaver
1868 1 Adrian Georgescu
==== methods ====
1869 1 Adrian Georgescu
1870 99 Adrian Georgescu
1871 95 Luci Stanescu
 '''!__init!__'''(''self'', '''from_header''', '''to_header''', '''contact_header, '''event''', '''route_header''', '''credentials'''={{{None}}}, '''refresh'''=300)::
1872 1 Adrian Georgescu
  Creates a new {{{Subscription}}} object which will be in the {{{NULL}}} state.
1873 1 Adrian Georgescu
  The arguments for this method are documented in the attributes section above.
1874 99 Adrian Georgescu
1875 1 Adrian Georgescu
 '''subscribe'''(''self'', '''extra_headers'''={{{None}}}, '''content_type'''={{{None}}}, '''body'''={{{None}}}, '''timeout'''={{{None}}})::
1876 1 Adrian Georgescu
  Calling this method triggers sending a {{{SUBSCRIBE}}} request to the presence agent.
1877 1 Adrian Georgescu
  The arguments passed will be stored and used for subsequent refreshing {{{SUBSCRIBE}}} requests.
1878 1 Adrian Georgescu
  This method may be used both to send the initial request and to update the arguments while the subscription is ongoing.
1879 1 Adrian Georgescu
  It may not be called when the object is in the {{{TERMINATED}}} state.
1880 1 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
1881 1 Adrian Georgescu
  A dictionary of additional headers to include in the {{{SUBSCRIBE}}} requests.
1882 1 Adrian Georgescu
  [[BR]]''content_type'':[[BR]]
1883 1 Adrian Georgescu
  The {{{Content-Type}}} of the supplied {{{body}}} argument as a string.
1884 1 Adrian Georgescu
  If this argument is supplied, the {{{body}}} argument cannot be {{{None}}}.
1885 1 Adrian Georgescu
  [[BR]]''body'':[[BR]]
1886 1 Adrian Georgescu
  The optional body to include in the {{{SUBSCRIBE}}} request as a string.
1887 1 Adrian Georgescu
  If this argument is supplied, the {{{content_type}}} argument cannot be {{{None}}}.
1888 1 Adrian Georgescu
  [[BR]]''timeout'':[[BR]]
1889 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.
1890 1 Adrian Georgescu
  If this is {{{None}}}, the internal 408 is only triggered by the internal PJSIP transaction timeout.
1891 1 Adrian Georgescu
  Note that, even if the timeout is specified, the PJSIP timeout is also still valid.
1892 99 Adrian Georgescu
1893 1 Adrian Georgescu
 '''end'''(''self'', '''timeout'''={{{None}}})::
1894 1 Adrian Georgescu
  This will end the subscription by sending a {{{SUBSCRIBE}}} request with an {{{Expires}}} value of 0.
1895 1 Adrian Georgescu
  If this object is no longer subscribed, this method will return without performing any action.
1896 1 Adrian Georgescu
  This method cannot be called when the object is in the {{{NULL}}} state.
1897 1 Adrian Georgescu
  The {{{timeout}}} argument has the same meaning as it does for the {{{subscribe()}}} method.
1898 59 Ruud Klaver
1899 95 Luci Stanescu
==== attributes ====
1900 95 Luci Stanescu
1901 99 Adrian Georgescu
1902 95 Luci Stanescu
 '''state'''::
1903 95 Luci Stanescu
  Indicates which state the internal state machine is in.
1904 95 Luci Stanescu
  See the previous section for a list of states the state machine can be in.
1905 99 Adrian Georgescu
1906 95 Luci Stanescu
 '''from_header'''::
1907 95 Luci Stanescu
  The {{{FrozenFromHeader}}} to be put in the {{{From}}} header of the {{{SUBSCRIBE}}} requests.
1908 95 Luci Stanescu
  This attribute is set on object instantiation and is read-only.
1909 99 Adrian Georgescu
1910 95 Luci Stanescu
 '''to_header'''::
1911 95 Luci Stanescu
  The {{{FrozenToHeader}}} that is the target for the subscription.
1912 95 Luci Stanescu
  This attribute is set on object instantiation and is read-only.
1913 99 Adrian Georgescu
1914 95 Luci Stanescu
 '''contact_header'''::
1915 95 Luci Stanescu
  The {{{FrozenContactHeader}}} to be put in the {{{Contact}}} header of the {{{SUBSCRIBE}}} requests.
1916 95 Luci Stanescu
  This attribute is set on object instantiation and is read-only.
1917 99 Adrian Georgescu
1918 95 Luci Stanescu
 '''event'''::
1919 95 Luci Stanescu
  The event package for which the subscription is as a string.
1920 95 Luci Stanescu
  This attribute is set on object instantiation and is read-only.
1921 99 Adrian Georgescu
1922 95 Luci Stanescu
 '''route_header'''::
1923 95 Luci Stanescu
  The outbound proxy to use in the form of a {{{FrozenRouteHeader}}} object.
1924 95 Luci Stanescu
  This attribute is set on object instantiation and is read-only.
1925 99 Adrian Georgescu
1926 95 Luci Stanescu
 '''credentials'''::
1927 95 Luci Stanescu
  The SIP credentials needed to authenticate at the SIP proxy in the form of a {{{FrozenCredentials}}} object.
1928 95 Luci Stanescu
  If none was specified when creating the {{{Subscription}}} object, this attribute is {{{None}}}.
1929 95 Luci Stanescu
  This attribute is set on object instantiation and is read-only.
1930 99 Adrian Georgescu
1931 95 Luci Stanescu
 '''refresh'''::
1932 95 Luci Stanescu
  The refresh interval in seconds that was requested on object instantiation as an int.
1933 95 Luci Stanescu
  This attribute is set on object instantiation and is read-only.
1934 99 Adrian Georgescu
1935 95 Luci Stanescu
 '''extra_headers'''::
1936 95 Luci Stanescu
  This contains the {{{frozenlist}}} of extra headers that was last passed to a successful call to the {{{subscribe()}}} method.
1937 95 Luci Stanescu
  If the argument was not provided, this attribute is an empty list.
1938 95 Luci Stanescu
  This attribute is read-only.
1939 99 Adrian Georgescu
1940 95 Luci Stanescu
 '''content_type'''::
1941 95 Luci Stanescu
  This attribute contains the {{{Content-Type}}} of the body that was last passed to a successful call to the {{{subscribe()}}} method.
1942 95 Luci Stanescu
  If the argument was not provided, this attribute is {{{None}}}.
1943 99 Adrian Georgescu
1944 95 Luci Stanescu
 '''body'''::
1945 95 Luci Stanescu
  This attribute contains the {{{body}}} string argument that was last passed to a successful call to the {{{subscribe()}}} method.
1946 95 Luci Stanescu
  If the argument was not provided, this attribute is {{{None}}}.
1947 95 Luci Stanescu
1948 59 Ruud Klaver
==== notifications ====
1949 59 Ruud Klaver
1950 99 Adrian Georgescu
1951 59 Ruud Klaver
 '''SIPSubscriptionChangedState'''::
1952 59 Ruud Klaver
  This notification will be sent every time the internal state machine of a {{{Subscription}}} object changes state.
1953 59 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
1954 29 Luci Stanescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1955 29 Luci Stanescu
  [[BR]]''prev_state'':[[BR]]
1956 59 Ruud Klaver
  The previous state that the sate machine was in.
1957 1 Adrian Georgescu
  [[BR]]''state'':[[BR]]
1958 1 Adrian Georgescu
  The new state the state machine moved into.
1959 99 Adrian Georgescu
1960 59 Ruud Klaver
 '''SIPSubscriptionWillStart'''::
1961 59 Ruud Klaver
  This notification will be emitted when the initial {{{SUBSCRIBE}}} request is sent.
1962 59 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
1963 59 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1964 99 Adrian Georgescu
1965 59 Ruud Klaver
 '''SIPSubscriptionDidStart'''::
1966 59 Ruud Klaver
  This notification will be sent when the initial {{{SUBSCRIBE}}} was accepted by the presence agent.
1967 59 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
1968 59 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1969 99 Adrian Georgescu
1970 59 Ruud Klaver
 '''SIPSubscriptionGotNotify'''::
1971 1 Adrian Georgescu
  This notification will be sent when a {{{NOTIFY}}} is received that corresponds to a particular {{{Subscription}}} object.
1972 59 Ruud Klaver
  Note that this notification could be sent when a {{{NOTIFY}}} without a body is received.
1973 59 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
1974 59 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1975 59 Ruud Klaver
  [[BR]]''method'':[[BR]]
1976 59 Ruud Klaver
  The method of the SIP request as a string.
1977 59 Ruud Klaver
  This will always be {{{NOTIFY}}}.
1978 59 Ruud Klaver
  [[BR]]''request_uri'':[[BR]]
1979 59 Ruud Klaver
  The request URI of the {{{NOTIFY}}} request as a {{{SIPURI}}} object.
1980 59 Ruud Klaver
  [[BR]]''headers'':[[BR]]
1981 59 Ruud Klaver
  The headers of the {{{NOTIFY}}} request as a dict.
1982 84 Ruud Klaver
  Each SIP header is represented in its parsed for as long as PJSIP supports it.
1983 84 Ruud Klaver
  The format of the parsed value depends on the header.
1984 84 Ruud Klaver
  [[BR]]''body'':[[BR]]
1985 84 Ruud Klaver
  The body of the {{{NOTIFY}}} request as a string, or {{{None}}} if no body was included.
1986 84 Ruud Klaver
  The content type of the body can be learned from the {{{Content-Type}}} header in the headers data attribute.
1987 99 Adrian Georgescu
1988 84 Ruud Klaver
 '''SIPSubscriptionDidFail'''::
1989 84 Ruud Klaver
  This notification will be sent whenever there is a failure, such as a rejected initial or refreshing {{{SUBSCRIBE}}}.
1990 84 Ruud Klaver
  After this notification the {{{Subscription}}} object is in the {{{TERMINATED}}} state and can no longer be used.
1991 84 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
1992 84 Ruud Klaver
  A {{{datetime.datetime}}} object indicating when the notification was sent.
1993 84 Ruud Klaver
  [[BR]]''code'':[[BR]]
1994 84 Ruud Klaver
  An integer SIP code from the fatal response that was received from the remote party of generated by PJSIP.
1995 84 Ruud Klaver
  If the error is internal to the SIP core, this attribute will have a value of 0.
1996 84 Ruud Klaver
  [[BR]]''reason'':[[BR]]
1997 84 Ruud Klaver
  An text string describing the failure that occurred.
1998 99 Adrian Georgescu
1999 84 Ruud Klaver
 '''SIPSubscriptionDidEnd'''::
2000 84 Ruud Klaver
  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.
2001 1 Adrian Georgescu
  After this notification the {{{Subscription}}} object is in the {{{TERMINATED}}} state and can no longer be used.
2002 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2003 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2004 1 Adrian Georgescu
2005 1 Adrian Georgescu
=== IncomingSubscription ===
2006 1 Adrian Georgescu
2007 1 Adrian Georgescu
Subscription and notifications for SIP events is an Internet standard published at [http://tools.ietf.org/html/rfc3856 RFC 3856].
2008 1 Adrian Georgescu
2009 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.
2010 1 Adrian Georgescu
This means that it can accept a {{{SUBSCRIBE}}} request and subsequent refreshing {{{SUBSCRIBE}}}s and sent {{{NOTIFY}}} requests containing event state.
2011 1 Adrian Georgescu
2012 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.
2013 1 Adrian Georgescu
This event needs to be known by the {{{Engine}}}, i.e. it should already be present in the {{{events}}} dictionary attribute.
2014 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.
2015 1 Adrian Georgescu
This will be indicated to the application through a {{{SIPIncomingSubscriptionGotSubscribe}}} notification.
2016 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.
2017 84 Ruud Klaver
2018 84 Ruud Klaver
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.
2019 84 Ruud Klaver
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.
2020 84 Ruud Klaver
Whenever a refreshing {{{SUBSCRIBE}}} is received, the latest contents to be set are sent in the resulting {{{NOTIFY}}} request.
2021 84 Ruud Klaver
The subscription can be ended by using the {{{end()}}} method.
2022 84 Ruud Klaver
2023 84 Ruud Klaver
==== methods ====
2024 84 Ruud Klaver
2025 99 Adrian Georgescu
2026 84 Ruud Klaver
 '''!__init!__'''(''self'')::
2027 84 Ruud Klaver
  An application should never create an {{{IncomingSubscription}}} object itself.
2028 84 Ruud Klaver
  Doing this will create a useless object in the {{{None}}} state.
2029 99 Adrian Georgescu
2030 84 Ruud Klaver
 '''reject'''(''self'', '''code''')::
2031 84 Ruud Klaver
  Will reply to the initial {{{SUBSCRIBE}}} with a negative response.
2032 84 Ruud Klaver
  This method can only be called in the {{{"incoming"}}} state and sets the subscription to the {{{"terminated"}}} state.
2033 84 Ruud Klaver
  [[BR]]''code'':[[BR]]
2034 84 Ruud Klaver
  The SIP response code to use.
2035 84 Ruud Klaver
  This should be a negative response, i.e. in the 3xx, 4xx, 5xx or 6xx range.
2036 99 Adrian Georgescu
2037 84 Ruud Klaver
 '''accept_pending'''(''self'')::
2038 84 Ruud Klaver
  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.
2039 84 Ruud Klaver
  The application can later decide to fully accept the subscription or terminate it.
2040 84 Ruud Klaver
  This method can only be called in the {{{"incoming"}}} state.
2041 99 Adrian Georgescu
2042 84 Ruud Klaver
 '''accept'''(''self'', '''content_type'''={{{None}}}, '''content'''={{{None}}})::
2043 84 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.
2044 84 Ruud Klaver
  In either case, a {{{NOTIFY}}} will be sent to update the state to "active", optionally with the content specified in the arguments.
2045 84 Ruud Klaver
  This method can only be called in the {{{"incoming"}}} or {{{"pending"}}} state.
2046 84 Ruud Klaver
  [[BR]]''content_type'':[[BR]]
2047 84 Ruud Klaver
  The Content-Type of the content to be set supplied as a string containing a {{{"/"}}} character.
2048 84 Ruud Klaver
  Note that if this argument is set, the {{{content}}} argument should also be set.
2049 84 Ruud Klaver
  [[BR]]''content'':[[BR]]
2050 84 Ruud Klaver
  The body of the {{{NOTIFY}}} to send when accepting the subscription, as a string.
2051 84 Ruud Klaver
  Note that if this argument is set, the {{{content_type}}} argument should also be set.
2052 99 Adrian Georgescu
2053 84 Ruud Klaver
 '''push_content'''(''self'', '''content_type''', '''content''')::
2054 84 Ruud Klaver
  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.
2055 84 Ruud Klaver
  This method can only be called in the {{{"active"}}} state.
2056 84 Ruud Klaver
  [[BR]]''content_type'':[[BR]]
2057 84 Ruud Klaver
  The Content-Type of the content to be set supplied as a string containing a {{{"/"}}} character.
2058 84 Ruud Klaver
  [[BR]]''content'':[[BR]]
2059 84 Ruud Klaver
  The body of the {{{NOTIFY}}} as a string.
2060 84 Ruud Klaver
2061 95 Luci Stanescu
==== attributes ====
2062 95 Luci Stanescu
2063 99 Adrian Georgescu
2064 95 Luci Stanescu
 '''state'''::
2065 95 Luci Stanescu
  Indicates which state the incoming subscription session is in.
2066 95 Luci Stanescu
  This can be one of {{{None}}}, {{{"incoming"}}}, {{{"pending"}}}, {{{"active"}}} or {{{"terminated"}}}.
2067 95 Luci Stanescu
  This attribute is read-only.
2068 99 Adrian Georgescu
2069 95 Luci Stanescu
 '''event'''::
2070 95 Luci Stanescu
  The name of the event package that this {{{IncomingSubscription}}} relates to.
2071 95 Luci Stanescu
  This attribute is a read-only string.
2072 99 Adrian Georgescu
2073 95 Luci Stanescu
 '''content_type'''::
2074 95 Luci Stanescu
  The {{{Content-Type}}} of the last set content in this subscription session.
2075 95 Luci Stanescu
  Inititally this will be {{{None}}}.
2076 95 Luci Stanescu
  This attribute is a read-only string.
2077 99 Adrian Georgescu
2078 95 Luci Stanescu
 '''content'''::
2079 95 Luci Stanescu
  The last set content in this subscription session as a read-only string.
2080 95 Luci Stanescu
2081 1 Adrian Georgescu
==== notifications ====
2082 1 Adrian Georgescu
2083 99 Adrian Georgescu
2084 1 Adrian Georgescu
 '''SIPIncomingSubscriptionChangedState'''::
2085 1 Adrian Georgescu
  This notification will be sent every time the an {{{IncomingSubscription}}} object changes state.
2086 1 Adrian Georgescu
  This notification is mostly indicative, an application should not let its logic depend on it.
2087 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2088 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2089 1 Adrian Georgescu
  [[BR]]''prev_state'':[[BR]]
2090 1 Adrian Georgescu
  The previous state that the subscription was in.
2091 1 Adrian Georgescu
  [[BR]]''state'':[[BR]]
2092 1 Adrian Georgescu
  The new state the subscription has.
2093 99 Adrian Georgescu
2094 1 Adrian Georgescu
 '''SIPIncomingSubscriptionGotSubscribe'''::
2095 1 Adrian Georgescu
  This notification will be sent when a new {{{IncomingSubscription}}} is created as result of an incoming {{{SUBSCRIBE}}} request.
2096 1 Adrian Georgescu
  The application should listen for this notification, retain a reference to the object that sent it and either accept or reject it.
2097 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2098 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2099 18 Adrian Georgescu
  [[BR]]''method'':[[BR]]
2100 1 Adrian Georgescu
  The method of the SIP request as a string, which will be {{{SUBSCRIBE}}}.
2101 1 Adrian Georgescu
  [[BR]]''request_uri'':[[BR]]
2102 17 Ruud Klaver
  The request URI of the {{{SUBSCRIBE}}} request as a {{{FrozenSIPURI}}} object.
2103 17 Ruud Klaver
  [[BR]]''headers'':[[BR]]
2104 17 Ruud Klaver
  The headers of the {{{SUBSCRIBE}}} request as a dict, the values of which are the relevant header objects.
2105 17 Ruud Klaver
  [[BR]]''body'':[[BR]]
2106 17 Ruud Klaver
  The body of the {{{SUBSCRIBE}}} request as a string, or {{{None}}} if no body was included.
2107 99 Adrian Georgescu
2108 17 Ruud Klaver
 '''SIPIncomingSubscriptionGotRefreshingSubscribe'''::
2109 17 Ruud Klaver
  This notification indicates that a refreshing {{{SUBSCRIBE}}} request was received from the subscriber.
2110 17 Ruud Klaver
  It is purely informative, no action needs to be taken by the application as a result of it.
2111 17 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
2112 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2113 1 Adrian Georgescu
  [[BR]]''method'':[[BR]]
2114 1 Adrian Georgescu
  The method of the SIP request as a string, which will be {{{SUBSCRIBE}}}.
2115 1 Adrian Georgescu
  [[BR]]''request_uri'':[[BR]]
2116 1 Adrian Georgescu
  The request URI of the {{{SUBSCRIBE}}} request as a {{{FrozenSIPURI}}} object.
2117 1 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
2118 1 Adrian Georgescu
  The headers of the {{{SUBSCRIBE}}} request as a dict, the values of which are the relevant header objects.
2119 1 Adrian Georgescu
  [[BR]]''body'':[[BR]]
2120 1 Adrian Georgescu
  The body of the {{{SUBSCRIBE}}} request as a string, or {{{None}}} if no body was included.
2121 99 Adrian Georgescu
2122 17 Ruud Klaver
 '''SIPIncomingSubscriptionGotUnsubscribe'''::
2123 1 Adrian Georgescu
  This notification indicates that a {{{SUBSCRIBE}}} request with an {{{Expires}}} header of 0 was received from the subscriber, effectively requesting to unsubscribe.
2124 1 Adrian Georgescu
  It is purely informative, no action needs to be taken by the application as a result of it.
2125 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2126 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2127 1 Adrian Georgescu
  [[BR]]''method'':[[BR]]
2128 1 Adrian Georgescu
  The method of the SIP request as a string, which will be {{{SUBSCRIBE}}}.
2129 17 Ruud Klaver
  [[BR]]''request_uri'':[[BR]]
2130 1 Adrian Georgescu
  The request URI of the {{{SUBSCRIBE}}} request as a {{{FrozenSIPURI}}} object.
2131 1 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
2132 1 Adrian Georgescu
  The headers of the {{{SUBSCRIBE}}} request as a dict, the values of which are the relevant header objects.
2133 1 Adrian Georgescu
  [[BR]]''body'':[[BR]]
2134 1 Adrian Georgescu
  The body of the {{{SUBSCRIBE}}} request or response as a string, or {{{None}}} if no body was included.
2135 99 Adrian Georgescu
2136 1 Adrian Georgescu
 '''SIPIncomingSubscriptionAnsweredSubscribe'''::
2137 1 Adrian Georgescu
  This notification is sent whenever a response to a {{{SUBSCRIBE}}} request is sent by the object, including an unsubscribing {{{SUBSCRIBE}}}.
2138 1 Adrian Georgescu
  It is purely informative, no action needs to be taken by the application as a result of it.
2139 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2140 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2141 1 Adrian Georgescu
  [[BR]]''code'':[[BR]]
2142 1 Adrian Georgescu
  The code of the SIP response as an int.
2143 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
2144 45 Ruud Klaver
  The reason text of the SIP response as an int.
2145 1 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
2146 1 Adrian Georgescu
  The headers of the response as a dict, the values of which are the relevant header objects.
2147 1 Adrian Georgescu
  [[BR]]''body'':[[BR]]
2148 71 Adrian Georgescu
  This will be {{{None}}}.
2149 99 Adrian Georgescu
2150 1 Adrian Georgescu
 '''SIPIncomingSubscriptionSentNotify'''::
2151 1 Adrian Georgescu
  This notification indicates that a {{{NOTIFY}}} request was sent to the subscriber.
2152 1 Adrian Georgescu
  It is purely informative, no action needs to be taken by the application as a result of it.
2153 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2154 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2155 1 Adrian Georgescu
  [[BR]]''method'':[[BR]]
2156 1 Adrian Georgescu
  The method of the SIP request as a string, which will be {{{NOTIFY}}}.
2157 1 Adrian Georgescu
  [[BR]]''request_uri'':[[BR]]
2158 1 Adrian Georgescu
  The request URI of the {{{NOTIFY}}} request as a {{{FrozenSIPURI}}} object.
2159 1 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
2160 1 Adrian Georgescu
  The headers of the {{{NOTIFY}}} request as a dict, the values of which are the relevant header objects.
2161 1 Adrian Georgescu
  [[BR]]''body'':[[BR]]
2162 1 Adrian Georgescu
  The body of the {{{NOTIFY}}} request or response as a string, or {{{None}}} if no body was included.
2163 99 Adrian Georgescu
2164 1 Adrian Georgescu
 '''SIPIncomingSubscriptionNotifyDidSucceed'''::
2165 1 Adrian Georgescu
  This indicates that a positive final response was received from the subscriber in reply to a sent {{{NOTIFY}}} request.
2166 1 Adrian Georgescu
  The notification is purely informative, no action needs to be taken by the application as a result of it.
2167 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2168 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2169 1 Adrian Georgescu
  [[BR]]''code'':[[BR]]
2170 1 Adrian Georgescu
  The code of the SIP response as an int.
2171 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
2172 1 Adrian Georgescu
  The reason text of the SIP response as a string.
2173 1 Adrian Georgescu
  [[BR]]''headers'':[[BR]]
2174 1 Adrian Georgescu
  The headers of the response as a dict, the values of which are the relevant header objects.
2175 1 Adrian Georgescu
  [[BR]]''body'':[[BR]]
2176 1 Adrian Georgescu
  This will be {{{None}}}.
2177 99 Adrian Georgescu
2178 1 Adrian Georgescu
 '''SIPIncomingSubscriptionNotifyDidFail'''::
2179 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.
2180 19 Ruud Klaver
  [[BR]]''timestamp'':[[BR]]
2181 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2182 1 Adrian Georgescu
  [[BR]]''code'':[[BR]]
2183 1 Adrian Georgescu
  The code of the SIP response as an int.
2184 1 Adrian Georgescu
  If this is 0, the notification was sent as a result of an internal error.
2185 1 Adrian Georgescu
  [[BR]]''reason'':[[BR]]
2186 1 Adrian Georgescu
  The reason text of the SIP response as a string or the internal error if the code attribute is 0.
2187 1 Adrian Georgescu
  [[BR]]''headers'': (if the notification was caused by a negative response)[[BR]]
2188 1 Adrian Georgescu
  The headers of the response as a dict, the values of which are the relevant header objects.
2189 1 Adrian Georgescu
  [[BR]]''body'': (if the notification was caused by a negative response)[[BR]]
2190 1 Adrian Georgescu
  This will be {{{None}}}.
2191 99 Adrian Georgescu
2192 1 Adrian Georgescu
 '''SIPIncomingSubscriptionNotifyDidEnd'''::
2193 1 Adrian Georgescu
  This notification is sent whenever the {{{IncomingSubscription}}} object reaches the {{{"terminated"}}} state and is no longer valid.
2194 1 Adrian Georgescu
  After receiving this notification, the application should not longer try to use the object.
2195 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2196 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2197 1 Adrian Georgescu
2198 1 Adrian Georgescu
=== Invitation ===
2199 1 Adrian Georgescu
2200 1 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.
2201 1 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.
2202 1 Adrian Georgescu
The {{{Invitation}}} class represents both incoming and outgoing sessions.
2203 1 Adrian Georgescu
2204 1 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.
2205 1 Adrian Georgescu
In order to represent re-{{{INVITE}}}s and user-requested disconnections, three more states have been added to this state machine.
2206 1 Adrian Georgescu
The progression through this state machine is fairly linear and is dependent on whether this is an incoming or an outgoing session.
2207 1 Adrian Georgescu
State changes are triggered either by incoming or by outgoing SIP requests and responses.
2208 1 Adrian Georgescu
The states and the transitions between them are shown in the following diagram:
2209 1 Adrian Georgescu
2210 1 Adrian Georgescu
[[Image(sipsimple-core-invite-state-machine.png, nolink)]]
2211 1 Adrian Georgescu
2212 1 Adrian Georgescu
The state changes of this machine are triggered by the following:
2213 1 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.
2214 1 Adrian Georgescu
 2. The application requested an outgoing session by calling the {{{send_invite()}}} method and and initial {{{INVITE}}} request is sent.
2215 1 Adrian Georgescu
 3. A new incoming session is received by the core.
2216 1 Adrian Georgescu
    The application should look out for state change to this state in order to be notified of new incoming sessions.
2217 1 Adrian Georgescu
 4. A provisional response (1xx) is received from the remove party.
2218 1 Adrian Georgescu
 5. A provisional response (1xx) is sent to the remote party, after the application called the {{{respond_to_invite_provisionally()}}} method.
2219 1 Adrian Georgescu
 6. A positive final response (2xx) is received from the remote party.
2220 1 Adrian Georgescu
 7. A positive final response (2xx) is sent to the remote party, after the application called the {{{accept_invite()}}} method.
2221 1 Adrian Georgescu
 8. A positive final response (2xx) is sent or received, depending on the orientation of the session.
2222 1 Adrian Georgescu
 9. An {{{ACK}}} is sent or received, depending on the orientation of the session.
2223 1 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.
2224 1 Adrian Georgescu
 10. The local party sent a re-{{{INVITE}}} to the remote party by calling the {{{send_reinvite()}}} method.
2225 1 Adrian Georgescu
 11. The remote party has sent a final response to the re-{{{INVITE}}}.
2226 1 Adrian Georgescu
 12. The remote party has sent a re-{{{INVITE}}}.
2227 1 Adrian Georgescu
 13. The local party has responded to the re-{{{INVITE}}} by calling the {{{respond_to_reinvite()}}} method.
2228 1 Adrian Georgescu
 14. The application requests that the session ends by calling the {{{end()}}} method.
2229 78 Ruud Klaver
 15. A response is received from the remote party to whichever message was sent by the local party to end the session.
2230 78 Ruud Klaver
 16. A message is received from the remote party which ends the session.
2231 78 Ruud Klaver
2232 81 Ruud Klaver
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.
2233 78 Ruud Klaver
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.
2234 78 Ruud Klaver
The application should compare the previous and current states and perform the appropriate action.
2235 78 Ruud Klaver
2236 78 Ruud Klaver
An {{{Invitiation}}} object also emits the {{{SIPInvitationGotSDPUpdate}}} notification, which indicates that SDP negotiation between the two parties has been completed.
2237 78 Ruud Klaver
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.
2238 78 Ruud Klaver
In the last case, the {{{Invitation}}} object will automatically include the current local SDP in the response.
2239 78 Ruud Klaver
2240 78 Ruud Klaver
==== attributes ====
2241 78 Ruud Klaver
2242 99 Adrian Georgescu
2243 78 Ruud Klaver
 '''state'''::
2244 78 Ruud Klaver
  The state the {{{Invitation}}} state machine is currently in.
2245 78 Ruud Klaver
  See the diagram above for possible states.
2246 78 Ruud Klaver
  This attribute is read-only.
2247 99 Adrian Georgescu
2248 95 Luci Stanescu
 '''sub_state'''::
2249 95 Luci Stanescu
  The sub-state the {{{Invitation}}} state machine is currently in.
2250 95 Luci Stanescu
  See the diagram above for possible states.
2251 95 Luci Stanescu
  This attribute is read-only.
2252 99 Adrian Georgescu
2253 95 Luci Stanescu
 '''directing'''::
2254 95 Luci Stanescu
  A string with the values {{{"incoming"}}} or {{{"outgoing"}}} depending on the direction of the original INVITE request.
2255 99 Adrian Georgescu
2256 78 Ruud Klaver
 '''credentials'''::
2257 95 Luci Stanescu
  The SIP credentials needed to authenticate at the SIP proxy in the form of a {{{FrozenCredentials}}} object.
2258 1 Adrian Georgescu
  If this {{{Invitation}}} object represents an incoming {{{INVITE}}} session this attribute will be {{{None}}}.
2259 1 Adrian Georgescu
  On an outgoing session this attribute will be {{{None}}} if it was not specified when the object was created.
2260 78 Ruud Klaver
  This attribute is set on object instantiation and is read-only.
2261 99 Adrian Georgescu
2262 95 Luci Stanescu
 '''from_header'''::
2263 95 Luci Stanescu
  The From header of the caller represented by a {{{FrozenFromHeader}}} object.
2264 95 Luci Stanescu
  If this is an outgoing {{{INVITE}}} session, this is the from_header from the {{{send_invite()}}} method.
2265 78 Ruud Klaver
  Otherwise the URI is taken from the {{{From:}}} header of the initial {{{INVITE}}}.
2266 78 Ruud Klaver
  This attribute is set on object instantiation and is read-only.
2267 99 Adrian Georgescu
2268 95 Luci Stanescu
 '''to_header'''::
2269 95 Luci Stanescu
  The To header of the callee represented by a {{{FrozenToHeader}}} object.
2270 95 Luci Stanescu
  If this is an outgoing {{{INVITE}}} session, this is the to_header from the {{{send_invite()}}} method.
2271 78 Ruud Klaver
  Otherwise the URI is taken from the {{{To:}}} header of the initial {{{INVITE}}}.
2272 78 Ruud Klaver
  This attribute is set on object instantiation and is read-only.
2273 99 Adrian Georgescu
2274 95 Luci Stanescu
 '''local_identity'''::
2275 95 Luci Stanescu
  The From or To header representing the local identity used in this session.
2276 95 Luci Stanescu
  If the original {{{INVITE}}} was incoming, this is the same as {{{to_header}}}, otherwise it will be the same as {{{from_header}}}.
2277 99 Adrian Georgescu
2278 95 Luci Stanescu
 '''remote_identity'''::
2279 95 Luci Stanescu
  The From or To header representing the remote party in this session.
2280 95 Luci Stanescu
  If the original {{{INVITE}}} was incoming, this is the same as {{{from_header}}}, otherwise it will be the same as {{{to_header}}}.
2281 99 Adrian Georgescu
2282 95 Luci Stanescu
 '''route_header'''::
2283 95 Luci Stanescu
  The outbound proxy that was requested to be used in the form of a {{{FrozenRouteHeader}}} object, including the desired transport.
2284 78 Ruud Klaver
  If this {{{Invitation}}} object represents an incoming {{{INVITE}}} session this attribute will always be {{{None}}}.
2285 78 Ruud Klaver
  This attribute is set on object instantiation and is read-only.
2286 99 Adrian Georgescu
2287 78 Ruud Klaver
 '''call_id'''::
2288 78 Ruud Klaver
  The call ID of the {{{INVITE}}} session as a read-only string.
2289 1 Adrian Georgescu
  In the {{{NULL}}} and {{{DISCONNECTED}}} states, this attribute is {{{None}}}.
2290 99 Adrian Georgescu
2291 1 Adrian Georgescu
 '''transport'''::
2292 76 Ruud Klaver
  A string indicating the transport used for the application.
2293 1 Adrian Georgescu
  This can be "udp", "tcp" or "tls".
2294 99 Adrian Georgescu
2295 95 Luci Stanescu
 '''local_contact_header'''::
2296 95 Luci Stanescu
  The Contact header that the local side provided to the remote side within this {{{INVITE}}} session as a {{{FrozenContactHeader}}} object.
2297 95 Luci Stanescu
  Note that this can either be set on object creation or updated using the {{{send_reinvite()}}} method.
2298 99 Adrian Georgescu
2299 95 Luci Stanescu
 '''call_id'''::
2300 95 Luci Stanescu
  A string representing the Call-Id header value of this INVITE dialog.
2301 99 Adrian Georgescu
2302 95 Luci Stanescu
 '''remote_user_agent'''::
2303 95 Luci Stanescu
  A string representing the remote user agent taken from the User-Agent or Server headers (depending on the direction of the original INVITE).
2304 99 Adrian Georgescu
2305 95 Luci Stanescu
 '''sdp.proposed_local'''::
2306 95 Luci Stanescu
  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.
2307 99 Adrian Georgescu
2308 95 Luci Stanescu
 '''sdp.proposed_remote'''::
2309 95 Luci Stanescu
  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.
2310 99 Adrian Georgescu
2311 95 Luci Stanescu
 '''sdp.active_local'''::
2312 95 Luci Stanescu
  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.
2313 99 Adrian Georgescu
2314 95 Luci Stanescu
 '''sdp.active_remote'''::
2315 95 Luci Stanescu
  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.
2316 76 Ruud Klaver
2317 1 Adrian Georgescu
==== methods ====
2318 1 Adrian Georgescu
2319 99 Adrian Georgescu
2320 95 Luci Stanescu
 '''!__init!__'''(''self'')::
2321 95 Luci Stanescu
  Creates a new {{{Invitation}}} object.
2322 99 Adrian Georgescu
2323 95 Luci Stanescu
 '''send_invite'''(''self'', '''from_header''', '''to_header''', '''route_header''', '''contact_header''', '''sdp''', '''credentials'''={{{None}}}, '''extra_headers'''={{{[]}}}, '''timeout'''=None)::
2324 95 Luci Stanescu
  [[BR]]''from_header'':[[BR]]
2325 95 Luci Stanescu
  The identity of the local account in the form of a {{{FromHeader}}} object.
2326 95 Luci Stanescu
  [[BR]]''to_header'':[[BR]]
2327 95 Luci Stanescu
  The identity we want to send the {{{INVITE}}} to, represented as a {{{ToHeader}}} object.
2328 95 Luci Stanescu
  [[BR]]''route_header'':[[BR]]
2329 95 Luci Stanescu
  The outbound proxy to use in the form of a {{{RouteHeader}}} object.
2330 15 Ruud Klaver
  This includes the desired transport to use.
2331 95 Luci Stanescu
  [[BR]]''contact_header'':[[BR]]
2332 95 Luci Stanescu
  The Contact header to include in the {{{INVITE}}} request, a {{{ContactHeader}}} object.
2333 95 Luci Stanescu
  [[BR]]''sdp'':[[BR]]
2334 95 Luci Stanescu
  The SDP to send as offer to the remote party.
2335 76 Ruud Klaver
  [[BR]]''credentials'':[[BR]]
2336 1 Adrian Georgescu
  The optional SIP credentials needed to authenticate at the SIP proxy in the form of a {{{Credentials}}} object.
2337 1 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
2338 95 Luci Stanescu
  Any extra headers that should be included in the {{{INVITE}}} request in the form of a list of header objects.
2339 76 Ruud Klaver
  [[BR]]''timeout'':[[BR]]
2340 76 Ruud Klaver
  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.
2341 1 Adrian Georgescu
  If this is set to {{{None}}}, the default PJSIP timeout will be used, which appears to be slightly longer than 30 seconds.
2342 99 Adrian Georgescu
2343 95 Luci Stanescu
 '''send_response'''(''self'', '''code''', '''reason''', '''contact_header''', '''sdp''', '''extra_headers''')::
2344 95 Luci Stanescu
  Send a response to a INVITE request. 
2345 95 Luci Stanescu
  [[BR]]''code'':[[BR]]
2346 95 Luci Stanescu
  The code of the response to use as an int.
2347 95 Luci Stanescu
  [[BR]]''reason'':[[BR]]
2348 95 Luci Stanescu
  The reason of the response as a str.
2349 95 Luci Stanescu
  [[BR]]''contact_header'':[[BR]]
2350 95 Luci Stanescu
  The Contact header to include in the response, a {{{ContactHeader}}} object.
2351 95 Luci Stanescu
  [[BR]]''sdp'':[[BR]]
2352 95 Luci Stanescu
  The SDP to send as offer/response to the remote party.
2353 1 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
2354 95 Luci Stanescu
  Any extra headers that should be included in the response in the form of a list of header objects.
2355 99 Adrian Georgescu
2356 95 Luci Stanescu
 '''send_reinvite'''(''self'', '''contact_header'''={{{None}}}, '''sdp'''={{{None}}}, '''extra_header'''={{{[]}}})::
2357 95 Luci Stanescu
  [[BR]]''contact_header'':[[BR]]
2358 95 Luci Stanescu
  The Contact header if it needs to be changed by the re-INVITE or None if it shouldn't be changed; a {{{BaseContactHeader}}} object.
2359 95 Luci Stanescu
  [[BR]]''sdp'':[[BR]]
2360 95 Luci Stanescu
  The SDP to send as offer to the remote party or None if the re-INVITE should not change the SDP; a {{{BaseSDPSession}}} object.
2361 1 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
2362 95 Luci Stanescu
  Any extra headers that should be included in the response in the form of a list of header objects.
2363 99 Adrian Georgescu
2364 95 Luci Stanescu
 '''cancel_reinvite'''(''self'')::
2365 95 Luci Stanescu
  Send a CANCEL after a re-INVITE has been sent to cancel the action of the re-INVITE.
2366 99 Adrian Georgescu
2367 95 Luci Stanescu
 '''end'''(''self'', '''extra_headers'''={{{[]}}}, '''timeout'''={{{None}}})::
2368 95 Luci Stanescu
  This moves the {{{INVITE}}} state machine into the {{{DISCONNECTING}}} state by sending the necessary SIP request.
2369 77 Ruud Klaver
  When a response from the remote party is received, the state machine will go into the {{{DISCONNECTED}}} state.
2370 95 Luci Stanescu
  Depending on the current state, this could be a CANCEL or a BYE request.
2371 1 Adrian Georgescu
  [[BR]]''extra_headers'':[[BR]]
2372 1 Adrian Georgescu
  Any extra headers that should be included in the request or response in the form of a dict.
2373 77 Ruud Klaver
  [[BR]]''timeout'':[[BR]]
2374 77 Ruud Klaver
  How many seconds to wait for the remote party to reply before changing the state to {{{DISCONNECTED}}}, as an int or a float.
2375 77 Ruud Klaver
  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.
2376 77 Ruud Klaver
2377 77 Ruud Klaver
==== notifications ====
2378 77 Ruud Klaver
2379 99 Adrian Georgescu
2380 1 Adrian Georgescu
 '''SIPInvitationChangedState'''::
2381 1 Adrian Georgescu
  This notification is sent by an {{{Invitation}}} object whenever its state machine changes state.
2382 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2383 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2384 1 Adrian Georgescu
  [[BR]]''prev_state'':[[BR]]
2385 77 Ruud Klaver
  The previous state of the INVITE state machine.
2386 95 Luci Stanescu
  [[BR]]''prev_sub_state'':[[BR]]
2387 95 Luci Stanescu
  THe previous sub-state of the INVITE state machine.
2388 77 Ruud Klaver
  [[BR]]''state'':[[BR]]
2389 1 Adrian Georgescu
  The new state of the INVITE state machine, which may be the same as the previous state.
2390 95 Luci Stanescu
  [[BR]]''sub_state'':[[BR]]
2391 95 Luci Stanescu
  The new sub-state of teh INVITE state machine, which may be the same as the previous sub-state.
2392 1 Adrian Georgescu
  [[BR]]''method'': (only if the state change got triggered by an incoming SIP request)[[BR]]
2393 1 Adrian Georgescu
  The method of the SIP request as a string.
2394 1 Adrian Georgescu
  [[BR]]''request_uri'': (only if the state change got triggered by an incoming SIP request)[[BR]]
2395 1 Adrian Georgescu
  The request URI of the SIP request as a {{{SIPURI}}} object.
2396 1 Adrian Georgescu
  [[BR]]''code'': (only if the state change got triggered by an incoming SIP response or internal timeout or error)[[BR]]
2397 1 Adrian Georgescu
  The code of the SIP response or error as an int.
2398 1 Adrian Georgescu
  [[BR]]''reason'': (only if the state change got triggered by an incoming SIP response or internal timeout or error)[[BR]]
2399 1 Adrian Georgescu
  The reason text of the SIP response or error as a string.
2400 1 Adrian Georgescu
  [[BR]]''headers'': (only if the state change got triggered by an incoming SIP request or response)[[BR]]
2401 1 Adrian Georgescu
  The headers of the SIP request or response as a dict.
2402 1 Adrian Georgescu
  Each SIP header is represented in its parsed for as long as PJSIP supports it.
2403 1 Adrian Georgescu
  The format of the parsed value depends on the header.
2404 1 Adrian Georgescu
  [[BR]]''body'': (only if the state change got triggered by an incoming SIP request or response)[[BR]]
2405 1 Adrian Georgescu
  The body of the SIP request or response as a string, or {{{None}}} if no body was included.
2406 1 Adrian Georgescu
  The content type of the body can be learned from the {{{Content-Type:}}} header in the headers argument.
2407 99 Adrian Georgescu
2408 1 Adrian Georgescu
 '''SIPInvitationGotSDPUpdate'''::
2409 1 Adrian Georgescu
  This notification is sent by an {{{Invitation}}} object whenever SDP negotiation has been performed.
2410 1 Adrian Georgescu
  It should be used by the application as an indication to start, change or stop any associated media streams.
2411 1 Adrian Georgescu
  [[BR]]''timestamp'':[[BR]]
2412 1 Adrian Georgescu
  A {{{datetime.datetime}}} object indicating when the notification was sent.
2413 1 Adrian Georgescu
  [[BR]]''succeeded'':[[BR]]
2414 1 Adrian Georgescu
  A boolean indicating if the SDP negotiation has succeeded.
2415 1 Adrian Georgescu
  [[BR]]''error'': (only if SDP negotiation did not succeed)[[BR]]
2416 1 Adrian Georgescu
  A string indicating why SDP negotiation failed.
2417 1 Adrian Georgescu
  [[BR]]''local_sdp'': (only if SDP negotiation succeeded)[[BR]]
2418 1 Adrian Georgescu
  A SDPSession object indicating the local SDP that was negotiated.
2419 1 Adrian Georgescu
  [[BR]]''remote_sdp'': (only if SDP negotiation succeeded)[[BR]]
2420 1 Adrian Georgescu
  A SDPSession object indicating the remote SDP that was negotiated.