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
- Contact — u (Contact_Handle)
- State — u (Channel_Call_State_Flags)
An integer handle for the contact.
The new state for this contact.
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)
- Queued (2)
- Held (4)
- Forwarded (8)
- In_Progress (16)
The contact has been alerted about the call but has not responded
(e.g. 180 Ringing in SIP).
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).
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.
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.
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.
Mapping (Permalink)
Channel_Call_State_Map — a{uu}
A map from contacts to call states.
- Contact — u (Contact_Handle)
- State — u (Channel_Call_State_Flags)
A contact involved in this call.
State flags for the given contact.