The static interface of the Bitmovin Player API class that is either available through the global [window.]bitmovin.player.Player namespace or imported as AMD module. The static API provides the constructor for player instances and other static fields as documented.

interface StaticPlayerAPI {
    new StaticPlayerAPInew (containerElement, config): PlayerAPI;
    version: string;
    addModule(moduleDefinition): void;
    getModules(): ModuleName[];
    removeModule(name): void;
}

Constructors

Properties

Methods

Constructors

  • Creates a new player instance.

    Parameters

    • containerElement: HTMLElement

      the DOM element container for the player

    • config: PlayerConfig

      the player configuration

    Returns PlayerAPI

    the player instance

Properties

version: string

The version number of the player.

Methods

  • Adds a module into the player.

    Parameters

    • moduleDefinition: any

      the module object which should be added to the player

    Returns void

  • Removes a module from the player.

    Parameters

    • name: ModuleName

      the module name which should be removed from the player.

    Returns void

Generated using TypeDoc