Interface Millicast

Dispatches events that are fired.

interface Millicast {
    addEventListener<TType extends "stats">(
        type: TType | readonly TType[],
        listener: EventListener<MillicastEventMap[TType]>,
    ): void;
    diagnose(config: Record<string, any>): Record<string, any>;
    removeEventListener<TType extends "stats">(
        type: TType | readonly TType[],
        listener: EventListener<MillicastEventMap[TType]>,
    ): void;
}

Hierarchy (View Summary)

EventDispatcher<MillicastEventMap>
- Millicast

Index

Methods

addEventListener diagnose removeEventListener

Methods

addEventListener

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

diagnose

diagnose(config: Record<string, any>): Record<string, any>
Returns diagnostics information about the Millicast connection and environment, formatted according to the specified parameters. See the Millicast SDK API reference for details on the configuration paramater and diagnostic info return type.
Parameters
- config: Record<string, any>
Returns Record<string, any>

removeEventListener

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