Skip to main content
Version: v1.11.0

Namespace: Errors

Variables

ADD_DEVICE_COMPOSITION_INDEX_MISSING_ERROR

Const ADD_DEVICE_COMPOSITION_INDEX_MISSING_ERROR: Object

Type declaration

NameType
code4003
message"VideoComposition's \"index\" property is missing"
name"AddDeviceCompositionIndexMissingError"

ADD_DEVICE_COMPOSITION_MISSING_ERROR

Const ADD_DEVICE_COMPOSITION_MISSING_ERROR: Object

Type declaration

NameType
code4002
message"VideoComposition is missing"
name"AddDeviceCompositionMissingError"

ADD_DEVICE_CONSTRAINTS_ERROR

Const ADD_DEVICE_CONSTRAINTS_ERROR: Object

Type declaration

NameType
code4006
message"Constraints error"
name"AddDeviceConstraintsError"

ADD_DEVICE_DEVICE_ERROR

Const ADD_DEVICE_DEVICE_ERROR: Object

Type declaration

NameType
code4000
message"Device is missing"
name"AddDeviceError"

ADD_DEVICE_NAME_EXISTS_ERROR

Const ADD_DEVICE_NAME_EXISTS_ERROR: Object

Type declaration

NameType
code4001
message"Name is already registered"
name"AddDeviceNameExistsError"

ADD_DEVICE_NAME_MISSING_ERROR

Const ADD_DEVICE_NAME_MISSING_ERROR: Object

Type declaration

NameType
code4004
message"Name property is missing"
name"AddDeviceNameMissingError"

ADD_DEVICE_UNSUPPORTED

Const ADD_DEVICE_UNSUPPORTED: Object

Type declaration

NameType
codenumber
messagestring
namestring

BROADCAST_CONFIGURATION_ERROR

Const BROADCAST_CONFIGURATION_ERROR: Object

Type declaration

NameType
code11000
message"Error when configuring broadcast client"
name"BroadcastConfigurationError"

BROADCAST_ERROR

Const BROADCAST_ERROR: Object

Type declaration

NameType
code1000
message"Unable to broadcast"
name"BroadcastError"

CAMERA_ERROR

Const CAMERA_ERROR: Object

Type declaration

NameType
code2000
message"Camera could not be captured"
name"CameraError"

CLIENT_INVALID_ERROR

Const CLIENT_INVALID_ERROR: Object

Type declaration

NameType
code16000
message"Client is no longer valid, possibly due to delete() invocation."
name"ClientInvalidError"

EXCHANGE_POSITION_DEVICE_NOT_FOUND_ERROR

Const EXCHANGE_POSITION_DEVICE_NOT_FOUND_ERROR: Object

Type declaration

NameType
code8000
message"Device with that name is not found"
name"ExchangePositionDeviceNotFoundError"

FAILED_TO_ADD_IMAGE_ERROR

Const FAILED_TO_ADD_IMAGE_ERROR: Object

Type declaration

NameType
code9000
message"Failed to add image"
name"FailedToAddImageError"

INGEST_ENDPOINT_TYPE_ERROR

Const INGEST_ENDPOINT_TYPE_ERROR: Object

Type declaration

NameType
code13000
message"Ingest endpoint must be a string"
name"IngestEndpointTypeError"

INGEST_ENDPOINT_URL_ERROR

Const INGEST_ENDPOINT_URL_ERROR: Object

Type declaration

NameType
code13001
message"Ingest endpoint must be a valid https or rtmps URL"
name"IngestEndpointUrlError"

INPUT_ERROR

Const INPUT_ERROR: Object

Type declaration

NameType
code3000
message"Input could not be attached"
name"InputError"

INVALID_STREAM_KEY

Const INVALID_STREAM_KEY: Object

Type declaration

NameType
code10003
message"Invalid Stream Key."
name"InvalidStreamKey"

LOGGER_TYPE_ERROR

Const LOGGER_TYPE_ERROR: Object

Type declaration

NameType
code15000
message"Logger must be an object"
name"LoggerTypeError"

LOG_LEVEL_TYPE_ERROR

Const LOG_LEVEL_TYPE_ERROR: Object

Type declaration

NameType
code14000
message"Log Level must be a valid integer between [0..5]"
name"LogLevelTypeError"

NETWORK_RECONNECT_CONFIGURATION_ERROR

Const NETWORK_RECONNECT_CONFIGURATION_ERROR: Object

Type declaration

NameType
code17000
message"Error when configuring network reconnect"
name"NetworkReconnectConfigurationError"

NETWORK_RECONNECT_CONFIGURATION_INVALID_TIMEOUT_ERROR

Const NETWORK_RECONNECT_CONFIGURATION_INVALID_TIMEOUT_ERROR: Object

Type declaration

NameType
code17001
message`Network reconnect timeout value must be a number between [10000, ${number}]`
name"NetworkReconnectConfigurationInvalidTimeoutError"

PEER_CONNECTION_ERROR

Const PEER_CONNECTION_ERROR: Object

Type declaration

NameType
code10001
message"Peer connection has failed."
name"PeerConnectionError"

PEER_SETUP_ERROR

Const PEER_SETUP_ERROR: Object

Type declaration

NameType
code10000
message"Unexpected return value from setup request"
name"PeerSetupError"

REMOVE_DEVICE_NOT_FOUND_ERROR

Const REMOVE_DEVICE_NOT_FOUND_ERROR: Object

Type declaration

NameType
code5000
message"Device not found"
name"RemoveDeviceNotFoundError"

REMOVE_IMAGE_NOT_FOUND_ERROR

Const REMOVE_IMAGE_NOT_FOUND_ERROR: Object

Type declaration

NameType
code6000
message"Image not found"
name"RemoveImageNotFoundError"

STAGE_TOKEN_TYPE_ERROR

Const STAGE_TOKEN_TYPE_ERROR: Object

Type declaration

NameType
code19000
message"Stage token must be a string"
name"StageTokenTypeError"

STAGE_WHIP_OVERRIDE_ERROR

Const STAGE_WHIP_OVERRIDE_ERROR: Object

Type declaration

NameType
code19001
message"Stage WHIP override URL must be a string starting with http"
name"StageWhipUrlOverrideError"

STREAM_CONFIGURATION_ERROR

Const STREAM_CONFIGURATION_ERROR: Object

Type declaration

NameType
code12000
message"Error when configuring stream"
name"StreamConfigurationError"

STREAM_KEY_INVALID_CHAR_ERROR

Const STREAM_KEY_INVALID_CHAR_ERROR: Object

Type declaration

NameType
code18000
message"Streamkey must contain only [A-Za-z0-9_-] characters"
name"StreamKeyInvalidCharError"

UPDATE_VIDEO_DEVICE_COMPOSITION_INDEX_MISSING_ERROR

Const UPDATE_VIDEO_DEVICE_COMPOSITION_INDEX_MISSING_ERROR: Object

Type declaration

NameType
code7001
message"VideoComposition's \"index\" property is missing"
name"UpdateVideoDeviceCompositionIndexMissingError"

UPDATE_VIDEO_DEVICE_COMPOSITION_MISSING_ERROR

Const UPDATE_VIDEO_DEVICE_COMPOSITION_MISSING_ERROR: Object

Type declaration

NameType
code7000
message"VideoComposition is missing"
name"UpdateVideoDeviceCompositionMissingError"

UPDATE_VIDEO_DEVICE_COMPOSITION_NAME_NOT_FOUND_ERROR

Const UPDATE_VIDEO_DEVICE_COMPOSITION_NAME_NOT_FOUND_ERROR: Object

Type declaration

NameType
code7002
message"Video device with that name is not found"
name"UpdateVideoDeviceCompositionNameMissingError"