Interface: Api
Methods
create
▸ create(args
): Promise
<Status
<Meeting
>>
Creates a new meeting via CRUD
Parameters
Name | Type |
---|---|
args | Object |
args.abortSignal? | AbortSignal |
Returns
meeting id
join
▸ join(args
): Promise
<Status
<JoinMeeting
>>
Joins a meeting for particular participantId
and participantSecret
Parameters
Name | Type |
---|---|
args | Object |
args.abortSignal? | AbortSignal |
args.meetingId | string |
args.participantId | string |
args.participantSecret | string |
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
Name | Type |
---|---|
args | Object |
args.abortSignal? | AbortSignal |
args.meetingId | string |
Returns
Promise
<Status
<Participant
>>
terminate
▸ terminate(args
): Promise
<Status
<unknown
>>
Terminates meeting with the specified meetingId
Parameters
Name | Type |
---|---|
args | Object |
args.abortSignal? | AbortSignal |
args.meetingId | string |
Returns
Promise
<Status
<unknown
>>