web.rtc.RTCDataChannel — clojure-interop/cljs-web-api 1.0.2

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).

binary-type cljs

(binary-type this)

Property.

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

buffered-amount cljs

(buffered-amount this)

Property.

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

buffered-amount-low-threshold cljs

(buffered-amount-low-threshold this)

Property.

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

close cljs

(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

id cljs

(id this)

Property.

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

label cljs

(label this)

Property.

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

max-packet-life-time cljs

(max-packet-life-time this)

Property.

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

max-retransmits cljs

(max-retransmits this)

Property.

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

negotiated cljs

(negotiated this)

Property.

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

onbufferedamountlow cljs

(onbufferedamountlow this)

Property.

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

onclose cljs

(onclose this)

Property.

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

onerror cljs

(onerror this)

Property.

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

onmessage cljs

(onmessage this)

Property.

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

onopen cljs

(onopen this)

Property.

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

ordered cljs

(ordered this)

Property.

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

protocol cljs

(protocol this)

Property.

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

ready-state cljs

(ready-state this)

Property.

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

reliable cljs

(reliable this)

Property.

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

var reliable = aDataChannel.reliable;

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

send cljs

(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

set-binary-type! cljs

(set-binary-type! this val)

Property.

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

set-buffered-amount-low-threshold! cljs

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

Property.

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

set-onbufferedamountlow! cljs

(set-onbufferedamountlow! this val)

Property.

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

set-onclose! cljs

(set-onclose! this val)

Property.

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

set-onerror! cljs

(set-onerror! this val)

Property.

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

set-onmessage! cljs

(set-onmessage! this val)

Property.

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

set-onopen! cljs

(set-onopen! this val)

Property.

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

stream cljs

(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 web.rtc.RTCDataChannel.

var stream = aDataChannel.stream;

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