Class TimelineEventNames

These are the event names that are being braodcast and/or handled by Eligius.

Hierarchy

  • TimelineEventNames

Constructors

Properties

BEFORE_REQUEST_TIMELINE_URI: string = 'before-request-timeline-uri'
COMPLETE: string = 'timeline-complete'
CONTAINER_REQUEST: string = 'timeline-container-request'

Broadcasting this event will return the element in which the current timeline is being rendered. This event takes one argument: The callback function that will return the specified element.

CURRENT_TIMELINE_CHANGE: string = 'timeline-current-timeline-change'
DURATION: string = 'timeline-duration'

This event is broadcast by ITimelineProvider instances to announce their duration.

DURATION_REQUEST: string = 'timeline-duration-request'

Broadcasting this event will return the duration of the current timeline. This event takes one argument: The callback function that will return the duration.

FIRST_FRAME: string = 'timeline-firstframe'
LANGUAGE_CHANGE: string = 'language-change'
PAUSE: string = 'timeline-pause'
PAUSE_REQUEST: string = 'timeline-pause-request'

Broadcasting this event will pause the current timeline.

PLAY: string = 'timeline-play'
PLAY_REQUEST: string = 'timeline-play-request'

Broadcasting this event will start the current timeline.

PLAY_TOGGLE_REQUEST: string = 'timeline-play-toggle-request'

Broadcasting this event will start the current timeline when it is currently paused, or pauses when it is playing.

REQUEST_ACTION: string = 'request-action'
REQUEST_CURRENT_LANGUAGE: string = 'request-current-language'
REQUEST_CURRENT_TIMELINE: string = 'timeline-request-current-timeline'

Broadcasting this event will return the uri of the current timeline. This event takes one argument: The callback function that will return the uri.

REQUEST_CURRENT_TIMELINE_POSITION: string = 'request-current-timeline-position'
REQUEST_ENGINE_ROOT: string = 'request-engine-root'
REQUEST_FUNCTION: string = 'request-function'
REQUEST_INSTANCE: string = 'request-instance'
REQUEST_LABEL_COLLECTION: string = 'request-label-collection'
REQUEST_LABEL_COLLECTIONS: string = 'request-label-collections'
REQUEST_TIMELINE_CLEANUP: string = 'request-timeline-cleanup'
REQUEST_TIMELINE_URI: string = 'request-timeline-uri'
RESIZE: string = 'timeline-resize'
RESIZE_REQUEST: string = 'timeline-resize-request'

Broadcasting this event will tell the current ITimelineProvider to resize.

RESTART: string = 'timeline-restart'
SEEK: string = 'timeline-seek'
SEEKED: string = 'timeline-seeked'

This event is broadcast by ITimelineProvider instances to announce the new play position and duration after a seek was executed.

SEEK_REQUEST: string = 'timeline-seek-request'

Broadcasting this event will seek the specified position in the current timeline. This event takes one argument: A numeric value that represents the new position.

STOP: string = 'timeline-stop'
STOP_REQUEST: string = 'timeline-stop-request'

Broadcasting this event will stop the current timeline.

TIME: string = 'timeline-time'

This event is broadcast by ITimelineProvider instances to announce the current play position whenever it changes.

Generated using TypeDoc