ODF integration¶

This documents layout the changes required to support a new type of stream for collaborative editing.

SDK changes¶

Signaling¶

There is no need to alter anything related to signalling.

Media¶

Variant 1¶

This by far the simplest way. Establish a standard chat stream and add 'application/odf+xml' to the lists of supported payloads.

Variant 2¶

A new MSRP media type can be created similar to file-transfer or screen sharing. See SIP SIMPLE Client SDK MSRP streams definition:

sipsimple/streams/msrp.py

Example of a new type of stream

class ODFStream(MSRPStreamBase):
    type = 'odf'

    media_type = 'odf'
    accept_types = ['application/odf+xml']
    accept_wrapped_types = ['*']

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.

Presence¶

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.

sipsimple/payloads/caps.py

GUI changes¶

The GUI must handle sessions for incoming and outgoing media stream defined above by creating its own controller.