videoPane Class Reference
The videoPane will create a <video> tag and manage its settings. More...
#include "remoto!stdlib:js/panes/panes/video.js"
Inheritance diagram for videoPane:
Public Member Functions | |
| videoPane (layout) | |
| videoPane constructor More... | |
| applyDiff (diff, user) | |
| applySettings (settings) | |
| applySubscription (data, metadata) | |
| attached () | |
| buildChapters (chapters, chapter) | |
| createHTML () | |
| destroy () | |
| detach () | |
| playChange (e) | |
| videoEnded () | |
| videoLoaded () | |
| videoLoadError () | |
| volumeChange (e) | |
 Public Member Functions inherited from pane | |
| pane (layout, object) | |
| activate () | |
| DOCME. More... | |
| applyDiff (data, user) | |
| applyReleaseLock (data) | |
| applyRequestError (command, id, reason) | |
| applyRequestLock (data) | |
| applyRequestSuccess (command, id, data, metadata) | |
| applySettings (settings) | |
| applySubscription (data, metadata) | |
| area () | |
| attach () | |
| Provides an opportunity for a pane to pass an attach command to its object. More... | |
| attached () | |
| Detects is this pane is attached to the DOM. More... | |
| createHTML () | |
| deactivate () | |
If a deactivate method is present on this pane's _object, call it. More... | |
| destroy () | |
| DOCME. More... | |
| detach () | |
Detach this._html and call this._object.detach(). More... | |
| find (p, type) | |
| hasHelp () | |
| mounted (mountState) | |
| Notify this pane that the mounted state has changed. More... | |
| rename (name) | |
| resize () | |
| DOCME. More... | |
| saveLayout () | |
| Build the layout for this pane. More... | |
| triggerCurrentPane () | |
| DOCME. More... | |
| getter | help |
| A getter that will return a pane object's help message, or a default message indicating that no help is available. More... | |
| getter | paneType |
| A getter which will calculate the pane type based on the _object, or return the default "pane". More... | |
Getters & Setters | |
| setter | play |
| a setter, receives true or false to set the video in a play/pause state More... | |
| setter | volume |
| a setter DOCME More... | |
| setter | muted |
| a setter DOCME More... | |
| setter | loop |
| a setter DOCME More... | |
| setter | currentTime |
| a setter DOCME More... | |
| setter | chapter |
| a setter DOCME More... | |
Detailed Description
The videoPane will create a <video> tag and manage its settings.
The videoPane accepts no options. All options are provided by the data file (usually .vid) being viewed.
A video data file (ie, .vid) can contain:
- play: (boolean) play state
- volume: (float) 1-0 volume level
- muted: (boolean) mute state
- loop: (boolean) video loops?
- restart: (trigger) can be sent to force a video to go to time 0
- feedback: (boolean) a player can choose to not report its state back to the video state file
- chapter: (json object) contains { options:{ options:[] }, value:v } for identifying chapter states
- src: (object) { mime:url, mime2:url2, ... } a list of urls to mime versions of a video
- [other]: (various) any other attribute to place on the video tag, for instance "controls" or "poster"
Constructor & Destructor Documentation
◆ videoPane()
| videoPane | ( | layout | ) |
Member Function Documentation
◆ applyDiff()
| applyDiff | ( | diff, | |
| user | |||
| ) |
- Parameters
-
diff user
DOCME
◆ applySettings()
| applySettings | ( | settings | ) |
- Parameters
-
settings
DOCME
◆ applySubscription()
| applySubscription | ( | data, | |
| metadata | |||
| ) |
- Parameters
-
data metadata
- Returns
DOCME
◆ attached()
| attached | ( | ) |
DOCME
◆ buildChapters()
| buildChapters | ( | chapters, | |
| chapter | |||
| ) |
- Parameters
-
chapters chapter
DOCME
◆ chapter()
| setter chapter |
a setter DOCME
◆ createHTML()
| createHTML | ( | ) |
- Returns
DOCME
◆ currentTime()
| setter currentTime |
a setter DOCME
◆ destroy()
| destroy | ( | ) |
DOCME
◆ detach()
| detach | ( | ) |
DOCME
◆ loop()
| setter loop |
a setter DOCME
◆ muted()
| setter muted |
a setter DOCME
◆ play()
| setter play |
a setter, receives true or false to set the video in a play/pause state
◆ playChange()
| playChange | ( | e | ) |
- Parameters
-
e
DOCME
◆ videoEnded()
| videoEnded | ( | ) |
DOCME
◆ videoLoaded()
| videoLoaded | ( | ) |
- Returns
DOCME
◆ videoLoadError()
| videoLoadError | ( | ) |
- Returns
DOCME
◆ volume()
| setter volume |
a setter DOCME
◆ volumeChange()
| volumeChange | ( | e | ) |
- Parameters
-
e
DOCME
The documentation for this class was generated from the following file:
