FrameTrail API Docs

  • for FrameTrail Version: 0.8.1

    • Modules & Types

    Show:

    Subtitle Type

    Defined in: frametrail/player/types/Subtitle/type.js:6
    Module: Player

    I am the type definition of a single Subtitle.

    Subtitles display in a separate layer on top of the video.

    Subtitles are managed by the SubtitlesController.

    Methods

    removeFromDOM

    ()

    Defined in frametrail/player/types/Subtitle/type.js:72

    I remove my DOM element (Subtitle/subtitleElement from the DOM.

    I am called when the single Subtitle is to be deleted.

    renderInDOM

    ()

    Defined in frametrail/player/types/Subtitle/type.js:53

    I render my DOM elements (Overlay/timelineElement and Overlay/overlayElement) into the DOM.

    I am called, when the Overlay is initialized. My counterpart ist Overlay/removeFromDOM.

    setActive

    ()

    Defined in frametrail/player/types/Subtitle/type.js:86

    When I am scheduled to be displayed, this is the method to be called.

    setInactive

    ()

    Defined in frametrail/player/types/Subtitle/type.js:97

    When I am scheduled to disappear, this is the method to be called.

    Attributes

    activeState

    Boolean

    Defined in frametrail/player/types/Subtitle/type.js:39

    I store my state, wether I am "active" (visible) or not active (invisible).

    data

    Defined in frametrail/player/types/Subtitle/type.js:32

    I hold the data object of a single Subtitle, which is stored in the Database.

    subtitleElement

    HTMLElement

    Defined in frametrail/player/types/Subtitle/type.js:46

    I hold the subtitleElement (a jquery-enabled HTMLElement), which indicates my start and end time.