Optional Readonly sideFeature support flag. If set to true, indicates that the player has support for side panel layout, including for full screen. Player that supports side panel layout, must reserve space for the widget, if requested by the widget. The widget applies number of classes and css variables to the player element:
Optional autoplayOptional controlsOptional controls(OPTIONAL) Get player controls Element for embedding annoto timeline for overlay and full screen mode. NOTE: Although this method is optional it's highly recomended and will make the integration much simpler, imrove performance and provide better User experience. NOTE: if not supported the function must be undefined.
Optional controlsif string, may contain 'px'
(OPTIONAL) Get player controls height in pixels. If supported it will be used instead of controlsDescriptor values. NOTE: if not supported the function must be undefined. Annoto will use other methods to detect height of the player.
Optional controlsGet the total media track duration in seconds 0 or NaN or 'undefined' values may be returned until media is ready. Note: For live video for best experience return the latest known duration of the stream. (for DVR enabled live stream, it can defer from currentTime)
Optional embeddableOptional fix(OPTIONAL) By default Annoto will try applying a fix To enable Annoto to work when player enters Full screen. The fix is moving annoto-app container as a child of the player element or embeddableElement() annoto-app will be moved only if the player element allows it (is NOT an IFRAME). annoto-app will be moved when player enters full screen, and moved back to the original parent of annoto-app obtained at Annoto.boot() call. NOTE: In rare case when this must be disabled, return false from the function.
Optional fullOptional heighthtml DOM element of the player (as configured by Annoto API)
Optional params: anyplayer.params of API configuration
This method is called by Annoto as the first method. Use it to configure the player interface object. If the method returns false, Annoto will retry a number of times with fixed period of time between the retries. This is useful if your player needs to load some resources, or wait for some condition. Notice: For Advanced use cases, the method can return a Promise. If a Promise is returned, No retries shall be performed. Annoto will wait for Promise resolve/reject.
Optional isOptional media(OPTIONAL) Get Details for the media. Notice: this value can be overriden by player.mediaDetails widget configuration.
Get currently played media source. The returned value, identifies the current video and must be unique. It can be a full URL or an unique identifier. Notice: this value can be overriden by player.mediaSrc widget configuration.
Optional on(OPTIONAL) cb should be called when click event captured on player progress bar or keydown event captured on player. Implementation of this callback may improve interactions and fast forwarding limit functionality NOTE: if not supported the function must be undefined.
Optional on(DEPRECATED) cb should be called when mouse enters player controls. If implemented the onControlsLeave() method must be implemented as well. NOTE: In most cases this event is not required. NOTE: if not supported the function must be undefined. If defined the main usage of this event is to hide Annoto Timeline when user hovers mouse over the players controls, for example for players where Annoto Timeline interfers with some hover functionality of the player. The function is required only for Iframe players for other players Annoto can detect the event by itself.
Optional on(OPTIONAL) cb should be called when player controls are hidden. If implemented the onControlsShow() method must be implemented as well. If implemented those events will be used instead of mouse tracking and controlsDescriptor.mouse parameters. NOTE: if not supported the function must be undefined. Annoto will use other methods to detect controls state.
Optional on(DEPRECATED) cb should be called when mouse leaves player controls. If implemented the onControlsEnter() method must be implemented as well. NOTE: In most cases this event is not required. NOTE: if not supported the function must be undefined. If defined the main usage of this event is to hide Annoto Timeline when user hovers mouse over the players controls, for example for players where Annoto Timeline interfers with some hover functionality of the player. The function is required only for Iframe players for other players Annoto can detect the event by itself.
Optional on(OPTIONAL) cb should be called when player controls are shown. If implemented the onControlsHide() method must be implemented as well. If implemented those events will be used instead of mouse tracking and controlsDescriptor.mouse parameters. NOTE: if not supported the function must be undefined. Annoto will use other methods to detect controls state.
Optional onOptional onthe callback may pass non mandatory new full screen state as boolean.
Optional isFullScreen: boolean(OPTIONAL) cb should be called when full screen state of the player changes. NOTE: if not supported the function must be undefined. Annoto will use other methods to detect full screen changes.
Optional onOptional onOptional remove(OPTIONAL) called by Annoto to release resources when the widget is closing. NOTICE: Although optional this method is highly recommended if you use Annoto API to dynamically load and close the widget. The adaptor implementation should discard the events that were regsitered using the onReady, onPlay, etc. when remove() is called.
Optional trackif string, may contain 'px'
(OPTIONAL) Get player controls track (progress bar) left margin in pixels. If supported it will be used instead of controlsDescriptor values. NOTE: if not supported the function must be undefined. Annoto will use other methods to detect height of the player.
Optional trackif string, may contain 'px'
(OPTIONAL) Get player player controls track (progress bar) right margin in pixels. If supported it will be used instead of controlsDescriptor values. NOTE: if not supported the function must be undefined. Annoto will use other methods to detect height of the player.
Optional update(OPTIONAL) If defined will be called at view refreshes of the widget. Allows the player to perform optional adjustments to the controls descriptor. NOTE: may be called frequently, so no heavy operations should be performed.
Optional video(OPTIONAL) Get the ration of width / height of the video frame itself. Note: the ratio shold be of the video frame, not of the player element (it can be differnt). Note: In most cases this method is not required. It is required only if the controls size depends on the video frame size and not on the player element size, for example this is the case in Vimeo player.
Optional width
Description
Annoto Player Adaptor API