Skip to Content
defold-typescript libraries
defold (official)

defold/extension-videoplayer-native/videoplayer

Fullscreen video playback using native/HTML5 backends.

  • GitHub: defold/extension-videoplayer-native — pinned to 1.4.0 (released while Defold 1.13.1 was current)
    1. Pick a release from defold/extension-videoplayer-native releases and add its Source code (zip) URL (or a packaged .zip asset, if the library ships one) to game.project under [project] dependencies, then Fetch Libraries in the Defold editor.
    2. Run bunx @defold-typescript/cli resolve to materialize its types.
    3. Import it under a namespace alias of your choice:
      import * as videoplayer from "videoplayer"

Functions

videoplayer.create(uri: string, settings: table | undefined, callback: function): number

Create a video handle for a URI and register a callback.

Parameters

  • uri: string — Video URI (remote URL or bundled resource).
  • settings: table | undefined — Optional settings.
    • play_sound?: boolean — Play audio (default true).
  • callback: function — Called on video events.
    • self: object
    • handle: number
    • event: number
    • data?: table — On READY contains width/height.

Returns

  • number — Video handle or nil on failure.

videoplayer.destroy(handle: number)

Destroy a video handle and remove the view.

Parameters

  • handle: number

videoplayer.start(handle: number)

Start playback.

Parameters

  • handle: number

videoplayer.stop(handle: number)

Stop playback without removing the video view or emitting VIDEO_EVENT_FINISHED. Call destroy to skip and remove the video.

Parameters

  • handle: number

videoplayer.pause(handle: number)

Pause playback.

Parameters

  • handle: number

videoplayer.set_visible(handle: number, visible: boolean)

Show or hide the video view.

Parameters

  • handle: number
  • visible: boolean

Constants

videoplayer.VIDEO_EVENT_READY

Video is prepared; data contains width/height.

videoplayer.VIDEO_EVENT_FINISHED

Playback finished.

videoplayer.VIDEO_EVENT_FAILED

Prepare/playback failed.

On this page