openvidu/openvidu-browser/lib/OpenViduInternal/Enums/OpenViduError.d.ts

80 lines
3.0 KiB
TypeScript
Raw Normal View History

/**
* Defines property [[OpenViduError.name]]
*/
2018-04-26 15:33:47 +02:00
export declare enum OpenViduErrorName {
2018-06-01 14:39:38 +02:00
/**
* Browser is not supported by OpenVidu.
* Returned uppon unsuccessful [[Session.connect]]
*/
2018-04-26 15:33:47 +02:00
BROWSER_NOT_SUPPORTED = "BROWSER_NOT_SUPPORTED",
2018-06-01 14:39:38 +02:00
/**
* The user hasn't granted permissions to the required input device when the browser asked for them.
* Returned uppon unsuccessful [[OpenVidu.initPublisher]] or [[OpenVidu.getUserMedia]]
*/
DEVICE_ACCESS_DENIED = "DEVICE_ACCESS_DENIED",
/**
* The user hasn't granted permissions to capture some desktop screen when the browser asked for them.
* Returned uppon unsuccessful [[OpenVidu.initPublisher]] or [[OpenVidu.getUserMedia]]
*/
2018-04-26 15:33:47 +02:00
SCREEN_CAPTURE_DENIED = "SCREEN_CAPTURE_DENIED",
2018-06-01 14:39:38 +02:00
/**
* Browser does not support screen sharing.
* Returned uppon unsuccessful [[OpenVidu.initPublisher]]
*/
2018-04-26 15:33:47 +02:00
SCREEN_SHARING_NOT_SUPPORTED = "SCREEN_SHARING_NOT_SUPPORTED",
2018-06-01 14:39:38 +02:00
/**
* Only for Chrome, there's no screen sharing extension installed
* Returned uppon unsuccessful [[OpenVidu.initPublisher]]
*/
2018-04-26 15:33:47 +02:00
SCREEN_EXTENSION_NOT_INSTALLED = "SCREEN_EXTENSION_NOT_INSTALLED",
2018-06-01 14:39:38 +02:00
/**
* Only for Chrome, the screen sharing extension is installed but is disabled
* Returned uppon unsuccessful [[OpenVidu.initPublisher]]
*/
2018-04-26 15:33:47 +02:00
SCREEN_EXTENSION_DISABLED = "SCREEN_EXTENSION_DISABLED",
2018-06-01 14:39:38 +02:00
/**
* No video input device found with the provided deviceId (property [[PublisherProperties.videoSource]])
* Returned uppon unsuccessful [[OpenVidu.initPublisher]]
*/
2018-04-26 15:33:47 +02:00
INPUT_VIDEO_DEVICE_NOT_FOUND = "INPUT_VIDEO_DEVICE_NOT_FOUND",
2018-06-01 14:39:38 +02:00
/**
* No audio input device found with the provided deviceId (property [[PublisherProperties.audioSource]])
* Returned uppon unsuccessful [[OpenVidu.initPublisher]]
*/
2018-04-26 15:33:47 +02:00
INPUT_AUDIO_DEVICE_NOT_FOUND = "INPUT_AUDIO_DEVICE_NOT_FOUND",
2018-06-01 14:39:38 +02:00
/**
* Method [[OpenVidu.initPublisher]] has been called with properties `videoSource` and `audioSource` of
* [[PublisherProperties]] parameter both set to *false* or *null*
*/
2018-04-26 15:33:47 +02:00
NO_INPUT_SOURCE_SET = "NO_INPUT_SOURCE_SET",
2018-06-01 14:39:38 +02:00
/**
* Some media property of [[PublisherProperties]] such as `frameRate` or `resolution` is not supported
* by the input devices (whenever it is possible they are automatically adjusted to the most similar value).
* Returned uppon unsuccessful [[OpenVidu.initPublisher]]
*/
2018-04-26 15:33:47 +02:00
PUBLISHER_PROPERTIES_ERROR = "PUBLISHER_PROPERTIES_ERROR",
2018-06-01 14:39:38 +02:00
/**
* _Not in use yet_
*/
2018-04-26 15:33:47 +02:00
OPENVIDU_PERMISSION_DENIED = "OPENVIDU_PERMISSION_DENIED",
2018-06-01 14:39:38 +02:00
/**
* _Not in use yet_
*/
2018-04-26 15:33:47 +02:00
OPENVIDU_NOT_CONNECTED = "OPENVIDU_NOT_CONNECTED",
2018-06-01 14:39:38 +02:00
/**
* _Not in use yet_
*/
2018-04-26 15:33:47 +02:00
GENERIC_ERROR = "GENERIC_ERROR",
}
/**
* Simple object to identify runtime errors on the client side
*/
export declare class OpenViduError {
name: OpenViduErrorName;
message: string;
/**
* @hidden
*/
constructor(name: OpenViduErrorName, message: string);
}