Search

Search something to see results

GitHub

RTCDataChannel

MDN Reference

interface RTCDataChannel {
    charging?: boolean;
    chargingTime?: number;
    dischargingTime?: number;
    level?: number;
    dispatchEvent(event: Event): boolean;
    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);
    onopen: null | ((this: RTCDataChannel, ev: Event) => any);
    ordered: boolean;
    protocol: string;
    readyState: RTCDataChannelState;
    close(): void;
    send(data: string): void;
    send(data: Blob): void;
    send(data: ArrayBuffer): void;
    send(data: ArrayBufferView): void;
    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;
    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;
}

Hierarchy

Index

Properties

<internal>.RTCDataChannel.charging<internal>.RTCDataChannel.chargingTime<internal>.RTCDataChannel.dischargingTime<internal>.RTCDataChannel.level<internal>.RTCDataChannel.binaryType<internal>.RTCDataChannel.bufferedAmount<internal>.RTCDataChannel.bufferedAmountLowThreshold<internal>.RTCDataChannel.id<internal>.RTCDataChannel.label<internal>.RTCDataChannel.maxPacketLifeTime<internal>.RTCDataChannel.maxRetransmits<internal>.RTCDataChannel.negotiated<internal>.RTCDataChannel.onbufferedamountlow<internal>.RTCDataChannel.onclose<internal>.RTCDataChannel.onclosing<internal>.RTCDataChannel.onerror<internal>.RTCDataChannel.onmessage<internal>.RTCDataChannel.onopen<internal>.RTCDataChannel.ordered<internal>.RTCDataChannel.protocol<internal>.RTCDataChannel.readyState

Methods

<internal>.RTCDataChannel.dispatchEvent<internal>.RTCDataChannel.close<internal>.RTCDataChannel.send<internal>.RTCDataChannel.addEventListener<internal>.RTCDataChannel.removeEventListener

Properties

charging?: boolean
chargingTime?: number
dischargingTime?: number
level?: number
binaryType: BinaryType

MDN Reference

bufferedAmount: number

MDN Reference

bufferedAmountLowThreshold: number

MDN Reference

id: null | number

MDN Reference

label: string

MDN Reference

maxPacketLifeTime: null | number

MDN Reference

maxRetransmits: null | number

MDN Reference

negotiated: boolean

MDN Reference

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

MDN Reference

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

MDN Reference

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

MDN Reference

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

MDN Reference

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

MDN Reference

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

MDN Reference

ordered: boolean

MDN Reference

protocol: string

MDN Reference

readyState: RTCDataChannelState

MDN Reference

Methods

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

Returns boolean

close(): void

MDN Reference

Returns void

send(data: string): void

MDN Reference

Parameters

  • data: string

Returns void

send(data: Blob): void

Parameters

Returns void

send(data: ArrayBuffer): void

Parameters

Returns void

send(data: ArrayBufferView): void

Parameters

Returns void

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

removeEventListener<K extends keyof RTCDataChannelEventMap>(
    type: K,
    listener: (this: RTCDataChannel, ev: RTCDataChannelEventMap[K]) => any,
    options?: boolean | EventListenerOptions,
): void

Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference

Type Parameters

Parameters

Returns void

removeEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void

Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference

Parameters

Returns void