@videosdk.live/js-sdk
Version:
<h1 align="center"> <img src="https://cdn.videosdk.live/docs/images/javascript/api_ref/js_api_ref.png"/><br/> </h1>
1,201 lines (969 loc) • 26.8 kB
TypeScript
export enum Errors {
// Server errors
/**
* The provided API key is missing or invalid.
*/
INVALID_API_KEY = 4001,
/**
* The provided token is empty, invalid, or has expired.
*/
INVALID_TOKEN = 4002,
/**
* The provided meeting ID is missing or invalid.
*/
INVALID_MEETING_ID = 4003,
/**
* The provided participant ID is missing or invalid.
*/
INVALID_PARTICIPANT_ID = 4004,
/**
* This participant has already joined from another device.
*/
DUPLICATE_PARTICIPANT = 4005,
/**
* Your account has been deactivated. Please contact VideoSDK support.
*/
ACCOUNT_DEACTIVATED = 4006,
/**
* Your account has been discontinued. Please contact support for more details.
*/
ACCOUNT_DISCONTINUED = 4007,
/**
* The permissions included in the token are invalid.
*/
INVALID_PERMISSIONS = 4008,
/**
* The maximum participant limit for this meeting has been reached.
*/
MAX_PARTCIPANT_REACHED = 4009,
/**
* The maximum number of speakers for this meeting has been reached.
*/
MAX_SPEAKER_REACHED = 4010,
/**
* Failed to start recording. Please try again.
*/
START_RECORDING_FAILED = 4011,
/**
* Failed to stop recording. Please try again.
*/
STOP_RECORDING_FAILED = 4012,
/**
* Failed to start the livestream. Please try again.
*/
START_LIVESTREAM_FAILED = 4013,
/**
* Failed to stop the livestream. Please try again.
*/
STOP_LIVESTREAM_FAILED = 4014,
/**
* The provided livestream output configuration is invalid.
*/
INVALID_LIVESTREAM_CONFIG = 4015,
/**
* Failed to start the HLS stream.
*/
START_HLS_FAILED = 4016,
/**
* Failed to stop the HLS stream.
*/
STOP_HLS_FAILED = 4017,
/**
* Previous recording session is being processed, please try again after few seconds!
*/
PREV_RECORDING_PROCESSING = 4018,
/**
* Previous RTMP recording session is being processed, please try again after few seconds!
*/
PREV_RTMP_RECORDING_PROCESSING = 4019,
/**
* Previous HLS streaming session is being processed, please try again after few seconds!
*/
PREV_HLS_STREAMING_PROCESSING = 4020,
/**
* Add-On services are disabled for your account! Please contact us at support@videosdk.live.
*/
ADD_ON_SERVICES_DISABLED = 4021,
/**
* 'token' is not valid for the provided meetingId
*/
UNAUTHORIZED_MEETING_ID = 4022,
/**
* 'token' is not valid for the provided participantId
*/
UNAUTHORIZED_PARTCIPANT_ID = 4023,
/**
* Role provided in 'token' is not valid for joining the meeting
*/
UNAUTHORIZED_ROLE = 4024,
/**
* Your request does not match the security configuration
*/
UNAUTHORIZED_REQUEST = 4025,
/**
* You have reached max speaker limit on organization. To increase contact at support@videosdk.live
*/
MAX_SPEAKER_LIMIT_REACHED_ON_ORGANIZATION = 4026,
/**
* You have reached the maximum limit for participants joining with VIEWER or SIGNALING_ONLY mode in your organization. To increase the limit, please contact support at support@videosdk.live.
*/
MAX_VIEWER_LIMIT_REACHED_ON_ORGANIZATION = 4027,
/**
* You have reached max limit of recording on organization. To increase contact at support@videosdk.live
*/
MAX_RECORDING_LIMIT_REACHED_ON_ORGANIZATION = 4028,
/**
* You have reached max limit of hls on organization. To increase contact at support@videosdk.live
*/
MAX_HLS_LIMIT_REACHED_ON_ORGANIZATION = 4029,
/**
* You have reached max limit of livestream on organization. To increase contact at support@videosdk.live
*/
MAX_LIVESTREAM_LIMIT_REACHED_ON_ORGANIZATION = 4030,
/**
* Failed to start transcription. Please try again.
*/
START_TRANSCRIPTION_FAILED = 4031,
/**
* Failed to stop transcription.
*/
STOP_TRANSCRIPTION_FAILED = 4032,
/**
* Participant recording start request failed due to an unknown error.
*/
START_PARTICIPANT_RECORDING_FAILED = 4035,
/**
* Participant recording stop request failed due to an unknown error.
*/
STOP_PARTICIPANT_RECORDING_FAILED = 4036,
/**
* Track recording start request failed due to an unknown error.
*/
START_TRACK_RECORDING_FAILED = 4037,
/**
* Track recording stop request failed due to an unknown error.
*/
STOP_TRACK_RECORDING_FAILED = 4038,
/**
* Composite recording start request failed due to an unknown error
*/
START_COMPOSITE_RECORDING_FAILED = 4039,
/**
* Composite recording stop request failed due to an unknown error.
*/
STOP_COMPPOSITE_RECORDING_FAILED = 4040,
/**
* You have reached the maximum limit for participants joining with RECV_ONLY mode in your organization. To increase the limit, please contact support at support@videosdk.live.
*/
MAX_RECV_ONLY_LIMIT_REACHED_ON_ORGANIZATION = 4041,
/**
* Translation start request failed due to an unknown error.
*/
START_TRANSLATION_FAILED = 4042,
/**
* Translation stop request failed due to an unknown error.
*/
STOP_TRANSLATION_FAILED = 4043,
/**
* Change translation language request failed due to an unknown error.
*/
CHANGE_TRANSLATION_LANGUAGE_FAILED = 4044,
/**
* Failed to set realtime store value.
*/
FAILED_TO_SET_VALUE = 4045,
/**
* Failed to get realtime store value.
*/
FAILED_TO_GET_VALUE = 4046,
/**
* Adaptive subscription is not enabled by the SDK. Please contact at support@videosdk.live
*/
ADAPTIVE_SUBSCRIPTION_NOT_ENABLED_BY_SDK = 4047,
/**
* Adaptive subscription is already enabled.
*/
ADAPTIVE_SUBSCRIPTION_ENABLE_FAILED = 4048,
/**
* Adaptive subscription is already disabled.
*/
ADAPTIVE_SUBSCRIPTION_DISABLE_FAILED = 4049,
/**
* Failed to create consumer.
*/
CREATE_CONSUMER_FAILED = 4050,
/**
* Your platform doesn't support the remote participant's video codec.
*/
CODEC_NOT_SUPPORTED = 4051,
/**
* 'meetingId' is disabled, please generate a new meetingId using the API.
*/
MEETING_ID_DISABLED= 4052,
/**
* 'apikey' provided in the token is deactivated, please verify it on the dashboard.
*/
APIKEY_DEACTIVATED= 4053,
/**
* Failed to start the whiteboard. Please try again.
*/
START_WHITEBOARD_FAILED = 4054,
/**
* Failed to stop the whiteboard. Please try again.
*/
STOP_WHITEBOARD_FAILED = 4055,
/**
* A whiteboard operation is already in progress. Please wait for it to complete.
*/
WHITEBOARD_OPERATION_IN_PROGRESS = 4056,
/**
* Failed to pause all streams. Please try again.
*/
PAUSE_ALL_STREAMS_FAILED = 4057,
/**
* Failed to resume all streams. Please try again.
*/
RESUME_ALL_STREAMS_FAILED = 4058,
/**
* Failed to respond to the entry request. Please try again.
*/
RESPOND_ENTRY_FAILED = 4059,
/**
* Failed to change the meeting mode. Please try again.
*/
CHANGE_MODE_FAILED = 4065,
/**
* Failed to remove the participant. Please try again.
*/
REMOVE_PARTICIPANT_FAILED = 4066,
/**
* Failed to enable the participant's microphone. Please try again.
*/
ENABLE_PARTICIPANT_MIC_FAILED = 4067,
/**
* Failed to disable the participant's microphone. Please try again.
*/
DISABLE_PARTICIPANT_MIC_FAILED = 4068,
/**
* Failed to enable the participant's webcam. Please try again.
*/
ENABLE_PARTICIPANT_WEBCAM_FAILED = 4069,
/**
* Failed to disable the participant's webcam. Please try again.
*/
DISABLE_PARTICIPANT_WEBCAM_FAILED = 4070,
/**
* Failed to pin the participant. Please try again.
*/
PIN_FAILED = 4071,
/**
* Failed to unpin the participant. Please try again.
*/
UNPIN_FAILED = 4072,
/**
* Failed to set the stream quality. Please try again.
*/
SET_QUALITY_FAILED = 4073,
/**
* Failed to pause the stream. Please try again.
*/
PAUSE_STREAM_FAILED = 4074,
/**
* Failed to resume the stream. Please try again.
*/
RESUME_STREAM_FAILED = 4075,
/**
* Failed to switch the meeting. Please try again.
*/
SWITCH_MEETING_FAILED = 4076,
/**
* Failed to switch the participant's room. Please try again.
*/
SWITCH_PARTICIPANT_ROOM_FAILED = 4077,
/**
* Failed to request media relay. Please try again.
*/
REQUEST_MEDIA_RELAY_FAILED = 4078,
/**
* Failed to stop media relay. Please try again.
*/
STOP_MEDIA_RELAY_FAILED = 4079,
/**
* Failed to consume the participant's microphone streams. Please try again.
*/
CONSUME_MIC_STREAMS_FAILED = 4080,
/**
* Failed to consume the participant's webcam streams. Please try again.
*/
CONSUME_WEBCAM_STREAMS_FAILED = 4081,
/**
* Failed to stop consuming the participant's microphone streams. Please try again.
*/
STOP_CONSUMING_MIC_STREAMS_FAILED = 4082,
/**
* Failed to stop consuming the participant's webcam streams. Please try again.
*/
STOP_CONSUMING_WEBCAM_STREAMS_FAILED = 4083,
/**
* Failed to respond to the media relay request. Please try again.
*/
RESPOND_MEDIA_RELAY_REQUEST_FAILED = 4084,
/**
* Failed to start observing the realtime store value.
*/
FAILED_TO_OBSERVE_VALUE = 4085,
/**
* Failed to stop observing the realtime store value.
*/
FAILED_TO_STOP_OBSERVING_VALUE = 4086,
/**
* Failed to publish the message to the pubsub topic. Please try again.
*/
PUBSUB_PUBLISH_FAILED = 4087,
/**
* Failed to subscribe to the pubsub topic. Please try again.
*/
PUBSUB_SUBSCRIBE_FAILED = 4088,
/**
* Failed to unsubscribe from the pubsub topic. Please try again.
*/
PUBSUB_UNSUBSCRIBE_FAILED = 4089,
/**
* Something went wrong
*/
SOMETHING_WENT_WRONG= 5000,
// Server critical errors
/**
* Recording stopped due to an internal error.
*/
RECORDING_FAILED = 5001,
/**
* Livestream stopped due to an internal error.
*/
LIVESTREAM_FAILED = 5002,
/**
* HLS streaming stopped due to an internal error.
*/
HLS_FAILED = 5003,
/**
* Recording was automatically stopped because the maximum duration limit was reached.
*/
RECORDING_DURATION_LIMIT_REACHED = 5004,
/**
* Livestream was automatically stopped because the maximum duration limit was reached.
*/
LIVESTREAM_DURATION_LIMIT_REACHED = 5005,
/**
* HLS was automatically stopped because the maximum duration limit was reached.
*/
HLS_DURATION_LIMIT_REACHED = 5006,
/**
* Transcription stopped due to an internal error.
*/
TRANSCRIPTION_FAILED = 5007,
/**
* Translation stopped due to an internal error.
*/
TRANSLATION_FAILED = 5015,
// SDK errors
/**
* Video capture is not supported on this browser or device.
*/
ERROR_GET_VIDEO_MEDIA = 3011,
/**
* Audio capture is not supported on this browser or device.
*/
ERROR_GET_AUDIO_MEDIA = 3012,
/**
* Screen sharing is not supported on this browser or device.
*/
ERROR_GET_DISPLAY_MEDIA = 3013,
/**
* Permission to access the camera was denied.
*/
ERROR_GET_VIDEO_MEDIA_PERMISSION_DENIED = 3014,
/**
* Permission to access the microphone was denied.
*/
ERROR_GET_AUDIO_MEDIA_PERMISSION_DENIED = 3015,
/**
* Permission to share the screen was denied.
*/
ERROR_GET_DISPLAY_MEDIA_PERMISSION_DENIED = 3016,
/**
* Camera access was denied or dismissed. Please allow access in your browser settings.
*/
ERROR_CAMERA_ACCESS_DENIED_OR_DISMISSED = 3017,
/**
* Microphone access was denied or dismissed. Please allow access in your browser settings.
*/
ERROR_MICROPHONE_ACCESS_DENIED_OR_DISMISSED = 3018,
/**
* Camera permission was denied by the operating system.
*/
ERROR_CAMERA_PERMISSION_DENIED_BY_OS = 3019,
/**
* Microphone permission was denied by the operating system.
*/
ERROR_MICROPHONE_PERMISSION_DENIED_BY_OS = 3020,
/**
* Camera not found. Please ensure it is properly connected.
*/
ERROR_CAMERA_NOT_FOUND = 3021,
/**
* Microphone not found. Please ensure it is properly connected.
*/
ERROR_MICROPHONE_NOT_FOUND = 3022,
/**
* Camera is currently in use by another application.
*/
ERROR_CAMERA_IN_USE = 3023,
/**
* Microphone is currently in use by another application.
*/
ERROR_MICROPHONE_IN_USE = 3024,
/**
* There may be an issue with camera permissions or autoplay.
* Refer to: http://tinyurl.com/autoplay-issue
*/
ERROR_CAMERA_PERMISSION_OR_AUTOPLAY_ISSUE = 3025,
/**
* Failed to initialize the video source. Please check browser permissions.
*/
ERROR_VIDEO_SOURCE_INITIATION_FAILED = 3026,
/**
* The webcam track ended or the device was disconnected.
*/
ERROR_WEBCAM_TRACK_ENDED = 3027,
/**
* The microphone track ended or the device was disconnected.
*/
ERROR_MICROPHONE_TRACK_ENDED = 3028,
/**
* The provided custom video track is invalid. Reverting to the default video track.
*/
ERROR_INVALID_CUSTOM_VIDEO_TRACK = 3029,
/**
* The provided custom audio track is invalid. Reverting to the default audio track.
*/
ERROR_INVALID_CUSTOM_AUDIO_TRACK = 3030,
/**
* The provided custom video track has ended.
*/
ERROR_CUSTOM_VIDEO_TRACK_ENDED = 3031,
/**
* The provided custom audio track has ended.
*/
ERROR_CUSTOM_AUDIO_TRACK_ENDED = 3032,
/**
* Camera access is currently unavailable.
*/
ERROR_CAMERA_ACCESS_UNAVAILABLE = 3033,
/**
* Microphone access is currently unavailable.
*/
ERROR_MICROPHONE_ACCESS_UNAVAILABLE = 3034,
/**
* An action was attempted before successfully joining the meeting.
*/
ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED = 3035,
/**
* Camera access was denied or dismissed via app permissions.
*/
ERROR_RN_CAMERA_ACCESS_DENIED_OR_DISMISSED = 3036,
/**
* Camera not found. Please ensure it is connected and enabled.
*/
ERROR_RN_CAMERA_NOT_FOUND = 3037,
/**
* Microphone access was denied or dismissed via app permissions.
*/
ERROR_RN_MIC_ACCESS_DENIED_OR_DISMISSED = 3038,
/**
* Microphone not found. Please ensure it is connected and enabled.
*/
ERROR_RN_MIC_NOT_FOUND = 3039,
/**
* Camera access is unavailable on this device.
*/
ERROR_RN_CAMERA_ACCESS_UNAVAILABLE = 3040,
/**
* Microphone access is unavailable on this device.
*/
ERROR_RN_MIC_ACCESS_UNAVAILABLE = 3041,
/**
* Camera track ended. Please restart or reconnect the camera.
*/
ERROR_RN_CAMERA_TRACK_ENDED = 3042,
/**
* Microphone track ended. Please reconnect or restart the microphone.
*/
ERROR_RN_MIC_TRACK_ENDED = 3043,
/**
* Unable to establish a meeting or media connection. Please check your network connection, firewall or security settings, and try again or connect using a different network.
*/
ERROR_MEETING_MEDIA_CONNECTION_FAILED = 3044,
/**
* The provided codec is not supported for producing video on this device. Falling back to VP8.
*/
ERROR_VIDEO_PRODUCE_CODEC_NOT_SUPPORTED = 3045,
/**
* Multistream is not supported for provided codec.
*/
ERROR_MULTISTREAM_NOT_SUPPORTED = 3046,
/**
* Unable to join the meeting. Please try again.
*/
ERROR_UNABLE_TO_JOIN_MEETING = 3047,
/**
* The meeting's media connection is not ready yet. Please try again in a moment.
*/
ERROR_MEDIA_NOT_READY = 3048,
/**
* The camera track was created but could not be published to the meeting.
*/
ERROR_WEBCAM_PRODUCE_FAILED = 3049,
/**
* The media device has not been initialized.
*/
ERROR_MEDIA_DEVICE_NOT_INITIALIZED = 3050,
/**
* No webcam device was found on this system.
*/
ERROR_NO_WEBCAM_DEVICE_FOUND = 3051,
/**
* No supported video codec is available on this device.
*/
ERROR_NO_SUPPORTED_VIDEO_CODEC = 3052,
/**
* Failed to create the video track.
*/
ERROR_VIDEO_TRACK_CREATION_FAILED = 3053,
/**
* The requested state is already active.
*/
ERROR_ALREADY_IN_REQUESTED_STATE = 3054,
/**
* The requested operation is already in progress.
*/
ERROR_OPERATION_IN_PROGRESS = 3055,
/**
* The operation was aborted before it completed.
*/
ERROR_OPERATION_ABORTED = 3056,
/**
* Unable to end the meeting. Please try again.
*/
ERROR_END_MEETING_FAILED = 3057,
/**
* The microphone track was created but could not be published to the meeting.
*/
ERROR_MICROPHONE_PRODUCE_FAILED = 3058,
/**
* No microphone device was found on this system.
*/
ERROR_NO_MICROPHONE_DEVICE_FOUND = 3059,
/**
* Failed to create the audio track.
*/
ERROR_AUDIO_TRACK_CREATION_FAILED = 3060,
/**
* Failed to start screen sharing.
*/
ERROR_SCREENSHARE_PRODUCE_FAILED = 3061,
/**
* The webcam is not enabled. Enable it before setting quality.
*/
ERROR_WEBCAM_NOT_ENABLED = 3062,
/**
* Failed to set the webcam quality.
*/
ERROR_SET_WEBCAM_QUALITY_FAILED = 3063,
/**
* The media device is not loaded yet. Please try again in a moment.
*/
ERROR_MEDIA_DEVICE_NOT_LOADED = 3064,
/**
* The meeting is reconnecting. Please try again once it reconnects.
*/
ERROR_MEETING_RECONNECTING = 3065,
/**
* This action is not supported in the current meeting mode.
*/
ERROR_ACTION_NOT_SUPPORTED_IN_MODE = 3066,
/**
* Invalid meeting mode requested.
*/
ERROR_INVALID_MODE = 3067,
/**
* This action is not supported here.
*/
ERROR_ACTION_NOT_SUPPORTED = 3068,
/**
* Unable to capture the image. Please try again.
*/
ERROR_CAPTURE_IMAGE_FAILED = 3069,
/**
* Unable to send the message. Please try again.
*/
ERROR_SEND_FAILED = 3070,
/**
* Invalid custom track configuration.
*/
ERROR_INVALID_CUSTOM_TRACK_CONFIG = 3071,
/**
* Payload exceeds the maximum allowed size.
*/
ERROR_PAYLOAD_TOO_LARGE = 3072,
/**
* The provided parameter is missing or invalid. Please verify the provided parameter and try again.
*/
ERROR_INVALID_PARAMETER = 3073,
/**
* Unable to upload the file. Please try again.
*/
ERROR_FILE_UPLOAD_FAILED = 3074,
/**
* Unable to fetch the file. Please try again.
*/
ERROR_FILE_FETCH_FAILED = 3075,
}
export enum recordingEvents {
/**
* Recording is in the starting phase.
*/
RECORDING_STARTING = "RECORDING_STARTING",
/**
* Recording has started successfully.
*/
RECORDING_STARTED = "RECORDING_STARTED",
/**
* Recording is in the stopping phase.
*/
RECORDING_STOPPING = "RECORDING_STOPPING",
/**
* Recording has stopped successfully.
*/
RECORDING_STOPPED = "RECORDING_STOPPED",
}
export enum livestreamEvents {
/**
* Livestream is in the starting phase.
*/
LIVESTREAM_STARTING = "LIVESTREAM_STARTING",
/**
* Livestream has started successfully.
*/
LIVESTREAM_STARTED = "LIVESTREAM_STARTED",
/**
* Livestream is in the stopping phase.
*/
LIVESTREAM_STOPPING = "LIVESTREAM_STOPPING",
/**
* Livestream has stopped successfully.
*/
LIVESTREAM_STOPPED = "LIVESTREAM_STOPPED",
}
export enum hlsEvents {
/**
* HLS streaming is in the starting phase.
*/
HLS_STARTING = "HLS_STARTING",
/**
* HLS streaming has started successfully.
*/
HLS_STARTED = "HLS_STARTED",
/**
* HLS stream is playable.
*/
HLS_PLAYABLE = "HLS_PLAYABLE",
/**
* HLS streaming is in the stopping phase.
*/
HLS_STOPPING = "HLS_STOPPING",
/**
* HLS streaming has stopped successfully.
*/
HLS_STOPPED = "HLS_STOPPED",
}
export enum transcriptionEvents {
/**
* Transcription is in the starting phase.
*/
TRANSCRIPTION_STARTING = "TRANSCRIPTION_STARTING",
/**
* Transcription has started successfully.
*/
TRANSCRIPTION_STARTED = "TRANSCRIPTION_STARTED",
/**
* Transcription is in the stopping phase.
*/
TRANSCRIPTION_STOPPING = "TRANSCRIPTION_STOPPING",
/**
* Transcription has stopped successfully.
*/
TRANSCRIPTION_STOPPED = "TRANSCRIPTION_STOPPED",
}
export enum translationEvents {
/**
* Translation is in the starting phase.
*/
TRANSLATION_STARTING = "TRANSLATION_STARTING",
/**
* Translation has started successfully.
*/
TRANSLATION_STARTED = "TRANSLATION_STARTED",
/**
* Translation is in the stopping phase.
*/
TRANSLATION_STOPPING = "TRANSLATION_STOPPING",
/**
* Translation has stopped successfully.
*/
TRANSLATION_STOPPED = "TRANSLATION_STOPPED",
}
export enum state {
/**
* The meeting connection is being established.
*/
CONNECTING = "CONNECTING",
/**
* The meeting connection has been successfully established.
*/
CONNECTED = "CONNECTED",
/**
* The meeting connection was lost and is attempting to reconnect.
*/
RECONNECTING = "RECONNECTING",
/**
* The meeting connection attempt has failed.
*/
FAILED = "FAILED",
/**
* The meeting connection has been disconnected.
*/
DISCONNECTED = "DISCONNECTED",
}
export enum CharacterState {
/**
* The character is currently speaking.
*/
CHARACTER_SPEAKING = "CHARACTER_SPEAKING",
/**
* The character is processing or generating a response.
*/
CHARACTER_THINKING = "CHARACTER_THINKING",
/**
* The character is actively listening to user input.
*/
CHARACTER_LISTENING = "CHARACTER_LISTENING",
}
export enum CharacterMode {
/**
* Text-based interaction mode.
*/
TEXT = "text",
/**
* Co-pilot interaction mode where the character assists the user.
*/
CO_PILOT = "co_pilot",
/**
* Auto-pilot interaction mode where the character acts autonomously.
*/
AUTO_PILOT = "auto_pilot",
/**
* Vision-pilot interaction mode with visual understanding capabilities.
*/
VISION_PILOT = "vision_pilot",
}
export enum modes {
/**
* @deprecated CONFERENCE mode is deprecated and will be removed in future versions.
* Use SEND_AND_RECV instead.
*/
CONFERENCE = "CONFERENCE",
/**
* @deprecated VIEWER mode is deprecated and will be removed in future versions.
* Use SIGNALLING_ONLY instead.
*/
VIEWER = "VIEWER",
/**
* Both audio and video streams will be produced and consumed.
*/
SEND_AND_RECV = "SEND_AND_RECV",
/**
* Both audio and video streams will not be produced or consumed. It is used solely for signaling.
*/
SIGNALLING_ONLY = "SIGNALLING_ONLY",
/**
* Only audio and video streams will be consumed without producing any.
*/
RECV_ONLY = "RECV_ONLY",
}
export enum Permission {
/**
* Audio permission.
*/
AUDIO = "audio",
/**
* Video permission.
*/
VIDEO = "video",
/**
* Audio and video permissions.
*/
AUDIO_AND_VIDEO = "audio_video",
}
export enum leaveReason {
/**
* WebSocket connection was disconnected.
*/
WEBSOCKET_DISCONNECTED = 1001,
/**
* Participant was removed from the meeting.
*/
REMOVE_PEER = 1002,
/**
* Participant was removed due to a viewer mode change.
*/
REMOVE_PEER_VIEWER_MODE_CHANGED = 1003,
/**
* Participant was removed because media relay stopped.
*/
REMOVE_PEER_MEDIA_RELAY_STOP = 1004,
/**
* Participant switched to another room.
*/
SWITCH_ROOM = 1005,
/**
* The meeting has been closed.
*/
ROOM_CLOSE = 1006,
/**
* Participant disconnected due to an unknown reason.
*/
UNKNOWN = 1007,
/**
* All participants were removed from the meeting.
*/
REMOVE_ALL = 1008,
/**
* Meeting ended via API.
*/
MEETING_END_API = 1009,
/**
* Participant was removed via API.
*/
REMOVE_PEER_API = 1010,
/**
* Participant joined from another device.
*/
DUPLICATE_PARTICIPANT = 1011,
/**
* Participant manually left the meeting.
*/
MANUAL_LEAVE_CALLED = 1101,
/**
* WebSocket connection attempts were exhausted.
*/
WEBSOCKET_CONNECTION_ATTEMPTS_EXHAUSTED = 1102,
/**
* Failed to join the meeting.
*/
JOIN_ROOM_FAILED = 1103,
/**
* Failed to switch rooms.
*/
SWITCH_ROOM_FAILED = 1104,
}
export enum BitrateMode {
/**
* Prioritizes video quality over bandwidth usage.
*/
HIGH_QUALITY = "high_quality",
/**
* Balances video quality and bandwidth usage.
*/
BALANCED = "balanced",
/**
* Optimizes for low bandwidth usage.
*/
BANDWIDTH_OPTIMIZED = "bandwidth_optimized",
}
export enum reliabilityMode {
/**
* Ensures reliable message delivery.
*/
RELIABLE = "RELIABLE",
/**
* Allows faster delivery without guaranteed reliability.
*/
UNRELIABLE = "UNRELIABLE",
}
export enum LogLevel {
/**
* Disables all logging output. No logs will be printed.
*/
NONE = "NONE",
/**
* Displays only critical failures and unrecoverable issues.
*/
ERROR = "ERROR",
/**
* Displays warnings and errors. Warnings indicate recoverable anomalies.
*/
WARN = "WARN",
/**
* Displays standard SDK activity logs including lifecycle events and state transitions.
*/
INFO = "INFO",
/**
* Displays detailed diagnostic logs for debugging SDK behavior and internal operations.
*/
DEBUG = "DEBUG",
/**
* Enables extremely verbose logging including high-frequency real-time events.
*/
ALL = "ALL",
}
export enum AgentState {
/** Agent is inactive and not processing any input */
IDLE = "idle",
/** Agent is actively listening to user input */
LISTENING = "listening",
/** Agent is processing or generating a response */
THINKING = "thinking",
/** Agent is speaking */
SPEAKING = "speaking",
}
export enum RealtimeOverflow {
/**
* Drop remaining realtime messages when your internet is slow or your device (CPU) can't keep up with the incoming rate.
*/
DROP = "drop",
/**
* Queue remaining realtime messages when your internet is slow or your device (CPU) can't keep up, so you receive them once you catch up. This is the default behavior.
*/
QUEUE = "queue",
}
export enum VideoCodec {
/**
* Provides good video quality with low CPU usage, broad compatibility, and support for multiStream.
*/
VP8 = "VP8",
/**
* Offers high-quality video compression for modern devices while requiring moderate to high CPU resources.
*/
VP9 = "VP9",
/**
* Delivers excellent video quality and compression efficiency, with support continuing to expand across browsers and devices.
*
* > **Note** :
* > AV1 has limited browser support. In our testing, it failed on some versions of Safari (macOS) and mobile web (Chrome and Safari on iPhone). Test it on your target browsers and devices before using it.
*/
AV1 = "AV1",
/**
* Provides good video quality with low CPU usage, broad device support, and support for multiStream.
*/
H264 = "H264",
}