@ceeblue/webrtc-client
    Preparing search index...

    Class StreamMetadata

    Use StreamMetadata to get real-time information on a server stream, including:

    • the list of tracks and their properties,
    • the list of availables sources and their properties,
    const streamMetadata = new StreamMetadata(Connect.buildURL(endPoint, streamName));
    streamMetadata.onMetadata = metadata => {
       console.log(metadata);
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    log

    Accessors

    closed connectParams metadata streamState url

    Methods

    close off on once onState

    Events

    onClose onMetadata

    Constructors

    Properties

    log: ILog

    Start a log

    a Log object with the levels of log to call

    Accessors

    Methods

    • Event unsubscription

      Parameters

      • name: "close" | "Close" | "metadata" | "State" | "Metadata" | "state"

        Name of event without the 'on' prefix (ex: 'log' to 'onLog' event declared)

      • event: Function

        Unsubscriber Function, must be the one passed to on or once subscription methods

      Returns boolean

    • Event subscription

      Parameters

      • name: "close" | "Close" | "metadata" | "State" | "Metadata" | "state"

        Name of event without the on prefix (ex: log to onLog event declared)

      • event: Function

        Subscriber Function

      • Optionaloptions: { signal?: AbortSignal }
        • Optionalsignal?: AbortSignal

          Optional AbortSignal to stop this or multiple subscriptions in same time

      Returns void

    • Event subscription only one time, once time fired it's automatically unsubscribe

      Parameters

      • name: "close" | "Close" | "metadata" | "State" | "Metadata" | "state"

        Name of event without the on prefix (ex: log to onLog event declared)

      • event: Function

        Subscriber Function

      • Optionaloptions: { signal?: AbortSignal }
        • Optionalsignal?: AbortSignal

          Optional AbortSignal to stop this or multiple subscriptions in same time

      Returns void

    Events

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    Events