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

/**
 * Defines property [[OpenViduError.name]]
 */
export declare enum OpenViduErrorName {
    /**
     * Browser is not supported by OpenVidu.
     * Returned upon unsuccessful [[Session.connect]]
     */
    BROWSER_NOT_SUPPORTED = "BROWSER_NOT_SUPPORTED",
    /**
     * The user hasn't granted permissions to the required input device when the browser asked for them.
     * Returned upon 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 upon unsuccessful [[OpenVidu.initPublisher]] or [[OpenVidu.getUserMedia]]
     */
    SCREEN_CAPTURE_DENIED = "SCREEN_CAPTURE_DENIED",
    /**
     * Browser does not support screen sharing.
     * Returned upon unsuccessful [[OpenVidu.initPublisher]]
     */
    SCREEN_SHARING_NOT_SUPPORTED = "SCREEN_SHARING_NOT_SUPPORTED",
    /**
     * Only for Chrome, there's no screen sharing extension installed
     * Returned upon unsuccessful [[OpenVidu.initPublisher]]
     */
    SCREEN_EXTENSION_NOT_INSTALLED = "SCREEN_EXTENSION_NOT_INSTALLED",
    /**
     * Only for Chrome, the screen sharing extension is installed but is disabled
     * Returned upon unsuccessful [[OpenVidu.initPublisher]]
     */
    SCREEN_EXTENSION_DISABLED = "SCREEN_EXTENSION_DISABLED",
    /**
     * No video input device found with the provided deviceId (property [[PublisherProperties.videoSource]])
     * Returned upon unsuccessful [[OpenVidu.initPublisher]]
     */
    INPUT_VIDEO_DEVICE_NOT_FOUND = "INPUT_VIDEO_DEVICE_NOT_FOUND",
    /**
     * No audio input device found with the provided deviceId (property [[PublisherProperties.audioSource]])
     * Returned upon unsuccessful [[OpenVidu.initPublisher]]
     */
    INPUT_AUDIO_DEVICE_NOT_FOUND = "INPUT_AUDIO_DEVICE_NOT_FOUND",
    /**
     * Method [[OpenVidu.initPublisher]] has been called with properties `videoSource` and `audioSource` of
     * [[PublisherProperties]] parameter both set to *false* or *null*
     */
    NO_INPUT_SOURCE_SET = "NO_INPUT_SOURCE_SET",
    /**
     * 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 upon unsuccessful [[OpenVidu.initPublisher]]
     */
    PUBLISHER_PROPERTIES_ERROR = "PUBLISHER_PROPERTIES_ERROR",
    /**
     * The client tried to call a method without the required permissions. This can occur for methods [[Session.publish]],
     * [[Session.forceUnpublish]], [[Session.forceDisconnect]], [[Stream.applyFilter]], [[Stream.removeFilter]]
     */
    OPENVIDU_PERMISSION_DENIED = "OPENVIDU_PERMISSION_DENIED",
    /**
     * _Not in use yet_
     */
    OPENVIDU_NOT_CONNECTED = "OPENVIDU_NOT_CONNECTED",
    /**
     * _Not in use yet_
     */
    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);
}