Class PlayerExternalAPI

External player API.

Hierarchy

  • PlayerExternalAPI

Actions

seek play pause changeVolume mute unmute changeQuality changeSpeed getQualityOptions getSpeedOptions enableCustomTurnstileIntegration

Common

isInitialized isDestroyed destroy onAPIReady

Subscriptions

onPlay onPause onSeekStarted onSeeked onTimeUpdate onQualityChange onVolumeChange onSpeedChange onReady onEnd onGetQualityOptions onGetSpeedOptions onUpdateDimensions onTimelineUnlock onTimelineTurnstileSkipped onTimelineTurnstileCompleted onTimelineButtonClick onTimelineButtonEnter onTimelineButtonPreExit onTimelineButtonExit onTimelineImageClick onTimelineImageEnter onTimelineImagePreExit onTimelineImageExit onTimelineGridClick onTimelineGridEnter onTimelineGridPreExit onTimelineGridExit onTimelineSurveyClick onTimelineSurveyEnter onTimelineSurveyPreExit onTimelineSurveyExit onTimelineQuizChoice onTimelineQuizEnter onTimelineQuizExit onTimelineAnnotationClick onTimelineImageAnnotationClick

Actions

seek

  • Ask video to jump on the given frame time.

    Events to listen: onSeekStarted and onSeeked

    External action event 'voomly:video:seek'

    Parameters

    • payload: number | {
          time: number;
      }

    Returns void

play

  • Ask video to play.

    Must be executed only with manual action (for ex. button click). To be able to start the video right after it's ready, use "autoplay" function in player editor.

    Events to listen: onPlay

    External action event 'voomly:video:play'

    Parameters

    • payload: number | void | {
          time: number;
      }

    Returns void

pause

pause: ((payload) => void) = ...

Type declaration

    • (payload): void

    • Ask video to pause.

      Events to listen: onPause

      External action event 'voomly:video:pause'

      Parameters

      • payload: void

      Returns void

changeVolume

changeVolume: ((payload) => void) = ...

Type declaration

    • (payload): void

    • Ask video to change volume.

      Events to listen: onVolumeChange

      External action event 'voomly:video:changeVolume'

      Parameters

      • payload: {
            volume: number;
        }
        • volume: number

      Returns void

mute

mute: ((payload) => void) = ...

Type declaration

    • (payload): void

    • Ask video to mute.

      Events to listen: onVolumeChange

      External action event 'voomly:video:mute'

      Parameters

      • payload: void

      Returns void

unmute

unmute: ((payload) => void) = ...

Type declaration

    • (payload): void

    • Ask video to unmute.

      Events to listen: onVolumeChange

      External action event 'voomly:video:unmute'

      Parameters

      • payload: void

      Returns void

changeQuality

changeQuality: ((payload) => void) = ...

Type declaration

    • (payload): void

    • Ask video to change video quality

      Events to listen: onQualityChange

      External action event 'voomly:video:changeQuality'

      Parameters

      • payload: {
            quality: number;
            hlsUrl: string;
        }
        • quality: number
        • hlsUrl: string

      Returns void

changeSpeed

changeSpeed: ((payload) => void) = ...

Type declaration

    • (payload): void

    • Ask video to change video playback rate

      Events to listen: onSpeedChange

      External action event 'voomly:video:changeSpeed'

      Parameters

      • payload: {
            speed: number;
        }
        • speed: number

      Returns void

getQualityOptions

getQualityOptions: ((payload) => void) = ...

Type declaration

    • (payload): void

    • Ask video to send back quality options.

      Events to listen: onGetQualityOptions

      External action event 'voomly:video:qualityOptions'

      Parameters

      • payload: void

      Returns void

getSpeedOptions

getSpeedOptions: ((payload) => void) = ...

Type declaration

    • (payload): void

    • Ask video to send back playback rate options.

      Events to listen: onGetSpeedOptions

      External action event 'voomly:video:speedOptions'

      Parameters

      • payload: void

      Returns void

enableCustomTurnstileIntegration

enableCustomTurnstileIntegration: ((payload) => void) = ...

Type declaration

    • (payload): void

    • Ask to enable custom turnstile integration (don't send events to any consumer defined in player editor).

      Events to listen: onTimelineTurnstileSkipped and onTimelineTurnstileCompleted

      External action event 'voomly:timeline:turnstile:enable'

      Parameters

      • payload: void

      Returns void

Common

isInitialized

  • Check if API is initialized (ready to use) and not destroyed

    Returns boolean

isDestroyed

  • Check if API is destroyed and not connected to node

    Returns boolean

destroy

  • Destroy API instance and unsubscribe all events

    Returns void

onAPIReady

  • Subscribe to event when API is ready to use. Should be used when getting API instance directly (not using Proxy object)

    Parameters

    • callback: (() => void)
        • (): void

        • Returns void

    Returns (() => void)

      • (): void

      • Returns void

Subscriptions

onPlay

onPlay: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:video:playStarted'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: void

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onPause

onPause: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:video:paused'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: void

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onSeekStarted

onSeekStarted: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:video:seekStarted'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: {
                  time: number;
              }
              • time: number

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onSeeked

onSeeked: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:video:seeked'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: {
                  time: number;
              }
              • time: number

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onTimeUpdate

onTimeUpdate: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:video:timeUpdate'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: {
                  time: number;
              }
              • time: number

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onQualityChange

onQualityChange: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:video:qualityChanged'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: {
                  quality: number;
              }
              • quality: number

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onVolumeChange

onVolumeChange: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:video:volumeChanged'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: {
                  volume: number;
                  muted: boolean;
              }
              • volume: number
              • muted: boolean

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onSpeedChange

onSpeedChange: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:video:speedChanged'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: {
                  speed: number;
              }
              • speed: number

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onReady

onReady: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:video:ready'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: void

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onEnd

onEnd: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:video:ended'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: void

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onGetQualityOptions

onGetQualityOptions: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:video:qualityOptions'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: {
                  options: {
                      value: number;
                      label: string;
                      hlsUrl: string;
                  }[];
                  current: number;
              }
              • options: {
                    value: number;
                    label: string;
                    hlsUrl: string;
                }[]
              • current: number

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onGetSpeedOptions

onGetSpeedOptions: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:video:speedOptions'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: {
                  options: number[];
                  current: number;
              }
              • options: number[]
              • current: number

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onUpdateDimensions

onUpdateDimensions: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:video:updateDimensions'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: {
                  width: number;
                  height: number;
              }
              • width: number
              • height: number

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onTimelineUnlock

onTimelineUnlock: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:unlock'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: {
                  password: string;
              }
              • password: string

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onTimelineTurnstileSkipped

onTimelineTurnstileSkipped: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:turnstile:skipped'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: void

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onTimelineTurnstileCompleted

onTimelineTurnstileCompleted: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:turnstile:completed'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: {
                  firstName: string;
                  lastName: string;
                  email: string;
              } | {
                  email: string;
              }

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onTimelineButtonClick

onTimelineButtonClick: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:button:click'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineButtonEnter

onTimelineButtonEnter: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:button:enter'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineButtonPreExit

onTimelineButtonPreExit: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:button:preExit'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineButtonExit

onTimelineButtonExit: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:button:exit'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineImageClick

onTimelineImageClick: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:image:click'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineImageEnter

onTimelineImageEnter: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:image:enter'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineImagePreExit

onTimelineImagePreExit: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:image:preExit'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineImageExit

onTimelineImageExit: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:image:exit'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineGridClick

onTimelineGridClick: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:grid:click'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineGridEnter

onTimelineGridEnter: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:grid:enter'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineGridPreExit

onTimelineGridPreExit: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:grid:preExit'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineGridExit

onTimelineGridExit: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:grid:exit'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineSurveyClick

onTimelineSurveyClick: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:survey:click'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineSurveyEnter

onTimelineSurveyEnter: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:survey:enter'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineSurveyPreExit

onTimelineSurveyPreExit: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:survey:preExit'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineSurveyExit

onTimelineSurveyExit: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:survey:exit'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineQuizChoice

onTimelineQuizChoice: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External quiz event 'voomly:timeline:quiz:choice'

      Parameters

      • callback: ((payload) => void)
          • (payload): void

          • Parameters

            • payload: ITimelineQuizChoiceSelectDescriptor

            Returns void

      Returns (() => void)

        • (): void

        • Returns void

onTimelineQuizEnter

onTimelineQuizEnter: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:quiz:enter'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineQuizExit

onTimelineQuizExit: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • External subscription event 'voomly:timeline:quiz:exit'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineAnnotationClick

onTimelineAnnotationClick: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • Subscribe to annotation click

      External subscription event 'voomly:timeline:annotation:click'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

onTimelineImageAnnotationClick

onTimelineImageAnnotationClick: ((callback) => (() => void)) = ...

Type declaration

    • (callback): (() => void)

    • Subscribe to image annotation click

      External subscription event 'voomly:timeline:imageAnnotation:click'

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

Settings

Theme

On This Page