forked from okode/cordova-plugin-twilio-video
-
Notifications
You must be signed in to change notification settings - Fork 0
/
twiliovideo.d.ts
40 lines (36 loc) · 1.8 KB
/
twiliovideo.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
declare module TwilioVideo {
interface TwilioVideoPlugin {
/**
* It opens Twilio Video controller and tries to start the videocall.
* All videocall UI controls will be positioned on the current view, so we can put
* our own controls from the application that uses the plugin.
* @param token
* @param roomName
* @param onEvent - (Optional) It will be fired any time that a call event is received
* @param {Object} config - (Optional) Call configuraiton
* @param config.primaryColor - Hex primary color that the app will use
* @param config.secondaryColor - Hex secondary color that the app will use
* @param config.i18nConnectionError - Message shown when it is not possible to join the room
* @param config.i18nDisconnectedWithError - Message show when the client is disconnected due to an error
* @param config.i18nAccept - Accept translation
* @param config.handleErrorInApp - (Default = false) Flag to indicate the application will manage any error in the app by events emitted by the plugin
* @param config.hangUpInApp - (Default = false) Flag to indicate the application should hang up the call by calling 'closeRoom'
*/
openRoom(token: string, roomName: string, onEvent?: Function, config?: any): void;
/**
* It closes the videocall room if it is running
*/
closeRoom(): Promise<void>;
/**
* Check if the user granted all required permissions (Camera and Microphone)
* @return If user has granted all permissions or not
*/
hasRequiredPermissions(): Promise<boolean>;
/**
* Request required permissions (Camera and Microphone)
* @return If user has granted all permissions or not
*/
requestPermissions(): Promise<boolean>;
}
}
declare var twiliovideo: TwilioVideo.TwilioVideoPlugin;