Interface Network

The network API.

Remarks

- Available since v2.21.0.

interface Network {
    estimator: NetworkEstimator;
    online: boolean;
    addEventListener<TType extends keyof NetworkEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<NetworkEventMap[TType]>,
    ): void;
    addRequestInterceptor(interceptor: RequestInterceptor): void;
    addResponseInterceptor(interceptor: ResponseInterceptor): void;
    removeEventListener<TType extends keyof NetworkEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<NetworkEventMap[TType]>,
    ): void;
    removeRequestInterceptor(interceptor: RequestInterceptor): void;
    removeResponseInterceptor(interceptor: ResponseInterceptor): void;
    setEstimator(estimator: undefined | MeasurableNetworkEstimator): void;
}

Hierarchy (View Summary)

Index

Properties

estimator online

Methods

addEventListener addRequestInterceptor addResponseInterceptor removeEventListener removeRequestInterceptor removeResponseInterceptor setEstimator

Properties

`Readonly`estimator

estimator: NetworkEstimator

Returns the active MeasurableNetworkEstimator. An internal implementation is provided by default.

`Readonly`online

online: boolean

Whether the stream is online.

Methods

addEventListener

addEventListener<TType extends keyof NetworkEventMap>(
type: TType | readonly TType[],
listener: EventListener<NetworkEventMap[TType]>,
): void
Add the given listener for the given event type(s).
Type Parameters
- TType extends keyof NetworkEventMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<NetworkEventMap[TType]>
  The callback which is executed when the event occurs.
Returns void
Inherited from EventDispatcher.addEventListener

addRequestInterceptor

addRequestInterceptor(interceptor: RequestInterceptor): void
Add a request interceptor.
Parameters
- interceptor: RequestInterceptor
  A RequestInterceptor
Returns void
Inherited from NetworkInterceptorController.addRequestInterceptor

addResponseInterceptor

addResponseInterceptor(interceptor: ResponseInterceptor): void
Add a response interceptor.
Parameters
- interceptor: ResponseInterceptor
  A ResponseInterceptor
Returns void
Inherited from NetworkInterceptorController.addResponseInterceptor

removeEventListener

removeEventListener<TType extends keyof NetworkEventMap>(
type: TType | readonly TType[],
listener: EventListener<NetworkEventMap[TType]>,
): void
Remove the given listener for the given event type(s).
Type Parameters
- TType extends keyof NetworkEventMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<NetworkEventMap[TType]>
  The callback which will be removed.
Returns void
Inherited from EventDispatcher.removeEventListener

removeRequestInterceptor

removeRequestInterceptor(interceptor: RequestInterceptor): void
Remove a request interceptor.
Parameters
- interceptor: RequestInterceptor
  A RequestInterceptor
Returns void
Inherited from NetworkInterceptorController.removeRequestInterceptor

removeResponseInterceptor

removeResponseInterceptor(interceptor: ResponseInterceptor): void
Remove a response interceptor.
Parameters
- interceptor: ResponseInterceptor
  A ResponseInterceptor
Returns void
Inherited from NetworkInterceptorController.removeResponseInterceptor

setEstimator

setEstimator(estimator: undefined | MeasurableNetworkEstimator): void
Set a MeasurableNetworkEstimator implementation for internal use by the player.
Parameters
- estimator: undefined | MeasurableNetworkEstimator
Returns void
Inherited from NetworkEstimatorController.setEstimator