This document use TypeScript-like definitions to describe interfaces.

mpegts.js exports all the interfaces through mpegts object which exposed in global context window.

mpegts object can also be accessed by require or ES6 import.

Functions:

• mpegts.createPlayer()
• mpegts.isSupported()
• mpegts.getFeatureList()

Classes:

• mpegts.MSEPlayer
• mpegts.NativePlayer
• mpegts.LoggingControl

Enums:

• mpegts.Events
• mpegts.ErrorTypes
• mpegts.ErrorDetails

function createPlayer(mediaDataSource: MediaDataSource, config?: Config): Player;

Create a player instance according to type field indicated in mediaDataSource, with optional config.

If segments field exists, transmuxer will treat this MediaDataSource as a multipart source.

In multipart mode, duration filesize url field in MediaDataSource structure will be ignored.

function isSupported(): boolean;

Return true if basic playback can works on your browser.

function getFeatureList(): FeatureList;

Return a FeatureList object which has following details:

interface MSEPlayer extends Player {}

MSE player which implements the Player interface. Can be created by new operator directly.

interface NativePlayer extends Player {}

Player wrapper for browser's native player (HTMLVideoElement) without MediaSource src, which implements the Player interface. Useful for singlepart MP4 file playback.

interface Player {
    constructor(mediaDataSource: MediaDataSource, config?: Config): Player;
    destroy(): void;
    on(event: string, listener: Function): void;
    off(event: string, listener: Function): void;
    attachMediaElement(mediaElement: HTMLMediaElement): void;
    detachMediaElement(): void;
    load(): void;
    unload(): void;
    play(): Promise<void>;
    pause(): void;
    type: string;
    buffered: TimeRanges;
    duration: number;
    volume: number;
    muted: boolean;
    currentTime: number;
    mediaInfo: Object;
    statisticsInfo: Object;
}

A global interface which include several static getter/setter to set mpegts.js logcat verbose level.

interface LoggingControl {
    forceGlobalTag: boolean;
    globalTag: string;
    enableAll: boolean;
    enableDebug: boolean;
    enableVerbose: boolean;
    enableInfo: boolean;
    enableWarn: boolean;
    enableError: boolean;
    getConfig(): Object;
    applyConfig(config: Object): void;
    addLogListener(listener: Function): void;
    removeLogListener(listener: Function): void;
}

A series of constants that can be used with Player.on() / Player.off(). They require the prefix mpegts.Events.

The possible errors that can come up during playback. They require the prefix mpegts.ErrorTypes.

Provide more verbose explanation for Network and Media errors. They require the prefix mpegts.ErrorDetails.