SipCoreApiDocumentation
Version 50 (Ruud Klaver, 05/07/2009 05:32 pm)
1 | 12 | Adrian Georgescu | = SIP core API = |
---|---|---|---|
2 | 1 | Adrian Georgescu | |
3 | 28 | Adrian Georgescu | [[TOC(Sip*, 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 | 1 | Adrian Georgescu | {{{sipsimple}}} is a Python package, the core of which wrapps 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 | 1 | Adrian Georgescu | The latter also includes an abstraction layer for the soundcard. |
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 | 1 | Adrian Georgescu | > The soundcard 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 | 1 | Adrian Georgescu | The SIP core part of the {{{sipsimple}}} Python package is subdivided into three modules: |
62 | 1 | Adrian Georgescu | '''sipsimple.engine''':: |
63 | 1 | Adrian Georgescu | Python module that contains the {{{Engine}}} singleton class, which manages the thread that constantly polls the PJSIP library, i.e. the PJSIP worker thread. |
64 | 1 | Adrian Georgescu | For the applications that use the core of {{{sipsimple}}}, the {{{Engine}}} object forms the main entry point. |
65 | 1 | Adrian Georgescu | '''sipsimple.core''':: |
66 | 1 | Adrian Georgescu | This is the Python C extension module ultimately compiled from the Cython file and PJSIP static libraries. |
67 | 1 | Adrian Georgescu | It contains these types of classes: |
68 | 1 | Adrian Georgescu | * The {{{PJSIPUA}}} class, which can only be instanced once, and is this case is only instanced once by the {{{Engine}}} object. |
69 | 1 | Adrian Georgescu | In this way the {{{Engine}}} singleton class acts as a wrapper to the one {{{PJSIPUA}}} instance. |
70 | 1 | Adrian Georgescu | The {{{PJSIPUA}}} class represents the SIP endpoint and manages the initialization and destruction of all the PJSIP libraries. |
71 | 1 | Adrian Georgescu | It also provides a number of methods. |
72 | 1 | Adrian Georgescu | The application however should never call these methods directly on the {{{PJSIPUA}}} object, rather it should call them on the {{{Engine}}} wrapper object. |
73 | 1 | Adrian Georgescu | This object handles everything that for one reason or another cannot or should not be handled from Cython. |
74 | 42 | Ruud Klaver | * The classes that represent the main SIP primitives to be used by the application, or in the case of {{{Request}}} a generic SIP transction. |
75 | 1 | Adrian Georgescu | The application can instantiate these classes once the {{{Engine}}} class has been instantiated and the PJSIP worker thread has been started. |
76 | 1 | Adrian Georgescu | All of these classes represent a state machine. |
77 | 42 | Ruud Klaver | * {{{Request}}} |
78 | 1 | Adrian Georgescu | * {{{Publication}}} |
79 | 1 | Adrian Georgescu | * {{{Subscription}}} |
80 | 1 | Adrian Georgescu | * {{{Invitation}}} |
81 | 1 | Adrian Georgescu | * Several helper classes, which represent some structured collection of data to be passed as parameter to methods of the SIP primitive classes and to parameters of notifications. |
82 | 1 | Adrian Georgescu | * {{{SIPURI}}} |
83 | 1 | Adrian Georgescu | * {{{Credentials}}} |
84 | 1 | Adrian Georgescu | * {{{Route}}} |
85 | 1 | Adrian Georgescu | * A number of SDP manipulation classes, which directly wrap the PJSIP structures representing either the parsed or to be generated SDP. |
86 | 1 | Adrian Georgescu | {{{SDPSession}}} objects may contain references to the other classes and are passed as arguments to methods of a {{{Invitiation}}} object or notifications sent by it. |
87 | 1 | Adrian Georgescu | * {{{SDPSession}}} |
88 | 1 | Adrian Georgescu | * {{{SDPMedia}}} |
89 | 1 | Adrian Georgescu | * {{{SDPConnection}}} |
90 | 1 | Adrian Georgescu | * {{{SDPAttribute}}} |
91 | 1 | Adrian Georgescu | * Two classes related to transport of media traffic and audio traffic specifically, built on PJMEDIA. |
92 | 1 | Adrian Georgescu | These classes can be instantiated independently from the other classes in order to keep signaling and media separate. |
93 | 1 | Adrian Georgescu | * {{{RTPTransport}}} |
94 | 1 | Adrian Georgescu | * {{{AudioTransport}}} |
95 | 1 | Adrian Georgescu | * Two classes related to {{{.wav}}} files, one for playback and one for recording. |
96 | 1 | Adrian Georgescu | * {{{WaveFile}}} |
97 | 1 | Adrian Georgescu | * {{{RecordingWaveFile}}} |
98 | 1 | Adrian Georgescu | * Two exception classes, the second being a subclass of the first. |
99 | 1 | Adrian Georgescu | * {{{SIPCoreError}}} |
100 | 1 | Adrian Georgescu | * {{{PJSIPError}}} |
101 | 1 | Adrian Georgescu | * Classes used internally within the {{{core}}} module, e.g. to wrap a particular PJSIP library. |
102 | 42 | Ruud Klaver | These classes should not be imported directly and are not included in the {{{__all__}}} variable of this module. |
103 | 42 | Ruud Klaver | '''sipsimple.primitives''':: |
104 | 42 | Ruud Klaver | This module contains several SIP primitive classes that are based on the {{{Request}}} object from the core: |
105 | 42 | Ruud Klaver | * {{{Registration}}} |
106 | 42 | Ruud Klaver | * {{{Message}}} |
107 | 1 | Adrian Georgescu | |
108 | 1 | Adrian Georgescu | These classes (except the ones internal to the {{{core}}} module) are illustrated in the following diagram: |
109 | 1 | Adrian Georgescu | |
110 | 1 | Adrian Georgescu | [[Image(sipsimple-core-classes.png, nolink)]] |
111 | 1 | Adrian Georgescu | |
112 | 11 | Adrian Georgescu | == Integration == |
113 | 1 | Adrian Georgescu | |
114 | 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. |
115 | 1 | Adrian Georgescu | These modules should be present on the system before the core can be used. |
116 | 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. |
117 | 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. |
118 | 1 | Adrian Georgescu | This means that any call to instance an object from this class will result in the same object. |
119 | 1 | Adrian Georgescu | As an example, this bit of code will create an observer for logging messages only: |
120 | 1 | Adrian Georgescu | |
121 | 1 | Adrian Georgescu | {{{ |
122 | 1 | Adrian Georgescu | from zope.interface import implements |
123 | 1 | Adrian Georgescu | from application.notification import NotificationCenter, IObserver |
124 | 1 | Adrian Georgescu | |
125 | 29 | Luci Stanescu | class SIPEngineLogObserver(object): |
126 | 1 | Adrian Georgescu | implements(IObserver) |
127 | 1 | Adrian Georgescu | |
128 | 1 | Adrian Georgescu | def handle_notification(self, notification): |
129 | 1 | Adrian Georgescu | print "%(timestamp)s (%(level)d) %(sender)14s: %(message)s" % notification.data.__dict__ |
130 | 1 | Adrian Georgescu | |
131 | 1 | Adrian Georgescu | notification_center = NotificationCenter() |
132 | 1 | Adrian Georgescu | log_observer = EngineLogObserver() |
133 | 29 | Luci Stanescu | notification_center.add_observer(self, name="SIPEngineLog") |
134 | 1 | Adrian Georgescu | }}} |
135 | 1 | Adrian Georgescu | |
136 | 1 | Adrian Georgescu | Each notification object has three attributes: |
137 | 1 | Adrian Georgescu | '''sender''':: |
138 | 1 | Adrian Georgescu | The object that sent the notification. |
139 | 1 | Adrian Georgescu | For generic notifications the sender will be the {{{Engine}}} instance, otherwise the relevant object. |
140 | 1 | Adrian Georgescu | '''name''':: |
141 | 1 | Adrian Georgescu | The name describing the notification. |
142 | 29 | Luci Stanescu | All messages will be described in this document and start with the prefix "SIP". |
143 | 1 | Adrian Georgescu | '''data''':: |
144 | 1 | Adrian Georgescu | An instance of {{{application.notification.NotificationData}}} or a subclass of it. |
145 | 1 | Adrian Georgescu | The attributes of this object provide additional data about the notification. |
146 | 1 | Adrian Georgescu | Notifications described in this document will also have the data attributes described. |
147 | 1 | Adrian Georgescu | |
148 | 43 | Ruud Klaver | Besides setting up the notification observers, the application should import the relevant objects from the {{{sipsimple.core}}}, {{{sipsimple.engine}}} and {{{sipsimple.primitives}}} modules. |
149 | 1 | Adrian Georgescu | It can then instance 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. |
150 | 1 | Adrian Georgescu | Most of these options can later be changed at runtime, by setting attributes of the same name on the {{{Engine}}} object. |
151 | 1 | Adrian Georgescu | The application may then instance one of the SIP primitive classes and perform operations on it. |
152 | 1 | Adrian Georgescu | |
153 | 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. |
154 | 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. |
155 | 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. |
156 | 1 | Adrian Georgescu | |
157 | 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. |
158 | 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. |
159 | 31 | Ruud Klaver | In this manner the SIP core continues the asynchronous pattern of PJSIP. |
160 | 1 | Adrian Georgescu | If there is an error in processing the request, an instance of {{{SIPCoreError}}}, or its subclass {{{PJSIPError}}} will be raised. |
161 | 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. |
162 | 1 | Adrian Georgescu | The {{{PJSIPError}}} object also contains a status attribute, which is the PJSIP errno as an integer. |
163 | 1 | Adrian Georgescu | |
164 | 43 | Ruud Klaver | As a very basic example, one can {{{REGISTER}}} for a sip account by typing the following lines on a Python console: |
165 | 1 | Adrian Georgescu | {{{ |
166 | 43 | Ruud Klaver | from sipsimple.engine import Engine |
167 | 43 | Ruud Klaver | from sipsimple.primitives import Registration |
168 | 43 | Ruud Klaver | from sipsimple.core import Credentials, SIPURI, Route |
169 | 1 | Adrian Georgescu | e = Engine() |
170 | 1 | Adrian Georgescu | e.start() |
171 | 1 | Adrian Georgescu | cred = Credentials(SIPURI(user="alice", host="example.com"), "password") |
172 | 43 | Ruud Klaver | reg = Registration(cred) |
173 | 43 | Ruud Klaver | reg.register(SIPURI("127.0.0.1",port=12345), Route("1.2.3.4")) |
174 | 1 | Adrian Georgescu | }}} |
175 | 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. |
176 | 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. |
177 | 43 | Ruud Klaver | See the {{{Registration}}} documentation for more details. |
178 | 43 | Ruud Klaver | When performing operations with a running {{{Engine}}} on a Python console, be sure to call the {{{stop()}}} method of the {{{Engine}}} before exiting the console. |
179 | 43 | Ruud Klaver | Failure to do so will keep the {{{Engine}}} running and will cause the program to hang. |
180 | 1 | Adrian Georgescu | |
181 | 1 | Adrian Georgescu | To see how this example can be converted to actually wait for the response without creating an observer, see the example for GreenRegistration at [wiki:SipSynchronousAPI#sipsimple.green.core.GreenRegistration SynchronousAPI]. |
182 | 43 | Ruud Klaver | |
183 | 43 | Ruud Klaver | > NOTE: GreenRegistration is outdated and should probably not be used anymore. |
184 | 43 | Ruud Klaver | |
185 | 43 | Ruud Klaver | Another convention that is worth mentioning at this point is that the SIP core will never perform DNS lookups. |
186 | 43 | Ruud Klaver | 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 {{{Route}}} helper object, indicating the destination IP address the resulting SIP request should be sent to. |
187 | 32 | Ruud Klaver | |
188 | 1 | Adrian Georgescu | == Components == |
189 | 1 | Adrian Georgescu | |
190 | 1 | Adrian Georgescu | === Engine === |
191 | 1 | Adrian Georgescu | |
192 | 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. |
193 | 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. |
194 | 1 | Adrian Georgescu | |
195 | 1 | Adrian Georgescu | ==== attributes ==== |
196 | 1 | Adrian Georgescu | |
197 | 1 | Adrian Georgescu | '''default_start_options''' (class attribute):: |
198 | 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. |
199 | 1 | Adrian Georgescu | Consult this method for documentation of the contents. |
200 | 32 | Ruud Klaver | '''is_running''':: |
201 | 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. |
202 | 1 | Adrian Georgescu | |
203 | 1 | Adrian Georgescu | ==== methods ==== |
204 | 1 | Adrian Georgescu | |
205 | 1 | Adrian Georgescu | '''!__init!__'''(''self''):: |
206 | 1 | 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. |
207 | 1 | Adrian Georgescu | '''start'''(''self'', '''**kwargs'''):: |
208 | 1 | Adrian Georgescu | Initialize all PJSIP libraries based on the keyword parameters provited and start the PJSIP worker thread. |
209 | 1 | Adrian Georgescu | If this fails an appropriate exception is raised. |
210 | 1 | Adrian Georgescu | After the {{{Engine}}} has been started successfully, it can never be started again after being stopped. |
211 | 1 | Adrian Georgescu | The keyword arguments will be discussed here. |
212 | 1 | Adrian Georgescu | Many of these values are also readable as (proxied) attributes on the Engine once the {{{start()}}} method has been called. |
213 | 1 | Adrian Georgescu | Many of them can also be set at runtime, either by modifying the attribute or by calling a particular method. |
214 | 1 | Adrian Georgescu | This will also be documented for each argument in the following list of options. |
215 | 1 | Adrian Georgescu | [[BR]]''auto_sound'':[[BR]] |
216 | 1 | Adrian Georgescu | A boolean indicating if PJSIP should automatically select and enable a soundcard to use for for recording and playing back sound. |
217 | 39 | Ruud Klaver | If this is set to {{{False}}} the Dummy sound device is selected. |
218 | 39 | Ruud Klaver | To be able to hear and contribute audio, the application will have to select a sound device manually through the {{{set_sound_devices}}} method. |
219 | 1 | Adrian Georgescu | This option is not accessible as an attribute on the object, as it is transitory. |
220 | 1 | Adrian Georgescu | [[BR]]''local_ip'': (Default: {{{None}}})[[BR]] |
221 | 1 | Adrian Georgescu | IP address of a local interface to bind to. |
222 | 44 | Ruud Klaver | If this is {{{None}}} or {{{0.0.0.0}}} on start, the {{{Engine}}} will listen on all network interfaces. |
223 | 44 | Ruud Klaver | As an attribute, this value is read-only and cannot be changed at runtime. |
224 | 1 | Adrian Georgescu | [[BR]]''local_udp_port'': (Default: {{{0}}})[[BR]] |
225 | 1 | Adrian Georgescu | The local UDP port to listen on for UDP datagrams. |
226 | 1 | Adrian Georgescu | If this is 0, a random port will be chosen. |
227 | 1 | Adrian Georgescu | If it is {{{None}}}, the UDP transport is disabled, both for incoming and outgoing traffic. |
228 | 1 | Adrian Georgescu | As an attribute, this value is read-only, but it can be changed at runtime using the {{{set_local_udp_port()}}} method. |
229 | 1 | Adrian Georgescu | [[BR]]''local_tcp_port'': (Default: {{{0}}})[[BR]] |
230 | 1 | Adrian Georgescu | The local TCP port to listen on for new TCP connections. |
231 | 1 | Adrian Georgescu | If this is 0, a random port will be chosen. |
232 | 1 | Adrian Georgescu | If it is {{{None}}}, the TCP transport is disabled, both for incoming and outgoing traffic. |
233 | 1 | Adrian Georgescu | As an attribute, this value is read-only, but it can be changed at runtime using the {{{set_local_tcp_port()}}} method. |
234 | 1 | Adrian Georgescu | [[BR]]''local_tls_port'': (Default: {{{0}}})[[BR]] |
235 | 1 | Adrian Georgescu | The local TCP port to listen on for new TLS over TCP connections. |
236 | 28 | Adrian Georgescu | If this is 0, a random port will be chosen. |
237 | 1 | Adrian Georgescu | If it is {{{None}}}, the TLS transport is disabled, both for incoming and outgoing traffic. |
238 | 35 | 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_protocol'': (Default: "TLSv1")[[BR]] |
240 | 32 | Ruud Klaver | This string describes the (minimum) TLS protocol that should be used. |
241 | 32 | Ruud Klaver | Its values should be either {{{None}}}, "SSLv2", "SSLv23", "SSLv3" or "TLSv1". |
242 | 32 | Ruud Klaver | If {{{None}}} is specified, the PJSIP default will be used, which is currently "TLSv1". |
243 | 1 | Adrian Georgescu | [[BR]]''tls_verify_server'': (Default: {{{False}}})[[BR]] |
244 | 28 | Adrian Georgescu | This boolean indicates whether PJSIP should verify the certificate of the server against the local CA list when making an outgoing TLS connection. |
245 | 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. |
246 | 1 | Adrian Georgescu | [[BR]]''tls_ca_file'': (Default: {{{None}}})[[BR]] |
247 | 1 | Adrian Georgescu | This string indicates the location of the file containing the local list of CA certificates, to be used for TLS connections. |
248 | 32 | Ruud Klaver | If this is set to {{{None}}}, no CA certificates will be read. |
249 | 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. |
250 | 32 | Ruud Klaver | [[BR]]''tls_cert_file'': (Default: {{{None}}})[[BR]] |
251 | 32 | Ruud Klaver | This string indicates the location of a file containing the TLS certificate to be used for TLS connections. |
252 | 32 | Ruud Klaver | If this is set to {{{None}}}, no certificate file will be read. |
253 | 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. |
254 | 32 | Ruud Klaver | [[BR]]''tls_privkey_file'': (Default: {{{None}}})[[BR]] |
255 | 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. |
256 | 32 | Ruud Klaver | If this is set to {{{None}}}, no private key file will be read. |
257 | 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. |
258 | 32 | Ruud Klaver | [[BR]]''tls_timeout'': (Default: 1000)[[BR]] |
259 | 32 | Ruud Klaver | The timeout value for a TLS negotiation in milliseconds. |
260 | 32 | Ruud Klaver | Note that this value should be reasonably small, as a TLS negotiation blocks the whole PJSIP polling thread. |
261 | 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. |
262 | 1 | Adrian Georgescu | [[BR]]''ec_tail_length'': (Default: {{{50}}})[[BR]] |
263 | 1 | Adrian Georgescu | Echo cancellation tail length in milliseconds. |
264 | 1 | Adrian Georgescu | A longer value should provide better echo cancellation but incurs more processing cost. |
265 | 1 | Adrian Georgescu | Setting this to 0 will disable echo cancellation. |
266 | 20 | Ruud Klaver | As an attribute, this value is read-only, but it can be set as an argument to the {{{set_sound_devices}}} method. |
267 | 1 | Adrian Georgescu | [[BR]]''user_agent'': (Default: {{{"ag-projects/sipclient-%version-pjsip-%pjsip-version"}}})[[BR]] |
268 | 1 | Adrian Georgescu | This value indicates what should be set in the {{{User-Agent}}} header, which is included in each request or response sent. |
269 | 1 | Adrian Georgescu | It can be read and set directly as an attribute at runtime. |
270 | 1 | Adrian Georgescu | [[BR]]''log_level'': (Default: 5)[[BR]] |
271 | 29 | Luci Stanescu | This integer dictates the maximum log level that may be reported to the application by PJSIP through the {{{SIPEngineLog}}} notification. |
272 | 1 | Adrian Georgescu | By default the maximum amount of logging information is reported. |
273 | 1 | Adrian Georgescu | This value can be read and set directly as an attribute at runtime. |
274 | 1 | Adrian Georgescu | [[BR]]''trace_sip'': (Default: {{{False}}})[[BR]] |
275 | 29 | Luci Stanescu | This boolean indicates if the SIP core should send the application SIP messages as seen on the wire through the {{{SIPEngineSIPTrace}}} notification. |
276 | 1 | Adrian Georgescu | It can be read and set directly as an attribute at runtime. |
277 | 1 | Adrian Georgescu | [[BR]]''sample_rate'': (Default: {{{32}}})[[BR]] |
278 | 1 | Adrian Georgescu | The sample rate in kHz at which the sound card should operate. |
279 | 1 | Adrian Georgescu | Higher values allow some codecs (such as speex) to achieve better quality but will incur higher processing cost, particularly in combination with echo cancellation. |
280 | 1 | Adrian Georgescu | This parameter should be either 8, 16 or 32. |
281 | 1 | Adrian Georgescu | The corresponding attribute of this value is read-only. |
282 | 1 | Adrian Georgescu | [[BR]]''playback_dtmf'': (Default: {{{True}}})[[BR]] |
283 | 1 | Adrian Georgescu | If this boolean is set to {{{True}}}, both incoming and outgoing DTMF signals have their corresponding audio tones played back on the sound card. |
284 | 1 | Adrian Georgescu | This value can be read and set directly as an attribute at runtime. |
285 | 1 | Adrian Georgescu | [[BR]]''rtp_port_range'': (Default: (40000, 40100))[[BR]] |
286 | 1 | Adrian Georgescu | This tuple of two ints indicates the range to select UDP ports from when creating a new {{{RTPTransport}}} object, which is used to transport media. |
287 | 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. |
288 | 40 | Ruud Klaver | [[BR]]''codecs'': (Default: {{{["speex", "G722", "PCMU", "PCMA", "iLBC", "GSM"]}}})[[BR]] |
289 | 1 | Adrian Georgescu | This list specifies the codecs to use for audio sessions and their preferred order. |
290 | 1 | Adrian Georgescu | It can be read and set directly as an attribute at runtime. |
291 | 40 | Ruud Klaver | Note that this global option can be overridden by an argument passed to {{{AudioTransport.__init__()}}}. |
292 | 40 | Ruud Klaver | The strings in this list is case insensitive. |
293 | 1 | Adrian Georgescu | [[BR]]''events'': (Default: <some sensible events>)[[BR]] |
294 | 1 | Adrian Georgescu | PJSIP needs a mapping between SIP SIMPLE event packages and content types. |
295 | 1 | Adrian Georgescu | This dictionary provides some default packages and their event types. |
296 | 1 | Adrian Georgescu | As an attribute, this value is read-only, but it can be changed at runtime using the {{{set_local_tls_port()}}} method. |
297 | 32 | Ruud Klaver | '''start_cfg'''(''self'', '''enable_sound'''={{{True}}}, '''**kwargs'''):: |
298 | 36 | Adrian Georgescu | This provides a [wiki:SipConfigurationAPI Configuration API] aware start method. |
299 | 32 | Ruud Klaver | It will retrieve all the arguments that can be passed to {{{start()}}} from the configuration framework, unless they are overridden by the keyword arguments to this method. |
300 | 32 | Ruud Klaver | Any argument that can be passed to {{{start()}}} may be specified, except for {{{auto_sound}}}. |
301 | 35 | Ruud Klaver | [[BR]]''enable_sound'':[[BR]] |
302 | 1 | Adrian Georgescu | If this is set to {{{True}}}, the sound devices set up in the configuration framework will be started. |
303 | 39 | Ruud Klaver | If it is {{{False}}}, the Dummy sound device will be used. |
304 | 1 | Adrian Georgescu | '''stop'''(''self''):: |
305 | 1 | Adrian Georgescu | Stop the PJSIP worker thread and unload all PJSIP libraries. |
306 | 1 | 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}}}. |
307 | 1 | Adrian Georgescu | Also note that, once stopped the {{{Engine}}} cannot be started again. |
308 | 1 | Adrian Georgescu | This method is automatically called when the Python interpreter exits. |
309 | 1 | Adrian Georgescu | |
310 | 1 | Adrian Georgescu | ==== proxied attributes ==== |
311 | 1 | Adrian Georgescu | |
312 | 1 | Adrian Georgescu | Besides all the proxied attributes described for the {{{__init__}}} method above, two other attributes are provided once the {{{Engine}}} has been started. |
313 | 1 | Adrian Georgescu | |
314 | 1 | Adrian Georgescu | '''playback_devices''':: |
315 | 20 | Ruud Klaver | This read-only attribute is a list of string, representing all audio playback devices on the system that can be used. |
316 | 20 | Ruud Klaver | These device names can be passed as the {{{playback_device}}} argument of the {{{set_sound_devices()}}} method. |
317 | 1 | Adrian Georgescu | '''recording_devices''':: |
318 | 1 | Adrian Georgescu | This read-only attribute is a list of string, representing all audio recording devices on the system that can be used. |
319 | 1 | Adrian Georgescu | These device names can be passed as the {{{recording_device}}} argument of the {{{set_sound_devices()}}} method. |
320 | 44 | Ruud Klaver | '''current_playback_device''':: |
321 | 44 | Ruud Klaver | The name of the audio playback device currently in use. |
322 | 44 | Ruud Klaver | '''current_recording_device''':: |
323 | 44 | Ruud Klaver | The name of the audio recording device currently in use. |
324 | 40 | Ruud Klaver | '''available_codecs''':: |
325 | 40 | Ruud Klaver | A read-only list of codecs available in the core, regardless of the codecs configured through the {{{codecs}}} attribute. |
326 | 1 | Adrian Georgescu | |
327 | 1 | Adrian Georgescu | ==== proxied methods ==== |
328 | 1 | Adrian Georgescu | |
329 | 1 | Adrian Georgescu | '''add_event'''(''self'', '''event''', '''accept_types'''):: |
330 | 1 | Adrian Georgescu | Couple a certain event package to a list of content types. |
331 | 1 | Adrian Georgescu | Once added it cannot be removed or modified. |
332 | 20 | Ruud Klaver | '''set_sound_devices'''(''self'', '''playback_device'''={{{None}}}, '''recording_device'''={{{None}}}, '''tail_length'''={{{None}}}):: |
333 | 1 | Adrian Georgescu | Set and open the playback and recording device, using the specified echo cancellation tail length in milliseconds. |
334 | 1 | Adrian Georgescu | If no echo cancellation value is specified, either the value set while calling the {{{start()}}} method will be used or the default value will be used (see the documentation of this method). |
335 | 1 | Adrian Georgescu | A {{{tail_length}}} of 0 disables echo cancellation. |
336 | 1 | Adrian Georgescu | The device attributes need to be strings and should be obtained from the {{{playback_devices}}} and {{{recording_devices}}} attributes respectively. |
337 | 1 | Adrian Georgescu | Passing either of these as {{{None}}} means that PJSIP should select a sound device automatically. |
338 | 1 | Adrian Georgescu | If sound devices were already opened these will be closed first. |
339 | 1 | Adrian Georgescu | '''connect_audio_transport'''(''self'', '''transport'''):: |
340 | 1 | Adrian Georgescu | Connect a started audio transport, in the form of a {{{AudioTransport}}} object, to the recording and playback audio devices and other connected audio transports. |
341 | 1 | Adrian Georgescu | This means that when more than one audio stream is connected they will form a conference. |
342 | 29 | Luci Stanescu | '''disconnect_audio_transport'''(''self'', '''transport'''):: |
343 | 1 | Adrian Georgescu | Disconnect a previously connected audio transport, in the form of a {{{AudioTransport}}} object. |
344 | 1 | Adrian Georgescu | Stopped audio streams are disconnected automatically. |
345 | 38 | Ruud Klaver | '''detect_nat_type'''(''self'', '''stun_server_address''', '''stun_server_port'''=3478, '''user_data'''=None):: |
346 | 1 | Adrian Georgescu | Will start a series of STUN requests which detect the type of NAT this host is behind. |
347 | 1 | 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. |
348 | 38 | Ruud Klaver | 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. |
349 | 1 | Adrian Georgescu | '''set_local_udp_port'''(''self'', '''value'''):: |
350 | 28 | Adrian Georgescu | Update the {{{local_udp_port}}} attribute to the newly specified value. |
351 | 28 | Adrian Georgescu | '''set_local_tcp_port'''(''self'', '''value'''):: |
352 | 28 | Adrian Georgescu | Update the {{{local_tcp_port}}} attribute to the newly specified value. |
353 | 32 | 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):: |
354 | 32 | 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}}}. |
355 | 1 | Adrian Georgescu | The semantics of the arguments are the same as on the {{{start()}}} method. |
356 | 1 | Adrian Georgescu | '''parse_sip_uri(''self'', '''uri_string'''):: |
357 | 1 | Adrian Georgescu | Will parse the provided SIP URI string using the PJSIP parsing capabilities and return a {{{SIPURI}}} object, or raise an exception if there was an error parsing the URI. |
358 | 44 | Ruud Klaver | '''play_tones(''self'', '''tones'''):: |
359 | 44 | Ruud Klaver | Play a sequence of single or dual frequency tones over the audio device. |
360 | 44 | Ruud Klaver | The tones 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. |
361 | 44 | Ruud Klaver | If {{{freq2}}} is 0, this indicates that only {{{freq1}}} should be used for the tone. |
362 | 44 | Ruud Klaver | If {{{freq1}}} is 0, this indicates a pause when no tone should be played for the set duration. |
363 | 1 | Adrian Georgescu | |
364 | 1 | Adrian Georgescu | ==== notifications ==== |
365 | 1 | Adrian Georgescu | |
366 | 16 | Ruud Klaver | Notifications sent by the {{{Engine}}} are notifications that are related to the {{{Engine}}} itself or unrelated to any SIP primitive object. |
367 | 1 | Adrian Georgescu | They are described here including the data attributes that is included with them. |
368 | 1 | Adrian Georgescu | |
369 | 29 | Luci Stanescu | '''SIPEngineWillStart''':: |
370 | 16 | Ruud Klaver | This notification is sent when the {{{Engine}}} is about to start. |
371 | 16 | Ruud Klaver | [[BR]]''timestamp'':[[BR]] |
372 | 16 | Ruud Klaver | A {{{datetime.datetime}}} object indicating when the notification was sent. |
373 | 29 | Luci Stanescu | '''SIPEngineDidStart''':: |
374 | 16 | Ruud Klaver | This notification is sent when the {{{Engine}}} is has just been started. |
375 | 16 | Ruud Klaver | [[BR]]''timestamp'':[[BR]] |
376 | 16 | Ruud Klaver | A {{{datetime.datetime}}} object indicating when the notification was sent. |
377 | 29 | Luci Stanescu | '''SIPEngineDidFail''':: |
378 | 16 | Ruud Klaver | This notification is sent whenever the {{{Engine}}} has failed fatally and either cannot start or is about to stop. |
379 | 16 | Ruud Klaver | It is not recommended to call any methods on the {{{Engine}}} at this point. |
380 | 16 | Ruud Klaver | [[BR]]''timestamp'':[[BR]] |
381 | 16 | Ruud Klaver | A {{{datetime.datetime}}} object indicating when the notification was sent. |
382 | 29 | Luci Stanescu | '''SIPEngineWillEnd''':: |
383 | 16 | Ruud Klaver | This notification is sent when the {{{Engine}}} is about to stop because the application called the {{{stop()}}} method. |
384 | 16 | Ruud Klaver | Methods on the {{{Engine}}} can be called at this point, but anything that has a delayed result will probably not return any notification. |
385 | 16 | Ruud Klaver | [[BR]]''timestamp'':[[BR]] |
386 | 16 | Ruud Klaver | A {{{datetime.datetime}}} object indicating when the notification was sent. |
387 | 29 | Luci Stanescu | '''SIPEngineDidEnd''':: |
388 | 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. |
389 | 16 | Ruud Klaver | [[BR]]''timestamp'':[[BR]] |
390 | 16 | Ruud Klaver | A {{{datetime.datetime}}} object indicating when the notification was sent. |
391 | 29 | Luci Stanescu | '''SIPEngineLog''':: |
392 | 1 | Adrian Georgescu | This notification is a wrapper for PJSIP logging messages. |
393 | 1 | Adrian Georgescu | It can be used by the application to output PJSIP logging to somewhere meaningful, possibly doing filtering based on log level. |
394 | 1 | Adrian Georgescu | [[BR]]''timestamp'':[[BR]] |
395 | 1 | Adrian Georgescu | A {{{datetime.datetime}}} object representing the time when the log message was output by PJSIP. |
396 | 1 | Adrian Georgescu | [[BR]]''sender'':[[BR]] |
397 | 1 | Adrian Georgescu | The PJSIP module that originated this log message. |
398 | 1 | Adrian Georgescu | [[BR]]''level'':[[BR]] |
399 | 1 | Adrian Georgescu | The logging level of the message as an integer. |
400 | 1 | Adrian Georgescu | Currently this is 1 through 5, 1 being the most critical. |
401 | 1 | Adrian Georgescu | [[BR]]''message'':[[BR]] |
402 | 1 | Adrian Georgescu | The actual log message. |
403 | 29 | Luci Stanescu | '''SIPEngineSIPTrace''':: |
404 | 1 | Adrian Georgescu | Will be sent only when the {{{do_siptrace}}} attribute of the {{{Engine}}} instance is set to {{{True}}}. |
405 | 1 | Adrian Georgescu | The notification data attributes will contain the SIP messages as they are sent and received on the wire. |
406 | 1 | Adrian Georgescu | [[BR]]''timestamp'':[[BR]] |
407 | 1 | Adrian Georgescu | A {{{datetime.datetime}}} object indicating when the notification was sent. |
408 | 1 | Adrian Georgescu | [[BR]]''received'':[[BR]] |
409 | 1 | Adrian Georgescu | A boolean indicating if this message was sent from or received by PJSIP (i.e. the direction of the message). |
410 | 1 | Adrian Georgescu | [[BR]]''source_ip'':[[BR]] |
411 | 1 | Adrian Georgescu | The source IP address as a string. |
412 | 1 | Adrian Georgescu | [[BR]]''source_port'':[[BR]] |
413 | 29 | Luci Stanescu | The source port of the message as an integer. |
414 | 1 | Adrian Georgescu | [[BR]]''destination_ip'':[[BR]] |
415 | 1 | Adrian Georgescu | The destination IP address as a string. |
416 | 1 | Adrian Georgescu | [[BR]]''source_port'':[[BR]] |
417 | 1 | Adrian Georgescu | The source port of the message as an integer. |
418 | 1 | Adrian Georgescu | [[BR]]''data'':[[BR]] |
419 | 1 | Adrian Georgescu | The contents of the message as a string. |
420 | 1 | Adrian Georgescu | |
421 | 1 | Adrian Georgescu | > For received message the destination_ip and for sent messages the source_ip may not be reliable. |
422 | 1 | Adrian Georgescu | |
423 | 29 | Luci Stanescu | '''SIPEngineDetectedNATType''':: |
424 | 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. |
425 | 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. |
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]]''succeeded'':[[BR]] |
429 | 1 | Adrian Georgescu | A boolean indicating if the NAT detection succeeded. |
430 | 38 | Ruud Klaver | [[BR]]''user_data'':[[BR]] |
431 | 38 | Ruud Klaver | The {{{user_data}}} argument passed while calling the {{{detect_nat_type()}}} method. |
432 | 38 | Ruud Klaver | This can be any object and could be used for matching requests to responses. |
433 | 1 | Adrian Georgescu | [[BR]]''nat_type'':[[BR]] |
434 | 1 | Adrian Georgescu | A string describing the type of NAT found. |
435 | 1 | Adrian Georgescu | This value is only present if NAT detection succeeded. |
436 | 1 | Adrian Georgescu | [[BR]]''error'':[[BR]] |
437 | 1 | Adrian Georgescu | A string indicating the error that occurred while attempting to detect the type of NAT. |
438 | 1 | Adrian Georgescu | This value only present if NAT detection did not succeed. |
439 | 1 | Adrian Georgescu | '''SIPEngineGotException''':: |
440 | 1 | Adrian Georgescu | This notification is sent whenever there is an unexpected exception within the PJSIP working thread. |
441 | 1 | Adrian Georgescu | The application should show the traceback to the user somehow. |
442 | 1 | Adrian Georgescu | An exception need not be fatal, but if it is it will be followed by a '''SIPEngineDidFail''' notification. |
443 | 1 | Adrian Georgescu | [[BR]]''timestamp'':[[BR]] |
444 | 1 | Adrian Georgescu | A {{{datetime.datetime}}} object indicating when the notification was sent. |
445 | 1 | Adrian Georgescu | [[BR]]''traceback'':[[BR]] |
446 | 1 | Adrian Georgescu | A string containing the traceback of the exception. |
447 | 1 | Adrian Georgescu | In general this should be printed on the console. |
448 | 1 | Adrian Georgescu | |
449 | 1 | Adrian Georgescu | === SIPURI === |
450 | 1 | Adrian Georgescu | |
451 | 1 | Adrian Georgescu | This is a helper object for representing a SIP URI. |
452 | 1 | Adrian Georgescu | This object needs to be used whenever a SIP URI should be specified to the SIP core. |
453 | 1 | Adrian Georgescu | It supports comparison to other {{{SIPURI}}} objects using the == and != expressions. |
454 | 1 | Adrian Georgescu | As all of its attributes are set by the {{{__init__}}} method, the individual attributes will not be documented here. |
455 | 1 | Adrian Georgescu | |
456 | 1 | Adrian Georgescu | ==== methods ==== |
457 | 1 | Adrian Georgescu | |
458 | 23 | Ruud Klaver | '''!__init!__'''(''self'', '''host''', '''user'''={{{None}}}, '''port'''={{{None}}}, '''display'''={{{None}}}, '''secure'''={{{False}}}, '''parameters'''={{{None}}}, '''headers'''={{{None}}}):: |
459 | 1 | Adrian Georgescu | Creates the SIPURI object with the specified parameters as attributes. |
460 | 1 | Adrian Georgescu | Each of these attributes can be accessed and changed on the object once instanced. |
461 | 1 | Adrian Georgescu | {{{host}}} is the only mandatory attribute. |
462 | 1 | Adrian Georgescu | [[BR]]''host'':[[BR]] |
463 | 1 | Adrian Georgescu | The host part of the SIP URI as a string. |
464 | 1 | Adrian Georgescu | [[BR]]''user'':[[BR]] |
465 | 1 | Adrian Georgescu | The username part of the SIP URI as a string, or None if not set. |
466 | 1 | Adrian Georgescu | [[BR]]''port'':[[BR]] |
467 | 1 | Adrian Georgescu | The port part of the SIP URI as an int, or None or 0 if not set. |
468 | 1 | Adrian Georgescu | [[BR]]''display'':[[BR]] |
469 | 1 | Adrian Georgescu | The optional display name of the SIP URI as a string, or None if not set. |
470 | 1 | Adrian Georgescu | [[BR]]''secure'':[[BR]] |
471 | 1 | Adrian Georgescu | A boolean indicating whether this is a SIP or SIPS URI, the latter being indicated by a value of {{{True}}}. |
472 | 1 | Adrian Georgescu | [[BR]]''parameters'':[[BR]] |
473 | 1 | Adrian Georgescu | The URI parameters. represented by a dictionary. |
474 | 1 | Adrian Georgescu | [[BR]]''headers'':[[BR]] |
475 | 1 | Adrian Georgescu | The URI headers, represented by a dictionary. |
476 | 1 | Adrian Georgescu | '''!__str!__'''(''self''):: |
477 | 1 | Adrian Georgescu | The special Python method to represent this object as a string, the output is the properly formatted SIP URI. |
478 | 1 | Adrian Georgescu | '''copy'''(''self''):: |
479 | 1 | Adrian Georgescu | Returns a copy of the {{{SIPURI}}} object. |
480 | 1 | Adrian Georgescu | |
481 | 1 | Adrian Georgescu | === Credentials === |
482 | 1 | Adrian Georgescu | |
483 | 1 | Adrian Georgescu | This object represents authentication credentials for a particular SIP account. |
484 | 1 | Adrian Georgescu | These should be included whenever creating a SIP primitive object that originates SIP requests. |
485 | 1 | Adrian Georgescu | As with the {{{SIPURI}}} object, the attributes of this object are the same as the arguments to the {{{__init__}}} method. |
486 | 1 | Adrian Georgescu | |
487 | 1 | Adrian Georgescu | ==== methods ==== |
488 | 1 | Adrian Georgescu | |
489 | 33 | Ruud Klaver | '''!__init!__'''(''self'', '''uri''', '''password'''={{{None}}}):: |
490 | 1 | Adrian Georgescu | Creates the Credentials object with the specified parameters as attributes. |
491 | 1 | Adrian Georgescu | Each of these attributes can be accessed and changed on the object once instanced. |
492 | 1 | Adrian Georgescu | [[BR]]''uri'':[[BR]] |
493 | 1 | Adrian Georgescu | A {{{SIPURI}}} object representing the account for which these are the credentials. |
494 | 1 | Adrian Georgescu | [[BR]]''password'':[[BR]] |
495 | 1 | Adrian Georgescu | The password for this SIP account as a string. |
496 | 1 | Adrian Georgescu | If a password is not needed, for example when sending SIP messages without a proxy, this can be {{{None}}}. |
497 | 1 | Adrian Georgescu | '''copy'''(''self''):: |
498 | 1 | Adrian Georgescu | Returns a copy of the {{{Credentials}}} object. |
499 | 1 | Adrian Georgescu | |
500 | 1 | Adrian Georgescu | === Route === |
501 | 1 | Adrian Georgescu | |
502 | 22 | Ruud Klaver | This class provides a means for the application using the SIP core to set the destination address, port and transport for a particular request, i.e. the outbound proxy. |
503 | 33 | Ruud Klaver | As it is the application's responsibility to look this up and pass it as an argument for every SIP primitive class it creates. |
504 | 22 | Ruud Klaver | The contents of the {{{Route}}} object will be placed in the {{{Route}}} header of the request. |
505 | 1 | Adrian Georgescu | As with the {{{SIPURI}}} object, the attributes of this object are the same as the arguments to the {{{__init__}}} method. |
506 | 1 | Adrian Georgescu | |
507 | 1 | Adrian Georgescu | ==== methods ==== |
508 | 1 | Adrian Georgescu | |
509 | 22 | Ruud Klaver | '''!__init!__'''(''self'', '''address''', '''port'''=5060, '''transport'''={{{None}}}):: |
510 | 1 | Adrian Georgescu | Creates the Route object with the specified parameters as attributes. |
511 | 1 | Adrian Georgescu | Each of these attributes can be accessed on the object once instanced. |
512 | 22 | Ruud Klaver | [[BR]]''address'':[[BR]] |
513 | 45 | Ruud Klaver | The IPv4 address that the request in question should be sent to as a string. |
514 | 1 | Adrian Georgescu | [[BR]]''port'':[[BR]] |
515 | 22 | Ruud Klaver | The port to send the requests to, represented as an int. |
516 | 1 | Adrian Georgescu | [[BR]]''transport'':[[BR]] |
517 | 35 | Ruud Klaver | The transport to use, this can be a string of either "udp", "tcp" or "tls" (case insensitive), depending on what transports are enabled on the {{{PJSIPUA}}} object. |
518 | 1 | Adrian Georgescu | '''copy'''(''self''):: |
519 | 1 | Adrian Georgescu | Returns a copy of the {{{Route}}} object. |
520 | 22 | Ruud Klaver | |
521 | 46 | Ruud Klaver | === Request === |
522 | 46 | Ruud Klaver | |
523 | 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. |
524 | 46 | Ruud Klaver | Although this class can be used by the application to construct and send an arbitrary SIP request, most applications will use the classes provided in the {{{sipsimple.primitives}}} module, which are built on top of one or several {{{Request}}} objects and deal with instances of specific SIP methods. |
525 | 46 | Ruud Klaver | |
526 | 46 | Ruud Klaver | The lifetime of this object is linear and is described by the following diagram: |
527 | 46 | Ruud Klaver | |
528 | 46 | Ruud Klaver | [[Image(sipsimple-request-lifetime.png, nolink)]] |
529 | 46 | Ruud Klaver | |
530 | 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. |
531 | 46 | Ruud Klaver | Directly after the object is instantiated, it will be in the {{{INIT}}} state. |
532 | 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. |
533 | 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. |
534 | 46 | Ruud Klaver | Note that this may not occur at all if not provisional responses are received. |
535 | 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. |
536 | 46 | Ruud Klaver | Both of these notifications include data on the response that triggered it. |
537 | 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. |
538 | 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. |
539 | 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. |
540 | 46 | Ruud Klaver | This should usually trigger whomever is using this {{{Request}}} object to construct a new {{{Request}}} for a refreshing operation. |
541 | 46 | 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. |
542 | 46 | Ruud Klaver | |
543 | 46 | Ruud Klaver | ==== attributes ==== |
544 | 46 | Ruud Klaver | |
545 | 49 | Ruud Klaver | '''expire_warning_time''' (class attribute):: |
546 | 49 | 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. |
547 | 49 | Ruud Klaver | The default value is 30 seconds. |
548 | 47 | Ruud Klaver | '''state''':: |
549 | 47 | Ruud Klaver | Indicates the state the {{{Request}}} object is in, in the form of a string. |
550 | 47 | Ruud Klaver | Refer to the diagram above for possible states. |
551 | 47 | Ruud Klaver | This attribute is read-only. |
552 | 47 | Ruud Klaver | '''method''':: |
553 | 47 | Ruud Klaver | The method of the SIP request as a string. |
554 | 47 | Ruud Klaver | This attribute is set on instantiation and is read-only. |
555 | 47 | Ruud Klaver | '''credentials''':: |
556 | 47 | Ruud Klaver | The credentials to be used when challenged for authentication, represented by a {{{Credentials}}} object. |
557 | 47 | Ruud Klaver | This attribute is set on instantiation and is read-only. |
558 | 47 | Ruud Klaver | '''from_uri''':: |
559 | 47 | Ruud Klaver | The SIP URI to put in the {{{From}}} header of the request, in the form of a {{{SIPURI}}} object. |
560 | 47 | Ruud Klaver | This attribute is a shortcut to the {{{uri}}} attribute on the {{{credentials}}} attribute of this object and is read-only. |
561 | 47 | Ruud Klaver | '''to_uri''':: |
562 | 47 | Ruud Klaver | The SIP URI to put in the {{{To}}} header of the request, in the form of a {{{SIPURI}}} object. |
563 | 47 | Ruud Klaver | This attribute is set on instantiation and is read-only. |
564 | 47 | Ruud Klaver | '''request_uri''':: |
565 | 47 | Ruud Klaver | The SIP URI to put as request URI in the request, in the form of a {{{SIPURI}}} object. |
566 | 47 | Ruud Klaver | This attribute is set on instantiation and is read-only. |
567 | 47 | Ruud Klaver | '''route''':: |
568 | 47 | Ruud Klaver | Where to send the SIP request to, including IP, port and transport, in the form of a {{{SIPURI}}} object. |
569 | 47 | Ruud Klaver | This will also be included in the {{{Route}}} header of the request. |
570 | 47 | Ruud Klaver | This attribute is set on instantiation and is read-only. |
571 | 47 | Ruud Klaver | '''contact_uri''':: |
572 | 47 | Ruud Klaver | The SIP URI to put in the {{{Contact}}} header of the request, in the form of a {{{SIPURI}}} object. |
573 | 47 | Ruud Klaver | If this was not specified, this attribute is {{{None}}}. |
574 | 47 | Ruud Klaver | It is set on instantiation and is read-only. |
575 | 47 | Ruud Klaver | '''call_id''':: |
576 | 47 | Ruud Klaver | The {{{Call-ID}}} to be used for this transaction as a string. |
577 | 47 | Ruud Klaver | If no call id was specified on instantiation, this attribute contains the generated id. |
578 | 47 | Ruud Klaver | This attribute is set on instantiation and is read-only. |
579 | 47 | Ruud Klaver | '''cseq''':: |
580 | 47 | Ruud Klaver | The sequence number to use in the request as an int. |
581 | 47 | Ruud Klaver | If no sequence number was specified on instantiation, this attribute contains the generated sequence number. |
582 | 47 | Ruud Klaver | Note that this number may be increased by one if an authentication challenge is received and a {{{Credentials}}} object is given. |
583 | 47 | Ruud Klaver | This attribute is read-only. |
584 | 47 | Ruud Klaver | '''extra_headers''':: |
585 | 47 | Ruud Klaver | Extra headers to include in the request as a dictionary. |
586 | 47 | Ruud Klaver | This attribute is set on instantiation and is read-only. |
587 | 47 | Ruud Klaver | '''content_type''':: |
588 | 47 | Ruud Klaver | What string to put as content type in the {{{Content-Type}}} headers, if the request contains a body. |
589 | 47 | Ruud Klaver | If no body was specified, this attribute is {{{None}}} |
590 | 47 | Ruud Klaver | It is set on instantiation and is read-only. |
591 | 47 | Ruud Klaver | '''body''':: |
592 | 47 | Ruud Klaver | The body of the request as a string. |
593 | 47 | Ruud Klaver | If no body was specified, this attribute is {{{None}}} |
594 | 47 | Ruud Klaver | It is set on instantiation and is read-only. |
595 | 47 | Ruud Klaver | '''expires_in''':: |
596 | 47 | Ruud Klaver | This read-only property indicates in how many seconds from now this {{{Request}}} will expire, if it is in the {{{EXPIRING}}} state. |
597 | 47 | Ruud Klaver | If this is not the case, this property is 0. |
598 | 47 | Ruud Klaver | |
599 | 46 | Ruud Klaver | ==== methods ==== |
600 | 46 | Ruud Klaver | |
601 | 48 | Ruud Klaver | '''!__init!__'''(''self'', '''method''', '''credentials''', '''to_uri''', '''request_uri''', '''route''', '''contact_uri'''={{{None}}}, '''call_id'''={{{None}}}, '''cseq'''={{{None}}}, '''extra_headers'''={{{None}}}, '''content_type'''={{{None}}}, '''body'''={{{None}}}):: |
602 | 48 | Ruud Klaver | Creates a new {{{Request}}} object in the {{{INIT}}} state. |
603 | 48 | Ruud Klaver | The arguments to this method are documented in the attributes section. |
604 | 48 | Ruud Klaver | '''send'''(''self'', '''timeout'''={{{None}}}):: |
605 | 48 | Ruud Klaver | Compose the SIP request and send it to the destination. |
606 | 48 | Ruud Klaver | This moves the {{{Request}}} object into the {{{IN_PROGRESS}}} state. |
607 | 48 | Ruud Klaver | [[BR]]''timeout'':[[BR]] |
608 | 48 | Ruud Klaver | This can be either an int or a float, indicating in how many seconds the request should timeout with an internally generated 408 response. |
609 | 48 | Ruud Klaver | This is is {{{None}}}, the internal 408 is only triggered by the internal PJSIP transaction timeout. |
610 | 48 | Ruud Klaver | Note that, even if the timeout is specified, the PJSIP timeout is also still valid. |
611 | 48 | Ruud Klaver | '''terminate'''(''self''):: |
612 | 48 | Ruud Klaver | Terminate the transaction, whichever state it is in, sending the appropriate notifications. |
613 | 48 | Ruud Klaver | Note that calling this method while in the {{{INIT}}} state does nothing. |
614 | 48 | Ruud Klaver | |
615 | 46 | Ruud Klaver | ==== notifications ==== |
616 | 49 | Ruud Klaver | |
617 | 49 | Ruud Klaver | '''SIPRequestGotProvisionalResponse''':: |
618 | 49 | Ruud Klaver | This notification will be sent on every provisional response received in reply to the sent request. |
619 | 49 | Ruud Klaver | [[BR]]''timestamp'':[[BR]] |
620 | 49 | Ruud Klaver | A {{{datetime.datetime}}} object indicating when the notification was sent. |
621 | 49 | Ruud Klaver | [[BR]]''code'':[[BR]] |
622 | 49 | Ruud Klaver | The SIP response code of the received provisional response as an int, which will be in the 1xx range. |
623 | 49 | Ruud Klaver | [[BR]]''reason'':[[BR]] |
624 | 49 | Ruud Klaver | The reason text string included with the SIP response code. |
625 | 49 | Ruud Klaver | [[BR]]''headers'':[[BR]] |
626 | 49 | Ruud Klaver | The headers included in the provisional response as a dictionary. |
627 | 49 | Ruud Klaver | [[BR]]''body'':[[BR]] |
628 | 49 | Ruud Klaver | The body of the provisional response as a string, or {{{None}}} if there was no body. |
629 | 49 | Ruud Klaver | '''SIPRequestDidSucceed''':: |
630 | 49 | Ruud Klaver | This notification will be sent when a positive final response was received in reply to the request. |
631 | 49 | Ruud Klaver | [[BR]]''timestamp'':[[BR]] |
632 | 49 | Ruud Klaver | A {{{datetime.datetime}}} object indicating when the notification was sent. |
633 | 49 | Ruud Klaver | [[BR]]''code'':[[BR]] |
634 | 49 | Ruud Klaver | The SIP response code of the received positive final response as an int, which will be in the 2xx range. |
635 | 49 | Ruud Klaver | [[BR]]''reason'':[[BR]] |
636 | 49 | Ruud Klaver | The reason text string included with the SIP response code. |
637 | 49 | Ruud Klaver | [[BR]]''headers'':[[BR]] |
638 | 49 | Ruud Klaver | The headers included in the positive final response as a dictionary. |
639 | 49 | Ruud Klaver | [[BR]]''body'':[[BR]] |
640 | 49 | Ruud Klaver | The body of the positive final response as a string, or {{{None}}} if there was no body. |
641 | 49 | Ruud Klaver | [[BR]]''expires'':[[BR]] |
642 | 49 | Ruud Klaver | Indicates in how many seconds the {{{Request}}} will expire as an int. |
643 | 49 | Ruud Klaver | If it does not expire and the {{{EXPIRING}}} state is skipped, this attribute is 0. |
644 | 49 | Ruud Klaver | '''SIPRequestDidFail''':: |
645 | 49 | Ruud Klaver | This notification will be sent when a negative final response is received in reply to the request or if an internal error occurs. |
646 | 49 | Ruud Klaver | [[BR]]''timestamp'':[[BR]] |
647 | 49 | Ruud Klaver | A {{{datetime.datetime}}} object indicating when the notification was sent. |
648 | 49 | Ruud Klaver | [[BR]]''code'':[[BR]] |
649 | 49 | Ruud Klaver | The SIP response code of the received negative final response as an int. |
650 | 49 | Ruud Klaver | This could also be a response code generated by PJSIP internally, or 0 when an internal error occurs. |
651 | 49 | Ruud Klaver | [[BR]]''reason'':[[BR]] |
652 | 49 | Ruud Klaver | The reason text string included with the SIP response code or error. |
653 | 49 | Ruud Klaver | [[BR]]''headers'': (only if a negative final response was received)[[BR]] |
654 | 49 | Ruud Klaver | The headers included in the negative final response as a dictionary, if this is what triggered the notification. |
655 | 49 | Ruud Klaver | [[BR]]''body'': (only if a negative final response was received)[[BR]] |
656 | 49 | Ruud Klaver | The body of the negative final response as a string, or {{{None}}} if there was no body. |
657 | 49 | Ruud Klaver | This attribute is absent if no response was received. |
658 | 49 | Ruud Klaver | '''SIPRequestWillExpire''':: |
659 | 49 | Ruud Klaver | This notification will be sent when a {{{Request}}} in the {{{EXPIRING}}} state will expire soon. |
660 | 49 | Ruud Klaver | [[BR]]''timestamp'':[[BR]] |
661 | 49 | Ruud Klaver | A {{{datetime.datetime}}} object indicating when the notification was sent. |
662 | 49 | Ruud Klaver | [[BR]]''expires'':[[BR]] |
663 | 49 | Ruud Klaver | An int indicating in how many seconds from now the {{{Request}}} will actually expire. |
664 | 49 | Ruud Klaver | '''SIPRequestDidEnd''':: |
665 | 49 | Ruud Klaver | This notification will be sent when a {{{Request}}} object enters the {{{TERMINATED}}} state and can no longer be used. |
666 | 49 | Ruud Klaver | [[BR]]''timestamp'':[[BR]] |
667 | 49 | Ruud Klaver | A {{{datetime.datetime}}} object indicating when the notification was sent. |
668 | 46 | Ruud Klaver | |
669 | 1 | Adrian Georgescu | === Publication === |
670 | 1 | Adrian Georgescu | |
671 | 1 | Adrian Georgescu | Publication of SIP events is an Internet standard published at [http://tools.ietf.org/html/rfc3903 RFC 3903]. |
672 | 1 | Adrian Georgescu | 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. |
673 | 1 | Adrian Georgescu | |
674 | 1 | Adrian Georgescu | A {{{Publication}}} object represents publishing some content for a particular SIP account and a particular event type at the SIP presence agent through a {{{PUBLISH}}} request. |
675 | 1 | Adrian Georgescu | The state machine of this object is very similar to that of the {{{Registration}}} object, as can be seen in the following diagram: |
676 | 1 | Adrian Georgescu | |
677 | 2 | Adrian Georgescu | [[Image(sipsimple-publication-state-machine.png, nolink)]] |
678 | 1 | Adrian Georgescu | |
679 | 1 | Adrian Georgescu | State changes are triggered by the following events: |
680 | 1 | Adrian Georgescu | 1. The initial state. |
681 | 1 | Adrian Georgescu | 2. User requests in the form of the {{{publish()}}} and {{{unpublish()}}} methods. |
682 | 1 | Adrian Georgescu | 3. A final response for a {{{PUBLISH}}} is received from the network. |
683 | 1 | Adrian Georgescu | 4. The refresh timer expires. |
684 | 1 | Adrian Georgescu | Like the {{{Registration}}} state machine, the {{{Publication}}} state machine is queued. |
685 | 1 | Adrian Georgescu | This means that the application may call either the {{{publish()}}} or {{{unpublish()}}} method at any point in the state machine. |
686 | 1 | Adrian Georgescu | The object will perform the requested action when ready. |
687 | 1 | Adrian Georgescu | When some content is published and the application wants to update the contents, it can directly call the {{{publish()}}} method with the new content. |
688 | 1 | Adrian Georgescu | |
689 | 1 | Adrian Georgescu | > The implementation of this object needs to be revised. |
690 | 1 | Adrian Georgescu | |
691 | 1 | Adrian Georgescu | > If this object is re-used after unpublication, the etag value is not reset by PJSIP. |
692 | 1 | Adrian Georgescu | > This needs to be fixed. |
693 | 1 | Adrian Georgescu | |
694 | 1 | Adrian Georgescu | ==== attributes ==== |
695 | 1 | Adrian Georgescu | |
696 | 1 | Adrian Georgescu | '''state''':: |
697 | 1 | Adrian Georgescu | Indicates which state the internal state machine is in. |
698 | 1 | Adrian Georgescu | This is one of {{{unpublished}}}, {{{publishing}}}, {{{published}}}, {{{unpublishing}}}. |
699 | 1 | Adrian Georgescu | '''credentials''':: |
700 | 1 | Adrian Georgescu | The SIP credentials needed to authenticate at the SIP proxy in the form of a {{{Credentials}}} object, including the SIP account for which we want to register. |
701 | 1 | Adrian Georgescu | This attribute is set on object instantiation and is read-only. |
702 | 1 | Adrian Georgescu | '''route''':: |
703 | 1 | Adrian Georgescu | The outbound proxy to use in the form of a {{{Route}}} object. |
704 | 1 | Adrian Georgescu | This attribute is set on object instantiation and is read-only. |
705 | 1 | Adrian Georgescu | '''extra_headers''':: |
706 | 1 | Adrian Georgescu | A dictionary of extra headers that should be added to any outgoing {{{PUBLISH}}} request. |
707 | 1 | Adrian Georgescu | This attribute is set on object instantiation and is read-only. |
708 | 1 | Adrian Georgescu | '''expires''':: |
709 | 1 | Adrian Georgescu | The amount of seconds the contents of the {{{PUBLISH}}} are valid, i.e. the value that should be put in the {{{Expires}}} header. |
710 | 1 | Adrian Georgescu | This attribute is set on object instantiation and can be modified at runtime. |
711 | 1 | Adrian Georgescu | A new value will be used during the next refreshing {{{PUBLISH}}}. |
712 | 1 | Adrian Georgescu | |
713 | 1 | Adrian Georgescu | ==== methods ==== |
714 | 1 | Adrian Georgescu | |
715 | 23 | Ruud Klaver | '''!__init!__'''(''self'', '''credentials''', '''event''', '''route''', '''expires'''=300, '''extra_headers'''={{{None}}}):: |
716 | 1 | Adrian Georgescu | Creates a new {{{Publication}}} object. |
717 | 1 | Adrian Georgescu | [[BR]]''credentials'':[[BR]] |
718 | 1 | Adrian Georgescu | The SIP credentials needed to authenticate at the SIP proxy in the form of a {{{Credentials}}} object, including the SIP account that we want to publish the content for. |
719 | 1 | Adrian Georgescu | [[BR]]''event'':[[BR]] |
720 | 1 | Adrian Georgescu | The event package for which we want to publish content. |
721 | 1 | Adrian Georgescu | [[BR]]''route'':[[BR]] |
722 | 1 | Adrian Georgescu | The outbound proxy to use in the form of a {{{Route}}} object |
723 | 1 | Adrian Georgescu | [[BR]]''expires'':[[BR]] |
724 | 1 | Adrian Georgescu | The amount of seconds the contents of the {{{PUBLISH}}} are valid, i.e. the value that should be put in the {{{Expires}}} header. |
725 | 1 | Adrian Georgescu | [[BR]]''extra_headers'':[[BR]] |
726 | 1 | Adrian Georgescu | A dictionary of extra headers that should be added to any outgoing {{{PUBLISH}}} request. |
727 | 1 | Adrian Georgescu | '''publish'''(''self'', '''content_type''', '''content_subtype''', '''body'''):: |
728 | 1 | Adrian Georgescu | Whenever the object is ready to send a {{{PUBLISH}}} for the specified SIP account it will do so, moving the state machine into the {{{publishing}}} state. |
729 | 1 | Adrian Georgescu | If the {{{PUBLISH}}} succeeds the state machines moves into the {{{published}}} state and the object will automatically refresh the publication before it expires (again moving into the {{{publishing}}} state). |
730 | 1 | Adrian Georgescu | If it is unsuccessful the state machine reverts to the {{{unregistered}}} state. |
731 | 1 | Adrian Georgescu | [[BR]]''content_type'':[[BR]] |
732 | 1 | Adrian Georgescu | The first part of the {{{Content-Type:}}} header of the {{{PUBLISH}}} request that is to be sent (before the {{{/}}}), indicating the type of content of the body. |
733 | 1 | Adrian Georgescu | [[BR]]''content_subtype'':[[BR]] |
734 | 1 | Adrian Georgescu | The second part of the {{{Content-Type:}}} header of the {{{PUBLISH}}} request that is to be sent (after the {{{/}}}), indicating the type of content of the body. |
735 | 1 | Adrian Georgescu | '''unpublish'''(''self''):: |
736 | 1 | Adrian Georgescu | If the object has some content published, it will send a {{{PUBLISH}}} with an {{{Expires}}} header of 0, effectively unpublishing the content for the specified SIP account. |
737 | 1 | Adrian Georgescu | |
738 | 1 | Adrian Georgescu | ==== notifications ==== |
739 | 1 | Adrian Georgescu | |
740 | 29 | Luci Stanescu | '''SIPPublicationChangedState''':: |
741 | 1 | Adrian Georgescu | This notification will be sent every time the internal state machine of a {{{Publication}}} object changes state. |
742 | 1 | Adrian Georgescu | [[BR]]''timestamp'':[[BR]] |
743 | 1 | Adrian Georgescu | A {{{datetime.datetime}}} object indicating when the notification was sent. |
744 | 1 | Adrian Georgescu | [[BR]]''state'':[[BR]] |
745 | 1 | Adrian Georgescu | The new state the state machine moved into. |
746 | 1 | Adrian Georgescu | [[BR]]''code'': (only on SIP response triggered state change)[[BR]] |
747 | 1 | Adrian Georgescu | The status code of the response that caused the state change. |
748 | 1 | Adrian Georgescu | This may be internally generated by PJSIP, e.g. on timeout. |
749 | 1 | Adrian Georgescu | [[BR]]''reason'': (only on SIP response triggered state change)[[BR]] |
750 | 1 | Adrian Georgescu | The status text of the response that caused the state change. |
751 | 1 | Adrian Georgescu | This may be internally generated by PJSIP, e.g. on timeout. |
752 | 1 | Adrian Georgescu | |
753 | 1 | Adrian Georgescu | > On init the event package is not checked with known event packages, this is only used for {{{Subscription}}} objects. |
754 | 1 | Adrian Georgescu | > This could be done for the sake of consistency. |
755 | 1 | Adrian Georgescu | |
756 | 1 | Adrian Georgescu | ==== example code ==== |
757 | 1 | Adrian Georgescu | |
758 | 1 | Adrian Georgescu | This code shows how to make a {{{Publication}}} object for a particular SIP account and have it attempt to publish its presence. |
759 | 1 | Adrian Georgescu | |
760 | 1 | Adrian Georgescu | {{{ |
761 | 1 | Adrian Georgescu | accnt = SIPURI(user="username", host="domain.com") |
762 | 1 | Adrian Georgescu | creds = Credentials(accnt, "password") |
763 | 22 | Ruud Klaver | pub = Publication(creds, "presence", Route("1.2.3.4")) |
764 | 1 | Adrian Georgescu | pub.publish("text", "plain", "hi!") |
765 | 1 | Adrian Georgescu | }}} |
766 | 1 | Adrian Georgescu | |
767 | 29 | Luci Stanescu | After executing this code, the application will have to wait until the {{{Publication}}} object sends the {{{SIPPublicationChangedState}}} notification, which includes the result of the requested operation. |
768 | 1 | Adrian Georgescu | In this case the presence agent will most likely reply with "Unsupported media type", as the code tries to submit Content-Type which is not valid for the presence event package. |
769 | 1 | Adrian Georgescu | |
770 | 1 | Adrian Georgescu | === Subscription === |
771 | 1 | Adrian Georgescu | |
772 | 1 | Adrian Georgescu | Subscription and notifications for SIP events is an Internet standard published at [http://tools.ietf.org/html/rfc3856 RFC 3856]. |
773 | 1 | Adrian Georgescu | |
774 | 1 | Adrian Georgescu | This SIP primitive class represents a subscription to a specific event type of a particular SIP URI. |
775 | 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. |
776 | 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. |
777 | 1 | Adrian Georgescu | Whenever a {{{NOTIFY}}} is received, the application will receive the {{{Subcription_notify}}} event. |
778 | 1 | Adrian Georgescu | |
779 | 1 | Adrian Georgescu | Internally a {{{Subscription}}} object has a state machine, which reflects the state of the subscription. |
780 | 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}}}. |
781 | 1 | Adrian Georgescu | The last three states are directly copied from the contents of the {{{Subscription-State}}} header of the received {{{NOTIFY}}} request. |
782 | 1 | 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. |
783 | 1 | Adrian Georgescu | The state machine of the {{{Subscription}}} object is not queued, meaning that if an action is performed that is not allowed in the state the state machine is currently in, an exception will be raised. |
784 | 1 | Adrian Georgescu | |
785 | 1 | Adrian Georgescu | > The implementation of this object needs to be revised. |
786 | 1 | Adrian Georgescu | |
787 | 1 | Adrian Georgescu | ==== attributes ==== |
788 | 1 | Adrian Georgescu | |
789 | 1 | Adrian Georgescu | '''state''':: |
790 | 1 | Adrian Georgescu | Indicates which state the internal state machine is in. |
791 | 1 | Adrian Georgescu | See the previous section for a list of states the state machine can be in. |
792 | 1 | Adrian Georgescu | '''credentials''':: |
793 | 1 | Adrian Georgescu | The SIP credentials needed to authenticate at the SIP proxy in the form of a {{{Credentials}}} object. |
794 | 1 | Adrian Georgescu | The {{{SIPURI}}} object included in the {{{Credentials}}} object is used for the {{{From}}} header of the {{{SUBSCRIBE}}} request. |
795 | 1 | Adrian Georgescu | This attribute is set on object instantiation and is read-only. |
796 | 1 | Adrian Georgescu | '''to_uri''':: |
797 | 1 | Adrian Georgescu | The SIP URI we want to subscribe to a particular event of represented as a {{{SIPURI}}} object. |
798 | 1 | Adrian Georgescu | This attribute is set on object instantiation and is read-only. |
799 | 1 | Adrian Georgescu | '''event''':: |
800 | 1 | Adrian Georgescu | The event package to which we want to subscribe at the given SIP URI. |
801 | 1 | Adrian Georgescu | This attribute is set on object instantiation and is read-only. |
802 | 1 | Adrian Georgescu | '''route''':: |
803 | 1 | Adrian Georgescu | The outbound proxy to use in the form of a {{{Route}}} object. |
804 | 1 | Adrian Georgescu | This attribute is set on object instantiation and is read-only. |
805 | 1 | Adrian Georgescu | '''expires''':: |
806 | 1 | Adrian Georgescu | The expires value that was requested on object instantiation. |
807 | 1 | Adrian Georgescu | This attribute is read-only. |
808 | 1 | Adrian Georgescu | '''extra_headers''':: |
809 | 1 | Adrian Georgescu | A dictionary of extra headers that should be added to any outgoing {{{SUBSCRIBE}}} request. |
810 | 1 | Adrian Georgescu | This attribute is set on object instantiation and is read-only. |
811 | 1 | Adrian Georgescu | |
812 | 1 | Adrian Georgescu | ==== methods ==== |
813 | 1 | Adrian Georgescu | |
814 | 33 | Ruud Klaver | '''!__init!__'''(''self'', '''credentials''', '''to_uri''', '''event''', '''route''', '''expires'''=300, '''contact_uri'''={{{None}}}, '''extra_headers'''={{{None}}}):: |
815 | 1 | Adrian Georgescu | Creates a new {{{Subscription}}} object. |
816 | 1 | Adrian Georgescu | [[BR]]''credentials'':[[BR]] |
817 | 1 | Adrian Georgescu | The SIP credentials needed to authenticate at the SIP proxy in the form of a {{{Credentials}}} object. |
818 | 1 | Adrian Georgescu | The {{{SIPURI}}} object included in the {{{Credentials}}} object is used for the {{{From}}} header of the {{{SUBSCRIBE}}} request. |
819 | 1 | Adrian Georgescu | [[BR]]''to_uri'':[[BR]] |
820 | 1 | Adrian Georgescu | The SIP URI we want to subscribe to a particular event of represented as a {{{SIPURI}}} object. |
821 | 1 | Adrian Georgescu | [[BR]]''event'':[[BR]] |
822 | 1 | Adrian Georgescu | The event package to which we want to subscribe at the given SIP URI. |
823 | 1 | Adrian Georgescu | [[BR]]''route'':[[BR]] |
824 | 1 | Adrian Georgescu | The outbound proxy to use in the form of a {{{Route}}} object |
825 | 1 | Adrian Georgescu | [[BR]]''expires'':[[BR]] |
826 | 1 | Adrian Georgescu | The amount of seconds the {{{SUBSCRIBE}}} is valid, i.e. the value that should be put in the {{{Expires}}} header. |
827 | 33 | Ruud Klaver | [[BR]]''contact_uri'':[[BR]] |
828 | 33 | Ruud Klaver | The Contact URI that should be used in the {{{SUBSCRIBE}}} requests. |
829 | 33 | Ruud Klaver | If this is {{{None}}}, a Contact URI will be generated internally. |
830 | 1 | Adrian Georgescu | [[BR]]''extra_headers'':[[BR]] |
831 | 1 | Adrian Georgescu | A dictionary of extra headers that should be added to any outgoing {{{SUBSCRIBE}}} request. |
832 | 1 | Adrian Georgescu | '''subscribe'''(''self''):: |
833 | 1 | Adrian Georgescu | This method activates the subscription and causes the object to send a {{{SUBSCRIBE}}} request to the relevant presence agent. |
834 | 1 | Adrian Georgescu | It can only be used when the object is in the {{{TERMINATED}}} state. |
835 | 1 | Adrian Georgescu | '''unsubscribe'''(''self''):: |
836 | 1 | Adrian Georgescu | This method causes the object to send a {{{SUBSCRIBE}}} request with an {{{Expires}}} value of 0, effectively canceling the active subscription. |
837 | 1 | Adrian Georgescu | It can be used when the object is not in the {{{TERMINATED}}} state. |
838 | 1 | Adrian Georgescu | |
839 | 1 | Adrian Georgescu | ==== notifications ==== |
840 | 1 | Adrian Georgescu | |
841 | 29 | Luci Stanescu | '''SIPSubscriptionChangedState''':: |
842 | 1 | Adrian Georgescu | This notification will be sent every time the internal state machine of a {{{Subscription}}} object changes state. |
843 | 1 | Adrian Georgescu | [[BR]]''timestamp'':[[BR]] |
844 | 1 | Adrian Georgescu | A {{{datetime.datetime}}} object indicating when the notification was sent. |
845 | 1 | Adrian Georgescu | [[BR]]''state'':[[BR]] |
846 | 1 | Adrian Georgescu | The new state the state machine moved into. |
847 | 1 | Adrian Georgescu | [[BR]]''code'': (only on SIP response triggered state change)[[BR]] |
848 | 1 | Adrian Georgescu | The status code of the response that caused the state change. |
849 | 1 | Adrian Georgescu | This may be internally generated by PJSIP, e.g. on timeout. |
850 | 1 | Adrian Georgescu | [[BR]]''reason'': (only on SIP response triggered state change)[[BR]] |
851 | 1 | Adrian Georgescu | The status text of the response that caused the state change. |
852 | 1 | Adrian Georgescu | This may be internally generated by PJSIP, e.g. on timeout. |
853 | 29 | Luci Stanescu | '''SIPSubscriptionGotNotify''':: |
854 | 1 | Adrian Georgescu | This notification will be sent when a {{{NOTIFY}}} is received that corresponds to a particular {{{Subscription}}} object. |
855 | 1 | Adrian Georgescu | Note that this notification will not be sent when a {{{NOTIFY}}} with an empty body is received. |
856 | 1 | Adrian Georgescu | [[BR]]''timestamp'':[[BR]] |
857 | 1 | Adrian Georgescu | A {{{datetime.datetime}}} object indicating when the notification was sent. |
858 | 1 | Adrian Georgescu | [[BR]]''content_type'':[[BR]] |
859 | 1 | Adrian Georgescu | The first part of the {{{Content-Type:}}} header of the received {{{NOTIFY}}} request (before the {{{/}}}), indicating the type of the body. |
860 | 1 | Adrian Georgescu | [[BR]]''content_subtype'':[[BR]] |
861 | 1 | Adrian Georgescu | The second part of the {{{Content-Type:}}} header of the received {{{NOTIFY}}} request (after the {{{/}}}), indicating the type of the body. |
862 | 1 | Adrian Georgescu | [[BR]]''body'':[[BR]] |
863 | 1 | Adrian Georgescu | The body of the {{{NOTIFY}}} request. |
864 | 1 | Adrian Georgescu | |
865 | 1 | Adrian Georgescu | ==== example code ==== |
866 | 1 | Adrian Georgescu | |
867 | 1 | Adrian Georgescu | This code shows how to make a {{{Subscription}}} object that subscribes to the presence of another SIP account. |
868 | 1 | Adrian Georgescu | |
869 | 1 | Adrian Georgescu | {{{ |
870 | 1 | Adrian Georgescu | accnt = SIPURI(user="watcher", host="domain.com") |
871 | 1 | Adrian Georgescu | creds = Credentials(accnt, "password") |
872 | 1 | Adrian Georgescu | to_uri = SIPURI(user="watched", host="domain.com") |
873 | 22 | Ruud Klaver | sub = Subscription(creds, to_uri, "presence", Route("1.2.3.4")) |
874 | 1 | Adrian Georgescu | sub.subscribe() |
875 | 1 | Adrian Georgescu | }}} |
876 | 1 | Adrian Georgescu | |
877 | 29 | Luci Stanescu | After executing this code, the application will have to wait until the {{{Subscription}}} object sends the {{{SIPSubscriptionChangedState}}} notification, which includes the result of the requested operation. |
878 | 29 | Luci Stanescu | Independently of this, the object sends a {{{SIPSubscriptionGotNotify}}} notification anytime it receives a {{{NOTIFY}}} request for this subscription, as long as the subscription is active. |
879 | 1 | Adrian Georgescu | |
880 | 1 | Adrian Georgescu | === Invitation === |
881 | 1 | Adrian Georgescu | |
882 | 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. |
883 | 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. |
884 | 1 | Adrian Georgescu | The {{{Invitation}}} class represents both incoming and outgoing sessions. |
885 | 1 | Adrian Georgescu | |
886 | 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. |
887 | 1 | Adrian Georgescu | In order to represent re-{{{INVITE}}}s and user-requested disconnections, three more states have been added to this state machine. |
888 | 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. |
889 | 1 | Adrian Georgescu | State changes are triggered either by incoming or by outgoing SIP requests and responses. |
890 | 1 | Adrian Georgescu | The states and the transitions between them are shown in the following diagram: |
891 | 1 | Adrian Georgescu | |
892 | 1 | Adrian Georgescu | [[Image(sipsimple-core-invite-state-machine.png, nolink)]] |
893 | 1 | Adrian Georgescu | |
894 | 1 | Adrian Georgescu | The state changes of this machine are triggered by the following: |
895 | 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. |
896 | 1 | Adrian Georgescu | 2. The application requested an outgoing session by calling the {{{send_invite()}}} method and and initial {{{INVITE}}} request is sent. |
897 | 1 | Adrian Georgescu | 3. A new incoming session is received by the core. |
898 | 1 | Adrian Georgescu | The application should look out for state change to this state in order to be notified of new incoming sessions. |
899 | 1 | Adrian Georgescu | 4. A provisional response (1xx) is received from the remove party. |
900 | 1 | Adrian Georgescu | 5. A provisional response (1xx) is sent to the remote party, after the application called the {{{respond_to_invite_provisionally()}}} method. |
901 | 1 | Adrian Georgescu | 6. A positive final response (2xx) is received from the remote party. |
902 | 1 | Adrian Georgescu | 7. A positive final response (2xx) is sent to the remote party, after the application called the {{{accept_invite()}}} method. |
903 | 1 | Adrian Georgescu | 8. A positive final response (2xx) is sent or received, depending on the orientation of the session. |
904 | 1 | Adrian Georgescu | 9. An {{{ACK}}} is sent or received, depending on the orientation of the session. |
905 | 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. |
906 | 1 | Adrian Georgescu | 10. The local party sent a re-{{{INVITE}}} to the remote party by calling the {{{send_reinvite()}}} method. |
907 | 1 | Adrian Georgescu | 11. The remote party has sent a final response to the re-{{{INVITE}}}. |
908 | 1 | Adrian Georgescu | 12. The remote party has sent a re-{{{INVITE}}}. |
909 | 1 | Adrian Georgescu | 13. The local party has responded to the re-{{{INVITE}}} by calling the {{{respond_to_reinvite()}}} method. |
910 | 1 | Adrian Georgescu | 14. The application requests that the session ends by calling the {{{disconnect()}}} method. |
911 | 1 | Adrian Georgescu | 15. A response is received from the remote party to whichever message was sent by the local party to end the session. |
912 | 1 | Adrian Georgescu | 16. A message is received from the remote party which ends the session. |
913 | 1 | Adrian Georgescu | |
914 | 29 | Luci Stanescu | 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. |
915 | 1 | Adrian Georgescu | If the event is triggered by and incoming message, extensive data about that message, such as method/code, headers and body, is also included with the notification. |
916 | 1 | Adrian Georgescu | The application should compare the previous and current states and perform the appropriate action. |
917 | 1 | Adrian Georgescu | |
918 | 29 | Luci Stanescu | An {{{Invitiation}}} object also emits the {{{SIPInvitationGotSDPUpdate}}} notification, which indicates that SDP negotiation between the two parties has been completed. |
919 | 1 | Adrian Georgescu | This will occur (at least) once during the initial session negotiation steps, during re-{{{INVITE}}}s in both directions and whenever an {{{UPDATE}}} request is received. |
920 | 1 | Adrian Georgescu | In the last case, the {{{Invitation}}} object will automatically include the current local SDP in the response. |
921 | 1 | Adrian Georgescu | |
922 | 1 | Adrian Georgescu | ==== attributes ==== |
923 | 1 | Adrian Georgescu | |
924 | 1 | Adrian Georgescu | '''state''':: |
925 | 1 | Adrian Georgescu | The state the {{{Invitation}}} state machine is currently in. |
926 | 1 | Adrian Georgescu | See the diagram above for possible states. |
927 | 1 | Adrian Georgescu | This attribute is read-only. |
928 | 1 | Adrian Georgescu | '''is_outgoing''':: |
929 | 1 | Adrian Georgescu | Boolean indicating if the original {{{INVITE}}} was outgoing, or incoming if set to {{{False}}}. |
930 | 1 | Adrian Georgescu | '''credentials''':: |
931 | 1 | Adrian Georgescu | The SIP credentials needed to authenticate at the SIP proxy in the form of a {{{Credentials}}} object. |
932 | 1 | Adrian Georgescu | If this {{{Invitation}}} object represents an incoming {{{INVITE}}} session this attribute will be {{{None}}}. |
933 | 1 | Adrian Georgescu | This attribute is set on object instantiation and is read-only. |
934 | 1 | Adrian Georgescu | '''caller_uri''':: |
935 | 1 | Adrian Georgescu | The SIP URI of the caller represented by a {{{SIPURI}}} object. |
936 | 1 | Adrian Georgescu | If this is in an outgoing {{{INVITE}}} session, the caller_uri is taken from the supplied {{{Credentials}}} object. |
937 | 1 | Adrian Georgescu | Otherwise the URI is taken from the {{{From:}}} header of the initial {{{INVITE}}}. |
938 | 1 | Adrian Georgescu | This attribute is set on object instantiation and is read-only. |
939 | 1 | Adrian Georgescu | '''callee_uri''':: |
940 | 1 | Adrian Georgescu | The SIP URI of the callee represented by a {{{SIPURI}}} object. |
941 | 1 | Adrian Georgescu | If this is an outgoing {{{INVITE}}} session, this is the callee_uri from the !__init!__ method. |
942 | 1 | Adrian Georgescu | Otherwise the URI is taken from the {{{To:}}} header of the initial {{{INVITE}}}. |
943 | 1 | Adrian Georgescu | This attribute is set on object instantiation and is read-only. |
944 | 1 | Adrian Georgescu | '''local_uri''':: |
945 | 1 | Adrian Georgescu | The local SIP URI used in this session. |
946 | 1 | Adrian Georgescu | If the original {{{INVITE}}} was incoming, this is the same as {{{callee_uri}}}, otherwise it will be the same as {{{caller_uri}}}. |
947 | 1 | Adrian Georgescu | '''remote_uri''':: |
948 | 1 | Adrian Georgescu | The SIP URI of the remote party in this session. |
949 | 1 | Adrian Georgescu | If the original {{{INVITE}}} was incoming, this is the same as {{{caller_uri}}}, otherwise it will be the same as {{{callee_uri}}}. |
950 | 1 | Adrian Georgescu | '''route''':: |
951 | 1 | Adrian Georgescu | The outbound proxy that was requested to be used in the form of a {{{Route}}} object, including the desired transport. |
952 | 1 | Adrian Georgescu | If this {{{Invitation}}} object represents an incoming {{{INVITE}}} session this attribute will always be {{{None}}}. |
953 | 1 | Adrian Georgescu | This attribute is set on object instantiation and is read-only. |
954 | 1 | Adrian Georgescu | '''call_id''':: |
955 | 1 | Adrian Georgescu | The call ID of the {{{INVITE}}} session as a read-only string. |
956 | 1 | Adrian Georgescu | In the {{{NULL}}} and {{{DISCONNECTED}}} states, this attribute is {{{None}}}. |
957 | 33 | Ruud Klaver | '''transport''':: |
958 | 33 | Ruud Klaver | A string indicating the transport used for the application. |
959 | 33 | Ruud Klaver | This can be "udp", "tcp" or "tls". |
960 | 33 | Ruud Klaver | '''local_contact_uri''':: |
961 | 33 | Ruud Klaver | The Contact URI that the local side provided to the remote side within this {{{INVITE}}} session as a {{{SIPURI}}} object. |
962 | 1 | Adrian Georgescu | |
963 | 1 | Adrian Georgescu | ==== methods ==== |
964 | 1 | Adrian Georgescu | |
965 | 33 | Ruud Klaver | '''!__init!__'''(''self'', '''credentials''', '''callee_uri''', '''route''', '''contact_uri'''={{{None}}}):: |
966 | 1 | Adrian Georgescu | Creates a new {{{Invitation}}} object for an outgoing session. |
967 | 1 | Adrian Georgescu | [[BR]]''credentials'':[[BR]] |
968 | 22 | Ruud Klaver | The SIP credentials needed to authenticate at the SIP proxy in the form of a {{{Credentials}}} object. |
969 | 1 | Adrian Georgescu | The {{{SIPURI}}} object included in the {{{Credentials}}} object is used for the {{{From}}} header of the {{{INVITE}}} request. |
970 | 1 | Adrian Georgescu | [[BR]]''callee_uri'':[[BR]] |
971 | 1 | Adrian Georgescu | The SIP URI we want to send the {{{INVITE}}} to, represented as a {{{SIPURI}}} object. |
972 | 1 | Adrian Georgescu | [[BR]]''route'':[[BR]] |
973 | 1 | Adrian Georgescu | The outbound proxy to use in the form of a {{{Route}}} object. |
974 | 1 | Adrian Georgescu | This includes the desired transport to use. |
975 | 33 | Ruud Klaver | [[BR]]''contact_uri'':[[BR]] |
976 | 33 | Ruud Klaver | The Contact URI to include in the {{{INVITE}}} request, a {{{SIPURI}}} object. |
977 | 33 | Ruud Klaver | If this is {{{None}}}, a Contact URI will be internally generated. |
978 | 1 | Adrian Georgescu | '''get_active_local_sdp'''(''self''):: |
979 | 1 | Adrian Georgescu | Returns a new {{{SDPSession}}} object representing the currently active local SDP. |
980 | 1 | Adrian Georgescu | If no SDP was negotiated yet, this returns {{{None}}}. |
981 | 1 | Adrian Georgescu | '''get_active_remote_sdp'''(''self''):: |
982 | 1 | Adrian Georgescu | Returns a new {{{SDPSession}}} object representing the currently active local SDP. |
983 | 1 | Adrian Georgescu | If no SDP was negotiated yet, this returns {{{None}}}. |
984 | 1 | Adrian Georgescu | '''get_offered_local_sdp'''(''self''):: |
985 | 1 | Adrian Georgescu | Returns a new {{{SDPSession}}} object representing the currently proposed local SDP. |
986 | 1 | Adrian Georgescu | If no local offered SDP has been set, this returns {{{None}}}. |
987 | 1 | Adrian Georgescu | '''set_offered_local_sdp'''(''self'', '''local_sdp'''):: |
988 | 1 | Adrian Georgescu | Sets the offered local SDP, either for an initial {{{INVITE}}} or re-{{{INVITE}}}, or as an SDP answer in response to an initial {{{INVITE}}} or re-{{{INVITE}}}. |
989 | 1 | Adrian Georgescu | [[BR]]''local_sdp'':[[BR]] |
990 | 1 | Adrian Georgescu | The SDP to send as offer or answer to the remote party. |
991 | 1 | Adrian Georgescu | '''get_offered_remote_sdp'''(''self''):: |
992 | 1 | Adrian Georgescu | Returns a new {{{SDPSession}}} object representing the currently proposed remote SDP. |
993 | 1 | Adrian Georgescu | If no remote SDP has been offered in the current state, this returns {{{None}}}. |
994 | 1 | Adrian Georgescu | '''send_invite'''(''self'', '''extra_headers'''={{{None}}}):: |
995 | 1 | Adrian Georgescu | This tries to move the state machine into the {{{CALLING}}} state by sending the initial {{{INVITE}}} request. |
996 | 1 | Adrian Georgescu | It may only be called from the {{{NULL}}} state on an outgoing {{{Invitation}}} object. |
997 | 1 | Adrian Georgescu | [[BR]]''extra_headers'':[[BR]] |
998 | 1 | Adrian Georgescu | Any extra headers that should be included in the {{{INVITE}}} request in the form of a dict. |
999 | 1 | Adrian Georgescu | '''respond_to_invite_provisionally'''(''self'', '''response_code'''=180, '''extra_headers'''={{{None}}}):: |
1000 | 1 | Adrian Georgescu | This tries to move the state machine into the {{{EARLY}}} state by sending a provisional response to the initial {{{INVITE}}}. |
1001 | 1 | Adrian Georgescu | It may only be called from the {{{INCOMING}}} state on an incoming {{{Invitation}}} object. |
1002 | 1 | Adrian Georgescu | [[BR]]''response_code'':[[BR]] |
1003 | 1 | Adrian Georgescu | The code of the provisional response to use as an int. |
1004 | 1 | Adrian Georgescu | This should be in the 1xx range. |
1005 | 1 | Adrian Georgescu | [[BR]]''extra_headers'':[[BR]] |
1006 | 1 | Adrian Georgescu | Any extra headers that should be included in the response in the form of a dict. |
1007 | 1 | Adrian Georgescu | '''accept_invite'''(''self'', '''extra_headers'''={{{None}}}):: |
1008 | 1 | Adrian Georgescu | This tries to move the state machine into the {{{CONNECTING}}} state by sending a 200 OK response to the initial {{{INVITE}}}. |
1009 | 1 | Adrian Georgescu | It may only be called from the {{{INCOMING}}} or {{{EARLY}}} states on an incoming {{{Invitation}}} object. |
1010 | 1 | Adrian Georgescu | [[BR]]''extra_headers'':[[BR]] |
1011 | 1 | Adrian Georgescu | Any extra headers that should be included in the response in the form of a dict. |
1012 | 41 | Ruud Klaver | '''disconnect'''(''self'', '''response_code'''=603, '''extra_headers'''={{{None}}}, '''timeout'''={{{None}}}):: |
1013 | 1 | Adrian Georgescu | This moves the {{{INVITE}}} state machine into the {{{DISCONNECTING}}} state by sending the necessary SIP message. |
1014 | 1 | Adrian Georgescu | When a response from the remote party is received, the state machine will go into the {{{DISCONNECTED}}} state. |
1015 | 1 | Adrian Georgescu | Depending on the current state, this could be a CANCEL or BYE request or a negative response. |
1016 | 1 | Adrian Georgescu | [[BR]]''response_code'':[[BR]] |
1017 | 1 | Adrian Georgescu | The code of the response to use as an int, if transmission of a response is needed. |
1018 | 1 | Adrian Georgescu | [[BR]]''extra_headers'':[[BR]] |
1019 | 1 | Adrian Georgescu | Any extra headers that should be included in the request or response in the form of a dict. |
1020 | 41 | Ruud Klaver | [[BR]]''timeout'':[[BR]] |
1021 | 41 | 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. |
1022 | 41 | Ruud Klaver | If this is set to {{{None}}}, the default PJSIP timeout will be used, which currently appears to be 3.5 seconds. |
1023 | 33 | Ruud Klaver | '''respond_to_reinvite'''(''self'', '''response_code'''=200, '''extra_headers'''={{{None}}}):: |
1024 | 1 | Adrian Georgescu | Respond to a received re-{{{INVITE}}} with a response that is either provisional (1xx), positive (2xx) or negative (3xx and upwards). |
1025 | 1 | Adrian Georgescu | This method can be called by the application when the state machine is in the {{{REINVITED}}} state and will move the state machine back into the {{{CONFIRMED}}} state. |
1026 | 1 | Adrian Georgescu | Before giving a positive final response, the SDP needs to be set using the {{{set_offered_local_sdp()}}} method. |
1027 | 1 | Adrian Georgescu | [[BR]]''response_code'':[[BR]] |
1028 | 1 | Adrian Georgescu | The code of the response to use as an int. |
1029 | 1 | Adrian Georgescu | This should be a 3 digit number. |
1030 | 1 | Adrian Georgescu | [[BR]]''extra_headers'':[[BR]] |
1031 | 1 | Adrian Georgescu | '''send_reinvite'''(''self'', '''extra_headers'''={{{None}}}):: |
1032 | 1 | Adrian Georgescu | The application may only call this method when the state machine is in the {{{CONFIRMED}}} state to induce sending a re-{{{INVITE}}}. |
1033 | 1 | Adrian Georgescu | Before doing this it needs to set the new local SDP offer by calling the {{{set_offered_local_sdp()}}} method. |
1034 | 1 | Adrian Georgescu | After this method is called, the state machine will be in the {{{REINVITING}}} state, until a final response from the remote party is received. |
1035 | 1 | Adrian Georgescu | [[BR]]''extra_headers'':[[BR]] |
1036 | 1 | Adrian Georgescu | Any extra headers that should be included in the re-{{{INVITE}}} in the form of a dict. |
1037 | 1 | Adrian Georgescu | |
1038 | 1 | Adrian Georgescu | ==== notifications ==== |
1039 | 1 | Adrian Georgescu | |
1040 | 29 | Luci Stanescu | '''SIPInvitationChangedState''':: |
1041 | 1 | Adrian Georgescu | This notification is sent by an {{{Invitation}}} object whenever its state machine changes state. |
1042 | 1 | Adrian Georgescu | [[BR]]''timestamp'':[[BR]] |
1043 | 1 | Adrian Georgescu | A {{{datetime.datetime}}} object indicating when the notification was sent. |
1044 | 1 | Adrian Georgescu | [[BR]]''prev_state'':[[BR]] |
1045 | 1 | Adrian Georgescu | The previous state of the INVITE state machine. |
1046 | 1 | Adrian Georgescu | [[BR]]''state'':[[BR]] |
1047 | 1 | Adrian Georgescu | The new state of the INVITE state machine, which may be the same as the previous state. |
1048 | 1 | Adrian Georgescu | [[BR]]''method'': (only if the state change got triggered by an incoming SIP request)[[BR]] |
1049 | 1 | Adrian Georgescu | The method of the SIP request as a string. |
1050 | 1 | Adrian Georgescu | [[BR]]''request_uri'': (only if the state change got triggered by an incoming SIP request)[[BR]] |
1051 | 1 | Adrian Georgescu | The request URI of the SIP request as a {{{SIPURI}}} object. |
1052 | 1 | Adrian Georgescu | [[BR]]''code'': (only if the state change got triggered by an incoming SIP response or internal timeout or error)[[BR]] |
1053 | 1 | Adrian Georgescu | The code of the SIP response or error as an int. |
1054 | 1 | Adrian Georgescu | [[BR]]''reason'': (only if the state change got triggered by an incoming SIP response or internal timeout or error)[[BR]] |
1055 | 1 | Adrian Georgescu | The reason text of the SIP response or error as an int. |
1056 | 1 | Adrian Georgescu | [[BR]]''headers'': (only if the state change got triggered by an incoming SIP request or response)[[BR]] |
1057 | 1 | Adrian Georgescu | The headers of the SIP request or response as a dict. |
1058 | 1 | Adrian Georgescu | Each SIP header is represented in its parsed for as long as PJSIP supports it. |
1059 | 1 | Adrian Georgescu | The format of the parsed value depends on the header. |
1060 | 1 | Adrian Georgescu | [[BR]]''body'': (only if the state change got triggered by an incoming SIP request or response)[[BR]] |
1061 | 1 | Adrian Georgescu | The body of the SIP request or response as a string, or {{{None}}} if no body was included. |
1062 | 1 | Adrian Georgescu | The content type of the body can be learned from the {{{Content-Type:}}} header in the headers argument. |
1063 | 29 | Luci Stanescu | '''SIPInvitationGotSDPUpdate''':: |
1064 | 1 | Adrian Georgescu | This notification is sent by an {{{Invitation}}} object whenever SDP negotation has been perfomed. |
1065 | 1 | Adrian Georgescu | It should be used by the application as an indication to start, change or stop any associated media streams. |
1066 | 1 | Adrian Georgescu | [[BR]]''timestamp'':[[BR]] |
1067 | 1 | Adrian Georgescu | A {{{datetime.datetime}}} object indicating when the notification was sent. |
1068 | 1 | Adrian Georgescu | [[BR]]''succeeded'':[[BR]] |
1069 | 1 | Adrian Georgescu | A boolean indicating if the SDP negotation has succeeded. |
1070 | 1 | Adrian Georgescu | [[BR]]''error'': (only if SDP negotation did not succeed)[[BR]] |
1071 | 1 | Adrian Georgescu | A string indicating why SDP negotation failed. |
1072 | 1 | Adrian Georgescu | [[BR]]''local_sdp'': (only if SDP negotation succeeded)[[BR]] |
1073 | 1 | Adrian Georgescu | A SDPSession object indicating the local SDP that was negotiated. |
1074 | 1 | Adrian Georgescu | [[BR]]''remote_sdp'': (only if SDP negotation succeeded)[[BR]] |
1075 | 1 | Adrian Georgescu | A SDPSession object indicating the remote SDP that was negotiated. |
1076 | 1 | Adrian Georgescu | |
1077 | 1 | Adrian Georgescu | === SDPSession === |
1078 | 1 | Adrian Georgescu | |
1079 | 1 | Adrian Georgescu | 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. |
1080 | 1 | Adrian Georgescu | |
1081 | 1 | Adrian Georgescu | SDPSession object directly represents the contents of a SDP body, as carried e.g. in a 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. |
1082 | 1 | Adrian Georgescu | It can be passed to those methods of an {{{Invitation}}} object that result in transmission of a message that includes SDP, or is passed to the application through a notification that is triggered by reception of a message that includes SDP. |
1083 | 1 | Adrian Georgescu | A {{{SDPSession}}} object may contain {{{SDPMedia}}}, {{{SDPConnection}}} and {{{SDPAttribute}}} objects. |
1084 | 1 | Adrian Georgescu | It supports comparison to other {{{SDPSession}}} objects using the == and != expressions. |
1085 | 1 | Adrian Georgescu | As all the attributes of the {{{SDPSession}}} class are set by attributes of the {{{__init__}}} method, they will be documented along with that method. |
1086 | 1 | Adrian Georgescu | |
1087 | 1 | Adrian Georgescu | ==== methods ==== |
1088 | 1 | Adrian Georgescu | |
1089 | 23 | Ruud Klaver | '''!__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}}}):: |
1090 | 1 | Adrian Georgescu | Creates the SDPSession object with the specified parameters as attributes. |
1091 | 1 | Adrian Georgescu | Each of these attributes can be accessed and changed on the object once instanced. |
1092 | 1 | Adrian Georgescu | [[BR]]''address'':[[BR]] |
1093 | 1 | Adrian Georgescu | The address that is contained in the "o" (origin) line of the SDP as a string. |
1094 | 1 | Adrian Georgescu | [[BR]]''id'':[[BR]] |
1095 | 1 | Adrian Georgescu | The session identifier contained in the "o" (origin) line of the SDP as an int. |
1096 | 1 | Adrian Georgescu | If this is set to {{{None}}} on init, a session identifier will be generated. |
1097 | 1 | Adrian Georgescu | [[BR]]''version'':[[BR]] |
1098 | 1 | Adrian Georgescu | The version identifier contained in the "o" (origin) line of the SDP as an int. |
1099 | 1 | Adrian Georgescu | If this is set to {{{None}}} on init, a version identifier will be generated. |
1100 | 1 | Adrian Georgescu | [[BR]]''user'':[[BR]] |
1101 | 1 | Adrian Georgescu | The user name contained in the "o" (origin) line of the SDP as a string. |
1102 | 1 | Adrian Georgescu | [[BR]]''net_type'':[[BR]] |
1103 | 1 | Adrian Georgescu | The network type contained in the "o" (origin) line of the SDP as a string. |
1104 | 1 | Adrian Georgescu | [[BR]]''address_type'':[[BR]] |
1105 | 1 | Adrian Georgescu | The address type contained in the "o" (origin) line of the SDP as a string. |
1106 | 1 | Adrian Georgescu | [[BR]]''name'':[[BR]] |
1107 | 1 | Adrian Georgescu | The contents of the "s" (session name) line of the SDP as a string. |
1108 | 1 | Adrian Georgescu | [[BR]]''info'':[[BR]] |
1109 | 1 | Adrian Georgescu | The contents of the session level "i" (information) line of the SDP as a string. |
1110 | 1 | Adrian Georgescu | If this is {{{None}}} or an empty string, the SDP has no "i" line. |
1111 | 1 | Adrian Georgescu | [[BR]]''connection'':[[BR]] |
1112 | 1 | Adrian Georgescu | The contents of the "c" (connection) line of the SDP as a {{{SDPConnection}}} object. |
1113 | 1 | Adrian Georgescu | If this is set to {{{None}}}, the SDP has no session level "c" line. |
1114 | 1 | Adrian Georgescu | [[BR]]''start_time'':[[BR]] |
1115 | 1 | Adrian Georgescu | The first value of the "t" (time) line of the SDP as an int. |
1116 | 1 | Adrian Georgescu | [[BR]]''stop_time'':[[BR]] |
1117 | 1 | Adrian Georgescu | The second value of the "t" (time) line of the SDP as an int. |
1118 | 1 | Adrian Georgescu | [[BR]]''attributes'':[[BR]] |
1119 | 1 | Adrian Georgescu | The session level "a" lines (attributes) in the SDP represented by a list of {{{SDPAttribute}}} objects. |
1120 | 1 | Adrian Georgescu | [[BR]]''media'':[[BR]] |
1121 | 1 | Adrian Georgescu | The media sections of the SDP represented by a list of {{{SDPMedia}}} objects. |
1122 | 1 | Adrian Georgescu | |
1123 | 1 | Adrian Georgescu | === SDPMedia === |
1124 | 1 | Adrian Georgescu | |
1125 | 1 | Adrian Georgescu | This object represents the contents of a media section of a SDP body, i.e. a "m" line and everything under it until the next "m" line. |
1126 | 1 | Adrian Georgescu | It is a simple wrapper for the PJSIP [http://www.pjsip.org/pjmedia/docs/html/structpjmedia__sdp__media.htm pjmedia_sdp_media] structure. |
1127 | 1 | Adrian Georgescu | One or more {{{SDPMedia}}} objects are usually contained in a {{{SDPSession}}} object. |
1128 | 1 | Adrian Georgescu | It supports comparison to other {{{SDPMedia}}} objects using the == and != expressions. |
1129 | 1 | Adrian Georgescu | As all the attributes of this class are set by attributes of the {{{__init__}}} method, they will be documented along with that method. |
1130 | 1 | Adrian Georgescu | |
1131 | 1 | Adrian Georgescu | ==== methods ==== |
1132 | 1 | Adrian Georgescu | |
1133 | 24 | Ruud Klaver | '''!__init!__'''(''self'', '''media''', '''port''', '''transport''', '''port_count'''=1, '''formats'''={{{None}}}, '''info'''={{{None}}}, '''connection'''={{{None}}}, '''attributes'''={{{None}}}):: |
1134 | 1 | Adrian Georgescu | Creates the SDPMedia object with the specified parameters as attributes. |
1135 | 1 | Adrian Georgescu | Each of these attributes can be accessed and changed on the object once instanced. |
1136 | 1 | Adrian Georgescu | [[BR]]''media'':[[BR]] |
1137 | 1 | Adrian Georgescu | The media type contained in the "m" (media) line as a string. |
1138 | 1 | Adrian Georgescu | [[BR]]''port'':[[BR]] |
1139 | 1 | Adrian Georgescu | The transport port contained in the "m" (media) line as an int. |
1140 | 1 | Adrian Georgescu | [[BR]]''transport'':[[BR]] |
1141 | 1 | Adrian Georgescu | The transport protocol in the "m" (media) line as a string. |
1142 | 1 | Adrian Georgescu | [[BR]]''port_count'':[[BR]] |
1143 | 1 | Adrian Georgescu | The port count in the "m" (media) line as an int. |
1144 | 1 | Adrian Georgescu | If this is set to 1, it is not included in the SDP. |
1145 | 1 | Adrian Georgescu | [[BR]]''formats'':[[BR]] |
1146 | 1 | Adrian Georgescu | The media formats in the "m" (media) line represented by a list of strings. |
1147 | 1 | Adrian Georgescu | [[BR]]''info'':[[BR]] |
1148 | 1 | Adrian Georgescu | The contents of the "i" (information) line of this media section as a string. |
1149 | 1 | Adrian Georgescu | If this is {{{None}}} or an empty string, the media section has no "i" line. |
1150 | 1 | Adrian Georgescu | [[BR]]''connection'':[[BR]] |
1151 | 1 | Adrian Georgescu | The contents of the "c" (connection) line that is somewhere below the "m" line of this section as a {{{SDPConnection}}} object. |
1152 | 1 | Adrian Georgescu | If this is set to {{{None}}}, this media section has no "c" line. |
1153 | 1 | Adrian Georgescu | [[BR]]''attributes'':[[BR]] |
1154 | 1 | Adrian Georgescu | The "a" lines (attributes) that are somewhere below the "m" line of this section represented by a list of {{{SDPAttribute}}} objects. |
1155 | 1 | Adrian Georgescu | '''get_direction'''(''self''):: |
1156 | 1 | Adrian Georgescu | This is a convenience methods that goes through all the attributes of the media section and returns the direction, which is either "sendrecv", "sendonly", "recvonly" or "inactive". |
1157 | 1 | Adrian Georgescu | If none of these attributes is present, the default direction is "sendrecv". |
1158 | 1 | Adrian Georgescu | |
1159 | 1 | Adrian Georgescu | === SDPConnection === |
1160 | 1 | Adrian Georgescu | |
1161 | 1 | Adrian Georgescu | This object represents the contents of a "c" (connection) line of a SDP body, either at the session level or for an individual media stream. |
1162 | 1 | Adrian Georgescu | It is a simple wrapper for the PJSIP [http://www.pjsip.org/pjmedia/docs/html/structpjmedia__sdp__conn.htm pjmedia_sdp_conn] structure. |
1163 | 1 | Adrian Georgescu | A {{{SDPConnection}}} object can be contained in a {{{SDPSession}}} object or {{{SDPMedia}}} object. |
1164 | 1 | Adrian Georgescu | It supports comparison to other {{{SDPConnection}}} objects using the == and != expressions. |
1165 | 1 | Adrian Georgescu | As all the attributes of this class are set by attributes of the {{{__init__}}} method, they will be documented along with that method. |
1166 | 1 | Adrian Georgescu | |
1167 | 1 | Adrian Georgescu | ==== methods ==== |
1168 | 1 | Adrian Georgescu | |
1169 | 1 | Adrian Georgescu | '''!__init!__'''(''self'', '''address''', '''net_type'''="IN", '''address_type'''="IP4"):: |
1170 | 1 | Adrian Georgescu | Creates the SDPConnection object with the specified parameters as attributes. |
1171 | 1 | Adrian Georgescu | Each of these attributes can be accessed and changed on the object once instanced. |
1172 | 1 | Adrian Georgescu | [[BR]]''address'':[[BR]] |
1173 | 1 | Adrian Georgescu | The address part of the connection line as a string. |
1174 | 1 | Adrian Georgescu | [[BR]]''net_type'':[[BR]] |
1175 | 1 | Adrian Georgescu | The network type part of the connection line as a string. |
1176 | 1 | Adrian Georgescu | [[BR]]''address_type'':[[BR]] |
1177 | 1 | Adrian Georgescu | The address type part of the connection line as a string. |
1178 | 1 | Adrian Georgescu | |
1179 | 1 | Adrian Georgescu | === SDPAttribute === |
1180 | 1 | Adrian Georgescu | |
1181 | 1 | Adrian Georgescu | This object represents the contents of a "a" (attribute) line of a SDP body, either at the session level or for an individual media stream. |
1182 | 1 | Adrian Georgescu | It is a simple wrapper for the PJSIP [http://www.pjsip.org/pjmedia/docs/html/structpjmedia__sdp__attr.htm pjmedia_sdp_attr] structure. |
1183 | 1 | Adrian Georgescu | One or more {{{SDPAttribute}}} objects can be contained in a {{{SDPSession}}} object or {{{SDPMedia}}} object. |
1184 | 1 | Adrian Georgescu | It supports comparison to other {{{SDPAttribute}}} objects using the == and != expressions. |
1185 | 1 | Adrian Georgescu | As all the attributes of this class are set by attributes of the {{{__init__}}} method, they will be documented along with that method. |
1186 | 1 | Adrian Georgescu | |
1187 | 1 | Adrian Georgescu | ==== methods ==== |
1188 | 1 | Adrian Georgescu | |
1189 | 1 | Adrian Georgescu | '''!__init!__'''(''self'', '''name''', '''value'''):: |
1190 | 1 | Adrian Georgescu | Creates the SDPAttribute object with the specified parameters as attributes. |
1191 | 1 | Adrian Georgescu | Each of these attributes can be accessed and changed on the object once instanced. |
1192 | 1 | Adrian Georgescu | [[BR]]''name'':[[BR]] |
1193 | 1 | Adrian Georgescu | The name part of the attribute line as a string. |
1194 | 1 | Adrian Georgescu | [[BR]]''value'':[[BR]] |
1195 | 1 | Adrian Georgescu | The value part of the attribute line as a string. |
1196 | 1 | Adrian Georgescu | |
1197 | 1 | Adrian Georgescu | === RTPTransport === |
1198 | 1 | Adrian Georgescu | |
1199 | 1 | Adrian Georgescu | 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. |
1200 | 1 | Adrian Georgescu | Internally it wraps a [http://www.pjsip.org/pjmedia/docs/html/group__PJMEDIA__TRANSPORT.htm pjmedia_transport] object. |
1201 | 1 | Adrian Georgescu | 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]. |
1202 | 1 | Adrian Georgescu | For this reason the {{{AudioTransport}}} and {{{RTPTransport}}} are two distinct objects. |
1203 | 1 | Adrian Georgescu | |
1204 | 1 | Adrian Georgescu | The {{{RTPTransport}}} object also allows support for ICE and SRTP functionality from PJSIP. |
1205 | 1 | Adrian Georgescu | 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. |
1206 | 1 | Adrian Georgescu | 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. |
1207 | 1 | Adrian Georgescu | This process of SDP negotiation is represented by the internal state machine of the object, as shown in the following diagram: |
1208 | 1 | Adrian Georgescu | |
1209 | 1 | Adrian Georgescu | > The Real-time Transport Protocol (or RTP) defines a standardized packet format for delivering audio and video over the Internet. |
1210 | 1 | Adrian Georgescu | > It was developed by the Audio-Video Transport Working Group of the IETF and published in [http://tools.ietf.org/html/rfc3550 RFC 3550]. |
1211 | 1 | Adrian Georgescu | > RTP is used in streaming media systems (together with the RTSP) as well as in videoconferencing and push to talk systems. |
1212 | 1 | Adrian Georgescu | > 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. |
1213 | 1 | Adrian Georgescu | |
1214 | 18 | Adrian Georgescu | [[Image(sipsimple-rtp-transport-state-machine.png, nolink)]] |
1215 | 1 | Adrian Georgescu | |
1216 | 1 | Adrian Georgescu | State changes are triggered by the following events: |
1217 | 17 | Ruud Klaver | 1. The application calls the {{{set_INIT()}}} method after object creation and ICE+STUN is not used. |
1218 | 17 | Ruud Klaver | 2. The application calls the {{{set_INIT()}}} method after object creation and ICE+STUN is used. |
1219 | 17 | Ruud Klaver | 3. A successful STUN response is received from the STUN server. |
1220 | 17 | Ruud Klaver | 4. The {{{set_LOCAL()}}} method is called. |
1221 | 17 | Ruud Klaver | 5. The {{{set_ESTABLISHED()}}} method is called. |
1222 | 17 | Ruud Klaver | 6. The {{{set_INIT()}}} method is called while the object is in the {{{LOCAL}}} or {{{ESTABLISHED}}} state. |
1223 | 17 | Ruud Klaver | 7. A method is called on the application, but in the meantime the {{{Engine}}} has stopped. |
1224 | 17 | Ruud Klaver | The object can no longer be used. |
1225 | 17 | Ruud Klaver | 8. There was an error in getting the STUN candidates from the STUN server. |
1226 | 1 | Adrian Georgescu | |
1227 | 1 | Adrian Georgescu | > 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 negotation has failed. |
1228 | 1 | Adrian Georgescu | > This means that the RTPTransport object is also unusable once it has reached the STUN_FAILED state. |
1229 | 1 | Adrian Georgescu | > A workaround would be destroy the RTPTransport object and create a new one that uses ICE without STUN. |
1230 | 1 | Adrian Georgescu | |
1231 | 1 | Adrian Georgescu | These states allow for two SDP negotiation scenarios to occur, represented by two paths that can be followed through the state machine. |
1232 | 1 | Adrian Georgescu | In this example we will assume that ICE with STUN is not used, as it is independent of the SDP negotiation procedure. |
1233 | 1 | Adrian Georgescu | * The first scenario is where the local party generates the SDP offer. |
1234 | 1 | Adrian Georgescu | For a stream that it wishes to include in this SDP offer, it instantiates a {{{RTPTransport}}} object. |
1235 | 17 | Ruud Klaver | 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}}} respectively, which can be used to generate the local SDP in the form of a {{{SDPSession}}} object (note that it needs the full object, not just the relevant {{{SDPMedia}}} object). |
1236 | 1 | Adrian Georgescu | This local SDP then needs to be passed to the {{{set_LOCAL()}}} method, which moves the state machine into the {{{LOCAL}}} state. |
1237 | 1 | Adrian Georgescu | Depending on the options used for the {{{RTPTransport}}} instantiation (such as ICE and SRTP), this may change the {{{SDPSession}}} object. |
1238 | 1 | Adrian Georgescu | This (possibly changed) {{{SDPSession}}} object then needs to be passed to the {{{Invitation}}} object. |
1239 | 1 | Adrian Georgescu | After SDP negotiation is completed, the application needs to pass both the local and remote SDP, in the form of {{{SDPSession}}} objects, to the {{{RTPTransport}}} object using the {{{set_ESTABLISHED()}}} method, moving the state machine into the {{{ESTABLISHED}}} state. |
1240 | 1 | Adrian Georgescu | This will not change either of the {{{SDPSession}}} objects. |
1241 | 1 | Adrian Georgescu | * The second scenario is where the local party is offered a media stream in SDP and wants to accept it. |
1242 | 17 | Ruud Klaver | 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. |
1243 | 1 | Adrian Georgescu | 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. |
1244 | 1 | Adrian Georgescu | In this case the local SDP object may be changed, after which it can be passed to the {{{Invitation}}} object. |
1245 | 1 | Adrian Georgescu | |
1246 | 1 | Adrian Georgescu | 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. |
1247 | 1 | Adrian Georgescu | Before doing this however, the internal transport object must no longer be in use. |
1248 | 1 | Adrian Georgescu | |
1249 | 1 | Adrian Georgescu | ==== attributes ==== |
1250 | 1 | Adrian Georgescu | |
1251 | 1 | Adrian Georgescu | '''state''':: |
1252 | 1 | Adrian Georgescu | Indicates which state the internal state machine is in. |
1253 | 1 | Adrian Georgescu | See the previous section for a list of states the state machine can be in. |
1254 | 1 | Adrian Georgescu | This attribute is read-only. |
1255 | 1 | Adrian Georgescu | '''local_rtp_address''':: |
1256 | 45 | Ruud Klaver | The local IPv4 address of the interface the {{{RTPTransport}}} object is listening on and the address that should be included in the SDP. |
1257 | 1 | Adrian Georgescu | If no address was specified during object instantiation, PJSIP will take guess out of the IP addresses of all interfaces. |
1258 | 1 | Adrian Georgescu | This attribute is read-only and will be {{{None}}} if PJSIP is not listening on the transport. |
1259 | 1 | Adrian Georgescu | '''local_rtp_port''':: |
1260 | 1 | Adrian Georgescu | The UDP port PJSIP is listening on for RTP traffic. |
1261 | 1 | Adrian Georgescu | RTCP traffic will always be this port plus one. |
1262 | 1 | Adrian Georgescu | This attribute is read-only and will be {{{None}}} if PJSIP is not listening on the transport. |
1263 | 1 | Adrian Georgescu | '''remote_rtp_address_sdp''':: |
1264 | 1 | Adrian Georgescu | The remote IP address that was seen in the SDP. |
1265 | 1 | Adrian Georgescu | This attribute is read-only and will be {{{None}}} unless the object is in the {{{ESTABLISHED}}} state. |
1266 | 1 | Adrian Georgescu | '''remote_rtp_port_sdp''':: |
1267 | 1 | Adrian Georgescu | The remote UDP port for RTP that was seen in the SDP. |
1268 | 1 | Adrian Georgescu | This attribute is read-only and will be {{{None}}} unless the object is in the {{{ESTABLISHED}}} state. |
1269 | 1 | Adrian Georgescu | '''remote_rtp_address_received''':: |
1270 | 1 | Adrian Georgescu | The remote IP address from which RTP data was received. |
1271 | 1 | Adrian Georgescu | This attribute is read-only and will be {{{None}}} unless RTP was actually received. |
1272 | 1 | Adrian Georgescu | '''remote_rtp_port_received''':: |
1273 | 1 | Adrian Georgescu | The remote UDP port from which RTP data was received. |
1274 | 1 | Adrian Georgescu | This attribute is read-only and will be {{{None}}} unless RTP was actually received. |
1275 | 1 | Adrian Georgescu | '''use_srtp''':: |
1276 | 1 | Adrian Georgescu | A boolean indicating if the use of SRTP was requested when the object was instantiated. |
1277 | 1 | Adrian Georgescu | This attribute is read-only. |
1278 | 1 | Adrian Georgescu | '''force_srtp''':: |
1279 | 1 | Adrian Georgescu | A boolean indicating if SRTP being mandatory for this transport if it is enabled was requested when the object was instantiated. |
1280 | 1 | Adrian Georgescu | This attribute is read-only. |
1281 | 1 | Adrian Georgescu | '''srtp_active''':: |
1282 | 1 | Adrian Georgescu | A boolean indicating if SRTP encryption and decryption is running. |
1283 | 1 | Adrian Georgescu | Querying this attribute only makes sense once the object is in the {{{ESTABLISHED}}} state and use of SRTP was requested. |
1284 | 1 | Adrian Georgescu | This attribute is read-only. |
1285 | 1 | Adrian Georgescu | '''use_ice''':: |
1286 | 1 | Adrian Georgescu | A boolean indicating if the use of ICE was requested when the object was instantiated. |
1287 | 1 | Adrian Georgescu | This attribute is read-only. |
1288 | 1 | Adrian Georgescu | '''ice_stun_address''':: |
1289 | 19 | Ruud Klaver | A string indicating the IP address of the STUN server that was requested to be used. |
1290 | 1 | Adrian Georgescu | This attribute is read-only. |
1291 | 1 | Adrian Georgescu | '''ice_stun_port''':: |
1292 | 1 | Adrian Georgescu | A string indicating the UDP port of the STUN server that was requested to be used. |
1293 | 1 | Adrian Georgescu | This attribute is read-only. |
1294 | 1 | Adrian Georgescu | |
1295 | 1 | Adrian Georgescu | ==== methods ==== |
1296 | 1 | Adrian Georgescu | |
1297 | 1 | Adrian Georgescu | '''!__init!__'''(''self'', '''local_rtp_address'''={{{None}}}, '''use_srtp'''={{{False}}}, '''srtp_forced'''={{{False}}}, '''use_ice'''={{{False}}}, '''ice_stun_address'''={{{None}}}, '''ice_stun_port'''=3478):: |
1298 | 1 | Adrian Georgescu | Creates a new {{{RTPTransport}}} object and opens the RTP and RTCP UDP sockets. |
1299 | 1 | Adrian Georgescu | If aditional features are requested, they will be initialized. |
1300 | 1 | Adrian Georgescu | 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. |
1301 | 1 | Adrian Georgescu | [[BR]]''local_rtp_address'':[[BR]] |
1302 | 45 | Ruud Klaver | Optionally contains the local IPv4 address to listen on. |
1303 | 1 | Adrian Georgescu | If this is not specified, PJSIP will listen on all network interfaces. |
1304 | 1 | Adrian Georgescu | [[BR]]''use_srtp'':[[BR]] |
1305 | 1 | Adrian Georgescu | A boolean indicating if SRTP should be used. |
1306 | 1 | Adrian Georgescu | If this is set to {{{True}}}, SRTP information will be added to the SDP when it passes this object. |
1307 | 1 | Adrian Georgescu | [[BR]]''srtp_forced'':[[BR]] |
1308 | 1 | Adrian Georgescu | A boolean indicating if use of SRTP is set to mandatory in the SDP. |
1309 | 1 | Adrian Georgescu | If this is set to {{{True}}} and the remote party does not support SRTP, the SDP negotation for this stream will fail. |
1310 | 1 | Adrian Georgescu | This argument is relevant only if {{{use_srtp}}} is set to {{{True}}}. |
1311 | 1 | Adrian Georgescu | [[BR]]''use_ice'':[[BR]] |
1312 | 1 | Adrian Georgescu | A boolean indicating if ICE should be used. |
1313 | 1 | Adrian Georgescu | If this is set to {{{True}}}, ICE candidates will be added to the SDP when it passes this object. |
1314 | 1 | Adrian Georgescu | [[BR]]''ice_stun_address'':[[BR]] |
1315 | 1 | Adrian Georgescu | 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. |
1316 | 1 | Adrian Georgescu | 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. |
1317 | 29 | Luci Stanescu | When this happens a {{{RTPTransportGotSTUNResponse}}} notification is sent. |
1318 | 1 | Adrian Georgescu | This argument is relevant only if {{{use_ice}}} is set to {{{True}}}. |
1319 | 1 | Adrian Georgescu | [[BR]]''ice_stun_address'':[[BR]] |
1320 | 1 | Adrian Georgescu | An int indicating the UDP port of the STUN server that should be used to add a STUN candidate to the ICE candidates. |
1321 | 1 | Adrian Georgescu | This argument is relevant only if {{{use_ice}}} is set to {{{True}}} and {{{ice_stun_address}}} is not {{{None}}}. |
1322 | 34 | Ruud Klaver | '''set_INIT'''(''self''):: |
1323 | 34 | Ruud Klaver | This moves the internal state machine into the {{{INIT}}} state. |
1324 | 34 | Ruud Klaver | If the state machine is in the {{{LOCAL}}} or {{{ESTABLISHED}}} states, this effectively resets the {{{RTPTransport}}} object for re-use. |
1325 | 34 | Ruud Klaver | '''set_LOCAL'''(''self'', '''local_sdp''', '''sdp_index'''):: |
1326 | 1 | Adrian Georgescu | This moves the the internal state machine into the {{{LOCAL}}} state. |
1327 | 1 | Adrian Georgescu | [[BR]]''local_sdp'':[[BR]] |
1328 | 1 | Adrian Georgescu | The local SDP to be proposed in the form of a {{{SDPSession}}} object. |
1329 | 1 | Adrian Georgescu | Note that this object may be modified by this method. |
1330 | 1 | Adrian Georgescu | [[BR]]''sdp_index'':[[BR]] |
1331 | 1 | Adrian Georgescu | The index in the SDP for the media stream for which this object was created. |
1332 | 34 | Ruud Klaver | '''set_ESTABLISHED'''(''self'', '''local_sdp''', '''remote_sdp''', '''sdp_index'''):: |
1333 | 1 | Adrian Georgescu | This moves the the internal state machine into the {{{ESTABLISHED}}} state. |
1334 | 1 | Adrian Georgescu | [[BR]]''local_sdp'':[[BR]] |
1335 | 1 | Adrian Georgescu | The local SDP to be proposed in the form of a {{{SDPSession}}} object. |
1336 | 1 | Adrian Georgescu | Note that this object may be modified by this method, but only when moving from the {{{LOCAL}}} to the {{{ESTABLISHED}}} state. |
1337 | 1 | Adrian Georgescu | [[BR]]''remote_sdp'':[[BR]] |
1338 | 1 | Adrian Georgescu | The remote SDP that was received in in the form of a {{{SDPSession}}} object. |
1339 | 17 | Ruud Klaver | [[BR]]''sdp_index'':[[BR]] |
1340 | 17 | Ruud Klaver | The index in the SDP for the media stream for which this object was created. |
1341 | 1 | Adrian Georgescu | |
1342 | 1 | Adrian Georgescu | ==== notifications ==== |
1343 | 1 | Adrian Georgescu | |
1344 | 29 | Luci Stanescu | '''RTPTransportDidInitialize''':: |
1345 | 17 | Ruud Klaver | This notification is sent when a {{{RTPTransport}}} object has successfully initialized. |
1346 | 17 | Ruud Klaver | If STUN+ICE is not requested, this is sent immediately on {{{set_INIT()}}}, otherwise it is sent after the STUN query has succeeded. |
1347 | 1 | Adrian Georgescu | [[BR]]''timestamp'':[[BR]] |
1348 | 1 | Adrian Georgescu | A {{{datetime.datetime}}} object indicating when the notification was sent. |
1349 | 29 | Luci Stanescu | '''RTPTransportDidFail''':: |
1350 | 17 | Ruud Klaver | This notification is sent by a {{{RTPTransport}}} object that fails to retrieve ICE candidates from the STUN server after {{{set_INIT()}}} is called. |
1351 | 17 | Ruud Klaver | [[BR]]''timestamp'':[[BR]] |
1352 | 17 | Ruud Klaver | A {{{datetime.datetime}}} object indicating when the notification was sent. |
1353 | 17 | Ruud Klaver | [[BR]]''reason'':[[BR]] |
1354 | 17 | Ruud Klaver | A string describing the failure reason. |
1355 | 1 | Adrian Georgescu | |
1356 | 1 | Adrian Georgescu | === AudioTransport === |
1357 | 1 | Adrian Georgescu | |
1358 | 1 | Adrian Georgescu | This object represent an audio stream as it is transported over the network. |
1359 | 1 | Adrian Georgescu | 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. |
1360 | 1 | Adrian Georgescu | It also generates a {{{SDPMedia}}} object to be included in the local SDP. |
1361 | 1 | Adrian Georgescu | |
1362 | 1 | Adrian Georgescu | Like the {{{RTPTransport}}} object there are two usage scenarios. |
1363 | 1 | Adrian Georgescu | * In the first scenario, only the {{{RTPTransport}}} instance to be used is passed to the AudioTransport object. |
1364 | 1 | Adrian Georgescu | The application can then generate the {{{SDPMedia}}} object by calling the {{{get_local_media()}}} method and should include it in the SDP offer. |
1365 | 1 | Adrian Georgescu | 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. |
1366 | 1 | Adrian Georgescu | The stream can then be connected to the conference bridge. |
1367 | 1 | Adrian Georgescu | * 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. |
1368 | 1 | Adrian Georgescu | The local {{{SDPMedia}}} object can again be generated by calling the {{{get_local_media()}}} method and is to be included in the SDP answer. |
1369 | 1 | Adrian Georgescu | The audio stream is started directly when the object is created. |
1370 | 1 | Adrian Georgescu | |
1371 | 1 | Adrian Georgescu | Unlike the {{{RTPTransport}}} object, this object cannot be reused. |
1372 | 1 | Adrian Georgescu | |
1373 | 1 | Adrian Georgescu | ==== attributes ==== |
1374 | 1 | Adrian Georgescu | |
1375 | 1 | Adrian Georgescu | '''transport''':: |
1376 | 1 | Adrian Georgescu | The {{{RTPTransport}}} object that was passed when the object got instatiated. |
1377 | 1 | Adrian Georgescu | This attribute is read-only. |
1378 | 1 | Adrian Georgescu | '''is_active''':: |
1379 | 1 | Adrian Georgescu | A boolean indicating if the object is currently sending and receiving audio. |
1380 | 1 | Adrian Georgescu | This attribute is read-only. |
1381 | 1 | Adrian Georgescu | '''is_started''':: |
1382 | 1 | Adrian Georgescu | A boolean indicating if the object has been started. |
1383 | 1 | Adrian Georgescu | 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. |
1384 | 1 | Adrian Georgescu | This is to prevent the object from being re-used. |
1385 | 1 | Adrian Georgescu | This attribute is read-only. |
1386 | 1 | Adrian Georgescu | '''codec''':: |
1387 | 1 | Adrian Georgescu | Once the SDP negotiation is complete, this attribute indicates the audio codec that was negotiated, otherwise it will be {{{None}}}. |
1388 | 1 | Adrian Georgescu | This attribute is read-only. |
1389 | 1 | Adrian Georgescu | '''sample_rate''':: |
1390 | 1 | Adrian Georgescu | Once the SDP negotiation is complete, this attribute indicates the sample rate of the audio codec that was negotiated, otherwise it will be {{{None}}}. |
1391 | 1 | Adrian Georgescu | This attribute is read-only. |
1392 | 1 | Adrian Georgescu | '''direction''':: |
1393 | 1 | Adrian Georgescu | The current direction of the audio transport, which is one of "sendrecv", "sendonly", "recvonly" or "inactive". |
1394 | 1 | Adrian Georgescu | This attribute is read-only, although it can be set using the {{{update_direction()}}} method. |
1395 | 1 | Adrian Georgescu | |
1396 | 1 | Adrian Georgescu | ==== methods ==== |
1397 | 1 | Adrian Georgescu | |
1398 | 40 | Ruud Klaver | '''!__init!__'''(''self'', '''transport''', '''remote_sdp'''={{{None}}}, '''sdp_index'''=0, '''enable_silence_detection'''=True, '''codecs'''={{{None}}}):: |
1399 | 1 | Adrian Georgescu | Creates a new {{{AudioTransport}}} object and start the underlying stream if the remote SDP is already known. |
1400 | 1 | Adrian Georgescu | [[BR]]''transport'':[[BR]] |
1401 | 1 | Adrian Georgescu | The transport to use in the form of a {{{RTPTransport}}} object. |
1402 | 1 | Adrian Georgescu | [[BR]]''remote_sdp'':[[BR]] |
1403 | 1 | Adrian Georgescu | The remote SDP that was received in the form of a {{{SDPSession}}} object. |
1404 | 1 | Adrian Georgescu | [[BR]]''sdp_index'':[[BR]] |
1405 | 1 | Adrian Georgescu | The index within the SDP of the audio stream that should be created. |
1406 | 1 | Adrian Georgescu | [[BR]]''enable_silence_detection''[[BR]] |
1407 | 1 | Adrian Georgescu | Boolean that indicates if silence detection should be used for this audio stream. |
1408 | 1 | Adrian Georgescu | When enabled, this {{{AudioTransport}}} object will stop sending audio to the remote party if the input volume is below a certain threshold. |
1409 | 40 | Ruud Klaver | [[BR]]''codecs''[[BR]] |
1410 | 40 | Ruud Klaver | A list of strings indicating the codecs that should be proposed in the SDP of this {{{AudioTransport}}}, in order of preference. |
1411 | 40 | Ruud Klaver | This overrides the global codecs list set on the {{{Engine}}}. |
1412 | 40 | Ruud Klaver | The values of this list are case insensitive. |
1413 | 1 | Adrian Georgescu | '''get_local_media'''(''self'', '''is_offer''', '''direction'''="sendrecv"):: |
1414 | 1 | Adrian Georgescu | Generates a {{{SDPMedia}}} object which describes the audio stream. |
1415 | 1 | Adrian Georgescu | This object should be included in a {{{SDPSession}}} object that gets passed to the {{{Invitation}}} object. |
1416 | 1 | Adrian Georgescu | This method should also be used to obtain the SDP to include in re-INVITEs and replies to re-INVITEs. |
1417 | 1 | Adrian Georgescu | [[BR]]''is_offer'':[[BR]] |
1418 | 1 | Adrian Georgescu | A boolean indicating if the SDP requested is to be included in an offer. |
1419 | 1 | Adrian Georgescu | If this is {{{False}}} it is to be included in an answer. |
1420 | 1 | Adrian Georgescu | [[BR]]''direction'':[[BR]] |
1421 | 1 | Adrian Georgescu | The direction attribute to put in the SDP. |
1422 | 1 | Adrian Georgescu | '''start'''(''self'', '''local_sdp''', '''remote_sdp''', '''sdp_index'''):: |
1423 | 1 | Adrian Georgescu | This method should only be called once, when the application has previously sent an SDP offer and the answer has been received. |
1424 | 1 | Adrian Georgescu | [[BR]]''local_sdp'':[[BR]] |
1425 | 1 | Adrian Georgescu | The full local SDP that was included in the SDP negotiation in the form of a {{{SDPSession}}} object. |
1426 | 1 | Adrian Georgescu | [[BR]]''remote_sdp'':[[BR]] |
1427 | 1 | Adrian Georgescu | The remote SDP that was received in the form of a {{{SDPSession}}} object. |
1428 | 1 | Adrian Georgescu | [[BR]]''sdp_index'':[[BR]] |
1429 | 1 | Adrian Georgescu | The index within the SDP of the audio stream. |
1430 | 1 | Adrian Georgescu | '''stop'''(''self''):: |
1431 | 1 | Adrian Georgescu | This method stops and destroys the audio stream encapsulated by this object. |
1432 | 1 | Adrian Georgescu | 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. |
1433 | 1 | Adrian Georgescu | 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. |
1434 | 1 | Adrian Georgescu | '''send_dtmf'''(''self'', '''digit'''):: |
1435 | 1 | Adrian Georgescu | For a negotiated audio transport this sends one DTMF digit to the other party |
1436 | 1 | Adrian Georgescu | [[BR]]''digit'':[[BR]] |
1437 | 1 | Adrian Georgescu | A string of length one indicating the DTMF digit to send. |
1438 | 1 | Adrian Georgescu | This can be either a number or letters A through D. |
1439 | 1 | Adrian Georgescu | '''update_direction'''(''self'', '''direction'''):: |
1440 | 1 | Adrian Georgescu | This method should be called after SDP negotiation has completed to update the direction of the media stream. |
1441 | 1 | Adrian Georgescu | [[BR]]''direction'':[[BR]] |
1442 | 1 | Adrian Georgescu | The direction that has been negotiated. |
1443 | 1 | Adrian Georgescu | |
1444 | 1 | Adrian Georgescu | ==== notifications ==== |
1445 | 1 | Adrian Georgescu | |
1446 | 29 | Luci Stanescu | '''RTPAudioTransportGotDTMF''':: |
1447 | 1 | Adrian Georgescu | This notification will be sent when an incoming DTMF digit is received from the remote party. |
1448 | 1 | Adrian Georgescu | [[BR]]''timestamp'':[[BR]] |
1449 | 1 | Adrian Georgescu | A {{{datetime.datetime}}} object indicating when the notification was sent. |
1450 | 1 | Adrian Georgescu | [[BR]]''digit'':[[BR]] |
1451 | 1 | Adrian Georgescu | The DTMF digit that was received, in the form of a string of length one. |
1452 | 1 | Adrian Georgescu | This can be either a number or letters A through D. |
1453 | 1 | Adrian Georgescu | |
1454 | 1 | Adrian Georgescu | === WaveFile === |
1455 | 1 | Adrian Georgescu | |
1456 | 1 | Adrian Georgescu | This is a simple object that allows playing back of a {{{.wav}}} file over the PJSIP conference bridge, possibly looping a number of times. |
1457 | 1 | Adrian Georgescu | Only 16-bit PCM and A-law/U-law formats are supported. |
1458 | 1 | Adrian Georgescu | Its main purpose is the playback of ringtones. |
1459 | 1 | Adrian Georgescu | |
1460 | 1 | Adrian Georgescu | This class can be instantiated by the application before the {{{Engine}}} is running, but in order to actually start playback, through the {{{start()}}} method, the {{{Engine}}} must have been started as well. |
1461 | 1 | Adrian Georgescu | Once the {{{start()}}} method is called, the {{{.wav}}} file will continue playing until the loop count specified is reached( or forever if the specified loop count is 0), or until the {{{stop()}}} method is called. |
1462 | 29 | Luci Stanescu | When playback stops for either of these reasons, a {{{WaveFileDidFinishPlaying}}} notification is sent by the object. |
1463 | 1 | Adrian Georgescu | After this the {{{start()}}} method may be called again in order to re-use the object. |
1464 | 1 | Adrian Georgescu | |
1465 | 1 | Adrian Georgescu | It is the application's responsibility to keep a reference to the {{{WaveFile}}} object for the duration of playback. |
1466 | 1 | Adrian Georgescu | If the reference count of the object reaches 0, playback will be stopped. |
1467 | 1 | Adrian Georgescu | In this case no notification will be sent. |
1468 | 1 | Adrian Georgescu | |
1469 | 1 | Adrian Georgescu | ==== attributes ==== |
1470 | 1 | Adrian Georgescu | |
1471 | 1 | Adrian Georgescu | '''file_name''':: |
1472 | 1 | Adrian Georgescu | The name of the {{{.wav}}} file, as specified when the object was created. |
1473 | 1 | Adrian Georgescu | '''is_active''':: |
1474 | 1 | Adrian Georgescu | A boolean read-only property that indicates if the file is currently being played back. |
1475 | 1 | Adrian Georgescu | Note that if the playback loop is currently in a pause between playbacks, this attribute will also be {{{True}}}. |
1476 | 1 | Adrian Georgescu | |
1477 | 1 | Adrian Georgescu | ==== methods ==== |
1478 | 1 | Adrian Georgescu | |
1479 | 1 | Adrian Georgescu | '''!__init!__'''(''self'', '''file_name'''):: |
1480 | 1 | Adrian Georgescu | Creates a new {{{WaveFile}}} object. |
1481 | 1 | Adrian Georgescu | [[BR]]''file_name'':[[BR]] |
1482 | 1 | Adrian Georgescu | The name of the {{{.wav}}} file to be played back as a string. |
1483 | 1 | Adrian Georgescu | This should include the full path to the file. |
1484 | 1 | Adrian Georgescu | '''start'''(''self'', '''level'''=100, '''loop_count'''=1, '''pause_time'''=0):: |
1485 | 1 | Adrian Georgescu | Start playback of the {{{.wav}}} file, optionally looping it. |
1486 | 1 | Adrian Georgescu | [[BR]]''level'':[[BR]] |
1487 | 1 | Adrian Georgescu | The level to play the file back at, in percentage. |
1488 | 1 | Adrian Georgescu | A percentage lower than 100 means playback will be attenuated, a percentage higher than 100 means it will amplified. |
1489 | 1 | Adrian Georgescu | [[BR]]''loop_count'':[[BR]] |
1490 | 1 | Adrian Georgescu | The number of time to loop playing this file. |
1491 | 1 | Adrian Georgescu | A value of 0 means looping infinitely. |
1492 | 1 | Adrian Georgescu | [[BR]]''pause_time'':[[BR]] |
1493 | 1 | Adrian Georgescu | The number of seconds to pause between consecutive loops. |
1494 | 1 | Adrian Georgescu | This can be either an int or a float. |
1495 | 1 | Adrian Georgescu | '''stop'''(''self''):: |
1496 | 1 | Adrian Georgescu | Stop playback of the file. |
1497 | 1 | Adrian Georgescu | |
1498 | 1 | Adrian Georgescu | ==== notifications ==== |
1499 | 1 | Adrian Georgescu | |
1500 | 29 | Luci Stanescu | '''WaveFileDidFinishPlaying''':: |
1501 | 1 | Adrian Georgescu | This notification will be sent whenever the {{{.wav}}} file has been played back the specified number of times. |
1502 | 1 | Adrian Georgescu | After sending this event, the playback may be re-started. |
1503 | 1 | Adrian Georgescu | [[BR]]''timestamp'':[[BR]] |
1504 | 1 | Adrian Georgescu | A {{{datetime.datetime}}} object indicating when the notification was sent. |
1505 | 1 | Adrian Georgescu | |
1506 | 1 | Adrian Georgescu | === RecordingWaveFile === |
1507 | 1 | Adrian Georgescu | |
1508 | 1 | Adrian Georgescu | This is a simple object that allows recording whatever is heard on the PJSIP conference bridge to a PCM {{{.wav}}} file. |
1509 | 1 | Adrian Georgescu | |
1510 | 1 | Adrian Georgescu | This class can be instantiated by the application before the {{{Engine}}} is running, but in order to actually start playback, through the {{{start()}}} method, the {{{Engine}}} must have been started as well. |
1511 | 1 | Adrian Georgescu | Recording to the file can be stopped either by calling the {{{stop()}}} method or by removing all references to the object. |
1512 | 1 | Adrian Georgescu | Once the {{{stop()}}} method has been called, the {{{start()}}} method may not be called again. |
1513 | 1 | Adrian Georgescu | It is the application's responsibility to keep a reference to the {{{RecordingWaveFile}}} object for the duration of the recording. |
1514 | 1 | Adrian Georgescu | |
1515 | 1 | Adrian Georgescu | ==== attributes ==== |
1516 | 1 | Adrian Georgescu | |
1517 | 1 | Adrian Georgescu | '''file_name''':: |
1518 | 15 | Ruud Klaver | The name of the {{{.wav}}} file, as specified when the object was created. |
1519 | 15 | Ruud Klaver | '''is_active''':: |
1520 | 15 | Ruud Klaver | A boolean read-only attribute that indicates if the file is currently being written to. |
1521 | 1 | Adrian Georgescu | '''is_paused''':: |
1522 | 1 | Adrian Georgescu | A boolean read-only attribute that indicates if the active recording is currently paused. |
1523 | 1 | Adrian Georgescu | |
1524 | 1 | Adrian Georgescu | ==== methods ==== |
1525 | 1 | Adrian Georgescu | |
1526 | 1 | Adrian Georgescu | '''!__init!__'''(''self'', '''file_name'''):: |
1527 | 1 | Adrian Georgescu | Creates a new {{{RecordingWaveFile}}} object. |
1528 | 1 | Adrian Georgescu | [[BR]]''file_name'':[[BR]] |
1529 | 1 | Adrian Georgescu | The name of the {{{.wav}}} file to record to as a string. |
1530 | 1 | Adrian Georgescu | This should include the full path to the file. |
1531 | 15 | Ruud Klaver | '''start'''(''self''):: |
1532 | 15 | Ruud Klaver | Start recording the sound on the conference bridge to the {{{.wav}}} file. |
1533 | 15 | Ruud Klaver | '''pause'''(''self''):: |
1534 | 15 | Ruud Klaver | Pause recording to the {{{.wav}}} file. |
1535 | 1 | Adrian Georgescu | '''resume'''(''self''):: |
1536 | 1 | Adrian Georgescu | Resume a previously paused recording. |
1537 | 1 | Adrian Georgescu | '''stop'''(''self''):: |
1538 | 1 | Adrian Georgescu | Stop recording to the file. |