Liking cljdoc? Tell your friends :D

web.rtc.RTCDataChannel

The RTCDataChannel interface represents a network channel which be used for bidirectional peer-to-peer transfers of arbitrary Every data channel is associated with an web.audio.RTCPeerConnection, each peer connection can have up to a theoretical maximum of data channels (the actual limit may vary from browser to browser).

The RTCDataChannel interface represents a network channel which
be used for bidirectional peer-to-peer transfers of arbitrary
Every data channel is associated with an `web.audio.RTCPeerConnection`,
each peer connection can have up to a theoretical maximum of
data channels (the actual limit may vary from browser to browser).
raw docstring

binary-typecljs

(binary-type this)

Property.

[Draft] [Experimental]

The property binaryType on the web.rtc.RTCDataChannel interface a web.dom.DOMString which specifies the type of JavaScript which should be used to represent binary data received on the Values allowed by the WebSocket.binaryType property are also here: "blob" if web.files.Blob objects are being used or if js.ArrayBuffer objects are being used. The default is "blob".

`var type = aDataChannel.binaryType;

aDataChannel.binaryType = type;`

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/binaryType

Property.

[Draft]
[Experimental]

The property binaryType on the `web.rtc.RTCDataChannel` interface
a `web.dom.DOMString` which specifies the type of JavaScript
which should be used to represent binary data received on the
Values allowed by the `WebSocket.binaryType` property are also
here: \"blob\" if `web.files.Blob` objects are being used or
if `js.ArrayBuffer` objects are being used. The default is \"blob\".

`var type = aDataChannel.binaryType;

aDataChannel.binaryType = type;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/binaryType`
sourceraw docstring

buffered-amountcljs

(buffered-amount this)

Property.

[Read Only] [Experimental]

The read-only RTCDataChannel property bufferedAmount returns number of bytes of data currently queued to be sent over the channel.

var amount = aDataChannel.bufferedAmount;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/bufferedAmount

Property.

[Read Only]
[Experimental]

The read-only RTCDataChannel property bufferedAmount returns
number of bytes of data currently queued to be sent over the
channel.

`var amount = aDataChannel.bufferedAmount;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/bufferedAmount`
sourceraw docstring

buffered-amount-low-thresholdcljs

(buffered-amount-low-threshold this)

Property.

[Experimental]

The RTCDataChannel property bufferedAmountLowThreshold is used specify the number of bytes of buffered outgoing data that is "low." The default value is 0.

`var threshold = aDataChannel.bufferedAmountLowThreshold;

aDataChannel.bufferedAmountLowThreshold = threshold;`

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/bufferedAmountLowThreshold

Property.

[Experimental]

The RTCDataChannel property bufferedAmountLowThreshold is used
specify the number of bytes of buffered outgoing data that is
\"low.\" The default value is 0.

`var threshold = aDataChannel.bufferedAmountLowThreshold;

aDataChannel.bufferedAmountLowThreshold = threshold;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/bufferedAmountLowThreshold`
sourceraw docstring

closecljs

(close this)

Method.

The RTCDataChannel.close() method closes the web.rtc.RTCDataChannel. peer is permitted to call this method to initiate closure of channel.

RTCDataChannel.close();

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/close

Method.

The RTCDataChannel.close() method closes the `web.rtc.RTCDataChannel`.
peer is permitted to call this method to initiate closure of
channel.

`RTCDataChannel.close();`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/close`
sourceraw docstring

idcljs

(id this)

Property.

[Read Only] [Experimental]

The read-only RTCDataChannel property id returns an ID number 0 and 65,534) which uniquely identifies the web.rtc.RTCDataChannel.

var id = aDataChannel.id;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/id

Property.

[Read Only]
[Experimental]

The read-only RTCDataChannel property id returns an ID number
0 and 65,534) which uniquely identifies the `web.rtc.RTCDataChannel`.

`var id = aDataChannel.id;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/id`
sourceraw docstring

labelcljs

(label this)

Property.

[Read Only] [Experimental]

The read-only RTCDataChannel property label returns a web.dom.DOMString a name describing the data channel. These labels are not required be unique.

var name = aDataChannel.label;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/label

Property.

[Read Only]
[Experimental]

The read-only RTCDataChannel property label returns a `web.dom.DOMString`
a name describing the data channel. These labels are not required
be unique.

`var name = aDataChannel.label;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/label`
sourceraw docstring

max-packet-life-timecljs

(max-packet-life-time this)

Property.

[Read Only] [Experimental]

The read-only RTCDataChannel property maxPacketLifeTime returns amount of time, in milliseconds, the browser is allowed to take attempt to transmit a message, as set when the data channel was or null.

var lifetime = aDataChannel.maxPacketLifeTime;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/maxPacketLifeTime

Property.

[Read Only]
[Experimental]

The read-only RTCDataChannel property maxPacketLifeTime returns
amount of time, in milliseconds, the browser is allowed to take
attempt to transmit a message, as set when the data channel was
or null.

`var lifetime = aDataChannel.maxPacketLifeTime;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/maxPacketLifeTime`
sourceraw docstring

max-retransmitscljs

(max-retransmits this)

Property.

[Read Only] [Experimental]

The read-only RTCDataChannel property maxRetransmits returns maximum number of times the browser should try to retransmit message before giving up, as set when the data channel was created, null, which indicates that there is no maximum.

var tries = aDataChannel.maxRetransmits;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/maxRetransmits

Property.

[Read Only]
[Experimental]

The read-only RTCDataChannel property maxRetransmits returns
maximum number of times the browser should try to retransmit
message before giving up, as set when the data channel was created,
null, which indicates that there is no maximum.

`var tries = aDataChannel.maxRetransmits;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/maxRetransmits`
sourceraw docstring

negotiatedcljs

(negotiated this)

Property.

[Read Only]

The read-only RTCDataChannel property negotiated indicates whether web.rtc.RTCDataChannel's connection was negotiated by the Web (true) or by the WebRTC layer (false).

var negotiated = aDataChannel.negotiated;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/negotiated

Property.

[Read Only]

The read-only RTCDataChannel property negotiated indicates whether
`web.rtc.RTCDataChannel`'s connection was negotiated by the Web
(true) or by the WebRTC layer (false).

`var negotiated = aDataChannel.negotiated;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/negotiated`
sourceraw docstring

onbufferedamountlowcljs

(onbufferedamountlow this)

Property.

[Experimental]

The RTCDataChannel.onbufferedamountlow property is an EventHandler specifies a function the browser calls when the bufferedamountlow is sent to the web.rtc.RTCDataChannel. This event, which is by a simple web.event.Event object, is sent when the amount data buffered to be sent falls to or below the threshold specified the channel's bufferedAmountLowThreshold.

RTCDataChannel.onbufferedamountlow = function;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onbufferedamountlow

Property.

[Experimental]

The RTCDataChannel.onbufferedamountlow property is an `EventHandler`
specifies a function the browser calls when the bufferedamountlow
is sent to the `web.rtc.RTCDataChannel`. This event, which is
by a simple `web.event.Event` object, is sent when the amount
data buffered to be sent falls to or below the threshold specified
the channel's `bufferedAmountLowThreshold`.

`RTCDataChannel.onbufferedamountlow = function;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onbufferedamountlow`
sourceraw docstring

onclosecljs

(onclose this)

Property.

[Experimental]

The RTCDataChannel.onclose property is an EventHandler which a function to be called by the browser when the close event is by the web.rtc.RTCDataChannel. This is a simple web.event.Event indicates that the data channel has closed down.

RTCDataChannel.onclose = function;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onclose

Property.

[Experimental]

The RTCDataChannel.onclose property is an `EventHandler` which
a function to be called by the browser when the close event is
by the `web.rtc.RTCDataChannel`. This is a simple `web.event.Event`
indicates that the data channel has closed down.

`RTCDataChannel.onclose = function;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onclose`
sourceraw docstring

onerrorcljs

(onerror this)

Property.

[Experimental]

The RTCDataChannel.onerror property is an EventHandler which a function to be called when the error event is received. When error occurs on the data channel, the function receives as input web.workers.ErrorEvent object describing the error which occurred.

RTCDataChannel.onerror = function;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onerror

Property.

[Experimental]

The RTCDataChannel.onerror property is an `EventHandler` which
a function to be called when the error event is received. When
error occurs on the data channel, the function receives as input
`web.workers.ErrorEvent` object describing the error which occurred.

`RTCDataChannel.onerror = function;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onerror`
sourceraw docstring

onmessagecljs

(onmessage this)

Property.

[Experimental]

The RTCDataChannel.onmessage property stores an EventHandler specifies a function to be called when the message event is fired the channel. This event is represented by the web.workers.MessageEvent This event is sent to the channel when a message is received the other peer.

RTCDataChannel.onmessage = function;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onmessage

Property.

[Experimental]

The RTCDataChannel.onmessage property stores an `EventHandler`
specifies a function to be called when the message event is fired
the channel. This event is represented by the `web.workers.MessageEvent`
This event is sent to the channel when a message is received
the other peer.

`RTCDataChannel.onmessage = function;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onmessage`
sourceraw docstring

onopencljs

(onopen this)

Property.

[Experimental]

The RTCDataChannel.onopen property is an EventHandler which a function to be called when the open event is fired; this is simple web.event.Event which is sent when the data channel's data transport—the link over which the web.rtc.RTCDataChannel's flow—is established or re-established.

RTCDataChannel.onopen = function;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onopen

Property.

[Experimental]

The RTCDataChannel.onopen property is an `EventHandler` which
a function to be called when the open event is fired; this is
simple `web.event.Event` which is sent when the data channel's
data transport—the link over which the `web.rtc.RTCDataChannel`'s
flow—is established or re-established.

`RTCDataChannel.onopen = function;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onopen`
sourceraw docstring

orderedcljs

(ordered this)

Property.

[Read Only] [Experimental]

The read-only RTCDataChannel property ordered indicates whether not the data channel guarantees in-order delivery of messages; default is true, which indicates that the data channel is indeed

`var ordered = aDataChannel.ordered;

A js.Boolean value which is true if in-order delivery is guaranteed and is otherwise false.`

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/ordered

Property.

[Read Only]
[Experimental]

The read-only RTCDataChannel property ordered indicates whether
not the data channel guarantees in-order delivery of messages;
default is true, which indicates that the data channel is indeed

`var ordered = aDataChannel.ordered;

A `js.Boolean` value which is true if in-order delivery is guaranteed and is otherwise false.`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/ordered`
sourceraw docstring

protocolcljs

(protocol this)

Property.

[Read Only] [Experimental]

The read-only RTCDataChannel property protocol returns a web.dom.DOMString the name of the subprotocol in use. If no protocol was specified the data channel was created, then this property's value is "" empty string).

var subProtocol = aDataChannel.protocol;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/protocol

Property.

[Read Only]
[Experimental]

The read-only RTCDataChannel property protocol returns a `web.dom.DOMString`
the name of the subprotocol in use. If no protocol was specified
the data channel was created, then this property's value is \"\"
empty string).

`var subProtocol = aDataChannel.protocol;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/protocol`
sourceraw docstring

ready-statecljs

(ready-state this)

Property.

[Read Only] [Experimental]

The read-only RTCDataChannel property readyState returns an enum type RTCDataChannelState which indicates the state of the data underlying data connection.

var state = aDataChannel.readyState;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/readyState

Property.

[Read Only]
[Experimental]

The read-only RTCDataChannel property readyState returns an enum
type RTCDataChannelState which indicates the state of the data
underlying data connection.

`var state = aDataChannel.readyState;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/readyState`
sourceraw docstring

reliablecljs

(reliable this)

Property.

The read-only RTCDataChannel property reliable indicates whether not the data channel is reliable.

Property.

The read-only RTCDataChannel property reliable indicates whether
not the data channel is reliable.
sourceraw docstring

sendcljs

(send this data)

Method.

The send() method of the web.rtc.RTCDataChannel interface sends across the data channel to the remote peer.

RTCDataChannel.send(data);

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/send

Method.

The send() method of the `web.rtc.RTCDataChannel` interface sends
across the data channel to the remote peer.

`RTCDataChannel.send(data);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/send`
sourceraw docstring

set-binary-type!cljs

(set-binary-type! this val)

Property.

[Draft] [Experimental]

The property binaryType on the web.rtc.RTCDataChannel interface a web.dom.DOMString which specifies the type of JavaScript which should be used to represent binary data received on the Values allowed by the WebSocket.binaryType property are also here: "blob" if web.files.Blob objects are being used or if js.ArrayBuffer objects are being used. The default is "blob".

`var type = aDataChannel.binaryType;

aDataChannel.binaryType = type;`

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/binaryType

Property.

[Draft]
[Experimental]

The property binaryType on the `web.rtc.RTCDataChannel` interface
a `web.dom.DOMString` which specifies the type of JavaScript
which should be used to represent binary data received on the
Values allowed by the `WebSocket.binaryType` property are also
here: \"blob\" if `web.files.Blob` objects are being used or
if `js.ArrayBuffer` objects are being used. The default is \"blob\".

`var type = aDataChannel.binaryType;

aDataChannel.binaryType = type;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/binaryType`
sourceraw docstring

set-buffered-amount-low-threshold!cljs

(set-buffered-amount-low-threshold! this val)

Property.

[Experimental]

The RTCDataChannel property bufferedAmountLowThreshold is used specify the number of bytes of buffered outgoing data that is "low." The default value is 0.

`var threshold = aDataChannel.bufferedAmountLowThreshold;

aDataChannel.bufferedAmountLowThreshold = threshold;`

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/bufferedAmountLowThreshold

Property.

[Experimental]

The RTCDataChannel property bufferedAmountLowThreshold is used
specify the number of bytes of buffered outgoing data that is
\"low.\" The default value is 0.

`var threshold = aDataChannel.bufferedAmountLowThreshold;

aDataChannel.bufferedAmountLowThreshold = threshold;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/bufferedAmountLowThreshold`
sourceraw docstring

set-onbufferedamountlow!cljs

(set-onbufferedamountlow! this val)

Property.

[Experimental]

The RTCDataChannel.onbufferedamountlow property is an EventHandler specifies a function the browser calls when the bufferedamountlow is sent to the web.rtc.RTCDataChannel. This event, which is by a simple web.event.Event object, is sent when the amount data buffered to be sent falls to or below the threshold specified the channel's bufferedAmountLowThreshold.

RTCDataChannel.onbufferedamountlow = function;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onbufferedamountlow

Property.

[Experimental]

The RTCDataChannel.onbufferedamountlow property is an `EventHandler`
specifies a function the browser calls when the bufferedamountlow
is sent to the `web.rtc.RTCDataChannel`. This event, which is
by a simple `web.event.Event` object, is sent when the amount
data buffered to be sent falls to or below the threshold specified
the channel's `bufferedAmountLowThreshold`.

`RTCDataChannel.onbufferedamountlow = function;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onbufferedamountlow`
sourceraw docstring

set-onclose!cljs

(set-onclose! this val)

Property.

[Experimental]

The RTCDataChannel.onclose property is an EventHandler which a function to be called by the browser when the close event is by the web.rtc.RTCDataChannel. This is a simple web.event.Event indicates that the data channel has closed down.

RTCDataChannel.onclose = function;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onclose

Property.

[Experimental]

The RTCDataChannel.onclose property is an `EventHandler` which
a function to be called by the browser when the close event is
by the `web.rtc.RTCDataChannel`. This is a simple `web.event.Event`
indicates that the data channel has closed down.

`RTCDataChannel.onclose = function;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onclose`
sourceraw docstring

set-onerror!cljs

(set-onerror! this val)

Property.

[Experimental]

The RTCDataChannel.onerror property is an EventHandler which a function to be called when the error event is received. When error occurs on the data channel, the function receives as input web.workers.ErrorEvent object describing the error which occurred.

RTCDataChannel.onerror = function;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onerror

Property.

[Experimental]

The RTCDataChannel.onerror property is an `EventHandler` which
a function to be called when the error event is received. When
error occurs on the data channel, the function receives as input
`web.workers.ErrorEvent` object describing the error which occurred.

`RTCDataChannel.onerror = function;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onerror`
sourceraw docstring

set-onmessage!cljs

(set-onmessage! this val)

Property.

[Experimental]

The RTCDataChannel.onmessage property stores an EventHandler specifies a function to be called when the message event is fired the channel. This event is represented by the web.workers.MessageEvent This event is sent to the channel when a message is received the other peer.

RTCDataChannel.onmessage = function;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onmessage

Property.

[Experimental]

The RTCDataChannel.onmessage property stores an `EventHandler`
specifies a function to be called when the message event is fired
the channel. This event is represented by the `web.workers.MessageEvent`
This event is sent to the channel when a message is received
the other peer.

`RTCDataChannel.onmessage = function;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onmessage`
sourceraw docstring

set-onopen!cljs

(set-onopen! this val)

Property.

[Experimental]

The RTCDataChannel.onopen property is an EventHandler which a function to be called when the open event is fired; this is simple web.event.Event which is sent when the data channel's data transport—the link over which the web.rtc.RTCDataChannel's flow—is established or re-established.

RTCDataChannel.onopen = function;

See also: https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onopen

Property.

[Experimental]

The RTCDataChannel.onopen property is an `EventHandler` which
a function to be called when the open event is fired; this is
simple `web.event.Event` which is sent when the data channel's
data transport—the link over which the `web.rtc.RTCDataChannel`'s
flow—is established or re-established.

`RTCDataChannel.onopen = function;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel/onopen`
sourceraw docstring

set-reliable!cljs

(set-reliable! this val)

Property.

The read-only RTCDataChannel property reliable indicates whether not the data channel is reliable.

Property.

The read-only RTCDataChannel property reliable indicates whether
not the data channel is reliable.
sourceraw docstring

set-stream!cljs

(set-stream! this val)

Property.

The deprecated (and never part of the official specification) RTCDataChannel property stream returns an ID number (between and 65,535) which uniquely identifies the RTCDataChannel.

Property.

The deprecated (and never part of the official specification)
RTCDataChannel property stream returns an ID number (between
and 65,535) which uniquely identifies the RTCDataChannel.
sourceraw docstring

streamcljs

(stream this)

Property.

The deprecated (and never part of the official specification) RTCDataChannel property stream returns an ID number (between and 65,535) which uniquely identifies the RTCDataChannel.

Property.

The deprecated (and never part of the official specification)
RTCDataChannel property stream returns an ID number (between
and 65,535) which uniquely identifies the RTCDataChannel.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close