Methods
SetCredentials | (s: Username, s: Password) | → | nothing | |
AddCandidates | (a(usqa{sv}): Candidates) | → | nothing | |
CandidatesPrepared | () | → | nothing |
Signals
LocalCandidatesAdded | (a(usqa{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(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 | ||
HasServerInfo | 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) |
Description
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
SetCredentials (s: Username, s: Password) → nothing
Parameters
- Username — s
- Password — s
Used to set the username fragment and password for streams that have global credentials.
AddCandidates (a(usqa{sv}): Candidates) → nothing
Parameters
- Candidates — a(usqa{sv}) (Candidate_List)
CandidatesPrepared () → nothing
Signals
LocalCandidatesAdded (a(usqa{sv}): Candidates)
Parameters
- Candidates — a(usqa{sv}) (Candidate_List)
LocalCredentialsChanged (s: Username, s: Password)
Parameters
- Username — s
- Password — s
RelayInfoChanged (aa{sv}: Relay_Info)
Parameters
- Relay_Info — aa{sv} (String_Variant_Map_List)
STUNServersChanged (a(sq): Servers)
Parameters
- Servers — a(sq) (Socket_Address_IP_List)
ServerInfoRetrieved ()
Signals that the initial information about STUN and Relay servers has been retrieved, i.e. the HasServerInfo property is now true.
EndpointsChanged (ao: Endpoints_Added, ao: Endpoints_Removed)
Parameters
- Endpoints_Added — ao
- Endpoints_Removed — ao
PleaseRestartICE ()
Properties
Transport — u (Stream_Transport_Type)
LocalCandidates — a(usqa{sv}) (Candidate_List)
LocalCredentials — (ss) (Stream_Credentials)
STUNServers — a(sq) (Socket_Address_IP_List)
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:
RelayInfo — aa{sv} (String_Variant_Map_List)
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, ortls
.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.
HasServerInfo — b
True if all the initial information about STUN servers and Relay servers has been retrieved. Change notification is via the ServerInfoRetrieved signal.
Rationale:
Endpoints — ao
The list of Endpoint.DRAFT objects that exist for this stream.
Change notification is via the EndpointsChanged signal.
Types
Stream_Transport_Type — u
- Unknown (0)
- Raw_UDP (1)
- ICE (2)
- GTalk_P2P (3)
- WLM_2009 (4)
- SHM (5)
- Multicast (6)
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
- Value — v
Candidate — (usqa{sv})
- Component — u
- IP — s
- Port — q
- Info — a{sv} (Candidate_Info)
Stream_Credentials — (ss)
- Username — s
- Password — s