Class VideoHelper

locked

pending

thumbs

awaitFirstGesture

• awaitFirstGesture(): void

  Register an event listener to await the first mousemove gesture and begin playback once observed A user interaction must involve a mouse click or keypress. Listen for any of these events, and handle the first observed gesture.

  Returns void

cloneTexture

• cloneTexture(source: HTMLVideoElement): Promise<Texture<Resource>>

  Clone a video texture so that it can be played independently of the original base texture.

  Parameters

  • source: HTMLVideoElement

    The video element source

  Returns Promise<Texture<Resource>>

  An unlinked PIXI.Texture which can be played independently

createThumbnail

• createThumbnail(src: string, options: object): Promise<string>

  Create and cache a static thumbnail to use for the video. The thumbnail is cached using the video file path or URL.

  Parameters

  • src: string

    The source video URL
  • options: object

    Thumbnail creation options, including width and height

  Returns Promise<string>

  The created and cached base64 thumbnail image, or a placeholder image if the canvas is disabled and no thumbnail can be generated.

getSourceElement

• getSourceElement(mesh: any): null | HTMLImageElement | HTMLVideoElement

  Return the HTML element which provides the source for a loaded texture.

  Parameters

  • mesh: any

    The rendered mesh

  Returns null | HTMLImageElement | HTMLVideoElement

  The source HTML element

getVideoSource

• getVideoSource(object: any): null | HTMLVideoElement

  Get the video element source corresponding to a Sprite or SpriteMesh.

  Parameters

  • object: any

    The PIXI source

  Returns null | HTMLVideoElement

  The source video element or null

getYouTubeEmbedURL

• getYouTubeEmbedURL(url: string, vars?: object): string

  Take a URL to a YouTube video and convert it into a URL suitable for embedding in a YouTube iframe.

  Parameters

  • url: string

    The URL to convert.
  • vars: object = {}

    YouTube player parameters.

  Returns string

  The YouTube embed URL.

getYouTubeId

• getYouTubeId(url: string): string

  Retrieve a YouTube video ID from a URL.

  Parameters

  • url: string

    The URL.

  Returns string

getYouTubePlayer

• getYouTubePlayer(id: string, config?: object): Promise<Player>

  Lazily-load the YouTube API and retrieve a Player instance for a given iframe.

  Parameters

  • id: string

    The iframe ID.
  • config: object = {}

    A player config object. See https://developers.google.com/youtube/iframe_api_reference for reference.

  Returns Promise<Player>

isYouTubeURL

• isYouTubeURL(url?: string): boolean

  Test a URL to see if it points to a YouTube video.

  Parameters

  • url: string = ""

    The URL to test.

  Returns boolean

play

• play(
      video: HTMLElement,
      options?: {
          loop?: boolean;
          offset?: number;
          playing?: boolean;
          volume?: number;
      },
  ): Promise<any>

  Play a single video source If playback is not yet enabled, add the video to the pending queue

  Parameters

  • video: HTMLElement

    The VIDEO element to play
  • Optionaloptions: { loop?: boolean; offset?: number; playing?: boolean; volume?: number } = {}

    Additional options for modifying video playback

    • Optionalloop?: boolean

      Should the video loop?

    • Optionaloffset?: number

      A specific timestamp between 0 and the video duration to begin playback

    • Optionalplaying?: boolean

      Should the video be playing? Otherwise, it will be paused

    • Optionalvolume?: number

      Desired volume level of the video's audio channel (if any)

  Returns Promise<any>

stop

• stop(video: HTMLElement): void

  Stop a single video source

  Parameters

  • video: HTMLElement

    The VIDEO element to stop

  Returns void

StatichasVideoExtension

• hasVideoExtension(src: string): boolean

  Check if a source has a video extension.

  Parameters

  • src: string

    The source.

  Returns boolean

  If the source has a video extension or not.