// AR Engine SDK
|
//
|
// Copyright (c) 2019 AR.io. All rights reserved.
|
//
|
|
#ifndef __AR_BASE_H__
|
#define __AR_BASE_H__
|
|
#include <stddef.h>
|
#include <stdio.h>
|
#include <stdarg.h>
|
#include <string.h>
|
#include <stdlib.h>
|
|
#if defined(_WIN32)
|
#define WIN32_LEAN_AND_MEAN
|
#include <windows.h>
|
#define AR_CALL __cdecl
|
#if defined(ARRTC_EXPORT)
|
#define AR_API extern "C" __declspec(dllexport)
|
#else
|
#define AR_API extern "C" __declspec(dllimport)
|
#endif
|
#elif defined(__APPLE__)
|
#include <TargetConditionals.h>
|
#define AR_API __attribute__((visibility("default"))) extern "C"
|
#define AR_CALL
|
#elif defined(__ANDROID__) || defined(__linux__)
|
#define AR_API extern "C" __attribute__((visibility("default")))
|
#define AR_CALL
|
#else
|
#define AR_API extern "C"
|
#define AR_CPP_API
|
#define AR_CALL
|
#endif
|
|
namespace ar {
|
namespace util {
|
|
template<class T>
|
class AutoPtr {
|
typedef T value_type;
|
typedef T* pointer_type;
|
public:
|
AutoPtr(pointer_type p=0)
|
:ptr_(p)
|
{}
|
~AutoPtr() {
|
if (ptr_)
|
ptr_->release();
|
}
|
operator bool() const { return ptr_ != (pointer_type)0; }
|
value_type& operator*() const {
|
return *get();
|
}
|
|
pointer_type operator->() const {
|
return get();
|
}
|
|
pointer_type get() const {
|
return ptr_;
|
}
|
|
pointer_type release() {
|
pointer_type tmp = ptr_;
|
ptr_ = 0;
|
return tmp;
|
}
|
|
void reset(pointer_type ptr = 0) {
|
if (ptr != ptr_ && ptr_)
|
ptr_->release();
|
ptr_ = ptr;
|
}
|
template<class C1, class C2>
|
bool queryInterface(C1* c, C2 iid) {
|
pointer_type p = NULL;
|
if (c && !c->queryInterface(iid, (void**)&p))
|
{
|
reset(p);
|
}
|
return p != NULL;
|
}
|
private:
|
AutoPtr(const AutoPtr&);
|
AutoPtr& operator=(const AutoPtr&);
|
private:
|
pointer_type ptr_;
|
};
|
class IString {
|
protected:
|
virtual ~IString(){}
|
public:
|
virtual bool empty() const = 0;
|
virtual const char* c_str() = 0;
|
virtual const char* data() = 0;
|
virtual size_t length() = 0;
|
virtual void release() = 0;
|
};
|
typedef AutoPtr<IString> AString;
|
|
}//namespace util
|
|
enum INTERFACE_ID_TYPE
|
{
|
AR_IID_AUDIO_DEVICE_MANAGER = 1,
|
AR_IID_VIDEO_DEVICE_MANAGER = 2,
|
AR_IID_RTC_ENGINE_PARAMETER = 3,
|
AR_IID_MEDIA_ENGINE = 4,
|
AR_IID_SIGNALING_ENGINE = 8,
|
};
|
|
/** Warning code.
|
*/
|
enum WARN_CODE_TYPE
|
{
|
/** 8: The specified view is invalid. Specify a view when using the video call function.
|
*/
|
WARN_INVALID_VIEW = 8,
|
/** 16: Failed to initialize the video function, possibly caused by a lack of resources. The users cannot see the video while the voice communication is not affected.
|
*/
|
WARN_INIT_VIDEO = 16,
|
/** 20: The request is pending, usually due to some module not being ready, and the SDK postponed processing the request.
|
*/
|
WARN_PENDING = 20,
|
/** 103: No channel resources are available. Maybe because the server cannot allocate any channel resource.
|
*/
|
WARN_NO_AVAILABLE_CHANNEL = 103,
|
/** 104: A timeout occurs when looking up the channel. When joining a channel, the SDK looks up the specified channel. This warning usually occurs when the network condition is too poor for the SDK to connect to the server.
|
*/
|
WARN_LOOKUP_CHANNEL_TIMEOUT = 104,
|
/** **DEPRECATED** 105: The server rejects the request to look up the channel. The server cannot process this request or the request is illegal.
|
|
Deprecated as of v2.4.1. Use CONNECTION_CHANGED_REJECTED_BY_SERVER(10) in the \ref ar::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" callback instead.
|
*/
|
WARN_LOOKUP_CHANNEL_REJECTED = 105,
|
/** 106: A timeout occurs when opening the channel. Once the specific channel is found, the SDK opens the channel. This warning usually occurs when the network condition is too poor for the SDK to connect to the server.
|
*/
|
WARN_OPEN_CHANNEL_TIMEOUT = 106,
|
/** 107: The server rejects the request to open the channel. The server cannot process this request or the request is illegal.
|
*/
|
WARN_OPEN_CHANNEL_REJECTED = 107,
|
|
// sdk: 100~1000
|
/** 111: A timeout occurs when switching to the live video.
|
*/
|
WARN_SWITCH_LIVE_VIDEO_TIMEOUT = 111,
|
/** 118: A timeout occurs when setting the client role in the live interactive streaming profile.
|
*/
|
WARN_SET_CLIENT_ROLE_TIMEOUT = 118,
|
/** 121: The ticket to open the channel is invalid.
|
*/
|
WARN_OPEN_CHANNEL_INVALID_TICKET = 121,
|
/** 122: Try connecting to another server.
|
*/
|
WARN_OPEN_CHANNEL_TRY_NEXT_VOS = 122,
|
/** 131: The channel connection cannot be recovered.
|
*/
|
WARN_CHANNEL_CONNECTION_UNRECOVERABLE = 131,
|
/** 132: The IP address has changed.
|
*/
|
WARN_CHANNEL_CONNECTION_IP_CHANGED = 132,
|
/** 133: The port has changed.
|
*/
|
WARN_CHANNEL_CONNECTION_PORT_CHANGED = 133,
|
/** 134: The socket error occurs, try to rejoin channel.
|
*/
|
WARN_CHANNEL_SOCKET_ERROR = 134,
|
/** 701: An error occurs in opening the audio mixing file.
|
*/
|
WARN_AUDIO_MIXING_OPEN_ERROR = 701,
|
/** 1014: Audio Device Module: A warning occurs in the playback device.
|
*/
|
WARN_ADM_RUNTIME_PLAYOUT_WARNING = 1014,
|
/** 1016: Audio Device Module: a warning occurs in the recording device.
|
*/
|
WARN_ADM_RUNTIME_RECORDING_WARNING = 1016,
|
/** 1019: Audio Device Module: no valid audio data is recorded.
|
*/
|
WARN_ADM_RECORD_AUDIO_SILENCE = 1019,
|
/** 1020: Audio device module: The audio playback frequency is abnormal, which may cause audio freezes. This abnormality is caused by high CPU usage. AR recommends stopping other apps.
|
*/
|
WARN_ADM_PLAYOUT_MALFUNCTION = 1020,
|
/** 1021: Audio device module: the audio recording frequency is abnormal, which may cause audio freezes. This abnormality is caused by high CPU usage. AR recommends stopping other apps.
|
*/
|
WARN_ADM_RECORD_MALFUNCTION = 1021,
|
/** 1025: The audio playback or recording is interrupted by system events (such as a phone call).
|
*/
|
WARN_ADM_CALL_INTERRUPTION = 1025,
|
/** 1029: During a call, the audio session category should be set to
|
* AVAudioSessionCategoryPlayAndRecord, and RtcEngine monitors this value.
|
* If the audio session category is set to other values, this warning code
|
* is triggered and RtcEngine will forcefully set it back to
|
* AVAudioSessionCategoryPlayAndRecord.
|
*/
|
WARN_ADM_IOS_CATEGORY_NOT_PLAYANDRECORD = 1029,
|
/** 1031: Audio Device Module: The recorded audio voice is too low.
|
*/
|
WARN_ADM_RECORD_AUDIO_LOWLEVEL = 1031,
|
/** 1032: Audio Device Module: the playback audio voice is too low.
|
*/
|
WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL = 1032,
|
/** 1033: Audio device module: The audio recording device is occupied.
|
*/
|
WARN_ADM_RECORD_AUDIO_IS_ACTIVE = 1033,
|
/** 1040: Audio device module: An exception occurs with the audio drive.
|
* Solutions:
|
* - Disable or re-enable the audio device.
|
* - Re-enable your device.
|
* - Update the sound card drive.
|
*/
|
WARN_ADM_WINDOWS_NO_DATA_READY_EVENT = 1040,
|
/** 1042: Audio device module: The audio recording device is different from the audio playback device,
|
* which may cause echoes problem. AR recommends using the same audio device to record and playback
|
* audio.
|
*/
|
WARN_ADM_INCONSISTENT_AUDIO_DEVICE = 1042,
|
/** 1051: (Communication profile only) Audio processing module: A howling sound is detected when recording the audio data.
|
*/
|
WARN_APM_HOWLING = 1051,
|
/** 1052: Audio Device Module: The device is in the glitch state.
|
*/
|
WARN_ADM_GLITCH_STATE = 1052,
|
/** 1053: Audio Processing Module: A residual echo is detected, which may be caused by the belated scheduling of system threads or the signal overflow.
|
*/
|
WARN_APM_RESIDUAL_ECHO = 1053,
|
/// @cond
|
WARN_ADM_WIN_CORE_NO_RECORDING_DEVICE = 1322,
|
/// @endcond
|
/** 1323: Audio device module: No available playback device.
|
* Solution: Plug in the audio device.
|
*/
|
WARN_ADM_WIN_CORE_NO_PLAYOUT_DEVICE = 1323,
|
/** Audio device module: The capture device is released improperly.
|
* Solutions:
|
* - Disable or re-enable the audio device.
|
* - Re-enable your device.
|
* - Update the sound card drive.
|
*/
|
WARN_ADM_WIN_CORE_IMPROPER_CAPTURE_RELEASE = 1324,
|
/** 1610: The origin resolution of the remote video is beyond the range where the super-resolution algorithm can be applied.
|
*/
|
WARN_SUPER_RESOLUTION_STREAM_OVER_LIMITATION = 1610,
|
/** 1611: Another user is already using the super-resolution algorithm.
|
*/
|
WARN_SUPER_RESOLUTION_USER_COUNT_OVER_LIMITATION = 1611,
|
/** 1612: The device does not support the super-resolution algorithm.
|
*/
|
WARN_SUPER_RESOLUTION_DEVICE_NOT_SUPPORTED = 1612,
|
/// @cond
|
WARN_RTM_LOGIN_TIMEOUT = 2005,
|
WARN_RTM_KEEP_ALIVE_TIMEOUT = 2009
|
/// @endcond
|
};
|
|
/** Error code.
|
*/
|
enum ERROR_CODE_TYPE
|
{
|
/** 0: No error occurs.
|
*/
|
ERR_OK = 0,
|
//1~1000
|
/** 1: A general error occurs (no specified reason).
|
*/
|
ERR_FAILED = 1,
|
/** 2: An invalid parameter is used. For example, the specific channel name includes illegal characters.
|
*/
|
ERR_INVALID_ARGUMENT = 2,
|
/** 3: The SDK module is not ready. Possible solutions:
|
|
- Check the audio device.
|
- Check the completeness of the application.
|
- Re-initialize the RTC engine.
|
*/
|
ERR_NOT_READY = 3,
|
/** 4: The SDK does not support this function.
|
*/
|
ERR_NOT_SUPPORTED = 4,
|
/** 5: The request is rejected.
|
*/
|
ERR_REFUSED = 5,
|
/** 6: The buffer size is not big enough to store the returned data.
|
*/
|
ERR_BUFFER_TOO_SMALL = 6,
|
/** 7: The SDK is not initialized before calling this method.
|
*/
|
ERR_NOT_INITIALIZED = 7,
|
/** 9: No permission exists. Check if the user has granted access to the audio or video device.
|
*/
|
ERR_NO_PERMISSION = 9,
|
/** 10: An API method timeout occurs. Some API methods require the SDK to return the execution result, and this error occurs if the request takes too long (more than 10 seconds) for the SDK to process.
|
*/
|
ERR_TIMEDOUT = 10,
|
/** 11: The request is canceled. This is for internal SDK use only, and it does not return to the application through any method or callback.
|
*/
|
ERR_CANCELED = 11,
|
/** 12: The method is called too often. This is for internal SDK use only, and it does not return to the application through any method or callback.
|
*/
|
ERR_TOO_OFTEN = 12,
|
/** 13: The SDK fails to bind to the network socket. This is for internal SDK use only, and it does not return to the application through any method or callback.
|
*/
|
ERR_BIND_SOCKET = 13,
|
/** 14: The network is unavailable. This is for internal SDK use only, and it does not return to the application through any method or callback.
|
*/
|
ERR_NET_DOWN = 14,
|
/** 15: No network buffers are available. This is for internal SDK internal use only, and it does not return to the application through any method or callback.
|
*/
|
ERR_NET_NOBUFS = 15,
|
/** 17: The request to join the channel is rejected.
|
*
|
* - This error usually occurs when the user is already in the channel, and still calls the method to join the channel, for example, \ref ar::rtc::IRtcEngine::joinChannel "joinChannel".
|
* - This error usually occurs when the user tries to join a channel during a call test (\ref ar::rtc::IRtcEngine::startEchoTest "startEchoTest"). Once you call \ref ar::rtc::IRtcEngine::startEchoTest "startEchoTest", you need to call \ref ar::rtc::IRtcEngine::stopEchoTest "stopEchoTest" before joining a channel.
|
*/
|
ERR_JOIN_CHANNEL_REJECTED = 17,
|
/** 18: The request to leave the channel is rejected.
|
|
This error usually occurs:
|
|
- When the user has left the channel and still calls \ref ar::rtc::IRtcEngine::leaveChannel "leaveChannel" to leave the channel. In this case, stop calling \ref ar::rtc::IRtcEngine::leaveChannel "leaveChannel".
|
- When the user has not joined the channel and still calls \ref ar::rtc::IRtcEngine::leaveChannel "leaveChannel" to leave the channel. In this case, no extra operation is needed.
|
*/
|
ERR_LEAVE_CHANNEL_REJECTED = 18,
|
/** 19: Resources are occupied and cannot be reused.
|
*/
|
ERR_ALREADY_IN_USE = 19,
|
/** 20: The SDK gives up the request due to too many requests.
|
*/
|
ERR_ABORTED = 20,
|
/** 21: In Windows, specific firewall settings can cause the SDK to fail to initialize and crash.
|
*/
|
ERR_INIT_NET_ENGINE = 21,
|
/** 22: The application uses too much of the system resources and the SDK fails to allocate the resources.
|
*/
|
ERR_RESOURCE_LIMITED = 22,
|
/** 101: The specified App ID is invalid. Please try to rejoin the channel with a valid App ID.
|
*/
|
ERR_INVALID_APP_ID = 101,
|
/** 102: The specified channel name is invalid. Please try to rejoin the channel with a valid channel name.
|
*/
|
ERR_INVALID_CHANNEL_NAME = 102,
|
/** 103: Fails to get server resources in the specified region. Please try to specify another region when calling \ref ar::rtc::IRtcEngine::initialize "initialize".
|
*/
|
ERR_NO_SERVER_RESOURCES = 103,
|
/** **DEPRECATED** 109: Deprecated as of v2.4.1. Use CONNECTION_CHANGED_TOKEN_EXPIRED(9) in the \ref ar::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" callback instead.
|
|
The token expired due to one of the following reasons:
|
|
- Authorized Timestamp expired: The timestamp is represented by the number of seconds elapsed since 1/1/1970. The user can use the Token to access the AR service within five minutes after the Token is generated. If the user does not access the AR service after five minutes, this Token is no longer valid.
|
- Call Expiration Timestamp expired: The timestamp is the exact time when a user can no longer use the AR service (for example, when a user is forced to leave an ongoing call). When a value is set for the Call Expiration Timestamp, it does not mean that the token will expire, but that the user will be banned from the channel.
|
*/
|
ERR_TOKEN_EXPIRED = 109,
|
/** **DEPRECATED** 110: Deprecated as of v2.4.1. Use CONNECTION_CHANGED_INVALID_TOKEN(8) in the \ref ar::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" callback instead.
|
|
The token is invalid due to one of the following reasons:
|
|
- The App Certificate for the project is enabled in Console, but the user is still using the App ID. Once the App Certificate is enabled, the user must use a token.
|
- The uid is mandatory, and users must set the same uid as the one set in the \ref ar::rtc::IRtcEngine::joinChannel "joinChannel" method.
|
*/
|
ERR_INVALID_TOKEN = 110,
|
/** 111: The internet connection is interrupted. This applies to the AR Web SDK only.
|
*/
|
ERR_CONNECTION_INTERRUPTED = 111, // only used in web sdk
|
/** 112: The internet connection is lost. This applies to the AR Web SDK only.
|
*/
|
ERR_CONNECTION_LOST = 112, // only used in web sdk
|
/** 113: The user is not in the channel when calling the \ref ar::rtc::IRtcEngine::sendStreamMessage "sendStreamMessage" or \ref ar::rtc::IRtcEngine::getUserInfoByUserAccount "getUserInfoByUserAccount" method.
|
*/
|
ERR_NOT_IN_CHANNEL = 113,
|
/** 114: The size of the sent data is over 1024 bytes when the user calls the \ref ar::rtc::IRtcEngine::sendStreamMessage "sendStreamMessage" method.
|
*/
|
ERR_SIZE_TOO_LARGE = 114,
|
/** 115: The bitrate of the sent data exceeds the limit of 6 Kbps when the user calls the \ref ar::rtc::IRtcEngine::sendStreamMessage "sendStreamMessage" method.
|
*/
|
ERR_BITRATE_LIMIT = 115,
|
/** 116: Too many data streams (over 5 streams) are created when the user calls the \ref ar::rtc::IRtcEngine::createDataStream "createDataStream" method.
|
*/
|
ERR_TOO_MANY_DATA_STREAMS = 116,
|
/** 117: The data stream transmission timed out.
|
*/
|
ERR_STREAM_MESSAGE_TIMEOUT = 117,
|
/** 119: Switching roles fail. Please try to rejoin the channel.
|
*/
|
ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED = 119,
|
/** 120: Decryption fails. The user may have used a different encryption password to join the channel. Check your settings or try rejoining the channel.
|
*/
|
ERR_DECRYPTION_FAILED = 120,
|
/** 123: The client is banned by the server.
|
*/
|
ERR_CLIENT_IS_BANNED_BY_SERVER = 123,
|
/** 124: Incorrect watermark file parameter.
|
*/
|
ERR_WATERMARK_PARAM = 124,
|
/** 125: Incorrect watermark file path.
|
*/
|
ERR_WATERMARK_PATH = 125,
|
/** 126: Incorrect watermark file format.
|
*/
|
ERR_WATERMARK_PNG = 126,
|
/** 127: Incorrect watermark file information.
|
*/
|
ERR_WATERMARKR_INFO = 127,
|
/** 128: Incorrect watermark file data format.
|
*/
|
ERR_WATERMARK_ARGB = 128,
|
/** 129: An error occurs in reading the watermark file.
|
*/
|
ERR_WATERMARK_READ = 129,
|
/** 130: Encryption is enabled when the user calls the \ref ar::rtc::IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method (CDN live streaming does not support encrypted streams).
|
*/
|
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH = 130,
|
/** 134: The user account is invalid. */
|
ERR_INVALID_USER_ACCOUNT = 134,
|
|
/** 151: CDN related errors. Remove the original URL address and add a new one by calling the \ref ar::rtc::IRtcEngine::removePublishStreamUrl "removePublishStreamUrl" and \ref ar::rtc::IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" methods.
|
*/
|
ERR_PUBLISH_STREAM_CDN_ERROR = 151,
|
/** 152: The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones.
|
*/
|
ERR_PUBLISH_STREAM_NUM_REACH_LIMIT = 152,
|
/** 153: The host manipulates other hosts' URLs. Check your app logic.
|
*/
|
ERR_PUBLISH_STREAM_NOT_AUTHORIZED = 153,
|
/** 154: An error occurs in AR's streaming server. Call the addPublishStreamUrl method to publish the streaming again.
|
*/
|
ERR_PUBLISH_STREAM_INTERNAL_SERVER_ERROR = 154,
|
/** 155: The server fails to find the stream.
|
*/
|
ERR_PUBLISH_STREAM_NOT_FOUND = 155,
|
/** 156: The format of the RTMP stream URL is not supported. Check whether the URL format is correct.
|
*/
|
ERR_PUBLISH_STREAM_FORMAT_NOT_SUPPORTED = 156,
|
|
//signaling: 400~600
|
/**
|
*/
|
ERR_LOGOUT_OTHER = 400, //
|
/** 401: The user logged out.
|
*/
|
ERR_LOGOUT_USER = 401, // logout by user
|
/** 402: Network failure.
|
*/
|
ERR_LOGOUT_NET = 402, // network failure
|
/** 403: Logged in another device.
|
*/
|
ERR_LOGOUT_KICKED = 403, // login in other device
|
/**
|
*/
|
ERR_LOGOUT_PACKET = 404, //
|
/** 405: The token expired.
|
*/
|
ERR_LOGOUT_TOKEN_EXPIRED = 405, // token expired
|
/**
|
*/
|
ERR_LOGOUT_OLDVERSION = 406, //
|
/**
|
*/
|
ERR_LOGOUT_TOKEN_WRONG = 407,
|
/**
|
*/
|
ERR_LOGOUT_ALREADY_LOGOUT = 408,
|
/**
|
*/
|
ERR_LOGIN_OTHER = 420,
|
/**
|
*/
|
ERR_LOGIN_NET = 421,
|
/**
|
*/
|
ERR_LOGIN_FAILED = 422,
|
/**
|
*/
|
ERR_LOGIN_CANCELED = 423,
|
/**
|
*/
|
ERR_LOGIN_TOKEN_EXPIRED = 424,
|
/**
|
*/
|
ERR_LOGIN_OLD_VERSION = 425,
|
/**
|
*/
|
ERR_LOGIN_TOKEN_WRONG = 426,
|
/**
|
*/
|
ERR_LOGIN_TOKEN_KICKED = 427,
|
/**
|
*/
|
ERR_LOGIN_ALREADY_LOGIN = 428,
|
/**
|
*/
|
ERR_JOIN_CHANNEL_OTHER = 440,
|
/**
|
*/
|
ERR_SEND_MESSAGE_OTHER = 440,
|
/**
|
*/
|
ERR_SEND_MESSAGE_TIMEOUT = 441,
|
/**
|
*/
|
ERR_QUERY_USERNUM_OTHER = 450,
|
/**
|
*/
|
ERR_QUERY_USERNUM_TIMEOUT = 451,
|
/**
|
*/
|
ERR_QUERY_USERNUM_BYUSER = 452,
|
/**
|
*/
|
ERR_LEAVE_CHANNEL_OTHER = 460,
|
/**
|
*/
|
ERR_LEAVE_CHANNEL_KICKED = 461,
|
/**
|
*/
|
ERR_LEAVE_CHANNEL_BYUSER = 462,
|
/**
|
*/
|
ERR_LEAVE_CHANNEL_LOGOUT = 463,
|
/**
|
*/
|
ERR_LEAVE_CHANNEL_DISCONNECTED = 464,
|
/**
|
*/
|
ERR_INVITE_OTHER = 470,
|
/**
|
*/
|
ERR_INVITE_REINVITE = 471,
|
/**
|
*/
|
ERR_INVITE_NET = 472,
|
/**
|
*/
|
ERR_INVITE_PEER_OFFLINE = 473,
|
ERR_INVITE_TIMEOUT = 474,
|
ERR_INVITE_CANT_RECV = 475,
|
|
|
//1001~2000
|
/** 1001: Fails to load the media engine.
|
*/
|
ERR_LOAD_MEDIA_ENGINE = 1001,
|
/** 1002: Fails to start the call after enabling the media engine.
|
*/
|
ERR_START_CALL = 1002,
|
/** **DEPRECATED** 1003: Fails to start the camera.
|
|
Deprecated as of v2.4.1. Use LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE(4) in the \ref ar::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" callback instead.
|
*/
|
ERR_START_CAMERA = 1003,
|
/** 1004: Fails to start the video rendering module.
|
*/
|
ERR_START_VIDEO_RENDER = 1004,
|
/** 1005: A general error occurs in the Audio Device Module (no specified reason). Check if the audio device is used by another application, or try rejoining the channel.
|
*/
|
ERR_ADM_GENERAL_ERROR = 1005,
|
/** 1006: Audio Device Module: An error occurs in using the Java resources.
|
*/
|
ERR_ADM_JAVA_RESOURCE = 1006,
|
/** 1007: Audio Device Module: An error occurs in setting the sampling frequency.
|
*/
|
ERR_ADM_SAMPLE_RATE = 1007,
|
/** 1008: Audio Device Module: An error occurs in initializing the playback device.
|
*/
|
ERR_ADM_INIT_PLAYOUT = 1008,
|
/** 1009: Audio Device Module: An error occurs in starting the playback device.
|
*/
|
ERR_ADM_START_PLAYOUT = 1009,
|
/** 1010: Audio Device Module: An error occurs in stopping the playback device.
|
*/
|
ERR_ADM_STOP_PLAYOUT = 1010,
|
/** 1011: Audio Device Module: An error occurs in initializing the recording device.
|
*/
|
ERR_ADM_INIT_RECORDING = 1011,
|
/** 1012: Audio Device Module: An error occurs in starting the recording device.
|
*/
|
ERR_ADM_START_RECORDING = 1012,
|
/** 1013: Audio Device Module: An error occurs in stopping the recording device.
|
*/
|
ERR_ADM_STOP_RECORDING = 1013,
|
/** 1015: Audio Device Module: A playback error occurs. Check your playback device and try rejoining the channel.
|
*/
|
ERR_ADM_RUNTIME_PLAYOUT_ERROR = 1015,
|
/** 1017: Audio Device Module: A recording error occurs.
|
*/
|
ERR_ADM_RUNTIME_RECORDING_ERROR = 1017,
|
/** 1018: Audio Device Module: Fails to record.
|
*/
|
ERR_ADM_RECORD_AUDIO_FAILED = 1018,
|
/** 1022: Audio Device Module: An error occurs in initializing the
|
* loopback device.
|
*/
|
ERR_ADM_INIT_LOOPBACK = 1022,
|
/** 1023: Audio Device Module: An error occurs in starting the loopback
|
* device.
|
*/
|
ERR_ADM_START_LOOPBACK = 1023,
|
/** 1027: Audio Device Module: No recording permission exists. Check if the
|
* recording permission is granted.
|
*/
|
ERR_ADM_NO_PERMISSION = 1027,
|
/** 1033: Audio device module: The device is occupied.
|
*/
|
ERR_ADM_RECORD_AUDIO_IS_ACTIVE = 1033,
|
/** 1101: Audio device module: A fatal exception occurs.
|
*/
|
ERR_ADM_ANDROID_JNI_JAVA_RESOURCE = 1101,
|
/** 1108: Audio device module: The recording frequency is lower than 50.
|
* 0 indicates that the recording is not yet started. We recommend
|
* checking your recording permission.
|
*/
|
ERR_ADM_ANDROID_JNI_NO_RECORD_FREQUENCY = 1108,
|
/** 1109: The playback frequency is lower than 50. 0 indicates that the
|
* playback is not yet started. We recommend checking if you have created
|
* too many AudioTrack instances.
|
*/
|
ERR_ADM_ANDROID_JNI_NO_PLAYBACK_FREQUENCY = 1109,
|
/** 1111: Audio device module: AudioRecord fails to start up. A ROM system
|
* error occurs. We recommend the following options to debug:
|
* - Restart your App.
|
* - Restart your cellphone.
|
* - Check your recording permission.
|
*/
|
ERR_ADM_ANDROID_JNI_JAVA_START_RECORD = 1111,
|
/** 1112: Audio device module: AudioTrack fails to start up. A ROM system
|
* error occurs. We recommend the following options to debug:
|
* - Restart your App.
|
* - Restart your cellphone.
|
* - Check your playback permission.
|
*/
|
ERR_ADM_ANDROID_JNI_JAVA_START_PLAYBACK = 1112,
|
/** 1115: Audio device module: AudioRecord returns error. The SDK will
|
* automatically restart AudioRecord. */
|
ERR_ADM_ANDROID_JNI_JAVA_RECORD_ERROR = 1115,
|
/** **DEPRECATED** */
|
ERR_ADM_ANDROID_OPENSL_CREATE_ENGINE = 1151,
|
/** **DEPRECATED** */
|
ERR_ADM_ANDROID_OPENSL_CREATE_AUDIO_RECORDER = 1153,
|
/** **DEPRECATED** */
|
ERR_ADM_ANDROID_OPENSL_START_RECORDER_THREAD = 1156,
|
/** **DEPRECATED** */
|
ERR_ADM_ANDROID_OPENSL_CREATE_AUDIO_PLAYER = 1157,
|
/** **DEPRECATED** */
|
ERR_ADM_ANDROID_OPENSL_START_PLAYER_THREAD = 1160,
|
/** 1201: Audio device module: The current device does not support audio
|
* input, possibly because you have mistakenly configured the audio session
|
* category, or because some other app is occupying the input device. We
|
* recommend terminating all background apps and re-joining the channel. */
|
ERR_ADM_IOS_INPUT_NOT_AVAILABLE = 1201,
|
/** 1206: Audio device module: Cannot activate the Audio Session.*/
|
ERR_ADM_IOS_ACTIVATE_SESSION_FAIL = 1206,
|
/** 1210: Audio device module: Fails to initialize the audio device,
|
* normally because the audio device parameters are wrongly set.*/
|
ERR_ADM_IOS_VPIO_INIT_FAIL = 1210,
|
/** 1213: Audio device module: Fails to re-initialize the audio device,
|
* normally because the audio device parameters are wrongly set.*/
|
ERR_ADM_IOS_VPIO_REINIT_FAIL = 1213,
|
/** 1214: Fails to re-start up the Audio Unit, possibly because the audio
|
* session category is not compatible with the settings of the Audio Unit.
|
*/
|
ERR_ADM_IOS_VPIO_RESTART_FAIL = 1214,
|
ERR_ADM_IOS_SET_RENDER_CALLBACK_FAIL = 1219,
|
/** **DEPRECATED** */
|
ERR_ADM_IOS_SESSION_SAMPLERATR_ZERO = 1221,
|
/** 1301: Audio device module: An audio driver abnomality or a
|
* compatibility issue occurs. Solutions: Disable and restart the audio
|
* device, or reboot the system.*/
|
ERR_ADM_WIN_CORE_INIT = 1301,
|
/** 1303: Audio device module: A recording driver abnomality or a
|
* compatibility issue occurs. Solutions: Disable and restart the audio
|
* device, or reboot the system. */
|
ERR_ADM_WIN_CORE_INIT_RECORDING = 1303,
|
/** 1306: Audio device module: A playout driver abnomality or a
|
* compatibility issue occurs. Solutions: Disable and restart the audio
|
* device, or reboot the system. */
|
ERR_ADM_WIN_CORE_INIT_PLAYOUT = 1306,
|
/** 1307: Audio device module: No audio device is available. Solutions:
|
* Plug in a proper audio device. */
|
ERR_ADM_WIN_CORE_INIT_PLAYOUT_NULL = 1307,
|
/** 1309: Audio device module: An audio driver abnomality or a
|
* compatibility issue occurs. Solutions: Disable and restart the audio
|
* device, or reboot the system. */
|
ERR_ADM_WIN_CORE_START_RECORDING = 1309,
|
/** 1311: Audio device module: Insufficient system memory or poor device
|
* performance. Solutions: Reboot the system or replace the device.
|
*/
|
ERR_ADM_WIN_CORE_CREATE_REC_THREAD = 1311,
|
/** 1314: Audio device module: An audio driver abnormality occurs.
|
* Solutions:
|
* - Disable and then re-enable the audio device.
|
* - Reboot the system.
|
* - Upgrade your audio card driver.*/
|
ERR_ADM_WIN_CORE_CAPTURE_NOT_STARTUP = 1314,
|
/** 1319: Audio device module: Insufficient system memory or poor device
|
* performance. Solutions: Reboot the system or replace the device. */
|
ERR_ADM_WIN_CORE_CREATE_RENDER_THREAD = 1319,
|
/** 1320: Audio device module: An audio driver abnormality occurs.
|
* Solutions:
|
* - Disable and then re-enable the audio device.
|
* - Reboot the system.
|
* - Replace the device. */
|
ERR_ADM_WIN_CORE_RENDER_NOT_STARTUP = 1320,
|
/** 1322: Audio device module: No audio sampling device is available.
|
* Solutions: Plug in a proper recording device. */
|
ERR_ADM_WIN_CORE_NO_RECORDING_DEVICE = 1322,
|
/** 1323: Audio device module: No audio playout device is available.
|
* Solutions: Plug in a proper playback device.*/
|
ERR_ADM_WIN_CORE_NO_PLAYOUT_DEVICE = 1323,
|
/** 1351: Audio device module: An audio driver abnormality or a
|
* compatibility issue occurs. Solutions:
|
* - Disable and then re-enable the audio device.
|
* - Reboot the system.
|
* - Upgrade your audio card driver. */
|
ERR_ADM_WIN_WAVE_INIT = 1351,
|
/** 1353: Audio device module: An audio driver abnormality occurs.
|
* Solutions:
|
* - Disable and then re-enable the audio device.
|
* - Reboot the system.
|
* - Upgrade your audio card driver. */
|
ERR_ADM_WIN_WAVE_INIT_RECORDING = 1353,
|
/** 1354: Audio device module: An audio driver abnormality occurs.
|
* Solutions:
|
* - Disable and then re-enable the audio device.
|
* - Reboot the system.
|
* - Upgrade your audio card driver. */
|
ERR_ADM_WIN_WAVE_INIT_MICROPHONE = 1354,
|
/** 1355: Audio device module: An audio driver abnormality occurs.
|
* Solutions:
|
* - Disable and then re-enable the audio device.
|
* - Reboot the system.
|
* - Upgrade your audio card driver. */
|
ERR_ADM_WIN_WAVE_INIT_PLAYOUT = 1355,
|
/** 1356: Audio device module: An audio driver abnormality occurs.
|
* Solutions:
|
* - Disable and then re-enable the audio device.
|
* - Reboot the system.
|
* - Upgrade your audio card driver. */
|
ERR_ADM_WIN_WAVE_INIT_SPEAKER = 1356,
|
/** 1357: Audio device module: An audio driver abnormality occurs.
|
* Solutions:
|
* - Disable and then re-enable the audio device.
|
* - Reboot the system.
|
* - Upgrade your audio card driver. */
|
ERR_ADM_WIN_WAVE_START_RECORDING = 1357,
|
/** 1358: Audio device module: An audio driver abnormality occurs.
|
* Solutions:
|
* - Disable and then re-enable the audio device.
|
* - Reboot the system.
|
* - Upgrade your audio card driver.*/
|
ERR_ADM_WIN_WAVE_START_PLAYOUT = 1358,
|
/** 1359: Audio Device Module: No recording device exists.
|
*/
|
ERR_ADM_NO_RECORDING_DEVICE = 1359,
|
/** 1360: Audio Device Module: No playback device exists.
|
*/
|
ERR_ADM_NO_PLAYOUT_DEVICE = 1360,
|
|
// VDM error code starts from 1500
|
/** 1501: Video Device Module: The camera is unauthorized.
|
*/
|
ERR_VDM_CAMERA_NOT_AUTHORIZED = 1501,
|
|
// VDM error code starts from 1500
|
/** **DEPRECATED** 1502: Video Device Module: The camera in use.
|
|
Deprecated as of v2.4.1. Use LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY(3) in the \ref ar::rtc::IRtcEngineEventHandler::onConnectionStateChanged "onConnectionStateChanged" callback instead.
|
*/
|
ERR_VDM_WIN_DEVICE_IN_USE = 1502,
|
|
// VCM error code starts from 1600
|
/** 1600: Video Device Module: An unknown error occurs.
|
*/
|
ERR_VCM_UNKNOWN_ERROR = 1600,
|
/** 1601: Video Device Module: An error occurs in initializing the video encoder.
|
*/
|
ERR_VCM_ENCODER_INIT_ERROR = 1601,
|
/** 1602: Video Device Module: An error occurs in encoding.
|
*/
|
ERR_VCM_ENCODER_ENCODE_ERROR = 1602,
|
/** 1603: Video Device Module: An error occurs in setting the video encoder.
|
*/
|
ERR_VCM_ENCODER_SET_ERROR = 1603,
|
};
|
|
/** Output log filter level. */
|
enum LOG_FILTER_TYPE
|
{
|
/** 0: Do not output any log information. */
|
LOG_FILTER_OFF = 0,
|
/** 0x080f: Output all log information.
|
Set your log filter as debug if you want to get the most complete log file. */
|
LOG_FILTER_DEBUG = 0x080f,
|
/** 0x000f: Output CRITICAL, ERROR, WARNING, and INFO level log information.
|
We recommend setting your log filter as this level.
|
*/
|
LOG_FILTER_INFO = 0x000f,
|
/** 0x000e: Outputs CRITICAL, ERROR, and WARNING level log information.
|
*/
|
LOG_FILTER_WARN = 0x000e,
|
/** 0x000c: Outputs CRITICAL and ERROR level log information. */
|
LOG_FILTER_ERROR = 0x000c,
|
/** 0x0008: Outputs CRITICAL level log information. */
|
LOG_FILTER_CRITICAL = 0x0008,
|
LOG_FILTER_MASK = 0x80f,
|
};
|
/** The output log level of the SDK.
|
*
|
* @since v3.3.0
|
*/
|
enum class LOG_LEVEL {
|
/** 0: Do not output any log. */
|
LOG_LEVEL_NONE = 0x0000,
|
/** 0x0001: (Default) Output logs of the FATAL, ERROR, WARN and INFO level. We recommend setting your log filter as this level.
|
*/
|
LOG_LEVEL_INFO = 0x0001,
|
/** 0x0002: Output logs of the FATAL, ERROR and WARN level.
|
*/
|
LOG_LEVEL_WARN = 0x0002,
|
/** 0x0004: Output logs of the FATAL and ERROR level. */
|
LOG_LEVEL_ERROR = 0x0004,
|
/** 0x0008: Output logs of the FATAL level. */
|
LOG_LEVEL_FATAL = 0x0008,
|
};
|
} // namespace ar
|
|
#endif
|
