akasha.rtc

Interface RTCIceServer

All Known Subinterfaces:

RTCIceServer.Builder

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Object")
public interface RTCIceServer

The RTCIceServer dictionary defines how to connect to a single ICE server (such as a STUN or TURN server). Objects of this type are provided in the configuration of an RTCPeerConnection, in the iceServers array.

See Also:

RTCIceServer - MDN

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RTCIceServer.Builder The RTCIceServer dictionary defines how to connect to a single ICE server (such as a STUN or TURN server).

Method Summary

Modifier and Type	Method and Description
static RTCIceServer.Builder	create(JsArray<java.lang.String> urls)
static RTCIceServer.Builder	create(java.lang.String urls)
static RTCIceServer.Builder	create(java.lang.String[] urls)
java.lang.String	credential() The RTCIceServer dictionary's credential property is a string providing the credential to use when connecting to the described server.
java.lang.String	credentialType() The RTCIceServer dictionary's credentialType property is a string value from the RTCIceCredentialType enum which indicates what type of credential the RTCIceServer.credential value is.
void	setCredential(java.lang.String credential) The RTCIceServer dictionary's credential property is a string providing the credential to use when connecting to the described server.
void	setCredentialType(java.lang.String credentialType) The RTCIceServer dictionary's credentialType property is a string value from the RTCIceCredentialType enum which indicates what type of credential the RTCIceServer.credential value is.
default void	setUrls(JsArray<java.lang.String> urls) The RTCIceServer dictionary's urls property specifies the URL or URLs of the servers to be used for ICE negotiations.
default void	setUrls(java.lang.String... urls) The RTCIceServer dictionary's urls property specifies the URL or URLs of the servers to be used for ICE negotiations.
default void	setUrls(java.lang.String urls) The RTCIceServer dictionary's urls property specifies the URL or URLs of the servers to be used for ICE negotiations.
void	setUrls(StringOrStringArrayUnion urls) The RTCIceServer dictionary's urls property specifies the URL or URLs of the servers to be used for ICE negotiations.
void	setUsername(java.lang.String username) The RTCIceServer dictionary's username property is a string which specifies the username to use when authenticating with the ICE server being described.
StringOrStringArrayUnion	urls() The RTCIceServer dictionary's urls property specifies the URL or URLs of the servers to be used for ICE negotiations.
java.lang.String	username() The RTCIceServer dictionary's username property is a string which specifies the username to use when authenticating with the ICE server being described.

Method Detail

create

@JsOverlay
 @Nonnull
static RTCIceServer.Builder create(@Nonnull
                                                        java.lang.String urls)

create

@JsOverlay
 @Nonnull
static RTCIceServer.Builder create(@Nonnull
                                                        JsArray<java.lang.String> urls)

create

@JsOverlay
 @Nonnull
static RTCIceServer.Builder create(@Nonnull
                                                        java.lang.String[] urls)

credential

@JsProperty(name="credential")
java.lang.String credential()

The RTCIceServer dictionary's credential property is a string providing the credential to use when connecting to the described server. This is typically a password, key, or other secret.

See Also:

RTCIceServer.credential - MDN, RTCIceServer.credential - WebRTC 1.0: Real-time Communication Between Browsers

setCredential

@JsProperty
void setCredential(@Nonnull
                               java.lang.String credential)

The RTCIceServer dictionary's credential property is a string providing the credential to use when connecting to the described server. This is typically a password, key, or other secret.

See Also:

RTCIceServer.credential - MDN, RTCIceServer.credential - WebRTC 1.0: Real-time Communication Between Browsers

credentialType

@JsProperty(name="credentialType")
 @RTCIceCredentialType
java.lang.String credentialType()

The RTCIceServer dictionary's credentialType property is a string value from the RTCIceCredentialType enum which indicates what type of credential the RTCIceServer.credential value is. The default is password.

See Also:

RTCIceServer.credentialType - MDN, RTCIceServer.credential - WebRTC 1.0: Real-time Communication Between Browsers

setCredentialType

@JsProperty
void setCredentialType(@RTCIceCredentialType @Nonnull
                                   java.lang.String credentialType)

The RTCIceServer dictionary's credentialType property is a string value from the RTCIceCredentialType enum which indicates what type of credential the RTCIceServer.credential value is. The default is password.

See Also:

RTCIceServer.credentialType - MDN, RTCIceServer.credential - WebRTC 1.0: Real-time Communication Between Browsers

urls

@JsProperty(name="urls")
 @Nonnull
StringOrStringArrayUnion urls()

The RTCIceServer dictionary's urls property specifies the URL or URLs of the servers to be used for ICE negotiations. These are typically STUN and/or TURN servers.

See Also:

RTCIceServer.urls - MDN, RTCIceServer.urls - WebRTC 1.0: Real-time Communication Between Browsers

setUrls

@JsProperty
void setUrls(@Nonnull
                         StringOrStringArrayUnion urls)

The RTCIceServer dictionary's urls property specifies the URL or URLs of the servers to be used for ICE negotiations. These are typically STUN and/or TURN servers.

See Also:

RTCIceServer.urls - MDN, RTCIceServer.urls - WebRTC 1.0: Real-time Communication Between Browsers

setUrls

@JsOverlay
default void setUrls(@Nonnull
                                java.lang.String urls)

The RTCIceServer dictionary's urls property specifies the URL or URLs of the servers to be used for ICE negotiations. These are typically STUN and/or TURN servers.

See Also:

RTCIceServer.urls - MDN, RTCIceServer.urls - WebRTC 1.0: Real-time Communication Between Browsers

setUrls

@JsOverlay
default void setUrls(@Nonnull
                                JsArray<java.lang.String> urls)

The RTCIceServer dictionary's urls property specifies the URL or URLs of the servers to be used for ICE negotiations. These are typically STUN and/or TURN servers.

See Also:

RTCIceServer.urls - MDN, RTCIceServer.urls - WebRTC 1.0: Real-time Communication Between Browsers

setUrls

@JsOverlay
default void setUrls(@Nonnull
                                java.lang.String... urls)

The RTCIceServer dictionary's urls property specifies the URL or URLs of the servers to be used for ICE negotiations. These are typically STUN and/or TURN servers.

See Also:

RTCIceServer.urls - MDN, RTCIceServer.urls - WebRTC 1.0: Real-time Communication Between Browsers

username

@JsProperty(name="username")
java.lang.String username()

The RTCIceServer dictionary's username property is a string which specifies the username to use when authenticating with the ICE server being described.

See Also:

RTCIceServer.username - MDN, RTCIceServer.username - WebRTC 1.0: Real-time Communication Between Browsers

setUsername

@JsProperty
void setUsername(@Nonnull
                             java.lang.String username)

The RTCIceServer dictionary's username property is a string which specifies the username to use when authenticating with the ICE server being described.

See Also:

RTCIceServer.username - MDN, RTCIceServer.username - WebRTC 1.0: Real-time Communication Between Browsers