THEOplayer > Player

Player class

Inherits from ChromelessPlayer . See parent page for inherited properties and methods.

The player API extended with UI functionality.

Signature:

export declare class Player extends ChromelessPlayer 

Remarks

- Only available with the feature 'ui'.

Constructors

Properties

Constructor Details

constructor

Constructs a new instance of the Player class

Signature:

constructor(element: HTMLElement, configuration?: UIPlayerConfiguration);

Parameters

Property Details

controls

Whether the player controls are visible.

Signature:

controls: boolean;

presentationMode

Warning: This API is deprecated.

Superseded by Presentation.currentMode and Presentation.requestMode().

The presentation mode of the player.

Signature:

presentationMode?: PresentationMode;

related

The related content UI API.

Signature:

readonly related?: UIRelatedContent;

Remarks

- Only available with the feature 'relatedcontent'.

social

The social sharing UI API.

Signature:

readonly social?: SocialSharing;

Remarks

- Only available with the feature 'social'.

ui

The Video.js player on which the UI is built.

Signature:

readonly ui: videojs.Player;

upnext

The up next UI API.

Signature:

readonly upnext?: UpNextManager;

Remarks

- Only available with the feature 'upnext'.