Interface Call.Stream.DRAFT

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

Methods

SetSending (b: Send) → nothing
RequestReceiving (u: Contact, b: Receive) → nothing

Signals

MembersChanged (a{uu}: Updates, au: Removed)

Properties

Interfaces as (DBus_Interface_List) Read only
Members a{uu} (Contact_Sending_State_Map) Read only
CanRequestReceiving b Read only

Types

Sending_State Enum u
Contact_Sending_State_Map Mapping a{uu}
WARNING: This interface is experimental and is likely to cause havoc to your API/ABI if bindings are generated. Do not include this interface in libraries that care about compatibility.
Added in 0.19.0. (draft 1)

Description

One stream inside a content FIXME, direction should be a mapping of contact -> (bool)sending ?

Methods

(Permalink)

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.

Set the stream to start or stop sending media from the local user to other contacts.

Possible Errors

(Permalink)

RequestReceiving (u: Contact, b: Receive) → nothing

Parameters

  • Contact — u (Contact_Handle)

    • Contact from which sending is requested

  • Receive — b

    • 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
    • The handle specified is unknown on this channel or connection.
  • Invalid Argument
    • The request contact is valid but is not involved in this stream.
  • Not Implemented
    • The protocol does not allow the local user to request the other side starts sending on this stream.

Signals

(Permalink)

MembersChanged (a{uu}: Updates, au: Removed)

Parameters

  • Updates — a{uu} (Contact_Sending_State_Map)
    • A mapping from channel-specific handles to their updated sending state, whose keys include at least the members who were added, and the members whose states changed.
  • Removed — au (Contact_Handle_List)
    • The channel-specific handles that were removed from the keys of the Members property, as a result of the contact leaving this stream
Emitted when Members changes.

Properties

Accessed using the org.freedesktop.DBus.Properties interface.
(Permalink)

Interfaces — as (DBus_Interface_List)

Read only
Added in 0.19.11.

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.

(Permalink)

Members — a{uu} (Contact_Sending_State_Map)

Read only

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 Members 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.

(Permalink)

CanRequestReceiving — b

Read only

If true, the user can request that a remote contact starts sending on this stream.

Rationale:
Not all protocols allow the user to ask the other side to start sending media.

Types

Enum (Permalink)

Sending_State — u

Tristate indicating whether a contact is sending media.
  • None (0)
    • The contact is not sending media and has not been asked to do so.
  • Pending_Send (1)
    • The contact has been asked to start sending media.
  • Sending (2)
    • The contact is sending media.
  • Pending_Stop_Sending (3)
    • The contact has been asked to stop sending media.
Mapping (Permalink)

Contact_Sending_State_Map — a{uu}

A map from contacts to their sending state.