Interface IVideoConfProvider

Represents a video conference provider

Hierarchy

IVideoConfProvider

Index

Properties

capabilities? name

Methods

customizeUrl generateUrl getVideoConferenceInfo? isFullyConfigured? onNewVideoConference? onUserJoin? onVideoConferenceChanged?

Properties

`Optional` capabilities

capabilities?: {
    cam?: boolean;
    mic?: boolean;
    persistentChat?: boolean;
    title?: boolean;
}

Type declaration

Optional cam?: boolean
Optional mic?: boolean
Optional persistentChat?: boolean
Optional title?: boolean

name

name: string

Methods

customizeUrl

customizeUrl(call, user, options, read, modify, http, persis): Promise<string>
The function which gets called whenever a user join url is requested
Parameters
- call: VideoConfDataExtended
- user: IVideoConferenceUser
- options: IVideoConferenceOptions
- read: IRead
- modify: IModify
- http: IHttp
- persis: IPersistence
Returns Promise<string>
- Defined in src/definition/videoConfProviders/IVideoConfProvider.ts:54

generateUrl

generateUrl(call, read, modify, http, persis): Promise<string>
The function which gets called when a new video conference url is requested
Parameters
- call: VideoConfData
- read: IRead
- modify: IModify
- http: IHttp
- persis: IPersistence
Returns Promise<string>
- Defined in src/definition/videoConfProviders/IVideoConfProvider.ts:50

`Optional` getVideoConferenceInfo

getVideoConferenceInfo(call, user, read, modify, http, persis): Promise<IBlock[]>
Parameters
- call: VideoConference
- user: IVideoConferenceUser
- read: IRead
- modify: IModify
- http: IHttp
- persis: IPersistence
Returns Promise<IBlock[]>
- Defined in src/definition/videoConfProviders/IVideoConfProvider.ts:38

`Optional` isFullyConfigured

isFullyConfigured(read, modify, http, persis): Promise<boolean>
Parameters
- read: IRead
- modify: IModify
- http: IHttp
- persis: IPersistence
Returns Promise<boolean>
- Defined in src/definition/videoConfProviders/IVideoConfProvider.ts:26

`Optional` onNewVideoConference

onNewVideoConference(call, read, modify, http, persis): Promise<void>
Parameters
- call: VideoConference
- read: IRead
- modify: IModify
- http: IHttp
- persis: IPersistence
Returns Promise<void>
- Defined in src/definition/videoConfProviders/IVideoConfProvider.ts:29

`Optional` onUserJoin

onUserJoin(call, user, read, modify, http, persis): Promise<void>
Parameters
- call: VideoConference
- user: IVideoConferenceUser
- read: IRead
- modify: IModify
- http: IHttp
- persis: IPersistence
Returns Promise<void>
- Defined in src/definition/videoConfProviders/IVideoConfProvider.ts:35

`Optional` onVideoConferenceChanged

onVideoConferenceChanged(call, read, modify, http, persis): Promise<void>
Parameters
- call: VideoConference
- read: IRead
- modify: IModify
- http: IHttp
- persis: IPersistence
Returns Promise<void>
- Defined in src/definition/videoConfProviders/IVideoConfProvider.ts:32

Generated using TypeDoc