FrameTrail API Docs

  • for FrameTrail Version: 0.8.1

    • Modules & Types

    Show:

    OverlaysController Module

    Defined in: frametrail/player/modules/OverlaysController/module.js:6
    Module: Player

    I am the OverlaysController. I am responsible for managing all the overlays in the current HypervideoModel, and for displaying them for viewing and editing.

    Methods

    addSyncedMedia

    (
    • overlay
    )

    Defined in frametrail/player/modules/OverlaysController/module.js:95

    I add an overlay to an array, which is used by this.syncMedia() to keep time-based overlays in sync with the main video. .

    Parameters:

    deleteOverlay

    (
    • overlay
    )

    Defined in frametrail/player/modules/OverlaysController/module.js:453

    I am the central function for deleting an overlay. I call all other methods necessary to delete it.

    Parameters:

    initController

    ()

    Defined in frametrail/player/modules/OverlaysController/module.js:32

    I tell all overlays in the HypervideoModel/overlays attribute to render themselves into the DOM.

    initEditOptions

    ()

    Defined in frametrail/player/modules/OverlaysController/module.js:470

    I prepare the "edit options" area, when the overlay editing mode is started. I fill the space with a list of thumbnails representing all resources, which can then be dragged onto the overlay container.

    See makeTimelineDroppable().

    makeTimelineDroppable

    (
    • droppable
    )

    Defined in frametrail/player/modules/OverlaysController/module.js:276

    I make the overlay container (not the timeline, despite my name) ready to accept dropped elements. These elements are thumbnails rendered from from the respective [ResourceType]/renderThumb() method.

    Upon drop, I read the meta-data stored in the data attributes of the thumbelement, and create and initialize the new overlay object.

    When my parameter is not true, I reset the drop functionality of the overlay container.

    Parameters:

    muteMedia

    ()

    Defined in frametrail/player/modules/OverlaysController/module.js:172

    I set the muted state of all media overlays (currently only

    removePropertiesControls

    ()

    Defined in frametrail/player/modules/OverlaysController/module.js:433

    I am the counterpart of renderPropertiesControls method. I remove the DOM element and the update functions.

    removeSyncedMedia

    (
    • overlay
    )

    Defined in frametrail/player/modules/OverlaysController/module.js:115

    I remove the overlay given as argument from the array of synced media. See also this.syncMedia()

    Parameters:

    renderPropertiesControls

    (
    • propertiesControlsInterface
    )

    Defined in frametrail/player/modules/OverlaysController/module.js:412

    When an overlay got "into focus", its gotInFocus method calls this method, to do two jobs:

    • first, append the properties controls elements to the respective DOM element.
    • secondly, save references to the update functions of the control interface, so that the textual data values of the controls (like start and end time or dimensions) can be updated, when they are changed directly by mouse interactions with the timeline or overlay element.

    Parameters:

    • propertiesControlsInterface Object

    resetTimelineView

    ()

    Defined in frametrail/player/modules/OverlaysController/module.js:259

    I reset the timeline to its default CSS configuration.

    setOverlayInFocus

    (
    • overlay
    )

    Defined in frametrail/player/modules/OverlaysController/module.js:383

    I set the overlay from the parameter (when given) "in focus" and remove any previous overlay from focus.

    Parameters:

    stackTimelineView

    ()

    Defined in frametrail/player/modules/OverlaysController/module.js:245

    I change the behavior and appearnace of the timeline of overlays, so that overlays are displayed "stacked" and do not overlap each other.

    syncMedia

    ()

    Defined in frametrail/player/modules/OverlaysController/module.js:135

    I synchronize the currentTime and the play/pause state of all overlays in the array of syncedMedia with the main video.

    toggleEditMode

    (
    • editMode
    • oldEditMode
    )

    Defined in frametrail/player/modules/OverlaysController/module.js:199

    I react to a change in the global state "editMode".

    When we enter the editMode "overlays", I prepare all overlays and the editor interface elements.

    When leaving the editMode "overlays", I restore them.

    Parameters:

    updateStatesOfOverlays

    (
    • currentTime
    )

    Defined in frametrail/player/modules/OverlaysController/module.js:50

    I am the central method for coordinating the time-based state of the overlays. I switch them active or inactive based on the current time.

    Parameters:

    Attributes

    overlayInFocus

    Overlay or null

    Defined in frametrail/player/modules/OverlaysController/module.js:564

    I hold the overlay "in focus", which is choosen by selecting the timeline element or the overlay element. I use the setOverlayInFocus method.

    updateControlsDimensions

    Function readonly

    Defined in frametrail/player/modules/OverlaysController/module.js:597

    I hold the callback function for dimension attributes (overlay.data.position[]) of the properties controls interface (see renderPropertiesControls).

    I am called from the "drag" event handler in Overlay/makeOverlayElementDraggable() and from the "resize" event handler in Overlay/makeOverlayElementResizeable().

    updateControlsEnd

    Function readonly

    Defined in frametrail/player/modules/OverlaysController/module.js:585

    I hold the callback function for end time (overlay.data.end) of the properties controls interface (see renderPropertiesControls).

    I am called from the "drag" event handler in Overlay/makeTimelineElementDraggable() and from the "resize" event handler in Overlay/makeTimelineElementResizeable().

    updateControlsStart

    Function readonly

    Defined in frametrail/player/modules/OverlaysController/module.js:573

    I hold the callback function for start time (overlay.data.start) of the properties controls interface (see renderPropertiesControls).

    I am called from the "drag" event handler in Overlay/makeTimelineElementDraggable() and from the "resize" event handler in Overlay/makeTimelineElementResizeable().