Interface Player

Freecaster player interface

See

interface Player {
    config: any;
    container: HTMLElement;
    currentTimecode: string;
    currentTimestamp: number;
    live: boolean;
    subtitlesEnabled: boolean;
    version: string;
    destroy(): void;
    goBackToLive(): void;
    loadVideo(id: string): void;
    mute(shouldMute: boolean): void;
    seek(time: number): void;
    setConfig(config: any): void;
    setConfig(key: string, value: any): void;
    setSrc(source: string): void;
    setVolume(level: number): void;
    toggleFullScreen(): void;
    togglePlay(force?: boolean): void;
}

Hierarchy

  • HTMLVideoElement
    • Player

Properties

config container currentTimecode currentTimestamp live subtitlesEnabled version

Methods

destroy goBackToLive loadVideo mute seek setConfig setSrc setVolume toggleFullScreen togglePlay

Properties

config

config: any

Player config

container

container: HTMLElement

Player's container HTMLElement

currentTimecode

currentTimecode: string

Returns a string containing the current timecode

currentTimestamp

currentTimestamp: number

Returns an integer of the current timestamp (UTC) in milliseconds. This feature only works for DASH or HLS playlists with non-native configuration.

live

live: boolean

Whether the video is a live feed

subtitlesEnabled

subtitlesEnabled: boolean

Whether subtitles/captions are currently enabled on the player

version

version: string

Current player version

Methods

destroy

  • destroy(): void

  • Destroy the player instance and remove the element from the DOM

    Returns void

goBackToLive

  • goBackToLive(): void

  • Seek closer to live

    Returns void

loadVideo

  • loadVideo(id): void

  • Load a new video from the API, replacing the current video

    Parameters

    • id: string

      Video ID

    Returns void

mute

  • mute(shouldMute): void

  • Mute or unmute the player

    Parameters

    • shouldMute: boolean

      Whether the player should be muted or not

    Returns void

seek

  • seek(time): void

  • Jump toward the provided time

    Parameters

    • time: number

      Time to jump to in seconds or as a timestamp

    Returns void

setConfig

  • setConfig(config): void

  • Update the player's config

    Parameters

    • config: any

    Returns void

  • setConfig(key, value): void

  • Parameters

    • key: string
    • value: any

    Returns void

setSrc

  • setSrc(source): void

  • Replaces the current source

    Parameters

    • source: string

      New source

    Returns void

setVolume

  • setVolume(level): void

  • Set the volume

    Parameters

    • level: number

      Volume between 0 et 1

    Returns void

toggleFullScreen

  • toggleFullScreen(): void

  • Toggle fullscreen mode

    Returns void

togglePlay

  • togglePlay(force?): void

  • Toggle play/pause mode

    Parameters

    • Optionalforce: boolean

      Optional boolean forces state (true=play, false=pause)

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods