FrameTrail API Docs

  • for FrameTrail Version: 0.8.1

    • Modules & Types

    Show:

    InteractionController Module

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

    I am the InteractionController.

    I listen to key events which happen on window.document & and scroll events on the 'ViewVideo' element. When the keycode is in the local map keyBindings, I call the bound method.

    Methods

    initController

    ()

    Defined in frametrail/player/modules/InteractionController/module.js:40

    I set the event listener which triggers the appropriate event-handler.

    Returns:

    CallExpression or undefined

    interfaceDown

    ()

    Defined in frametrail/player/modules/InteractionController/module.js:141

    I {{#crossLink "ViewVideo/slidePositionDown:method"}}slide the video view down{{#crossLink}}.

    In case the annotation position is set to 'bottom' and no annotation has been opened before, I try to {{#crossLink "Annotation/openAnnotation:method"}}open the first annotation{{/crossLink}}.

    interfaceLeft

    ()

    Defined in frametrail/player/modules/InteractionController/module.js:175

    I try to open the annotation to the left of the currently selected annotation.

    interfaceRight

    ()

    Defined in frametrail/player/modules/InteractionController/module.js:208

    I try to open the annotation to the right of the currently selected annotation.

    interfaceUp

    ()

    Defined in frametrail/player/modules/InteractionController/module.js:106

    I {{#crossLink "ViewVideo/slidePositionUp:method"}}slide the video view up{{#crossLink}}.

    In case the annotation position is set to 'top' and no annotation has been opened before, I try to {{#crossLink "Annotation/openAnnotation:method"}}open the first annotation{{/crossLink}}.

    spaceKey

    ()

    Defined in frametrail/player/modules/InteractionController/module.js:240

    When the space key is pressed, I toggle play / pause in the player

    xKey

    ()

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

    When the "x" key is pressed, I change the xKey state so other modules can listen to the change