Call.Stream.Endpoint.DRAFT — Telepathy D-Bus Interface Specification

# Interface Call.Stream.Endpoint.DRAFT

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

### Methods

SetSelectedCandidate | ((usqa{sv}): Candidate) | → | nothing |
SetStreamState | (u: State) | → | nothing |

### Signals

RemoteCredentialsSet | (s: Username, s: Password) |
RemoteCandidatesAdded | (a(usqa{sv}): Candidates) |
CandidateSelected | ((usqa{sv}): Candidate) |
StreamStateChanged | (u: state) |

### Properties

RemoteCredentials | (ss) (Stream_Credentials) | Read only |  |
RemoteCandidates | a(usqa{sv}) (Candidate_List) | Read only |  |
SelectedCandidate | (usqa{sv}) (Candidate) | Read only |  |
StreamState | u (Media_Stream_State) | Read only |  |
Transport | u (Stream_Transport_Type) | Read only |  |

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

This object represents an endpoint for a stream. In a one-to-one call, there will be one (bidirectional) stream per content and one endpoint per stream (as there is only one remote contact). In a multi-user call there is a stream for each remote contact and each stream has one endpoint as it refers to the one physical machine on the other end of the stream.

The multiple endpoint use case appears when SIP call forking is used. Unlike jingle call forking (which is just making multiple jingle calls to different resources appear as one call), SIP call forking is actually done at the server so you have one stream to the remote contact and then and endpoint for each SIP client to be called.

# Methods

(Permalink)

## SetSelectedCandidate ((usqa{sv}): Candidate) → nothing

### Parameters

- Candidate — (usqa{sv}) (Candidate)
The candidate that has been selected.

Set the value of CandidateSelected.

### Possible Errors

- Invalid Argument
Raised when one of the provided arguments is invalid.

(Permalink)

## SetStreamState (u: State) → nothing

### Parameters

- State — u (Media_Stream_State)
The requested stream state.

Change the StreamState of the endpoint.

### Possible Errors

- Invalid Argument
Raised when one of the provided arguments is invalid.
- Not Available
Raised when the requested functionality is temporarily unavailable.

# Signals

(Permalink)

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

### Parameters

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

Emitted when the remote ICE credentials for the endpoint are set. If each candidate has different credentials, then this signal will never be fired.
(Permalink)

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

### Parameters

- Candidates — a(usqa{sv}) (Candidate_List)
The candidates that were added.

Emitted when remote candidates are added to the RemoteCandidates property.
(Permalink)

## CandidateSelected ((usqa{sv}): Candidate)

### Parameters

- Candidate — (usqa{sv}) (Candidate)
The candidate that has been selected.

Emitted when a candidate is selected for use in the stream.
(Permalink)

## StreamStateChanged (u: state)

### Parameters

- state — u (Media_Stream_State)
The new StreamState value.

Emitted when the StreamState property changes.

# Properties

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

## RemoteCredentials — (ss) (Stream_Credentials)

Read only
The ICE credentials used for all candidates. If each candidate has different credentials, then this property SHOULD be ("", ""). Per-candidate credentials are set in the Candidate's Candidate_Info a{sv}.
(Permalink)

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

Read only
A list of candidates for this endpoint.
(Permalink)

## SelectedCandidate — (usqa{sv}) (Candidate)

Read only
The candidate that has been selected for use to stream packets to the remote contact. Change notification is given via the the CandidateSelected signal.
(Permalink)

## StreamState — u (Media_Stream_State)

Read only
The stream state of the endpoint.
(Permalink)

## Transport — u (Stream_Transport_Type)

Read only
The transport type for the stream endpoint.