Developer toolkit for adding annotation to streaming video presentations.
Video Annotator uses events to notify components of changes in data or application state. For example, the video driver will fire events notifying components about the progress of the video as it plays, allowing annotations to be brought in and out of view.
Each event object has two methods:
#addListener, to add a callback function that is called when the event fires, and
#fire, to fire the event. See the MITHgrid documentation on events for more details. Generally, you will use
#addListener and not
In the following list of events, the top-level heading is the namespace holding the initInstance function that creates an object of that type. Each instance will have the listed events as properties of the instance’s
events property. For example, if
app is an instance of
OAC.Client.StreamingVideo, then you would use
app.events.onActiveAnnotationChange.addListener(...) to add a function that gets called when the active annotation changes for the
app application instance.
Binding events are those associated with the binding object returned when a controller is bound to a DOM element. Static events are available from the namespace instead of an instance.
Unless otherwise noted, events are multicast and not preventable.
In addition to the following events, instances have a data store (
app.dataStore.canvas) and a data view (
app.dataView.currentAnnotations) that have their own events (assuming the instance is held in
app). See the MITHgrid documentation for data stores and data views for more information.
Each binding of a video player driver to a video player has the following events.