@sourceloop/video-conferencing-service / Exports / VonageVideoChat

Interface: VonageVideoChat¶

Hierarchy¶

VideoChatInterface

↳ VonageVideoChat

Table of contents¶

Methods¶

checkWebhookPayload¶

▸ checkWebhookPayload(webhookPaylod): Promise<void>

Parameters¶

Name	Type
`webhookPaylod`	`WebhookPayloadParameters`

Returns¶

Promise<void>

Overrides¶

VideoChatInterface.checkWebhookPayload

Defined in¶

services/video-conferencing-service/src/providers/vonage/types.ts:204

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

Overrides¶

VideoChatInterface.deleteArchive

Defined in¶

services/video-conferencing-service/src/providers/vonage/types.ts:184

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

Overrides¶

VideoChatInterface.getArchives

Defined in¶

services/video-conferencing-service/src/providers/vonage/types.ts:176

getFeatures¶

▸ getFeatures(): VideoChatFeatures

getMeetingLink¶

▸ getMeetingLink(options): Promise<VonageMeetingResponse>

Function

getMeetingLink Generates a meeting Id which is further used for sharing links

Interface

MeetingOptions which is defined as an Interface

Parameters¶

Name	Type
`options`	`MeetingOptions`

Returns¶

Promise<VonageMeetingResponse>

Promise when resolved returns meeting id

Overrides¶

VideoChatInterface.getMeetingLink

Defined in¶

services/video-conferencing-service/src/providers/vonage/types.ts:153

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

Overrides¶

VideoChatInterface.getToken

Defined in¶

services/video-conferencing-service/src/providers/vonage/types.ts:159

setUploadTarget¶

▸ setUploadTarget(config): Promise<void>

Function

setUploadTarget set the upload target

Interface

VonageS3TargetOptions or

Interface

VonageAzureTargetOptions

Parameters¶

Name	Type	Description
`config`	`VonageS3TargetOptions` \| `VonageAzureTargetOptions`	of type

Returns¶

Promise<void>

Overrides¶

VideoChatInterface.setUploadTarget

Defined in¶

services/video-conferencing-service/src/providers/vonage/types.ts:195