Class JibriSession

Represents a recording session.

Index

Constructors

Methods

_createIQ getError getID getInitiator getJibriJid getLiveStreamViewURL getMode getStatus getTerminator setError setInitiator setJibriJid setLiveStreamViewURL setStatus setStatusFromJicofo setTerminator start stop

Constructors

constructor

new JibriSession(options?: IJibriSessionOptions): JibriSession
Initializes a new JibriSession instance.
Parameters
- options: IJibriSessionOptions = {}
Returns JibriSession
- Defined in modules/recording/JibriSession.ts:59

Methods

_createIQ

_createIQ(__namedParameters?: IQOptions): any
Generates the message to change the status of the recording session.
Parameters
- Optional__namedParameters: IQOptions
Returns any
Object - The XMPP IQ message.
- Defined in modules/recording/JibriSession.ts:292

getError

getError(): string
Returns the error related to the session instance, if any.

Returns string
- Defined in modules/recording/JibriSession.ts:74

getID

getID(): string
Returns the session ID of the session instance.

Returns string
- Defined in modules/recording/JibriSession.ts:83

getInitiator

getInitiator(): string | JitsiParticipant
Returns the initiator of the session instance.

Returns string | JitsiParticipant
The participant that started the session.
- Defined in modules/recording/JibriSession.ts:92

getJibriJid

getJibriJid(): string
Returns string
- Defined in modules/recording/JibriSession.ts:122

getLiveStreamViewURL

getLiveStreamViewURL(): string
Returns the streaming URL of the session.

Returns string
- Defined in modules/recording/JibriSession.ts:101

getMode

getMode(): string
Returns the current recording mode of the session, such as "file".

Returns string
- Defined in modules/recording/JibriSession.ts:140

getStatus

getStatus(): string
Returns the current status of the session.

Returns string
- Defined in modules/recording/JibriSession.ts:110

getTerminator

getTerminator(): string | JitsiParticipant
Returns the jid of the participant that stopped the session.

Returns string | JitsiParticipant
The participant that stopped the session.
- Defined in modules/recording/JibriSession.ts:131

setError

setError(error: string): void
Sets the last known error message related to the session.
Parameters
- error: string
  The error string explaining why the session entered an error state.
Returns void
- Defined in modules/recording/JibriSession.ts:151

setInitiator

setInitiator(participant: string | JitsiParticipant): void
Sets the participant that started the session.
Parameters
- participant: string | JitsiParticipant
  The participant or resource id if local participant.
Returns void
- Defined in modules/recording/JibriSession.ts:200

setJibriJid

setJibriJid(jibriJid: string): void
Set the JID of the jibri associated with this session.
Parameters
- jibriJid: string
Returns void
- Defined in modules/recording/JibriSession.ts:191

setLiveStreamViewURL

setLiveStreamViewURL(url: string): void
Sets the last live stream URL for the session instance. Usually this is a YouTube URL and usually this is only set for "stream" sessions.
Parameters
- url: string
  The live stream URL associated with the session.
Returns void
- Defined in modules/recording/JibriSession.ts:162

setStatus

setStatus(status?: string): void
Sets the last known status for this recording session.
Parameters
- Optionalstatus: string
  The new status to set.
Returns void
- Defined in modules/recording/JibriSession.ts:172

setStatusFromJicofo

setStatusFromJicofo(status: string): void
Set the session status reported by jicofo. If a jibri is present in the room, the status is always 'on'. Otherwise, we fallback to the status reported by jicofo.
Parameters
- status: string
Returns void
- Defined in modules/recording/JibriSession.ts:182

setTerminator

setTerminator(participant: string | JitsiParticipant): void
Sets the participant that stopped the session.
Parameters
- participant: string | JitsiParticipant
  The participant or the resource id if local participant.
Returns void
- Defined in modules/recording/JibriSession.ts:209

start

start(options: IStartOptions): Promise<void>
Sends a message to start the actual recording.
Parameters
- options: IStartOptions
  Additional arguments for starting therecording.
  - appData
    Data specific to the app/service that the result file will be uploaded.
  - broadcastId
    The broadcast ID of an associated YouTube stream, used for knowing the URL from which the stream can be viewed.
  - focusMucJid
    The JID of the focus participant that controls recording.
  - streamId
    Necessary for live streaming, this is the stream key needed to start a live streaming session with the streaming service provider.
Returns Promise<void>
Promise
- Defined in modules/recording/JibriSession.ts:225

stop

stop(options: IStopOptions): Promise<any>
Sends a message to actually stop the recording session.
Parameters
- options: IStopOptions
  Additional arguments for stopping the recording.
  - focusMucJid
    The JID of the focus participant that controls recording.
Returns Promise<any>
Promise
- Defined in modules/recording/JibriSession.ts:261

Class JibriSession

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns JibriSession

Methods

_createIQ

Parameters

Returns any

getError

Returns string

getID

Returns string

getInitiator

Returns string | JitsiParticipant

getJibriJid

Returns string

getLiveStreamViewURL

Returns string

getMode

Returns string

getStatus

Returns string

getTerminator

Returns string | JitsiParticipant

setError

Parameters

Returns void

setInitiator

Parameters

Returns void

setJibriJid

Parameters

Returns void

setLiveStreamViewURL

Parameters

Returns void

setStatus

Parameters

Returns void

setStatusFromJicofo

Parameters

Returns void

setTerminator

Parameters

Returns void

start

Parameters

appData

broadcastId

focusMucJid

streamId

Returns Promise<void>

stop

Parameters

focusMucJid

Returns Promise<any>

Settings

On This Page