org.freedesktop.Telepathy.Call.Stream.Interface.Media.DRAFT

# Interface org.freedesktop.Telepathy.Call.Stream.Interface.Media.DRAFT

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

### Methods

AddCandidates | (a(usqa{sv}): candidates) | → | nothing |
CandidatesPrepared | () | → | nothing |

### Signals

LocalCandidatesAdded | (a(usqa{sv}): Candidates) |
LocalCredentialsSet | (s: Username, s: Password) |
ServerInfoRetrieved | () |
EndpointsChanged | (ao: EndpointsAdded, ao: EndpointsRemoved) |

### Properties

Transport | u (Stream_Transport_Type) | Read only |
LocalCandidates | a(usqa{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 |
RetrievedServerInfo | b | Read only |
Endpoints | ao | Read only |

### Types

Stream_Transport_Type | Enum | u |
Candidate_Info | Mapping | a{sv} |
Candidate | Struct | (usqa{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:

- org.freedesktop.Telepathy.Call.Stream

### Description

[FIXME]

# Methods

(Permalink)

## AddCandidates (a(usqa{sv}): candidates) → nothing

### Parameters

- candidates — a(usqa{sv}) (Candidate_List)
Candidates to be appended to LocalCandidates

Add candidates to LocalCandidates 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.
[FIXME: rationale]

# Signals

(Permalink)

## LocalCandidatesAdded (a(usqa{sv}): Candidates)

### Parameters

- Candidates — a(usqa{sv}) (Candidate_List)
Candidates that have been appended to LocalCandidates

Emitted when local candidates are added to LocalCandidates.
(Permalink)

## LocalCredentialsSet (s: Username, s: Password)

### Parameters

- Username — s
- Password — s

Emitted when the value of LocalCredentials changes.
(Permalink)

## ServerInfoRetrieved ()

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

(Permalink)

## EndpointsChanged (ao: EndpointsAdded, ao: EndpointsRemoved)

### Parameters

- EndpointsAdded — ao
Endpoints that were added.
- EndpointsRemoved — ao
Endpoints that no longer exist.

Emitted when the Endpoints property changes.

# Properties

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

## Transport — u (Stream_Transport_Type)

Read only
The transport for this stream. This property is immutable.
(Permalink)

## LocalCandidates — a(usqa{sv}) (Candidate_List)

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

## LocalCredentials — (ss) (Stream_Credentials)

Read only
[FIXME]. Change notification is via LocalCredentialsSet.
(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. This property cannot change once the stream has been created, so there is no change notification. The IP addresses MUST NOT be given as DNS hostnames.
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.
  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.
  In ICE draft 6, as used by Google Talk, credentials are only valid once, so each component needs relaying separately.

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.

(Permalink)

## RetrievedServerInfo — b

Read only

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

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 endpoints Endpoint.DRAFT that exist for this stream.

Change notification is via the EndpointsChanged signal.

# Types

Enum (Permalink)

## Stream_Transport_Type — u

A transport that can be used for streaming.

- Raw_UDP (0)
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 (1)
Interactive Connectivity Establishment, as defined by the IETF MMUSIC working group. [FIXME: do we want this to cover both ICE-UDP and ICE-TCP, or split them?] [This corresponds to "ice-udp" in the old Media.StreamHandler interface.]
- GTalk_P2P (2)
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_8_5 (3)
The transport used by Windows Live Messenger 8.5 or later, which resembles ICE draft 6. [This corresponds to "wlm-8.5" 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.]

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 — (usqa{sv})

A Stream Candidate

- Component — u
The component number
- IP — s
The IP address to use
- Port — q
The port number to use
- Info — a{sv} (Candidate_Info)
Additional information about the candidate

Struct (Permalink)

## Stream_Credentials — (ss)

A username/password pair.

- Username — s
The username
- Password — s
The password