Interface RTCDataChannel

EventTarget is a DOM interface implemented by objects that can receive events and may have listeners for them.

interface RTCDataChannel {
    binaryType: BinaryType;
    bufferedAmount: number;
    bufferedAmountLowThreshold: number;
    id: null | number;
    label: string;
    maxPacketLifeTime: null | number;
    maxRetransmits: null | number;
    negotiated: boolean;
    onbufferedamountlow: null | ((this, ev) => any);
    onclose: null | ((this, ev) => any);
    onclosing: null | ((this, ev) => any);
    onerror: null | ((this, ev) => any);
    onmessage: null | ((this, ev) => any);
    onopen: null | ((this, ev) => any);
    ordered: boolean;
    protocol: string;
    readyState: RTCDataChannelState;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    close(): void;
    dispatchEvent(event): boolean;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
    send(data): void;
    send(data): void;
    send(data): void;
    send(data): void;
}

Hierarchy (view full)

Properties

binaryType bufferedAmount bufferedAmountLowThreshold id label maxPacketLifeTime maxRetransmits negotiated onbufferedamountlow onclose onclosing onerror onmessage onopen ordered protocol readyState

Methods

addEventListener close dispatchEvent removeEventListener send

Properties

binaryType

binaryType: BinaryType

Readonly bufferedAmount

bufferedAmount: number

bufferedAmountLowThreshold

bufferedAmountLowThreshold: number

Readonly id

id: null | number

Readonly label

label: string

Readonly maxPacketLifeTime

maxPacketLifeTime: null | number

Readonly maxRetransmits

maxRetransmits: null | number

Readonly negotiated

negotiated: boolean

onbufferedamountlow

onbufferedamountlow: null | ((this, ev) => any)

Type declaration

onclose

onclose: null | ((this, ev) => any)

Type declaration

onclosing

onclosing: null | ((this, ev) => any)

Type declaration

onerror

onerror: null | ((this, ev) => any)

Type declaration

onmessage

onmessage: null | ((this, ev) => any)

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onopen

onopen: null | ((this, ev) => any)

Type declaration

Readonly ordered

ordered: boolean

Readonly protocol

protocol: string

Readonly readyState

readyState: RTCDataChannelState

Methods

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    Type Parameters

    Parameters

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    Returns void

close

  • close(): void

  • Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    Returns boolean

removeEventListener

send

  • send(data): void

  • Parameters

    • data: string

    Returns void

  • send(data): void

  • Parameters

    • data: Blob

    Returns void

  • send(data): void

  • Parameters

    • data: ArrayBuffer

    Returns void

  • send(data): void

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page