Controls a video adapter
Name | Type | Description |
---|---|---|
psv |
PSV.Viewer | |
options |
PSV.plugins.VideoPlugin.Options |
Extends
Members
-
Unique identifier of the plugin
-
-
psv PSV.Viewer readonly inherited overrides
Reference to main controller
-
Methods
-
destroy () package overrides
-
-
Returns the durection of the video
-
Returns:
Type Description number -
Returns the play progression of the video
-
Returns:
Type Description number 0-1 -
Returns the current time of the video
-
Returns:
Type Description number -
Returns the video volume
-
Returns:
Type Description number -
init () package overrides
-
-
Returns if the video is playing
-
Returns:
Type Description boolean -
Pauses the cideo if playing
-
-
Starts the video if paused
-
-
Starts or pause the video
-
-
Changes the keypoints
-
Name Type Description keypoints
Array.<PSV.plugins.VideoPlugin.Keypoint> -
(Un)mutes the video
-
Name Type Description mute
boolean optional toggle if undefined
-
Changes the progression of the video
-
Name Type Description progress
number 0-1
-
Changes the current time of the video
-
Name Type Description time
number -
Sets the volume of the video
-
Name Type Description volume
number
Type Definitions
-
Properties:
Name Type Description position
PSV.ExtendedPosition time
number -
Properties:
Name Type Argument Default Description progressbar
boolean <optional>
true displays a progressbar on top of the navbar
bigbutton
boolean <optional>
true displays a big "play" button in the center of the viewer
keypoints
Array.<PSV.plugins.VideoPlugin.Keypoint> <optional>
defines autorotate timed keypoints
Events
-
Triggered when the video buffer changes
-
Name Type Description maxBuffer
number -
Triggered when the video is paused
-
-
Triggered when the video starts playing
-
-
Triggered when the video play progression changes
-
Name Type Description data
Object -
Triggered when the video volume changes
-
Name Type Description volume
number