THEOplayer > MultiViewPlayer

MultiViewPlayer class

The MultiViewPlayer API.

Signature:

export declare class MultiViewPlayer implements EventDispatcher<MultiViewPlayerEventMap> 

Remarks

- Available since v4.3.0
- Only available with the feature 'multiviewplayer'.
- Only supported on modern browsers such as evergreen Chrome, Firefox and Safari. Not supported on Internet Explorer.

Properties

Methods

Property Details

autoplay

Whether the player should immediately start playback.

Signature:

autoplay: boolean;

Remarks

- To autoplay with sound on certain platforms, MultiViewPlayer.prepareWithUserAction() must be called at least once.
- To autoplay without sound, PlayerConfiguration.mutedAutoplay must be configured.

buffered

Returns a TimeRanges object that represents the intersection of all buffered properties of the underlying players.

Signature:

readonly buffered: TimeRanges;

currentTime

The current playback position of the player currently at position zero.

Signature:

currentTime: number;

duration

Returns the minimum of all duration properties of the underlying players.

Signature:

readonly duration: number;

ended

Whether any of the underlying players is ended.

Signature:

readonly ended: boolean;

errorObject

Returns the last error that occurred of the underlying players.

Signature:

readonly errorObject: THEOplayerError | undefined;

layout

The currently selected layout.

Signature:

layout: MultiViewPlayerLayout;

mainAudioView

The View whose audio is in focus.

Signature:

readonly mainAudioView: View | undefined;

Remarks

Only one view can have audio focus at a time.

mainVideoView

The View whose video is in focus.

Signature:

readonly mainVideoView: View | undefined;

Remarks

This is the same as the View at position zero.

muted

Whether all the underlying players are muted.

Signature:

muted: boolean;

paused

Whether any of the underlying players is muted.

Signature:

readonly paused: boolean;

playbackRate

Returns the playbackRate of the player at position zero.

Signature:

playbackRate: number;

played

Returns the intersection of all played properties of the underlying players.

Signature:

readonly played: TimeRanges;

readyState

Returns the minimum of all readyState properties of the underlying players.

Signature:

readonly readyState: number;

seekable

Returns the intersection of all seekable properties of the underlying players.

Signature:

readonly seekable: TimeRanges;

seeking

Whether any of the underlying players is seeking.

Signature:

readonly seeking: boolean;

views

Returns all Views in their respective order.

Signature:

readonly views: ReadonlyArray<View>;

volume

Returns the volume of the player at position zero.

Signature:

volume: number;

Method Details

addEventListener

Add the given listener for the given event type(s).

Signature:

addEventListener<TType extends StringKeyOf<MultiViewPlayerEventMap>>(type: TType | readonly TType[], listener: EventListener<MultiViewPlayerEventMap[TType]>): void;

Parameters

destroy

Calls destroy() on all underlying players and removes all views.

Signature:

destroy(): void;

exitFullscreen

Disables fullscreen mode.

Signature:

exitFullscreen(): void;

load

Creates a new view.

Signature:

load(label: string, source: SourceDescription, description?: string, offset?: number): View;

Parameters

Remarks

- If the given label clashes with an existing label, the existing view will be returned.
- A player which is created is with position set to the length of MultiViewPlayer.views.

pause

Calls pause() on all underlying players.

Signature:

pause(): void;

play

Calls play() on all underlying players and starts in-sync playback.

Signature:

play(): void;

prepareWithUserAction

Calls prepareWithUserAction() on all underlying players.

Signature:

prepareWithUserAction(): void;

removeEventListener

Remove the given listener for the given event type(s).

Signature:

removeEventListener<TType extends StringKeyOf<MultiViewPlayerEventMap>>(type: TType | readonly TType[], listener: EventListener<MultiViewPlayerEventMap[TType]>): void;

Parameters

requestFullscreen

Enables fullscreen mode on the element of the MultiViewPlayer.

Signature:

requestFullscreen(options?: FullscreenOptions): void;

Parameters

stop

Stops playback and removes all views.

Signature:

stop(): void;