<theolive-default-ui> - A default UI for THEOlive.

Hierarchy (view full)

Constructors

Properties

_shadowRoot: ShadowRoot

Accessors

  • get autoplay(): boolean
  • Whether the player should attempt to automatically start playback.

    Returns boolean

  • set autoplay(value): void
  • Parameters

    • value: boolean

    Returns void

  • get dvrThreshold(): number
  • The minimum length (in seconds) of a livestream's sliding window for the stream to be DVR and its stream type to be set to "dvr".

    Returns number

  • set dvrThreshold(value): void
  • Parameters

    • value: number

    Returns void

  • get fluid(): boolean
  • Whether to automatically adjusts the player's height to fit the video's aspect ratio.

    Returns boolean

  • set fluid(value): void
  • Parameters

    • value: boolean

    Returns void

  • get muted(): boolean
  • Whether the player's audio is muted.

    Returns boolean

  • set muted(value): void
  • Parameters

    • value: boolean

    Returns void

  • get streamType(): StreamType
  • The stream type, either "vod", "live" or "dvr".

    If you know in advance that the source will be a livestream, you can set this property to avoid a screen flicker when the player switches between its VOD-specific and live-only controls.

    Returns StreamType

  • set streamType(value): void
  • Parameters

    Returns void

  • get userIdleTimeout(): number
  • The timeout (in seconds) between when the user stops interacting with the UI, and when the user is considered to be "idle".

    Returns number

  • set userIdleTimeout(value): void
  • Parameters

    • value: number

    Returns void

Methods

Events

READY_EVENT: "theoplayerready" = READY_EVENT

Fired when the backing player is created, and the DefaultUI.player property is set.

Generated using TypeDoc