Interface Channel.Interface.Splittable

Interface Index (Compact) | Summary | Description | Methods

Methods

Split () nothing
Added in 0.21.UNRELEASED. as stable API, with no changes
Objects implementing this interface must also implement:

Description

An interface for channels that can be made conceptually part of a Conference, and can then be detached from that conference. This is primarily intended for cellular calls, where conferences consist of several 1-1 calls which can be combined and later detached one by one. (Other services, such as PBXs, might have similar behaviour and could also implement this interface.)

A channel with this interface can be merged into an existing conference by calling MergeableConference.Merge on the existing conference. Once part of a conference call, the channel will appear in the conference channel's Channels property. To split it back out, call Split on the member channel.

Rationale:

This interface addresses part of freedesktop.org bug #24906 (GSM-compatible conference calls). GSM is currently the only protocol known to implement this; PBXs might implement it too.

Methods

(Permalink)

Split () → nothing

Request that this channel is removed from any Conference of which it is a part.

This implies that the media streams within the conference are put on hold and the media streams within the member channel leaving the conference are unheld.


Possible Errors