Interface Call.Stream.Interface.Media.DRAFT

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

Methods

SetCredentials (s: Username, s: Password) → nothing
AddCandidates (a(usua{sv}): Candidates) → nothing
CandidatesPrepared () → nothing

Signals

LocalCandidatesAdded (a(usua{sv}): Candidates)
LocalCredentialsChanged (s: Username, s: Password)
RelayInfoChanged (aa{sv}: Relay_Info)
STUNServersChanged (a(sq): Servers)
ServerInfoRetrieved ()
EndpointsChanged (ao: Endpoints_Added, ao: Endpoints_Removed)
PleaseRestartICE ()

Properties

Transport u (Stream_Transport_Type) Read only Immutable
LocalCandidates a(usua{sv}) (Candidate_List) Read only
LocalCredentials (ss) (Stream_Credentials) Read only
STUNServers a(sq) (Socket_Address_IP_List) Read only
RelayInfo aa{sv} (String_Variant_Map_List) Read only
HasServerInfo b Read only
Endpoints ao Read only

Types

Stream_Component Enum u
Stream_Transport_Type Enum u
Candidate_Info Mapping a{sv}
Candidate Struct (usua{sv})
Stream_Credentials Struct (ss)
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)
Objects implementing this interface must also implement:

Description

[FIXME]

ICE restarts

If the RemoteCredentialsSet signal is fired during a call once it has been called before whilst setting up the call for initial use, and the credentials have changed, then there has been an ICE restart. In such a case, the CM SHOULD also empty the remote candidate list in the Endpoint.DRAFT.

If the CM does an ICE restart, then the PleaseRestartICE signal is emitted and the streaming implementation should then call SetCredentials again.

For more information on ICE restarts see RFC 5245 section 9.1.1.1

Methods

(Permalink)

SetCredentials (s: Username, s: Password) → nothing

Parameters

  • Username — s
    • The username to use when authenticating on the stream.
  • Password — s
    • The password to use when authenticating on the stream.

Used to set the username fragment and password for streams that have global credentials.

(Permalink)

AddCandidates (a(usua{sv}): Candidates) → nothing

Parameters

  • Candidates — a(usua{sv}) (Candidate_List)
    • The candidates to be added.
Add candidates to the LocalCandidates property and signal them to the remote contact(s).
(Permalink)

CandidatesPrepared () → nothing

This indicates to the CM that the initial batch of candidates has been added.

Signals

(Permalink)

LocalCandidatesAdded (a(usua{sv}): Candidates)

Parameters

  • Candidates — a(usua{sv}) (Candidate_List)
    • Candidates that have been added.
Emitted when local candidates are added to the LocalCandidates property.
(Permalink)

LocalCredentialsChanged (s: Username, s: Password)

Changed in 0.21.2. renamed from LocalCredentailsSet

Parameters

  • Username — s
  • Password — s
Emitted when the value of LocalCredentials changes.
(Permalink)

RelayInfoChanged (aa{sv}: Relay_Info)

Parameters

Emitted when the value of RelayInfo changes.
(Permalink)

STUNServersChanged (a(sq): Servers)

Parameters

Emitted when the value of STUNServers changes.
(Permalink)

ServerInfoRetrieved ()

Signals that the initial information about STUN and Relay servers has been retrieved, i.e. the HasServerInfo property is now true.

(Permalink)

EndpointsChanged (ao: Endpoints_Added, ao: Endpoints_Removed)

Parameters

  • Endpoints_Added — ao
    • Endpoints that were added.
  • Endpoints_Removed — ao
    • Endpoints that no longer exist.
Emitted when the Endpoints property changes.
(Permalink)

PleaseRestartICE ()

Emitted when the CM does an ICE restart to notify the streaming implementation that it should call SetCredentials again.

Properties

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

Transport — u (Stream_Transport_Type)

Read only
This property is immutable which means that it can never change.
The transport for this stream.
(Permalink)

LocalCandidates — a(usua{sv}) (Candidate_List)

Read only
[FIXME]. Change notification is via the LocalCandidatesAdded signal.
(Permalink)

LocalCredentials — (ss) (Stream_Credentials)

Read only
[FIXME]. Change notification is via the LocalCredentialsChanged signal.
(Permalink)

STUNServers — a(sq) (Socket_Address_IP_List)

Read only

The IP addresses of possible STUN servers to use for NAT traversal, as dotted-quad IPv4 address literals or RFC2373 IPv6 address literals. Change notification is via the STUNServersChanged signal. The IP addresses MUST NOT be given as DNS hostnames.

Rationale:
High-quality connection managers already need an asynchronous DNS resolver, so they might as well resolve this name to an IP to make life easier for streaming implementations.
(Permalink)

RelayInfo — aa{sv} (String_Variant_Map_List)

Read only

A list of mappings describing TURN or Google relay servers available for the client to use in its candidate gathering, as determined from the protocol. Map keys are:

ip - s
The IP address of the relay server as a dotted-quad IPv4 address literal or an RFC2373 IPv6 address literal. This MUST NOT be a DNS hostname.
Rationale:
High-quality connection managers already need an asynchronous DNS resolver, so they might as well resolve this name to an IP and make life easier for streaming implementations.
type - s

Either udp for UDP (UDP MUST be assumed if this key is omitted), tcp for TCP, or tls.

The precise meaning of this key depends on the Transport property: if Transport is ICE, tls means TLS over TCP as referenced by ICE draft 19, and if Transport is GTalk_P2P, tls means a fake SSL session over TCP as implemented by libjingle.

port - q
The UDP or TCP port of the relay server as an ASCII unsigned integer
username - s
The username to use
password - s
The password to use
component - u
The component number to use this relay server for, as an ASCII unsigned integer; if not included, this relay server may be used for any or all components.
Rationale:
In ICE draft 6, as used by Google Talk, credentials are only valid once, so each component needs relaying separately.
Rationale:

An equivalent of the gtalk-p2p-relay-token property on MediaSignalling channels is not included here. The connection manager should be responsible for making the necessary HTTP requests to turn the token into a username and password.

The type of relay server that this represents depends on the value of the Transport property. If Transport is ICE, this is a TURN server; if Transport is GTalk_P2P, this is a Google relay server; otherwise, the meaning of RelayInfo is undefined.

If relaying is not possible for this stream, the list is empty.

Change notification is given via the RelayInfoChanged signal.

(Permalink)

HasServerInfo — b

Read only

True if all the initial information about STUN servers and Relay servers has been retrieved. Change notification is via the ServerInfoRetrieved signal.

Rationale:
Streaming implementations that can't cope with STUN and relay servers being added later SHOULD wait for this property to become true before proceeding.
(Permalink)

Endpoints — ao

Read only

The list of Endpoint.DRAFT objects that exist for this stream.

Change notification is via the EndpointsChanged signal.

Types

Enum (Permalink)

Stream_Component — u

Media streams can use more than one UDP socket: one for RTP (data) and one for RTCP (control). Most of the time, they are adjacent to each other, but some protocols (xmpp) signal each port separately.
  • Unknown (0)
    • The stream transport type is unknown or not applicable (should not appear over dbus).
  • Data (1)
    • This is the high-traffic data socket, containing the audio/video data for the stream.
  • Control (2)
    • This is the low-traffic control socket, usually containing feedback about packet loss etc.
Enum (Permalink)

Stream_Transport_Type — u

Changed in 0.21.2. WLM_8_5 was removed
A transport that can be used for streaming.
  • Unknown (0)
    • The stream transport type is unknown or not applicable (for streams that do not have a configurable transport).
  • Raw_UDP (1)
    • Raw UDP, with or without STUN. All streaming clients are assumed to support this transport, so there is no handler capability token for it in the Call.DRAFT interface. [This corresponds to "none" or "stun" in the old Media.StreamHandler interface.]
  • ICE (2)
    • Interactive Connectivity Establishment, as defined by RFC 5245. Note that this value covers ICE-UDP only. [This corresponds to "ice-udp" in the old Media.StreamHandler interface.]
  • GTalk_P2P (3)
    • Google Talk peer-to-peer connectivity establishment, as implemented by libjingle 0.3. [This corresponds to "gtalk-p2p" in the old Media.StreamHandler interface.]
  • WLM_2009 (4)
    • The transport used by Windows Live Messenger 2009 or later, which resembles ICE draft 19. [This corresponds to "wlm-2009" in the old Media.StreamHandler interface.]
  • SHM (5)
    • Added in 0.21.2.
    Shared memory transport, as implemented by the GStreamer shmsrc and shmsink plugins.
  • Multicast (6)
    • Added in 0.21.5.
    Multicast transport.
Mapping (Permalink)

Candidate_Info — a{sv}

Extra information about the candidate. Allowed and mandatory keys depend on the transport protocol used. The following keys are commenly used:

Type (u)
type of candidate (host, srflx, prflx, relay)
Foundation (s)
the foundation of this candiate
Protocol (u)
Underlying protocol of the candidate (udp, tcp)
Priority (u)
Priority of the candidate
BaseIP (u)
Base IP of this candidate
Username (s)
Username of this candidate (only if credentials are per candidate)
Password (s)
Password of this candidate (only if credentials are per candidate)
RawUDPFallback (b)
Indicate whether this candidate may be used to provide a UDP fallback
  • Key — s
    • One of the well-known keys documented here, or an implementation-specific key.
  • Value — v
    • The value corresponding to that key.
Struct (Permalink)

Candidate — (usua{sv})

A Stream Candidate.
  • Component — u (Stream_Component)
    • The component number.
  • IP — s
    • The IP address to use.
  • Port — u
    • The port number to use.
  • Info — a{sv} (Candidate_Info)
    • Additional information about the candidate.
Struct (Permalink)

Stream_Credentials — (ss)

A username and password pair.
  • Username — s
    • The username.
  • Password — s
    • The password.