Interface Channel.Interface.CallState

Interface Index (Compact) | Summary | Description | Methods | Signals | Types

Methods

GetCallStates () → a{uu}: States

Signals

CallStateChanged (u: Contact, u: State)

Types

Channel_Call_State_Flags Flags u
Channel_Call_State_Map Mapping a{uu}
Added in 0.17.2.
Objects implementing this interface must also implement:

Description

An interface for streamed media channels that can indicate call progress or call states. The presence of this interface is no guarantee that call states will actually be signalled (for instance, SIP implementations are not guaranteed to generate status 180 Ringing, so a call can be accepted without the Ringing flag ever having been set; similarly, Jingle implementations are not guaranteed to send <ringing/>).

To notify the other participant in the call that they are on hold, see Hold.

Methods

(Permalink)

GetCallStates () → a{uu}: States

Returns

  • States — a{uu} (Channel_Call_State_Map)
    • The current call states. Participants where the call state flags would be 0 (all unset) may be omitted from this mapping.
Get the current call states for all contacts involved in this call.

Signals

(Permalink)

CallStateChanged (u: Contact, u: State)

Parameters

Emitted when the state of a member of the channel has changed.

Types

Flags (Permalink)

Channel_Call_State_Flags — u

A set of flags representing call states.
  • Ringing (1)
    • The contact has been alerted about the call but has not responded (e.g. 180 Ringing in SIP).
  • Queued (2)
    • The contact is temporarily unavailable, and the call has been placed in a queue (e.g. 182 Queued in SIP, or call-waiting in telephony).
  • Held (4)
    • The contact has placed the call on hold, and will not receive media from the local user or any other participants until they unhold the call again.
  • Forwarded (8)
    • The initiator of the call originally called a contact other than the current recipient of the call, but the call was then forwarded or diverted.
  • In_Progress (16)
    • Progress has been made in placing the outgoing call, but the destination contact may not have been made aware of the call yet (so the Ringing state is not appropriate). This corresponds to SIP's status code 183 Session Progress, and could be used when the outgoing call has reached a gateway, for instance.
  • Conference_Host (32)
    • Added in 0.19.UNRELEASED.
    This contact has merged this call into a conference. Note that GSM provides a notification when the remote party merges a call into a conference, but not when it is split out again; thus, this flag can only indicate that the call has been part of a conference at some point. If a GSM connection manager receives a notification that a call has been merged into a conference a second time, it SHOULD represent this by clearing and immediately re-setting this flag on the remote contact.
Mapping (Permalink)

Channel_Call_State_Map — a{uu}

A map from contacts to call states.