Methods
SetSending | (b: Send) | → | nothing | |
RequestReceiving | (u: Contact, b: Receive) | → | nothing |
Signals
RemoteMembersChanged | (a{uu}: Updates, au: Removed) | |
LocalSendingStateChanged | (u: State) |
Properties
Interfaces | as (DBus_Interface_List) | Read only | Immutable | |
RemoteMembers | a{uu} (Contact_Sending_State_Map) | Read only | ||
LocalSendingState | u (Sending_State) | Read only | ||
CanRequestReceiving | b | Read only | Immutable |
Types
Sending_State | Enum | u | |
Contact_Sending_State_Map | Mapping | a{uu} |
Description
Methods
SetSending (b: Send) → nothing
Parameters
- Send — b
If True, the LocalSendingState should change to Sending_State_Sending, if it isn't already.
If False, the LocalSendingState should change to Sending_State_None, if it isn't already.
Possible Errors
- Not Implemented
RequestReceiving (u: Contact, b: Receive) → nothing
Parameters
- Contact — u (Contact_Handle)
- Receive — b
Contact from which sending is requested
If true, request that the given contact starts to send media. If false, request that the given contact stops sending media.
Request that a remote contact stops or starts sending on this stream.
The CanRequestReceiving property defines whether the protocol allows the local user to request the other side start sending on this stream.
Possible Errors
- Invalid Handle
- Invalid Argument
- Not Implemented
Signals
RemoteMembersChanged (a{uu}: Updates, au: Removed)
Parameters
- Updates — a{uu} (Contact_Sending_State_Map)
- Removed — au (Contact_Handle_List)
LocalSendingStateChanged (u: State)
Parameters
- State — u (Sending_State)
Properties
Interfaces — as (DBus_Interface_List)
Extra interfaces provided by this stream, such as Stream.Interface.Media.DRAFT. This SHOULD NOT include the Stream interface itself, and cannot change once the stream has been created.
RemoteMembers — a{uu} (Contact_Sending_State_Map)
A map from remote contacts to their sending state. The local user's sending state is shown in LocalSendingState.
Sending_State_Pending_Send indicates that another contact has asked the local user to send media.
Other contacts' handles in this map indicate whether they are sending media to the contacts in this stream. Sending_State_Pending_Send indicates contacts who are not sending but have been asked to do so.
LocalSendingState — u (Sending_State)
The local user's sending state. Media sent on this stream should be assumed to be received, directly or indirectly, by every other contact in the RemoteMembers mapping. Change notification is given via the LocalSendingStateChanged signal.
Rationale:
A value of Sending_State_Pending_Send for this property indicates that the other side requested the local user start sending media, which can be done by calling SetSending. When a call is accepted, all initial contents with streams that have a local sending state of Sending_State_Pending_Send are automatically set to sending. For example, on an incoming call it means you need to Accept to start the actual call, on an outgoing call it might mean you need to call Accept before actually starting the call.
CanRequestReceiving — b
If true, the user can request that a remote contact starts sending on this stream.
Rationale:
Types
Sending_State — u
- None (0)
- Pending_Send (1)
- Sending (2)
- Pending_Stop_Sending (3)
Contact_Sending_State_Map — a{uu}
- Contact — u (Contact_Handle)
- Sending — u (Sending_State)