@theoplayer/web-ui
    Preparing search index...

    Class THEOliveDefaultUI

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

    <theolive-default-ui>

    Hierarchy (View Summary)

    Index

    Other

    _uiRef: Ref<UIContainer> = ...
    READY_EVENT: "theoplayerready" = READY_EVENT

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

    autoplay: boolean

    Whether the player should attempt to automatically start playback.

    • 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: number): void

      Parameters

      • value: number

      Returns void

    fluid: boolean

    Whether to automatically adjust the player's height to fit the video's aspect ratio.

    Attribute.FLUID

    muted: boolean

    Whether the player's audio is muted.

    Attribute.MUTED

    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.

    • get userIdle(): boolean

      Whether the user has stopped interacting with the UI and is considered to be "idle".

      Returns boolean

    • 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: number | undefined): void

      Parameters

      • value: number | undefined

      Returns void

    lifecycle

    • Invoked when the component is added to the document's DOM.

      In connectedCallback() you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.

      connectedCallback() {
      super.connectedCallback();
      addEventListener('keydown', this._handleKeydown);
      }

      Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().

      Returns void

    • Invoked when the component is removed from the document's DOM.

      This callback is the main signal to the element that it may no longer be used. disconnectedCallback() should ensure that nothing is holding a reference to the element (such as event listeners added to nodes external to the element), so that it is free to be garbage collected.

      disconnectedCallback() {
      super.disconnectedCallback();
      window.removeEventListener('keydown', this._handleKeydown);
      }

      An element may be re-connected after being disconnected.

      Returns void

    rendering

    shadowRootOptions: ShadowRootInit = ...

    Options used when calling attachShadow. Set this property to customize the options for the shadowRoot; for example, to create a closed shadowRoot: {mode: 'closed'}.

    Note, these options are used in createRenderRoot. If this method is customized, options should be respected if possible.

    • Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

      Returns HTMLTemplateResult

    styles

    styles: CSSResult[] = ...

    Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

    Note on Content Security Policy:

    Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

    To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

    <script>
    // Generated and unique per request:
    window.litNonce = 'a1b2c3d4';
    </script>

    updates

    • Invoked when the element is first updated. Implement to perform one time work on the element after update.

      firstUpdated() {
      this.renderRoot.getElementById('my-text-area').focus();
      }

      Setting properties inside this method will trigger the element to update again after this update cycle completes.

      Returns void