Class VideoSprite

constructor

• new VideoSprite(opts): VideoSprite

• Build a VideoSprite

  Parameters

  • opts: {
        height: number;
        offset?: {
            dx: number;
            dy: number;
        };
        vid: string;
        width: number;
        z?: ZIndex;
    }

    • height: number

      The height of the image, in meters

    • Optional offset?: {
          dx: number;
          dy: number;
      }

      An offset between the component's center and its RigidBody's center (optional)

      • dx: number

      • dy: number

    • vid: string

      The name of the video file to use

    • width: number

      The width of the image, in meters

    • Optional z?: ZIndex

      An optional z index in the range [-2,2]

  Returns VideoSprite

Optional actor

height

offset

sprite

src

width

z

duration

• duration(): number

• Report the duration of the video associated with this VideoSprite

  Returns number

onEnd

• onEnd(callback): void

• Run code when the video playback reaches the end

  Parameters

  • callback: (() => void)

    • • (): void

      • Returns void

  Returns void

pause

• pause(): void

• Pause this VideoSprite's video

  Returns void

play

• play(): void

• Start playing this VideoSprite's video

  Returns void

prerender

• prerender(_elapsedMs): void

• Perform any custom updates to the video before displaying it

  Parameters

  • _elapsedMs: number

  Returns void

render

• render(camera, _elapsedMs, location): void

• Render the video

  Parameters

  • camera: CameraService

    The camera for the current stage

  • _elapsedMs: number

    The time since the last render

  • location: SpriteLocation

    Where should this be drawn (WORLD/OVERLAY/HUD)

  Returns void

renderAsParallax

• renderAsParallax(anchor, camera, _elapsedMs, foreground): void

• Render the video when it does not have a rigidBody. This is only used for Parallax

  Parameters

  • anchor: {
        cx: number;
        cy: number;
    }

    The center x/y at which to draw the image

    • cx: number

    • cy: number

  • camera: CameraService

    The camera for the current stage

  • _elapsedMs: number

    The time since the last render

  • foreground: boolean

    Should this go in the foreground (true) or background (false)

  Returns void

reset

• reset(): void

• Reset the video playback to the beginning

  Returns void

resize

• resize(scale): void

• Change the size of the video. You shouldn't call this directly. It gets called by Actor.resize().

  Parameters

  • scale: number

    The amount to scale the size by. 1 means "no change", >1 means "grow", fraction means "shrink".

  Returns void