Project

General

Profile

ODF » History » Version 7

Adrian Georgescu, 11/04/2014 01:14 PM

1 1 Adrian Georgescu
h1. ODF integration
2
3 5 Adrian Georgescu
This documents layout the changes required to support a new type of stream for collaborative editing.
4 1 Adrian Georgescu
5 6 Adrian Georgescu
h2. SDK changes
6 1 Adrian Georgescu
7 6 Adrian Georgescu
h3. Signaling
8
9 1 Adrian Georgescu
There is no need to alter anything related to signalling.
10
11 6 Adrian Georgescu
h3. Media
12 1 Adrian Georgescu
13 7 Adrian Georgescu
h4. Variant 1
14
15
This by far the simplest way. Establish a standard chat stream and add _'application/odf+xml'_ to the lists of supported payloads.
16
17
h4. Variant 2
18
19 2 Adrian Georgescu
A new MSRP media type can be created similar to file-transfer or screen sharing. See SIP SIMPLE Client SDK MSRP streams definition:
20
21 1 Adrian Georgescu
<pre>
22
sipsimple/streams/msrp.py
23
</pre>
24
25 7 Adrian Georgescu
Example of a new type of stream
26 3 Adrian Georgescu
27
<pre>
28
class ODFStream(MSRPStreamBase):
29
    type = 'odf'
30
31
    media_type = 'odf'
32
    accept_types = ['application/odf+xml']
33
    accept_wrapped_types = ['*']
34
</pre>
35 1 Adrian Georgescu
36
Once established, the MSRP stream can cary back and forth payloads of the types specified in the stream definition. Is up to the end-points to handle the actual payloads and match various files shared through this mechanism over the same session. The SIP session id can be used to group together various flows within the same stream.
37 7 Adrian Georgescu
38 1 Adrian Georgescu
39 6 Adrian Georgescu
h3. Presence
40 1 Adrian Georgescu
41
The end-points supporting this feature will advertise this capability by publishing it using SIP SIMPLE Presence. For this the end-point capabilities must be extended to support off.
42
43
<pre>
44
sipsimple/payloads/caps.py
45 4 Adrian Georgescu
</pre>
46 6 Adrian Georgescu
47
h2. GUI changes
48
49
The GUI must handle sessions for incoming and outgoing media stream defined above by creating its own controller.