Class RTCIceCandidate
Represents an ICE candidate used for network connectivity checks.
Implements
Namespace: Unity.WebRTC
Assembly: Unity.WebRTC.dll
Syntax
public class RTCIceCandidate : IDisposableConstructors
RTCIceCandidate(RTCIceCandidateInit)
Creates a new RTCIceCandidate instance from initialization data.
Declaration
public RTCIceCandidate(RTCIceCandidateInit candidateInfo = null)Parameters
| Type | Name | Description |
|---|---|---|
| RTCIceCandidateInit | candidateInfo | Initialization data for the candidate. |
Properties
Address
Returns the IP address for this candidate.
Declaration
public string Address { get; }Property Value
| Type | Description |
|---|---|
| string |
Candidate
Returns the SDP string for this candidate.
Declaration
public string Candidate { get; }Property Value
| Type | Description |
|---|---|
| string |
Component
Returns the ICE component type.
Declaration
public RTCIceComponent? Component { get; }Property Value
| Type | Description |
|---|---|
| RTCIceComponent? |
Foundation
Returns a string which uniquely identifies the candidate.
Declaration
public string Foundation { get; }Property Value
| Type | Description |
|---|---|
| string |
Port
Returns the port number for this candidate.
Declaration
public ushort? Port { get; }Property Value
| Type | Description |
|---|---|
| ushort? |
Priority
Returns the priority value for this candidate.
Declaration
public uint Priority { get; }Property Value
| Type | Description |
|---|---|
| uint |
Protocol
Returns the transport protocol for this candidate.
Declaration
public RTCIceProtocol? Protocol { get; }Property Value
| Type | Description |
|---|---|
| RTCIceProtocol? |
RelatedAddress
Returns the related IP address for this candidate.
Declaration
public string RelatedAddress { get; }Property Value
| Type | Description |
|---|---|
| string |
RelatedPort
Returns the related port number for this candidate.
Declaration
public ushort? RelatedPort { get; }Property Value
| Type | Description |
|---|---|
| ushort? |
SdpMLineIndex
Returns the index of the m-line in SDP.
Declaration
public int? SdpMLineIndex { get; }Property Value
| Type | Description |
|---|---|
| int? |
SdpMid
Returns the media stream identification.
Declaration
public string SdpMid { get; }Property Value
| Type | Description |
|---|---|
| string |
TcpType
Returns the TCP type for this candidate, if applicable.
Declaration
public RTCIceTcpCandidateType? TcpType { get; }Property Value
| Type | Description |
|---|---|
| RTCIceTcpCandidateType? |
Type
Returns the candidate type.
Declaration
public RTCIceCandidateType? Type { get; }Property Value
| Type | Description |
|---|---|
| RTCIceCandidateType? |
UserNameFragment
Returns the username fragment for this candidate.
Declaration
public string UserNameFragment { get; }Property Value
| Type | Description |
|---|---|
| string |
Methods
Dispose()
Releases resources used by the ICE candidate.
Declaration
public void Dispose()~RTCIceCandidate()
Finalizer for RTCIceCandidate to release resources.
Declaration
protected ~RTCIceCandidate()