Class SessionsResource

Sessions API — inspect and control live and past sessions and their participants.

Index

Constructors

Methods

end get getParticipant getParticipantStats getStats list listActiveParticipants listParticipants removeParticipant

Constructors

constructor

new SessionsResource(http: HttpClient): SessionsResource
Parameters
- http: HttpClient
Returns SessionsResource

Methods

end

end(options: EndSessionOptions): Promise<Session>
End a live session. Returns the (now ended) session.
Parameters
- options: EndSessionOptions
Returns Promise<Session>

get

get(sessionId: string): Promise<Session>
Fetch a session by id.
Parameters
- sessionId: string
Returns Promise<Session>

getParticipant

getParticipant(sessionId: string, participantId: string): Promise<Participant>
Fetch a single participant within a session.
Parameters
- sessionId: string
- participantId: string
Returns Promise<Participant>

getParticipantStats

getParticipantStats(
sessionId: string,
participantId: string,
): Promise<QualityStats>
Fetch per-participant quality stats, plus resolution usage.
Parameters
- sessionId: string
- participantId: string
Returns Promise<QualityStats>

getStats

getStats(sessionId: string): Promise<QualityStats>
Fetch aggregated session-level quality stats.
Parameters
- sessionId: string
Returns Promise<QualityStats>

list

list(params?: ListSessionsParams): Promise<Page<Session>>
List sessions (paginated, async-iterable).
Parameters
- params: ListSessionsParams = {}
Returns Promise<Page<Session>>

listActiveParticipants

listActiveParticipants(
sessionId: string,
params?: ListParams,
): Promise<Page<Participant>>
List currently-active participants of a session.
Parameters
- sessionId: string
- params: ListParams = {}
Returns Promise<Page<Participant>>

listParticipants

listParticipants(
sessionId: string,
params?: ListParams,
): Promise<Page<Participant>>
List participants of a session (paginated, async-iterable).
Parameters
- sessionId: string
- params: ListParams = {}
Returns Promise<Page<Participant>>

removeParticipant

removeParticipant(options: RemoveParticipantOptions): Promise<string>
Remove (kick) a participant from a live session. Returns a confirmation message.
Parameters
- options: RemoveParticipantOptions
Returns Promise<string>