RTCIceCandidate (Akasha Java Browser API for J2CL)

java.lang.Object
- akasha.core.JsObject
- - akasha.rtc.RTCIceCandidate

```
@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="RTCIceCandidate")
public class RTCIceCandidate
extends JsObject
```
The RTCIceCandidate interface—part of the WebRTC API—represents a candidate Internet Connectivity Establishment (ICE) configuration which may be used to establish an RTCPeerConnection.

See Also:

RTCIceCandidate - MDN, (WebRTC 1.0) # rtcicecandidate-interface

Constructor Summary

Constructors
Constructor and Description
`RTCIceCandidate()` The RTCIceCandidate() constructor creates and returns a new RTCIceCandidate object, which can be configured to represent a single ICE candidate.
`RTCIceCandidate(RTCIceCandidateInit candidateInitDict)` The RTCIceCandidate() constructor creates and returns a new RTCIceCandidate object, which can be configured to represent a single ICE candidate.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`address()` The RTCIceCandidate interface's read-only address property is a string providing the address of the device which is the source of the candidate.
`java.lang.String`	`candidate()` The read-only property candidate on the RTCIceCandidate interface returns a DOMString describing the candidate in detail.
`java.lang.String`	`component()` The read-only component property on the RTCIceCandidate interface is a string which indicates whether the candidate is an RTP or an RTCP candidate.
`java.lang.String`	`foundation()` The RTCIceCandidate interface's read-only foundation property is a string which uniquely identifies the candidate across multiple transports.
`java.lang.Double`	`port()` The RTCIceCandidate interface's read-only port property contains the port number on the device at the address given by ip at which the candidate's peer can be reached.
`java.lang.Double`	`priority()` The RTCIceCandidate interface's read-only priority property specifies the candidate's priority according to the remote peer; the higher this value is, the better the remote peer considers the candidate to be.
`java.lang.String`	`protocol()` The RTCIceCandidate interface's read-only protocol property is a string which indicates whether the candidate uses UDP or TCP as its transport protocol.
`java.lang.String`	`relatedAddress()` The RTCIceCandidate interface's read-only relatedAddress property is a string indicating the related address of a relay or reflexive candidate.
`java.lang.Double`	`relatedPort()` The RTCIceCandidate interface's read-only relatedPort property indicates the port number of reflexive or relay candidates.
`java.lang.String`	`sdpMid()` The read-only property sdpMid on the RTCIceCandidate interface returns a DOMString specifying the media stream identification tag of the media component with which the candidate is associated.
`java.lang.Double`	`sdpMLineIndex()` The read-only sdpMLineIndex property on the RTCIceCandidate interface is a zero-based index of the m-line describing the media associated with the candidate.
`java.lang.String`	`tcpType()` The RTCIceCandidate interface's read-only tcpType property is included on TCP candidates to provide additional details about the candidate type.
`RTCIceCandidateInit`	`toJSON()` The RTCIceCandidate method toJSON() converts the RTCIceCandidate on which it's called into JSON in the form of an RTCIceCandidateInit object.
`java.lang.String`	`type()` The RTCIceCandidate interface's read-only type specifies the type of candidate the object represents.
`java.lang.String`	`usernameFragment()` The read-only usernameFragment property on the RTCIceCandidate interface is a string indicating the username fragment ("ufrag") that uniquely identifies a single ICE interaction session.

Methods inherited from class akasha.core.JsObject
assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, is, isExtensible, isFrozen, isSealed, keys, preventExtensions, seal, setPrototypeOf, valueOf_, values

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RTCIceCandidate
```
public RTCIceCandidate(@Nonnull
                       RTCIceCandidateInit candidateInitDict)
```
    The RTCIceCandidate() constructor creates and returns a new RTCIceCandidate object, which can be configured to represent a single ICE candidate.
    
    See Also:
    
    RTCIceCandidate.RTCIceCandidate - MDN, RTCIceCandidate() - WebRTC 1.0: Real-time Communication Between Browsers
  - RTCIceCandidate
```
public RTCIceCandidate()
```
    The RTCIceCandidate() constructor creates and returns a new RTCIceCandidate object, which can be configured to represent a single ICE candidate.
    
    See Also:
    
    RTCIceCandidate.RTCIceCandidate - MDN, RTCIceCandidate() - WebRTC 1.0: Real-time Communication Between Browsers
- Method Detail
  - address
```
@JsProperty(name="address")
 @Nullable
public java.lang.String address()
```
    The RTCIceCandidate interface's read-only address property is a string providing the address of the device which is the source of the candidate.
    
    See Also:
    
    RTCIceCandidate.address - MDN, RTCIceCandidate: address - WebRTC 1.0: Real-time Communication Between Browsers
  - candidate
```
@JsProperty(name="candidate")
 @Nonnull
public java.lang.String candidate()
```
    The read-only property candidate on the RTCIceCandidate interface returns a DOMString describing the candidate in detail.
    
    See Also:
    
    RTCIceCandidate.candidate - MDN, RTCIceCandidate.candidate - WebRTC 1.0: Real-time Communication Between Browsers
  - component
```
@JsProperty(name="component")
 @Nullable
 @RTCIceComponent
public java.lang.String component()
```
    The read-only component property on the RTCIceCandidate interface is a string which indicates whether the candidate is an RTP or an RTCP candidate.
    
    See Also:
    
    RTCIceCandidate.component - MDN, RTCIceCandidate.component - WebRTC 1.0: Real-time Communication Between Browsers
  - foundation
```
@JsProperty(name="foundation")
 @Nullable
public java.lang.String foundation()
```
    The RTCIceCandidate interface's read-only foundation property is a string which uniquely identifies the candidate across multiple transports.
    
    See Also:
    
    RTCIceCandidate.foundation - MDN, RTCIceCandidate.foundation - WebRTC 1.0: Real-time Communication Between Browsers
  - port
```
@JsProperty(name="port")
 @Nullable
public java.lang.Double port()
```
    The RTCIceCandidate interface's read-only port property contains the port number on the device at the address given by ip at which the candidate's peer can be reached.
    
    See Also:
    
    RTCIceCandidate.port - MDN, RTCIceCandidate.port - WebRTC 1.0: Real-time Communication Between Browsers
  - priority
```
@JsProperty(name="priority")
 @Nullable
public java.lang.Double priority()
```
    The RTCIceCandidate interface's read-only priority property specifies the candidate's priority according to the remote peer; the higher this value is, the better the remote peer considers the candidate to be.
    
    See Also:
    
    RTCIceCandidate.priority - MDN, RTCIceCandidate.priority - WebRTC 1.0: Real-time Communication Between Browsers
  - protocol
```
@JsProperty(name="protocol")
 @Nullable
 @RTCIceProtocol
public java.lang.String protocol()
```
    The RTCIceCandidate interface's read-only protocol property is a string which indicates whether the candidate uses UDP or TCP as its transport protocol.
    
    See Also:
    
    RTCIceCandidate.protocol - MDN, RTCIceCandidate.protocol - WebRTC 1.0: Real-time Communication Between Browsers
  - relatedAddress
```
@JsProperty(name="relatedAddress")
 @Nullable
public java.lang.String relatedAddress()
```
    The RTCIceCandidate interface's read-only relatedAddress property is a string indicating the related address of a relay or reflexive candidate.
    
    See Also:
    
    RTCIceCandidate.relatedAddress - MDN, RTCIceCandidate.relatedAddress - WebRTC 1.0: Real-time Communication Between Browsers
  - relatedPort
```
@JsProperty(name="relatedPort")
 @Nullable
public java.lang.Double relatedPort()
```
    The RTCIceCandidate interface's read-only relatedPort property indicates the port number of reflexive or relay candidates.
    
    See Also:
    
    RTCIceCandidate.relatedPort - MDN, RTCIceCandidate.relatedPort - WebRTC 1.0: Real-time Communication Between Browsers
  - sdpMLineIndex
```
@JsProperty(name="sdpMLineIndex")
 @Nullable
public java.lang.Double sdpMLineIndex()
```
    The read-only sdpMLineIndex property on the RTCIceCandidate interface is a zero-based index of the m-line describing the media associated with the candidate.
    
    See Also:
    
    RTCIceCandidate.sdpMLineIndex - MDN, RTCIceCandidate.sdpMLineIndex - WebRTC 1.0: Real-time Communication Between Browsers
  - sdpMid
```
@JsProperty(name="sdpMid")
 @Nullable
public java.lang.String sdpMid()
```
    The read-only property sdpMid on the RTCIceCandidate interface returns a DOMString specifying the media stream identification tag of the media component with which the candidate is associated.
    
    See Also:
    
    RTCIceCandidate.sdpMid - MDN, RTCIceCandidate.sdpMid - WebRTC 1.0: Real-time Communication Between Browsers
  - tcpType
```
@JsProperty(name="tcpType")
 @Nullable
 @RTCIceTcpCandidateType
public java.lang.String tcpType()
```
    The RTCIceCandidate interface's read-only tcpType property is included on TCP candidates to provide additional details about the candidate type.
    
    See Also:
    
    RTCIceCandidate.tcpType - MDN, RTCIceCandidate.tcpType - WebRTC 1.0: Real-time Communication Between Browsers
  - type
```
@JsProperty(name="type")
 @Nullable
 @RTCIceCandidateType
public java.lang.String type()
```
    The RTCIceCandidate interface's read-only type specifies the type of candidate the object represents.
    
    See Also:
    
    RTCIceCandidate.type - MDN, RTCIceCandidate.type - WebRTC 1.0: Real-time Communication Between Browsers
  - usernameFragment
```
@JsProperty(name="usernameFragment")
 @Nullable
public java.lang.String usernameFragment()
```
    The read-only usernameFragment property on the RTCIceCandidate interface is a string indicating the username fragment ("ufrag") that uniquely identifies a single ICE interaction session.
    
    See Also:
    
    RTCIceCandidate.usernameFragment - MDN, RTCIceCandidate.usernameFragment - WebRTC 1.0: Real-time Communication Between Browsers
  - toJSON
```
@Nonnull
public RTCIceCandidateInit toJSON()
```
    The RTCIceCandidate method toJSON() converts the RTCIceCandidate on which it's called into JSON in the form of an RTCIceCandidateInit object.
    
    See Also:
    
    RTCIceCandidate.toJSON - MDN, RTCIceCandidate.toJSON() - WebRTC 1.0: Real-time Communication Between Browsers

Class RTCIceCandidate

Constructor Summary

Method Summary

Methods inherited from class akasha.core.JsObject

Methods inherited from class java.lang.Object

Constructor Detail

RTCIceCandidate

RTCIceCandidate

Method Detail

address

candidate

component

foundation

port

priority

protocol

relatedAddress

relatedPort

sdpMLineIndex

sdpMid

tcpType

type

usernameFragment

toJSON