lib-jitsi-meet
    Preparing search index...

    A class responsible for starting and stopping recording sessions and emitting state updates for them.

    Index

    Constructors

    Methods

    • Create a new instance of a recording session and stores a reference to it.

      Parameters

      • sessionID: string

        The session ID of the recording in progress.

      • status: string

        The current status of the recording session.

      • mode: string

        The recording mode of the session.

      Returns JibriSession

    • Parses presence to update an existing JibriSession or to create a new JibriSession.

      Parameters

      • presence: Element

        An XMPP presence update.

      Returns void

    • Handles updates from the Jibri which can broadcast a YouTube URL that needs to be updated in a JibriSession.

      Parameters

      • presence: Element

        An XMPP presence update.

      Returns void

    • Callback to invoke to parse through a presence update to find recording related updates (from Jibri participant doing the recording and the focus which controls recording).

      Parameters

      • event: { fromHiddenDomain: boolean; presence: Element }

        The presence data from the pubsub event.

        • fromHiddenDomain: boolean

          Whether or not the update comes from a participant that is trusted but not visible, as would be the case with the Jibri recorder participant.

        • presence: Element

          An XMPP presence update.

      Returns void

    • Start a recording session.

      Parameters

      • options: IRecordingOptions

        Configuration for the recording.

        • OptionalappData?: string
        • OptionalbroadcastId?: string
        • mode: string
        • OptionalstreamId?: string

      Returns Promise<JibriSession>

      A promise for starting a recording, which will pass back the session on success. The promise resolves after receiving an acknowledgment of the start request success or fail.

    • Stop a recording session.

      Parameters

      • sessionID: string

        The ID associated with the recording session to be stopped.

      Returns Promise<any>

      The promise resolves after receiving an acknowledgment of the stop request success or fail.