Options
All
  • Public
  • Public/Protected
  • All
Menu

The PIXI.js renderer for the VideoRuntimeObject.

Hierarchy

  • VideoRuntimeObjectPixiRenderer

Index

Constructors

Methods

  • ensureUpToDate(): void
  • Returns void

  • getCurrentTime(): number
  • Get the current time of the playback.

    Returns number

  • getDuration(): number
  • Get the duration of the video.

    Returns number

  • getHeight(): number
  • Returns number

  • getPlaybackSpeed(): number
  • Return the playback speed (1 = 100%)

    Returns number

  • getRendererObject(): any
  • Returns any

  • getVolume(): number
  • Get the volume on video, between 0 and 1.

    Returns number

  • getWidth(): number
  • Returns number

  • isEnded(): boolean
  • Return true if the video has ended.

    Returns boolean

  • isLooped(): boolean
  • Return true if the video is looping

    Returns boolean

  • isMuted(): boolean
  • Return true if the video is muted.

    Returns boolean

  • isPlayed(): boolean
  • Return true if the video is playing

    Returns boolean

  • onDestroy(): void
  • To be called when the object is removed from the scene: will pause the video.

    Returns void

  • pause(): void
  • Pause the video

    Returns void

  • play(): void
  • Start the video

    Returns void

  • setCurrentTime(number: any): void
  • Set the current time of the video.

    Parameters

    • number: any

    Returns void

  • setHeight(height: number): void
  • Set the rendered video height

    Parameters

    • height: number

      The new height, in pixels.

    Returns void

  • setLoop(enable: boolean): void
  • Set the loop on video in renderer

    Parameters

    • enable: boolean

      true to loop the video

    Returns void

  • setMute(enable: boolean): void
  • Set or unset mute on the video.

    Parameters

    • enable: boolean

      true to mute

    Returns void

  • setPlaybackSpeed(playbackRate: any): void
  • Set the playback speed (1 = 100%)

    Parameters

    • playbackRate: any

    Returns void

  • setVolume(volume: number): void
  • Set the volume of the video, between 0 and 1.

    Parameters

    • volume: number

      The new volume.

    Returns void

  • setWidth(width: number): void
  • Set the rendered video width

    Parameters

    • width: number

      The new width, in pixels.

    Returns void

  • updateAngle(): void
  • Returns void

  • updateLoop(): void
  • Returns void

  • updateOpacity(): void
  • Returns void

  • updatePosition(): void
  • Returns void

  • updateVolume(): void
  • Returns void

Generated using TypeDoc