Skip to main content

Interface: Api

Methods

create

create(args): Promise<Status<Meeting>>

Creates a new meeting via CRUD

Parameters

NameType
argsObject
args.abortSignal?AbortSignal

Returns

Promise<Status<Meeting>>

meeting id


join

join(args): Promise<Status<JoinMeeting>>

Joins a meeting for particular participantId and participantSecret

Parameters

NameType
argsObject
args.abortSignal?AbortSignal
args.meetingIdstring
args.participantIdstring
args.participantSecretstring

Returns

Promise<Status<JoinMeeting>>

location path to be able to connect to WebSocket for all the meeting updates


participants

participants(args): Promise<Status<Participant>>

Creates participant_id and participant_secret for the given meetingId

Parameters

NameType
argsObject
args.abortSignal?AbortSignal
args.meetingIdstring

Returns

Promise<Status<Participant>>


terminate

terminate(args): Promise<Status<unknown>>

Terminates meeting with the specified meetingId

Parameters

NameType
argsObject
args.abortSignal?AbortSignal
args.meetingIdstring

Returns

Promise<Status<unknown>>