Interface RTCDataChannel

MDN Reference

interface RTCDataChannel {
    binaryType: BinaryType;
    bufferedAmount: number;
    bufferedAmountLowThreshold: number;
    id: null | number;
    label: string;
    maxPacketLifeTime: null | number;
    maxRetransmits: null | number;
    negotiated: boolean;
    onbufferedamountlow: null | (this: RTCDataChannel, ev: Event) => any;
    onclose: null | (this: RTCDataChannel, ev: Event) => any;
    onclosing: null | (this: RTCDataChannel, ev: Event) => any;
    onerror: null | (this: RTCDataChannel, ev: RTCErrorEvent) => any;
    onmessage: null | (this: RTCDataChannel, ev: MessageEvent<any>) => any;
    onopen: null | (this: RTCDataChannel, ev: Event) => any;
    ordered: boolean;
    protocol: string;
    readyState: RTCDataChannelState;
    addEventListener<K extends keyof RTCDataChannelEventMap>(
        type: K,
        listener: (this: RTCDataChannel, ev: RTCDataChannelEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    close(): void;
    dispatchEvent(event: Event): boolean;
    removeEventListener<K extends keyof RTCDataChannelEventMap>(
        type: K,
        listener: (this: RTCDataChannel, ev: RTCDataChannelEventMap[K]) => any,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
    send(data: string): void;
    send(data: Blob): void;
    send(data: ArrayBuffer): void;
    send(data: ArrayBufferView<ArrayBufferLike>): void;
}

Hierarchy

  • EventTarget
    • RTCDataChannel

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

MDN Reference

ReadonlybufferedAmount

bufferedAmount: number

MDN Reference

bufferedAmountLowThreshold

bufferedAmountLowThreshold: number

MDN Reference

Readonlyid

id: null | number

MDN Reference

Readonlylabel

label: string

MDN Reference

ReadonlymaxPacketLifeTime

maxPacketLifeTime: null | number

MDN Reference

ReadonlymaxRetransmits

maxRetransmits: null | number

MDN Reference

Readonlynegotiated

negotiated: boolean

MDN Reference

onbufferedamountlow

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

MDN Reference

onclose

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

MDN Reference

onclosing

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

MDN Reference

onerror

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

MDN Reference

onmessage

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

MDN Reference

onopen

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

MDN Reference

Readonlyordered

ordered: boolean

MDN Reference

Readonlyprotocol

protocol: string

MDN Reference

ReadonlyreadyState

readyState: RTCDataChannelState

MDN Reference

Methods

addEventListener

  • addEventListener<K extends keyof RTCDataChannelEventMap>(
        type: K,
        listener: (this: RTCDataChannel, ev: RTCDataChannelEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): 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.

    MDN Reference

    Type Parameters

    Parameters

    Returns void

  • addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): 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.

    MDN Reference

    Parameters

    Returns void

close

  • close(): void

  • MDN Reference

    Returns void

dispatchEvent

  • dispatchEvent(event: 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.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

removeEventListener

send

  • send(data: string): void

  • MDN Reference

    Parameters

    • data: string

    Returns void

  • send(data: Blob): void

  • Parameters

    • data: Blob

    Returns void

  • send(data: ArrayBuffer): void

  • Parameters

    • data: ArrayBuffer

    Returns void

  • send(data: ArrayBufferView<ArrayBufferLike>): void

  • Parameters

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods