@sourceloop/video-conferencing-service / Exports / VideoChatInterface
Interface: VideoChatInterface¶
Hierarchy¶
-
VideoChatInterface
Table of contents¶
Methods¶
Methods¶
checkWebhookPayload¶
▸ checkWebhookPayload(webhookPayload): Promise<void>
Parameters¶
| Name | Type |
|---|---|
webhookPayload |
WebhookPayloadParameters |
Returns¶
Promise<void>
Defined in¶
services/video-conferencing-service/src/types.ts:63
deleteArchive¶
▸ deleteArchive(archiveId): Promise<void>
Function
deleteArchive delete a specific archive
Parameters¶
| Name | Type | Description |
|---|---|---|
archiveId |
string |
id of an archive |
Returns¶
Promise<void>
Promise then returns a successful message for deleting if promise is resolved
Defined in¶
services/video-conferencing-service/src/types.ts:50
getArchives¶
▸ getArchives(archiveId): Promise<ArchiveResponse | ArchiveResponseList>
Function
getArchives get a specific recorded/composed archive or a list of archives
Parameters¶
| Name | Type |
|---|---|
archiveId |
null | string |
Returns¶
Promise<ArchiveResponse | ArchiveResponseList>
a list of archives after resolving promise
Defined in¶
services/video-conferencing-service/src/types.ts:42
getFeatures¶
▸ getFeatures(): VideoChatFeatures
Returns¶
Defined in¶
services/video-conferencing-service/src/types.ts:61
getMeetingLink¶
▸ getMeetingLink(options): Promise<MeetingResponse>
Function
getMeetingLink Generates a meeting Id which is further used for sharing links
Interface
MeetingOptions which is defined as an Interface
Interface
MeetingResponse
Parameters¶
| Name | Type |
|---|---|
options |
MeetingOptions |
Returns¶
Promise<MeetingResponse>
Promise when resolved returns object of
Defined in¶
services/video-conferencing-service/src/types.ts:27
getToken¶
▸ getToken(sessionId, options): Promise<SessionResponse>
Function
getToken Generates a token which is used for authorization to connect to a room
Interface
SessionOptions
Interface
SessionResponse
Parameters¶
| Name | Type |
|---|---|
sessionId |
string |
options |
SessionOptions |
Returns¶
Promise<SessionResponse>
Promise when resolved returns object of type
Defined in¶
services/video-conferencing-service/src/types.ts:33
setUploadTarget¶
▸ setUploadTarget(config): Promise<void>
Function
setUploadTarget set the upload target
Interface
S3TargetOptions or
Interface
AzureTargetOptions
Parameters¶
| Name | Type | Description |
|---|---|---|
config |
ExternalStorageOptions |
of type |
Returns¶
Promise<void>