Interface StaticPlayerAPI

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 StaticPlayerAPI(
        containerElement: HTMLElement,
        config: PlayerConfig,
    ): PlayerAPI;
    version: string;
    addModule(moduleDefinition: any): void;
    getModules(): ModuleName[];
    removeModule(name: ModuleName): void;
}

Index

Constructors

Properties

Methods

addModule getModules removeModule

Constructors

constructor

new StaticPlayerAPI(
containerElement: HTMLElement,
config: PlayerConfig,
): PlayerAPI
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

`Readonly`version

version: string

The version number of the player.

Methods

addModule

addModule(moduleDefinition: any): void
Adds a module into the player.
Parameters
- moduleDefinition: any
  the module object which should be added to the player
Returns void

getModules

getModules(): ModuleName[]

Gets the list of modules that have been added through addModule.

Returns ModuleName[]
the list of added modules

removeModule

removeModule(name: ModuleName): void
Removes a module from the player.
Parameters
- name: ModuleName
  the module name which should be removed from the player.
Returns void