akasha.rtc

Interface RTCConfiguration

All Known Subinterfaces:

RTCConfiguration.Builder

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

The RTCConfiguration dictionary is used to provide configuration options for an RTCPeerConnection. It may be passed into the constructor when instantiating a connection, or used with the RTCPeerConnection.getConfiguration() and RTCPeerConnection.setConfiguration() methods, which allow inspecting and changing the configuration while a connection is established.

See Also:

RTCConfiguration - MDN, (WebRTC 1.0) # dom-rtcconfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RTCConfiguration.Builder The RTCConfiguration dictionary is used to provide configuration options for an RTCPeerConnection.

Method Summary

Modifier and Type	Method and Description
java.lang.String	bundlePolicy() The RTCConfiguration dictionary's bundlePolicy property is a string value indicating which SDP bundling policy, if any, to use for the underlying RTP streams used by an RTCPeerConnection.
JsArray<RTCCertificate>	certificates() The RTCConfiguration dictionary's optional certificates property is an array of RTCCertificate objects providing the security certificates available for use when authenticating duing the connection process.
static RTCConfiguration.Builder	create()
short	iceCandidatePoolSize()
JsArray<RTCIceServer>	iceServers()
java.lang.String	iceTransportPolicy() The WebRTC Device API dictionary RTCConfiguration's iceTransportPolicy property is a string indicating the transport selection policy the ICE agent should use during negotiation of connections.
java.lang.String	peerIdentity()
java.lang.String	rtcpMuxPolicy()
void	setBundlePolicy(java.lang.String bundlePolicy) The RTCConfiguration dictionary's bundlePolicy property is a string value indicating which SDP bundling policy, if any, to use for the underlying RTP streams used by an RTCPeerConnection.
void	setCertificates(JsArray<RTCCertificate> certificates) The RTCConfiguration dictionary's optional certificates property is an array of RTCCertificate objects providing the security certificates available for use when authenticating duing the connection process.
default void	setCertificates(RTCCertificate... certificates) The RTCConfiguration dictionary's optional certificates property is an array of RTCCertificate objects providing the security certificates available for use when authenticating duing the connection process.
void	setIceCandidatePoolSize(short iceCandidatePoolSize)
void	setIceServers(JsArray<RTCIceServer> iceServers)
default void	setIceServers(RTCIceServer... iceServers)
void	setIceTransportPolicy(java.lang.String iceTransportPolicy) The WebRTC Device API dictionary RTCConfiguration's iceTransportPolicy property is a string indicating the transport selection policy the ICE agent should use during negotiation of connections.
void	setPeerIdentity(java.lang.String peerIdentity)
void	setRtcpMuxPolicy(java.lang.String rtcpMuxPolicy)

Method Detail

create

@JsOverlay
 @Nonnull
static RTCConfiguration.Builder create()

bundlePolicy

@JsProperty(name="bundlePolicy")
 @RTCBundlePolicy
java.lang.String bundlePolicy()

The RTCConfiguration dictionary's bundlePolicy property is a string value indicating which SDP bundling policy, if any, to use for the underlying RTP streams used by an RTCPeerConnection.

See Also:

RTCConfiguration.bundlePolicy - MDN, RTCConfiguration.bundlePolicy - WebRTC 1.0: Real-time Communication Between Browsers

setBundlePolicy

@JsProperty
void setBundlePolicy(@RTCBundlePolicy @Nonnull
                                 java.lang.String bundlePolicy)

The RTCConfiguration dictionary's bundlePolicy property is a string value indicating which SDP bundling policy, if any, to use for the underlying RTP streams used by an RTCPeerConnection.

See Also:

RTCConfiguration.bundlePolicy - MDN, RTCConfiguration.bundlePolicy - WebRTC 1.0: Real-time Communication Between Browsers

certificates

@JsProperty(name="certificates")
JsArray<RTCCertificate> certificates()

The RTCConfiguration dictionary's optional certificates property is an array of RTCCertificate objects providing the security certificates available for use when authenticating duing the connection process.

See Also:

RTCConfiguration.certificates - MDN, RTCConfiguration.certificates - WebRTC 1.0: Real-time Communication Between Browsers

setCertificates

@JsProperty
void setCertificates(@Nonnull
                                 JsArray<RTCCertificate> certificates)

The RTCConfiguration dictionary's optional certificates property is an array of RTCCertificate objects providing the security certificates available for use when authenticating duing the connection process.

See Also:

RTCConfiguration.certificates - MDN, RTCConfiguration.certificates - WebRTC 1.0: Real-time Communication Between Browsers

setCertificates

@JsOverlay
default void setCertificates(@Nonnull
                                        RTCCertificate... certificates)

The RTCConfiguration dictionary's optional certificates property is an array of RTCCertificate objects providing the security certificates available for use when authenticating duing the connection process.

See Also:

RTCConfiguration.certificates - MDN, RTCConfiguration.certificates - WebRTC 1.0: Real-time Communication Between Browsers

iceCandidatePoolSize

@JsProperty(name="iceCandidatePoolSize")
short iceCandidatePoolSize()

setIceCandidatePoolSize

@JsProperty
void setIceCandidatePoolSize(short iceCandidatePoolSize)

iceServers

@JsProperty(name="iceServers")
JsArray<RTCIceServer> iceServers()

See Also:

RTCConfiguration.iceServers - MDN, RTCConfiguration.iceServers - WebRTC 1.0: Real-time Communication Between Browsers

setIceServers

@JsProperty
void setIceServers(@Nonnull
                               JsArray<RTCIceServer> iceServers)

See Also:

RTCConfiguration.iceServers - MDN, RTCConfiguration.iceServers - WebRTC 1.0: Real-time Communication Between Browsers

setIceServers

@JsOverlay
default void setIceServers(@Nonnull
                                      RTCIceServer... iceServers)

See Also:

RTCConfiguration.iceServers - MDN, RTCConfiguration.iceServers - WebRTC 1.0: Real-time Communication Between Browsers

iceTransportPolicy

@JsProperty(name="iceTransportPolicy")
 @RTCIceTransportPolicy
java.lang.String iceTransportPolicy()

The WebRTC Device API dictionary RTCConfiguration's iceTransportPolicy property is a string indicating the transport selection policy the ICE agent should use during negotiation of connections. Its value must come from the RTCIceTransportPolicy enumerated type.

See Also:

RTCConfiguration.iceTransportPolicy - MDN, RTCCandidate.iceTransportPolicy - WebRTC 1.0: Real-time Communication Between Browsers

setIceTransportPolicy

@JsProperty
void setIceTransportPolicy(@RTCIceTransportPolicy @Nonnull
                                       java.lang.String iceTransportPolicy)

The WebRTC Device API dictionary RTCConfiguration's iceTransportPolicy property is a string indicating the transport selection policy the ICE agent should use during negotiation of connections. Its value must come from the RTCIceTransportPolicy enumerated type.

See Also:

RTCConfiguration.iceTransportPolicy - MDN, RTCCandidate.iceTransportPolicy - WebRTC 1.0: Real-time Communication Between Browsers

rtcpMuxPolicy

@JsProperty(name="rtcpMuxPolicy")
 @RTCRtcpMuxPolicy
java.lang.String rtcpMuxPolicy()

setRtcpMuxPolicy

@JsProperty
void setRtcpMuxPolicy(@RTCRtcpMuxPolicy @Nonnull
                                  java.lang.String rtcpMuxPolicy)

peerIdentity

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

setPeerIdentity

@JsProperty
void setPeerIdentity(@Nonnull
                                 java.lang.String peerIdentity)