Optional
configuration: UIPlayerConfigurationWhether the player should immediately start playback.
- To autoplay with sound on certain platforms, MultiViewPlayer.prepareWithUserAction must be called at least once.
- To autoplay without sound, PlayerConfiguration.mutedAutoplay must be configured.
Readonly
bufferedReturns a TimeRanges object that represents the intersection of all buffered properties of the underlying players.
The current playback position of the player currently at position zero.
Readonly
durationReturns the minimum of all duration properties of the underlying players.
Readonly
endedWhether any of the underlying players is ended.
Readonly
errorReturns the last error that occurred of the underlying players.
The currently selected layout.
Readonly
mainThe View whose audio is in focus.
Only one view can have audio focus at a time.
Readonly
mainThe View whose video is in focus.
This is the same as the View at position zero.
Whether all the underlying players are muted.
Readonly
pausedWhether any of the underlying players is muted.
Returns the playbackRate of the player at position zero.
Readonly
playedReturns the intersection of all played properties of the underlying players.
Readonly
readyReturns the minimum of all readyState properties of the underlying players.
Readonly
seekableReturns the intersection of all seekable properties of the underlying players.
Readonly
seekingWhether any of the underlying players is seeking.
Readonly
viewsReturns all Views in their respective order.
Returns the volume of the player at position zero.
Add the given listener for the given event type(s).
The type of the event.
The callback which is executed when the event occurs.
Creates a new view.
The name belonging to a view which is used in the multiview menu.
The SourceDescription set on the view.
Optional
description: stringA short description of the view which will be displayed on top.
Optional
offset: numberThe offset in milliseconds used for improving synchronization between views.
- 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.
Remove the given listener for the given event type(s).
The type of the event.
The callback which will be removed.
Generated using TypeDoc
The MultiViewPlayer API.
Remarks
- Available since v4.3.0
- Only available with the feature
'multiview'
.- Only supported on modern browsers such as evergreen Chrome, Firefox and Safari. Not supported on Internet Explorer.