Methods
SetSending | (b: Send) | → | nothing | |
RequestReceiving | (u: Contact, b: Receive) | → | nothing |
Signals
SendersChanged | (a{uu}: Updates, au: Removed) |
Properties
Senders | a{uu} (Contact_Sending_State_Map) | Read only |
Types
Sending_State | Enum | u | |
Contact_Sending_State_Map | Mapping | a{uu} |
Description
Methods
SetSending (b: Send) → nothing
Parameters
- Send — b
If true, the local user's sending state should change to Sending, if it isn't already.
If false, the local user's sending state should change to 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.
Possible Errors
- Not Implemented
Signals
SendersChanged (a{uu}: Updates, au: Removed)
Parameters
- Updates — a{uu} (Contact_Sending_State_Map)
- Removed — au (Contact_Handle_List)
Properties
Senders — a{uu} (Contact_Sending_State_Map)
A map from contacts to their sending state.
The local user's handle in this map (the Group.SelfHandle if the channel implements Group, or the Connection.SelfHandle otherwise) indicates whether the local user is sending media. Media sent on this stream should be assumed to be received, directly or indirectly, by every other contact in the Senders mapping. 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.
Types
Sending_State — u
- None (0)
- Pending_Send (1)
- Sending (2)
Contact_Sending_State_Map — a{uu}
- Contact — u (Contact_Handle)
- Sending — u (Sending_State)