logo

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

Constructor

Description

constructor​(element: HTMLElement, configuration: UIPlayerConfiguration)

Constructs a new instance of the Player class

Properties

Property

Type

Description

controls

boolean

Whether the player controls are visible.

presentationMode

PresentationMode

The presentation mode of the player.

related

UIRelatedContent

The related content UI API.

social

SocialSharing

The social sharing UI API.

ui

videojs.Player

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

upnext

UpNextManager

The up next UI API.

Constructor Details

constructor

Constructs a new instance of the Player class

Signature:

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

Parameters

Parameter

Type

Description

element

HTMLElement

configuration

UIPlayerConfiguration

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'.

github
Make sure to follow us on GitHub!
THEO-logo-white
twitter
facebook
linkedin
Copyright © 2020. All Rights Reserved.
Leuven
New York
San Francisco
Singapore
Barcelona