Agora Java API Reference for Android
Classes | Static Public Attributes | List of all members
io.agora.rtc2.Constants Class Reference

Classes

enum  AreaCode
 
enum  AUDIO_EQUALIZATION_BAND_FREQUENCY
 
enum  AUDIO_REVERB_TYPE
 
enum  AudioProfile
 
enum  AudioScenario
 
enum  LogLevel
 
enum  MediaType
 
enum  VideoSourceType
 

Static Public Attributes

static final int LASTMILE_PROBE_RESULT_COMPLETE = 1
 
static final int LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE = 2
 
static final int LASTMILE_PROBE_RESULT_UNAVAILABLE = 3
 
static final int QUALITY_UNKNOWN = 0
 
static final int QUALITY_EXCELLENT = 1
 
static final int QUALITY_GOOD = 2
 
static final int QUALITY_POOR = 3
 
static final int QUALITY_BAD = 4
 
static final int QUALITY_VBAD = 5
 
static final int QUALITY_DOWN = 6
 
static final int WARN_INVALID_VIEW = 8
 
static final int WARN_INIT_VIDEO = 16
 
static final int WARN_PENDING = 20
 
static final int WARN_NO_AVAILABLE_CHANNEL = 103
 
static final int WARN_LOOKUP_CHANNEL_TIMEOUT = 104
 
static final int WARN_LOOKUP_CHANNEL_REJECTED = 105
 
static final int WARN_OPEN_CHANNEL_TIMEOUT = 106
 
static final int WARN_OPEN_CHANNEL_REJECTED = 107
 
static final int WARN_SWITCH_LIVE_VIDEO_TIMEOUT = 111
 
static final int WARN_SET_CLIENT_ROLE_TIMEOUT = 118
 
static final int WARN_SET_CLIENT_ROLE_NOT_AUTHORIZED = 119
 
static final int WARN_OPEN_CHANNEL_INVALID_TICKET = 121
 
static final int WARN_OPEN_CHANNEL_TRY_NEXT_VOS = 122
 
static final int WARN_AUDIO_MIXING_OPEN_ERROR = 701
 
static final int WARN_ADM_RUNTIME_PLAYOUT_WARNING = 1014
 
static final int WARN_ADM_RUNTIME_RECORDING_WARNING = 1016
 
static final int WARN_ADM_RECORD_AUDIO_SILENCE = 1019
 
static final int WARN_ADM_RECORD_AUDIO_LOWLEVEL = 1031
 
static final int WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL = 1032
 
static final int WARN_ADM_RECORD_IS_OCCUPIED = 1033
 
static final int WARN_APM_HOWLING = 1051
 
static final int WARN_ADM_GLITCH_STATE = 1052
 
static final int WARN_ADM_IMPROPER_SETTINGS = 1053
 
static final int ERR_OK = 0
 
static final int ERR_FAILED = 1
 
static final int ERR_INVALID_ARGUMENT = 2
 
static final int ERR_NOT_READY = 3
 
static final int ERR_NOT_SUPPORTED = 4
 
static final int ERR_REFUSED = 5
 
static final int ERR_BUFFER_TOO_SMALL = 6
 
static final int ERR_NOT_INITIALIZED = 7
 
static final int ERR_INVALID_STATE = 8
 
static final int ERR_NO_PERMISSION = 9
 
static final int ERR_TIMEDOUT = 10
 
static final int ERR_CANCELED = 11
 
static final int ERR_TOO_OFTEN = 12
 
static final int ERR_BIND_SOCKET = 13
 
static final int ERR_NET_DOWN = 14
 
static final int ERR_NET_NOBUFS = 15
 
static final int ERR_JOIN_CHANNEL_REJECTED = 17
 
static final int ERR_LEAVE_CHANNEL_REJECTED = 18
 
static final int ERR_ALREADY_IN_USE = 19
 
static final int ERR_INVALID_APP_ID = 101
 
static final int ERR_INVALID_CHANNEL_NAME = 102
 
static final int ERR_NO_SERVER_RESOURCES = 103
 
static final int ERR_TOKEN_EXPIRED = 109
 
static final int ERR_INVALID_TOKEN = 110
 
static final int ERR_CONNECTION_INTERRUPTED = 111
 
static final int ERR_CONNECTION_LOST = 112
 
static final int ERR_NOT_IN_CHANNEL = 113
 
static final int ERR_SIZE_TOO_LARGE = 114
 
static final int ERR_BITRATE_LIMIT = 115
 
static final int ERR_TOO_MANY_DATA_STREAMS = 116
 
static final int ERR_DECRYPTION_FAILED = 120
 
static final int ERR_CLIENT_IS_BANNED_BY_SERVER = 123
 
static final int ERR_INVALID_UID_NAME = 124
 
static final int ERR_WATERMARK_PARAM = 124
 
static final int ERR_WATERMARK_PATH = 125
 
static final int ERR_WATERMARK_PNG = 126
 
static final int ERR_WATERMARKR_INFO = 127
 
static final int ERR_WATERMARK_ARGB = 128
 
static final int ERR_WATERMARK_READ = 129
 
static final int ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISHED = 130
 
static final int ERR_LOAD_MEDIA_ENGINE = 1001
 
static final int ERR_START_CALL = 1002
 
static final int ERR_START_CAMERA = 1003
 
static final int ERR_START_VIDEO_RENDER = 1004
 
static final int ERR_ADM_GENERAL_ERROR = 1005
 
static final int ERR_ADM_JAVA_RESOURCE = 1006
 
static final int ERR_ADM_SAMPLE_RATE = 1007
 
static final int ERR_ADM_INIT_PLAYOUT = 1008
 
static final int ERR_ADM_START_PLAYOUT = 1009
 
static final int ERR_ADM_STOP_PLAYOUT = 1010
 
static final int ERR_ADM_INIT_RECORDING = 1011
 
static final int ERR_ADM_START_RECORDING = 1012
 
static final int ERR_ADM_STOP_RECORDING = 1013
 
static final int ERR_ADM_RUNTIME_PLAYOUT_ERROR = 1015
 
static final int ERR_ADM_RUNTIME_RECORDING_ERROR = 1017
 
static final int ERR_ADM_RECORD_AUDIO_FAILED = 1018
 
static final int ERR_ADM_INIT_LOOPBACK = 1022
 
static final int ERR_ADM_START_LOOPBACK = 1023
 
static final int ERR_ADM_NO_PERMISSION = 1027
 
static final int ERR_AUDIO_BT_SCO_FAILED = 1030
 
static final int ERR_ADM_NO_RECORDING_DEVICE = 1359
 
static final int ERR_ADM_NO_PLAYOUT_DEVICE = 1360
 
static final int ERR_VDM_CAMERA_NOT_AUTHORIZED = 1501
 
static final int ERR_VCM_UNKNOWN_ERROR = 1600
 
static final int ERR_VCM_ENCODER_INIT_ERROR = 1601
 
static final int ERR_VCM_ENCODER_ENCODE_ERROR = 1602
 
static final int ERR_VCM_ENCODER_SET_ERROR = 1603
 
static final int VIDEO_PROFILE_120P = 0
 
static final int VIDEO_PROFILE_120P_3 = 2
 
static final int VIDEO_PROFILE_180P = 10
 
static final int VIDEO_PROFILE_180P_3 = 12
 
static final int VIDEO_PROFILE_180P_4 = 13
 
static final int VIDEO_PROFILE_240P = 20
 
static final int VIDEO_PROFILE_240P_3 = 22
 
static final int VIDEO_PROFILE_240P_4 = 23
 
static final int VIDEO_PROFILE_360P = 30
 
static final int VIDEO_PROFILE_360P_3 = 32
 
static final int VIDEO_PROFILE_360P_4 = 33
 
static final int VIDEO_PROFILE_360P_6 = 35
 
static final int VIDEO_PROFILE_360P_7 = 36
 
static final int VIDEO_PROFILE_360P_8 = 37
 
static final int VIDEO_PROFILE_360P_9 = 38
 
static final int VIDEO_PROFILE_360P_10 = 39
 
static final int VIDEO_PROFILE_360P_11 = 100
 
static final int VIDEO_PROFILE_480P = 40
 
static final int VIDEO_PROFILE_480P_3 = 42
 
static final int VIDEO_PROFILE_480P_4 = 43
 
static final int VIDEO_PROFILE_480P_6 = 45
 
static final int VIDEO_PROFILE_480P_8 = 47
 
static final int VIDEO_PROFILE_480P_9 = 48
 
static final int VIDEO_PROFILE_480P_10 = 49
 
static final int VIDEO_PROFILE_720P = 50
 
static final int VIDEO_PROFILE_720P_3 = 52
 
static final int VIDEO_PROFILE_720P_5 = 54
 
static final int VIDEO_PROFILE_720P_6 = 55
 
static final int VIDEO_PROFILE_1080P = 60
 
static final int VIDEO_PROFILE_1080P_3 = 62
 
static final int VIDEO_PROFILE_1080P_5 = 64
 
static final int VIDEO_PROFILE_1440P = 66
 
static final int VIDEO_PROFILE_1440P_2 = 67
 
static final int VIDEO_PROFILE_4K = 70
 
static final int VIDEO_PROFILE_4K_3 = 72
 
static final int VIDEO_PROFILE_DEFAULT = VIDEO_PROFILE_360P
 
static final int AUDIO_PROFILE_DEFAULT = 0
 
static final int AUDIO_PROFILE_SPEECH_STANDARD = 1
 
static final int AUDIO_PROFILE_MUSIC_STANDARD = 2
 
static final int AUDIO_PROFILE_MUSIC_STANDARD_STEREO = 3
 
static final int AUDIO_PROFILE_MUSIC_HIGH_QUALITY = 4
 
static final int AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO = 5
 
static final int AUDIO_SCENARIO_DEFAULT = 0
 
static final int AUDIO_SCENARIO_GAME_STREAMING = 3
 
static final int AUDIO_SCENARIO_CHATROOM = 5
 
static final int AUDIO_SCENARIO_HIGH_DEFINITION = 6
 
static final int AUDIO_SCENARIO_CHORUS = 7
 
static final int VOICE_CHANGER_OFF = 0x00000000
 
static final int VOICE_CHANGER_OLDMAN = 0x02020200
 
static final int VOICE_CHANGER_BABYBOY = 0x02020300
 
static final int VOICE_CHANGER_BABYGIRL = 0x02020500
 
static final int VOICE_CHANGER_ZHUBAJIE = 0x02020600
 
static final int VOICE_CHANGER_ETHEREAL = 0x02010700
 
static final int VOICE_CHANGER_HULK = 0x02020700
 
static final int VOICE_BEAUTY_VIGOROUS = 0x01030100
 
static final int VOICE_BEAUTY_DEEP = 0x01030200
 
static final int VOICE_BEAUTY_MELLOW = 0x01030300
 
static final int VOICE_BEAUTY_FALSETTO = 0x01030400
 
static final int VOICE_BEAUTY_FULL = 0x01030500
 
static final int VOICE_BEAUTY_CLEAR = 0x01030600
 
static final int VOICE_BEAUTY_RESOUNDING = 0x01030700
 
static final int VOICE_BEAUTY_RINGING = 0x01030800
 
static final int VOICE_BEAUTY_SPACIAL = 0x02010600
 
static final int GENERAL_BEAUTY_VOICE_MALE_MAGNETIC = 0x01010100
 
static final int GENERAL_BEAUTY_VOICE_FEMALE_FRESH = 0x01010200
 
static final int GENERAL_BEAUTY_VOICE_FEMALE_VITALITY = 0x01010300
 
static final int AUDIO_REVERB_OFF = 0x00000000
 
static final int AUDIO_REVERB_FX_KTV = 0x02010100
 
static final int AUDIO_REVERB_FX_VOCAL_CONCERT = 0x02010200
 
static final int AUDIO_REVERB_FX_UNCLE = 0x02020100
 
static final int AUDIO_REVERB_FX_SISTER = 0x02020400
 
static final int AUDIO_REVERB_FX_STUDIO = 0x02010300
 
static final int AUDIO_REVERB_FX_POPULAR = 0x02030200
 
static final int AUDIO_REVERB_FX_RNB = 0x02030100
 
static final int AUDIO_REVERB_FX_PHONOGRAPH = 0x02010400
 
static final int VOICE_BEAUTIFIER_OFF = 0x00000000
 
static final int AUDIO_EFFECT_OFF = 0x00000000
 
static final int CHAT_BEAUTIFIER_MAGNETIC = 0x01010100
 
static final int CHAT_BEAUTIFIER_FRESH = 0x01010200
 
static final int CHAT_BEAUTIFIER_VITALITY = 0x01010300
 
static final int SINGING_BEAUTIFIER = 0x01020100
 
static final int TIMBRE_TRANSFORMATION_VIGOROUS = 0x01030100
 
static final int TIMBRE_TRANSFORMATION_DEEP = 0x01030200
 
static final int TIMBRE_TRANSFORMATION_MELLOW = 0x01030300
 
static final int TIMBRE_TRANSFORMATION_FALSETTO = 0x01030400
 
static final int TIMBRE_TRANSFORMATION_FULL = 0x01030500
 
static final int TIMBRE_TRANSFORMATION_CLEAR = 0x01030600
 
static final int TIMBRE_TRANSFORMATION_RESOUNDING = 0x01030700
 
static final int TIMBRE_TRANSFORMATION_RINGING = 0x01030800
 
static final int ROOM_ACOUSTICS_KTV = 0x02010100
 
static final int ROOM_ACOUSTICS_VOCAL_CONCERT = 0x02010200
 
static final int ROOM_ACOUSTICS_STUDIO = 0x02010300
 
static final int ROOM_ACOUSTICS_PHONOGRAPH = 0x02010400
 
static final int ROOM_ACOUSTICS_VIRTUAL_STEREO = 0x02010500
 
static final int ROOM_ACOUSTICS_SPACIAL = 0x02010600
 
static final int ROOM_ACOUSTICS_ETHEREAL = 0x02010700
 
static final int ROOM_ACOUSTICS_3D_VOICE = 0x02010800
 
static final int VOICE_CHANGER_EFFECT_UNCLE = 0x02020100
 
static final int VOICE_CHANGER_EFFECT_OLDMAN = 0x02020200
 
static final int VOICE_CHANGER_EFFECT_BOY = 0x02020300
 
static final int VOICE_CHANGER_EFFECT_SISTER = 0x02020400
 
static final int VOICE_CHANGER_EFFECT_GIRL = 0x02020500
 
static final int VOICE_CHANGER_EFFECT_PIGKING = 0x02020600
 
static final int VOICE_CHANGER_EFFECT_HULK = 0x02020700
 
static final int STYLE_TRANSFORMATION_RNB = 0x02030100
 
static final int STYLE_TRANSFORMATION_POPULAR = 0x02030200
 
static final int PITCH_CORRECTION = 0x02040100
 
static final int VOICE_CONVERSION_OFF = 0x00000000
 
static final int VOICE_CHANGER_NEUTRAL = 0x03010100
 
static final int VOICE_CHANGER_SWEET = 0x03010200
 
static final int VOICE_CHANGER_SOLID = 0x03010300
 
static final int VOICE_CHANGER_BASS = 0x03010400
 
static final int CHANNEL_PROFILE_COMMUNICATION = 0
 
static final int CHANNEL_PROFILE_LIVE_BROADCASTING = 1
 
static final int CHANNEL_PROFILE_GAME = 2
 
static final int CHANNEL_PROFILE_CLOUD_GAMING = 3
 
static final int CHANNEL_PROFILE_COMMUNICATION_1v1 = 4
 
static final int CHANNEL_PROFILE_LIVE_BROADCASTING_2 = 5
 
static final int CLIENT_ROLE_BROADCASTER = 1
 
static final int CLIENT_ROLE_AUDIENCE = 2
 
static final int USER_OFFLINE_QUIT = 0
 
static final int USER_OFFLINE_DROPPED = 1
 
static final int USER_OFFLINE_BECOME_AUDIENCE = 2
 
static final int INJECT_STREAM_STATUS_START_SUCCESS = 0
 
static final int INJECT_STREAM_STATUS_START_ALREADY_EXISTS = 1
 
static final int INJECT_STREAM_STATUS_START_UNAUTHORIZED = 2
 
static final int INJECT_STREAM_STATUS_START_TIMEDOUT = 3
 
static final int INJECT_STREAM_STATUS_START_FAILED = 4
 
static final int INJECT_STREAM_STATUS_STOP_SUCCESS = 5
 
static final int INJECT_STREAM_STATUS_STOP_NOT_FOUND = 6
 
static final int INJECT_STREAM_STATUS_STOP_UNAUTHORIZED = 7
 
static final int INJECT_STREAM_STATUS_STOP_TIMEDOUT = 8
 
static final int INJECT_STREAM_STATUS_STOP_FAILED = 9
 
static final int INJECT_STREAM_STATUS_BROKEN = 10
 
static final int QUALITY_REPORT_FORMAT_JSON = 0
 
static final int QUALITY_REPORT_FORMAT_HTML = 1
 
static final int RENDER_MODE_HIDDEN = 1
 
static final int RENDER_MODE_FIT = 2
 
static final int RENDER_MODE_ADAPTIVE = 3
 
static final int VIDEO_MIRROR_MODE_AUTO = 0
 
static final int VIDEO_MIRROR_MODE_ENABLED = 1
 
static final int VIDEO_MIRROR_MODE_DISABLED = 2
 
static final int VIDEO_SOURCE_CAMERA_PRIMARY = 0
 
static final int VIDEO_SOURCE_CAMERA_SECONDARY = 1
 
static final int VIDEO_SOURCE_SCREEN_PRIMARY = 2
 
static final int VIDEO_SOURCE_SCREEN_SECONDARY = 3
 
static final int VIDEO_SOURCE_CUSTOM = 4
 
static final int VIDEO_SOURCE_MEDIA_PLAYER = 5
 
static final int VIDEO_SOURCE_RTC_IMAGE_PNG = 6
 
static final int VIDEO_SOURCE_RTC_IMAGE_JPEG = 7
 
static final int VIDEO_SOURCE_RTC_IMAGE_GIF = 8
 
static final int VIDEO_SOURCE_REMOTE = 9
 
static final int VIDEO_SOURCE_TRANSCODED = 10
 
static final int VIDEO_SOURCE_UNKNOWN = 100
 
static final int LOG_FILTER_OFF = 0
 
static final int LOG_FILTER_DEBUG = 0x80f
 
static final int LOG_FILTER_INFO = 0x0f
 
static final int LOG_FILTER_WARNING = 0x0e
 
static final int LOG_FILTER_ERROR = 0x0c
 
static final int LOG_FILTER_CRITICAL = 0x08
 
static final int AUDIO_ROUTE_DEFAULT = -1
 
static final int AUDIO_ROUTE_HEADSET = 0
 
static final int AUDIO_ROUTE_EARPIECE = 1
 
static final int AUDIO_ROUTE_HEADSETNOMIC = 2
 
static final int AUDIO_ROUTE_SPEAKERPHONE = 3
 
static final int AUDIO_ROUTE_LOUDSPEAKER = 4
 
static final int AUDIO_ROUTE_HEADSETBLUETOOTH = 5
 
static final int VIDEO_STREAM_HIGH = 0
 
static final int VIDEO_STREAM_LOW = 1
 
static final int USER_PRIORITY_HIGH = 50
 
static final int USER_PRIORITY_NORANL = 100
 
static final int HARDWARE_ENCODER = 0
 
static final int SOFTWARE_ENCODER = 1
 
static final int RAW_AUDIO_FRAME_OP_MODE_READ_ONLY = 0
 
static final int RAW_AUDIO_FRAME_OP_MODE_WRITE_ONLY = 1
 
static final int RAW_AUDIO_FRAME_OP_MODE_READ_WRITE = 2
 
static final int MEDIA_ENGINE_RECORDING_ERROR = 0
 
static final int MEDIA_ENGINE_PLAYOUT_ERROR = 1
 
static final int MEDIA_ENGINE_RECORDING_WARNING = 2
 
static final int MEDIA_ENGINE_PLAYOUT_WARNING = 3
 
static final int MEDIA_ENGINE_AUDIO_FILE_MIX_FINISH = 10
 
static final int MEDIA_ENGINE_ROLE_BROADCASTER_SOLO = 20
 
static final int MEDIA_ENGINE_ROLE_BROADCASTER_INTERACTIVE = 21
 
static final int MEDIA_ENGINE_ROLE_AUDIENCE = 22
 
static final int MEDIA_ENGINE_ROLE_COMM_PEER = 23
 
static final int NETWORK_TYPE_UNKNOWN = -1
 
static final int NETWORK_TYPE_DISCONNECTED = 0
 
static final int NETWORK_TYPE_LAN = 1
 
static final int NETWORK_TYPE_WIFI = 2
 
static final int NETWORK_TYPE_MOBILE_2G = 3
 
static final int NETWORK_TYPE_MOBILE_3G = 4
 
static final int NETWORK_TYPE_MOBILE_4G = 5
 
static final int STREAM_LIFE_CYCLE_BIND2CHANNEL = 1
 
static final int STREAM_LIFE_CYCLE_BIND2OWNER = 2
 
static final int AUDIO_FILE_RECORDING_MIC = 1
 
static final int AUDIO_FILE_RECORDING_PLAYBACK = 2
 
static final int AUDIO_FILE_RECORDING_MIXED = 3
 
static final int AUDIO_RECORDING_QUALITY_LOW = 0
 
static final int AUDIO_RECORDING_QUALITY_MEDIUM = 1
 
static final int AUDIO_RECORDING_QUALITY_HIGH = 2
 
static final int AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIC = 1
 
static final int AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK = 2
 
static final int AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED = 3
 
static final int AUDIO_ENCODING_TYPE_AAC_16000_LOW = 0x010101
 
static final int AUDIO_ENCODING_TYPE_AAC_16000_MEDIUM = 0x010102
 
static final int AUDIO_ENCODING_TYPE_AAC_32000_LOW = 0x010201
 
static final int AUDIO_ENCODING_TYPE_AAC_32000_MEDIUM = 0x010202
 
static final int AUDIO_ENCODING_TYPE_AAC_32000_HIGH = 0x010203
 
static final int AUDIO_ENCODING_TYPE_AAC_48000_MEDIUM = 0x010302
 
static final int AUDIO_ENCODING_TYPE_AAC_48000_HIGH = 0x010303
 
static final int AUDIO_ENCODING_TYPE_OPUS_16000_LOW = 0x020101
 
static final int AUDIO_ENCODING_TYPE_OPUS_16000_MEDIUM = 0x020102
 
static final int AUDIO_ENCODING_TYPE_OPUS_48000_MEDIUM = 0x020302
 
static final int AUDIO_ENCODING_TYPE_OPUS_48000_HIGH = 0x020303
 
static final int MEDIA_TYPE_NONE = 0
 
static final int MEDIA_TYPE_AUDIO_ONLY = 1
 
static final int MEDIA_TYPE_VIDEO_ONLY = 2
 
static final int MEDIA_TYPE_AUDIO_AND_VIDEO = 3
 
static final int STREAM_FALLBACK_OPTION_DISABLED = 0
 
static final int STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW = 1
 
static final int LOCAL_VIDEO_STREAM_STATE_STOPPED = 0
 
static final int LOCAL_VIDEO_STREAM_STATE_CAPTURING = 1
 
static final int LOCAL_VIDEO_STREAM_STATE_ENCODING = 2
 
static final int LOCAL_VIDEO_STREAM_STATE_FAILED = 3
 
static final int LOCAL_VIDEO_STREAM_ERROR_OK = 0
 
static final int LOCAL_VIDEO_STREAM_ERROR_FAILURE = 1
 
static final int LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION = 2
 
static final int LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY = 3
 
static final int LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE = 4
 
static final int LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE = 5
 
static final int REMOTE_VIDEO_STATE_STOPPED = 0
 
static final int REMOTE_VIDEO_STATE_STARTING = 1
 
static final int REMOTE_VIDEO_STATE_PLAYING = 2
 
static final int REMOTE_VIDEO_STATE_FROZEN = 3
 
static final int REMOTE_VIDEO_STATE_FAILED = 4
 
static final int REMOTE_VIDEO_STATE_REASON_INTERNAL = 0
 
static final int REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION = 1
 
static final int REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY = 2
 
static final int REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED = 3
 
static final int REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED = 4
 
static final int REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED = 5
 
static final int REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED = 6
 
static final int REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE = 7
 
static final int REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK = 8
 
static final int REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY = 9
 
static final int AUDIO_MIXING_STATE_PLAYING = 710
 
static final int AUDIO_MIXING_STATE_PAUSED = 711
 
static final int AUDIO_MIXING_STATE_STOPPED = 713
 
static final int AUDIO_MIXING_STATE_FAILED = 714
 
static final int AUDIO_MIXING_STATE_COMPLETED = 715
 
static final int AUDIO_MIXING_STATE_ALL_LOOPS_COMPLETED = 716
 
static final int AUDIO_MIXING_ERROR_CAN_NOT_OPEN = 701
 
static final int AUDIO_MIXING_ERROR_TOO_FREQUENT_CALL = 702
 
static final int AUDIO_MIXING_ERROR_INTERRUPTED_EOF = 703
 
static final int AUDIO_MIXING_ERROR_OK = 0
 
static final int VIDEO_CODEC_VP8 = 1
 
static final int VIDEO_CODEC_H264 = 2
 
static final int VIDEO_CODEC_VP9 = 5
 
static final int AUDIO_CODEC_OPUS = 1
 
static final int AUDIO_CODEC_AACLC = 8
 
static final int AUDIO_CODEC_HEAAC = 9
 
static final int AUDIO_CODEC_HEAAC2 = 11
 
static final int PACKETIZE_MODE_H264_NON_INTERLEAVED = 0
 
static final int PACKETIZE_MODE_H264_SINGLE_NAL_UNIT = 1
 
static final int VIDEO_FRAME_TYPE_BLANK_FRAME = 0
 
static final int VIDEO_FRAME_TYPE_KEY_FRAME = 3
 
static final int VIDEO_FRAME_TYPE_DELTA_FRAME = 4
 
static final int VIDEO_FRAME_TYPE_B_FRAME = 5
 
static final int VIDEO_FRAME_TYPE_UNKNOWN = 6
 
static final int VIDEO_ORIENTATION_0 = 0
 
static final int VIDEO_ORIENTATION_90 = 90
 
static final int VIDEO_ORIENTATION_180 = 180
 
static final int VIDEO_ORIENTATION_270 = 270
 
static final int DEFAULT_CONNECTION_ID = 0
 
static final int CONNECTION_STATE_DISCONNECTED = 1
 
static final int CONNECTION_STATE_CONNECTING = 2
 
static final int CONNECTION_STATE_CONNECTED = 3
 
static final int CONNECTION_STATE_RECONNECTING = 4
 
static final int CONNECTION_STATE_FAILED = 5
 
static final int CONNECTION_CHANGED_CONNECTING = 0
 
static final int CONNECTION_CHANGED_JOIN_SUCCESS = 1
 
static final int CONNECTION_CHANGED_INTERRUPTED = 2
 
static final int CONNECTION_CHANGED_BANNED_BY_SERVER = 3
 
static final int CONNECTION_CHANGED_JOIN_FAILED = 4
 
static final int CONNECTION_CHANGED_LEAVE_CHANNEL = 5
 
static final int CONNECTION_CHANGED_INVALID_APP_ID = 6
 
static final int CONNECTION_CHANGED_INVALID_CHANNEL_NAME = 7
 
static final int CONNECTION_CHANGED_INVALID_TOKEN = 8
 
static final int CONNECTION_CHANGED_TOKEN_EXPIRED = 9
 
static final int CONNECTION_CHANGED_REJECTED_BY_SERVER = 10
 
static final int CONNECTION_CHANGED_SETTING_PROXY_SERVER = 11
 
static final int CONNECTION_CHANGED_RENEW_TOKEN = 12
 
static final int CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED = 13
 
static final int CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT = 14
 
static final int CONNECTION_CHANGED_REJOIN_SUCCESS = 15
 
static final int CONNECTION_CHANGED_LOST = 16
 
static final int CONNECTION_CHANGED_ECHO_TEST = 17
 
static final int RELAY_OK = 0
 
static final int RELAY_ERROR_SERVER_ERROR_RESPONSE = 1
 
static final int RELAY_ERROR_SERVER_NO_RESPONSE = 2
 
static final int RELAY_ERROR_NO_RESOURCE_AVAILABLE = 3
 
static final int RELAY_ERROR_FAILED_JOIN_SRC = 4
 
static final int RELAY_ERROR_FAILED_JOIN_DEST = 5
 
static final int RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC = 6
 
static final int RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST = 7
 
static final int RELAY_ERROR_SERVER_CONNECTION_LOST = 8
 
static final int RELAY_ERROR_INTERNAL_ERROR = 9
 
static final int RELAY_ERROR_SRC_TOKEN_EXPIRED = 10
 
static final int RELAY_ERROR_DEST_TOKEN_EXPIRED = 11
 
static final int RELAY_EVENT_NETWORK_DISCONNECTED = 0
 
static final int RELAY_EVENT_NETWORK_CONNECTED = 1
 
static final int RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL = 2
 
static final int RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL = 3
 
static final int RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL = 4
 
static final int RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC = 5
 
static final int RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC = 6
 
static final int RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL = 7
 
static final int RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED = 8
 
static final int RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE = 9
 
static final int RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL = 10
 
static final int RELAY_EVENT_VIDEO_PROFILE_UPDATE = 11
 
static final int RELAY_STATE_IDLE = 0
 
static final int RELAY_STATE_CONNECTING = 1
 
static final int RELAY_STATE_RUNNING = 2
 
static final int RELAY_STATE_FAILURE = 3
 
static final int MAX_CROSS_DEST_CHANNEL_SIZE = 4
 
static final int EAR_MONITORING_FILTER_NONE = (1 << 0)
 
static final int EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS = (1 << 1)
 
static final int EAR_MONITORING_FILTER_NOISE_SUPPRESSION = (1 << 2)
 

Detailed Description

Rating of the media or network quality.

Member Data Documentation

◆ LASTMILE_PROBE_RESULT_COMPLETE

final int io.agora.rtc2.Constants.LASTMILE_PROBE_RESULT_COMPLETE = 1
static

1: The last-mile probe result is complete.

◆ LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE

final int io.agora.rtc2.Constants.LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE = 2
static

2: The last-mile network probe test is incomplete and the bandwidth estimation is not available, probably due to limited test resources.

◆ LASTMILE_PROBE_RESULT_UNAVAILABLE

final int io.agora.rtc2.Constants.LASTMILE_PROBE_RESULT_UNAVAILABLE = 3
static

3: The last-mile network probe test is not carried out, probably due to poor network conditions.

◆ QUALITY_UNKNOWN

final int io.agora.rtc2.Constants.QUALITY_UNKNOWN = 0
static

The quality is unknown.

◆ QUALITY_EXCELLENT

final int io.agora.rtc2.Constants.QUALITY_EXCELLENT = 1
static

The quality is excellent.

◆ QUALITY_GOOD

final int io.agora.rtc2.Constants.QUALITY_GOOD = 2
static

The quality is quite good, but the bitrate may be slightly lower than excellent.

◆ QUALITY_POOR

final int io.agora.rtc2.Constants.QUALITY_POOR = 3
static

Users can feel the communication slightly impaired.

◆ QUALITY_BAD

final int io.agora.rtc2.Constants.QUALITY_BAD = 4
static

Users can communicate not very smoothly.

◆ QUALITY_VBAD

final int io.agora.rtc2.Constants.QUALITY_VBAD = 5
static

The quality is so bad that users can barely communicate.

◆ QUALITY_DOWN

final int io.agora.rtc2.Constants.QUALITY_DOWN = 6
static

Users cannot communicate at all.

◆ WARN_INVALID_VIEW

final int io.agora.rtc2.Constants.WARN_INVALID_VIEW = 8
static

The specified view is invalid. It is required to specify a view when using the video call function.

◆ WARN_INIT_VIDEO

final int io.agora.rtc2.Constants.WARN_INIT_VIDEO = 16
static

Failed to initialize the video function.

◆ WARN_PENDING

final int io.agora.rtc2.Constants.WARN_PENDING = 20
static

The request is pending, usually due to some module not being ready, and the SDK postponed processing the request.

◆ WARN_NO_AVAILABLE_CHANNEL

final int io.agora.rtc2.Constants.WARN_NO_AVAILABLE_CHANNEL = 103
static

No channel resources are available. Maybe because the server cannot allocate any channel resource.

◆ WARN_LOOKUP_CHANNEL_TIMEOUT

final int io.agora.rtc2.Constants.WARN_LOOKUP_CHANNEL_TIMEOUT = 104
static

A timeout when looking up the channel. When joining a channel, the SDK looks up the specified channel. The warning usually occurs when the network condition is too poor to connect to the server.

◆ WARN_LOOKUP_CHANNEL_REJECTED

final int io.agora.rtc2.Constants.WARN_LOOKUP_CHANNEL_REJECTED = 105
static

The server rejected the request to look up the channel. The server cannot process this request or the request is illegal.

◆ WARN_OPEN_CHANNEL_TIMEOUT

final int io.agora.rtc2.Constants.WARN_OPEN_CHANNEL_TIMEOUT = 106
static

A timeout when opening the channel. Once the specific channel is found, the SDK opens the channel. The warning usually occurs when the network condition is too poor to connect to the server.

◆ WARN_OPEN_CHANNEL_REJECTED

final int io.agora.rtc2.Constants.WARN_OPEN_CHANNEL_REJECTED = 107
static

The server rejected the request to open the channel. The server cannot process this request or the request is illegal.

◆ WARN_SWITCH_LIVE_VIDEO_TIMEOUT

final int io.agora.rtc2.Constants.WARN_SWITCH_LIVE_VIDEO_TIMEOUT = 111
static

A timeout when switching the live video.

◆ WARN_SET_CLIENT_ROLE_TIMEOUT

final int io.agora.rtc2.Constants.WARN_SET_CLIENT_ROLE_TIMEOUT = 118
static

A timeout when setting the client role in the broadcast mode.

◆ WARN_SET_CLIENT_ROLE_NOT_AUTHORIZED

final int io.agora.rtc2.Constants.WARN_SET_CLIENT_ROLE_NOT_AUTHORIZED = 119
static

The client role is not authorized.

◆ WARN_OPEN_CHANNEL_INVALID_TICKET

final int io.agora.rtc2.Constants.WARN_OPEN_CHANNEL_INVALID_TICKET = 121
static

The ticket to open the channel is invalid.

◆ WARN_OPEN_CHANNEL_TRY_NEXT_VOS

final int io.agora.rtc2.Constants.WARN_OPEN_CHANNEL_TRY_NEXT_VOS = 122
static

Try connecting to another server.

◆ WARN_AUDIO_MIXING_OPEN_ERROR

final int io.agora.rtc2.Constants.WARN_AUDIO_MIXING_OPEN_ERROR = 701
static

Error in opening the audio mixing.

◆ WARN_ADM_RUNTIME_PLAYOUT_WARNING

final int io.agora.rtc2.Constants.WARN_ADM_RUNTIME_PLAYOUT_WARNING = 1014
static

Audio Device Module: A warning in the runtime playback device.

◆ WARN_ADM_RUNTIME_RECORDING_WARNING

final int io.agora.rtc2.Constants.WARN_ADM_RUNTIME_RECORDING_WARNING = 1016
static

Audio Device Module: A warning in the runtime recording device.

◆ WARN_ADM_RECORD_AUDIO_SILENCE

final int io.agora.rtc2.Constants.WARN_ADM_RECORD_AUDIO_SILENCE = 1019
static

Audio Device Module: No valid audio data is collected.

◆ WARN_ADM_RECORD_AUDIO_LOWLEVEL

final int io.agora.rtc2.Constants.WARN_ADM_RECORD_AUDIO_LOWLEVEL = 1031
static

Audio Device Module: The recorded audio volume is too low.

◆ WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL

final int io.agora.rtc2.Constants.WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL = 1032
static

Audio Device Module: The playback audio volume is too low.

◆ WARN_ADM_RECORD_IS_OCCUPIED

final int io.agora.rtc2.Constants.WARN_ADM_RECORD_IS_OCCUPIED = 1033
static

Audio Device Module: The recording device is occupied.

◆ WARN_APM_HOWLING

final int io.agora.rtc2.Constants.WARN_APM_HOWLING = 1051
static

Audio Device Module: Howling is detected.

◆ WARN_ADM_GLITCH_STATE

final int io.agora.rtc2.Constants.WARN_ADM_GLITCH_STATE = 1052
static

Audio Device Module: The device is in the glitch state.

◆ WARN_ADM_IMPROPER_SETTINGS

final int io.agora.rtc2.Constants.WARN_ADM_IMPROPER_SETTINGS = 1053
static

Audio Device Module: The settings are improper.

◆ ERR_OK

final int io.agora.rtc2.Constants.ERR_OK = 0
static

No error occurs.

◆ ERR_FAILED

final int io.agora.rtc2.Constants.ERR_FAILED = 1
static

A general error occurs (no specified reason).

◆ ERR_INVALID_ARGUMENT

final int io.agora.rtc2.Constants.ERR_INVALID_ARGUMENT = 2
static

An invalid parameter is used. For example, the specific channel name includes illegal characters.

◆ ERR_NOT_READY

final int io.agora.rtc2.Constants.ERR_NOT_READY = 3
static

The SDK module is not ready. We recommend the following methods to solve this error:

  • Check the audio device.
  • Check the completeness of the app.
  • Re-initialize the SDK.

◆ ERR_NOT_SUPPORTED

final int io.agora.rtc2.Constants.ERR_NOT_SUPPORTED = 4
static

The SDK does not support this function.

◆ ERR_REFUSED

final int io.agora.rtc2.Constants.ERR_REFUSED = 5
static

The request is rejected. This is for internal SDK internal use only, and it will not return to the application through any API or callback event.

◆ ERR_BUFFER_TOO_SMALL

final int io.agora.rtc2.Constants.ERR_BUFFER_TOO_SMALL = 6
static

The buffer size is not big enough to store the returned data.

◆ ERR_NOT_INITIALIZED

final int io.agora.rtc2.Constants.ERR_NOT_INITIALIZED = 7
static

The SDK is not initialized before calling this API.

◆ ERR_INVALID_STATE

final int io.agora.rtc2.Constants.ERR_INVALID_STATE = 8
static

The state is invalid.

◆ ERR_NO_PERMISSION

final int io.agora.rtc2.Constants.ERR_NO_PERMISSION = 9
static

No permission. Check if the user has granted access to the audio or video device.

◆ ERR_TIMEDOUT

final int io.agora.rtc2.Constants.ERR_TIMEDOUT = 10
static

An API timeout. Some APIs require the SDK to return the execution result, and this error occurs if the request takes too long for the SDK to process.

◆ ERR_CANCELED

final int io.agora.rtc2.Constants.ERR_CANCELED = 11
static

The request is cancelled. This is for internal SDK internal use only, and it will not return to the application through any API or callback event.

◆ ERR_TOO_OFTEN

final int io.agora.rtc2.Constants.ERR_TOO_OFTEN = 12
static

The call frequency is too high. This is for internal SDK internal use only, and it will not return to the application through any API or callback event.

◆ ERR_BIND_SOCKET

final int io.agora.rtc2.Constants.ERR_BIND_SOCKET = 13
static

The SDK fails to bind to the network socket. This is for internal SDK internal use only, and is not returned to the app through any method or callback.

◆ ERR_NET_DOWN

final int io.agora.rtc2.Constants.ERR_NET_DOWN = 14
static

The network is unavailable. This is for internal SDK internal use only, and it will not return to the application through any API or callback event.

◆ ERR_NET_NOBUFS

final int io.agora.rtc2.Constants.ERR_NET_NOBUFS = 15
static

No network buffers available. This is for internal SDK internal use only, and it will not return to the application through any API or callback event.

◆ ERR_JOIN_CHANNEL_REJECTED

final int io.agora.rtc2.Constants.ERR_JOIN_CHANNEL_REJECTED = 17
static

The request to join the channel is rejected. This error usually occurs when the user is already in the channel, and still calls the API to join the channel, for example, {}.

◆ ERR_LEAVE_CHANNEL_REJECTED

final int io.agora.rtc2.Constants.ERR_LEAVE_CHANNEL_REJECTED = 18
static

The request to leave the channel is rejected. This error usually occurs when the user has already left the channel, and still calls the API to leave the channel, for example, {}.

◆ ERR_ALREADY_IN_USE

final int io.agora.rtc2.Constants.ERR_ALREADY_IN_USE = 19
static

Resources are occupied, and cannot be reused.

◆ ERR_INVALID_APP_ID

final int io.agora.rtc2.Constants.ERR_INVALID_APP_ID = 101
static

The specified App ID is invalid.

◆ ERR_INVALID_CHANNEL_NAME

final int io.agora.rtc2.Constants.ERR_INVALID_CHANNEL_NAME = 102
static

The specified channel name is invalid.

◆ ERR_NO_SERVER_RESOURCES

final int io.agora.rtc2.Constants.ERR_NO_SERVER_RESOURCES = 103
static

Fails to get server resources in the specified region.

◆ ERR_TOKEN_EXPIRED

final int io.agora.rtc2.Constants.ERR_TOKEN_EXPIRED = 109
static

The Token expired due to one of the following reasons:

  1. 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 Agora service within five minutes after the Token is generated. If the user does not access the Agora service after five minutes, this Token will no longer be valid.
  2. Call Expiration Timestamp expired: The timestamp indicates the exact time when a user can no longer use the Agora service (for example, when a user is forced to leave an ongoing call). When the value is set for the Call Expiration Timestamp, it does not mean that the Dynamic Key will be expired, but that the user will be kicked out of the channel.</il>

◆ ERR_INVALID_TOKEN

final int io.agora.rtc2.Constants.ERR_INVALID_TOKEN = 110
static

The Token is invalid due to one of the following reasons: The App Certificate for the project is enabled on the Dashboard, but the user is still using the App ID. Once the App Certificate is enabled, the user must use a Token. The uid field is mandatory, and users must set the same uid when setting the uid parameter when calling joinChannel.

◆ ERR_CONNECTION_INTERRUPTED

final int io.agora.rtc2.Constants.ERR_CONNECTION_INTERRUPTED = 111
static

The CONNECTION_INTERRUPTED callback. This applies to the Agora Web SDK only.

◆ ERR_CONNECTION_LOST

final int io.agora.rtc2.Constants.ERR_CONNECTION_LOST = 112
static

The CONNECTION_LOST callback. This applies to the Agora Web SDK only.

◆ ERR_NOT_IN_CHANNEL

final int io.agora.rtc2.Constants.ERR_NOT_IN_CHANNEL = 113
static

The user is not in the channel.

◆ ERR_SIZE_TOO_LARGE

final int io.agora.rtc2.Constants.ERR_SIZE_TOO_LARGE = 114
static

The data size is too big.

◆ ERR_BITRATE_LIMIT

final int io.agora.rtc2.Constants.ERR_BITRATE_LIMIT = 115
static

The bitrate is limited.

◆ ERR_TOO_MANY_DATA_STREAMS

final int io.agora.rtc2.Constants.ERR_TOO_MANY_DATA_STREAMS = 116
static

Too many data streams.

◆ ERR_DECRYPTION_FAILED

final int io.agora.rtc2.Constants.ERR_DECRYPTION_FAILED = 120
static

Failed to decrypt.

◆ ERR_CLIENT_IS_BANNED_BY_SERVER

final int io.agora.rtc2.Constants.ERR_CLIENT_IS_BANNED_BY_SERVER = 123
static

The client is banned by the server.

◆ ERR_WATERMARK_PARAM

final int io.agora.rtc2.Constants.ERR_WATERMARK_PARAM = 124
static

Incorrect watermark file parameter.

◆ ERR_WATERMARK_PATH

final int io.agora.rtc2.Constants.ERR_WATERMARK_PATH = 125
static

Incorrect watermark file path.

◆ ERR_WATERMARK_PNG

final int io.agora.rtc2.Constants.ERR_WATERMARK_PNG = 126
static

Incorrect watermark file format.

◆ ERR_WATERMARKR_INFO

final int io.agora.rtc2.Constants.ERR_WATERMARKR_INFO = 127
static

Incorrect watermark file information.

◆ ERR_WATERMARK_ARGB

final int io.agora.rtc2.Constants.ERR_WATERMARK_ARGB = 128
static

Incorrect watermark file data format.

◆ ERR_WATERMARK_READ

final int io.agora.rtc2.Constants.ERR_WATERMARK_READ = 129
static

An error occurs in reading the watermark file.

◆ ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISHED

final int io.agora.rtc2.Constants.ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISHED = 130
static

◆ ERR_LOAD_MEDIA_ENGINE

final int io.agora.rtc2.Constants.ERR_LOAD_MEDIA_ENGINE = 1001
static

Failed to load the media engine.

◆ ERR_START_CALL

final int io.agora.rtc2.Constants.ERR_START_CALL = 1002
static

Failed to start the call after enabling the media engine.

◆ ERR_START_CAMERA

final int io.agora.rtc2.Constants.ERR_START_CAMERA = 1003
static

Failed to start the camera.

◆ ERR_START_VIDEO_RENDER

final int io.agora.rtc2.Constants.ERR_START_VIDEO_RENDER = 1004
static

Failed to start the video rendering module.

◆ ERR_ADM_GENERAL_ERROR

final int io.agora.rtc2.Constants.ERR_ADM_GENERAL_ERROR = 1005
static

General error on the Audio Device Module (no classified reason).

◆ ERR_ADM_JAVA_RESOURCE

final int io.agora.rtc2.Constants.ERR_ADM_JAVA_RESOURCE = 1006
static

Audio Device Module: Error in using the Java resources.

◆ ERR_ADM_SAMPLE_RATE

final int io.agora.rtc2.Constants.ERR_ADM_SAMPLE_RATE = 1007
static

Audio Device Module: Error in setting the sampling frequency.

◆ ERR_ADM_INIT_PLAYOUT

final int io.agora.rtc2.Constants.ERR_ADM_INIT_PLAYOUT = 1008
static

Audio Device Module: Error in initializing the playback device.

◆ ERR_ADM_START_PLAYOUT

final int io.agora.rtc2.Constants.ERR_ADM_START_PLAYOUT = 1009
static

Audio Device Module: Error in starting the playback device.

◆ ERR_ADM_STOP_PLAYOUT

final int io.agora.rtc2.Constants.ERR_ADM_STOP_PLAYOUT = 1010
static

Audio Device Module: Error in stopping the playback device.

◆ ERR_ADM_INIT_RECORDING

final int io.agora.rtc2.Constants.ERR_ADM_INIT_RECORDING = 1011
static

Audio Device Module: Error in initializing the recording device.

◆ ERR_ADM_START_RECORDING

final int io.agora.rtc2.Constants.ERR_ADM_START_RECORDING = 1012
static

Audio Device Module: Error in starting the recording device.

◆ ERR_ADM_STOP_RECORDING

final int io.agora.rtc2.Constants.ERR_ADM_STOP_RECORDING = 1013
static

Audio Device Module: Error in stopping the recording device.

◆ ERR_ADM_RUNTIME_PLAYOUT_ERROR

final int io.agora.rtc2.Constants.ERR_ADM_RUNTIME_PLAYOUT_ERROR = 1015
static

Audio Device Module: Runtime playback error.

◆ ERR_ADM_RUNTIME_RECORDING_ERROR

final int io.agora.rtc2.Constants.ERR_ADM_RUNTIME_RECORDING_ERROR = 1017
static

Audio Device Module: Runtime recording error.

◆ ERR_ADM_RECORD_AUDIO_FAILED

final int io.agora.rtc2.Constants.ERR_ADM_RECORD_AUDIO_FAILED = 1018
static

Audio Device Module: Failed to record.

◆ ERR_ADM_INIT_LOOPBACK

final int io.agora.rtc2.Constants.ERR_ADM_INIT_LOOPBACK = 1022
static

Audio Device Module: Error in initializing the loopback device.

◆ ERR_ADM_START_LOOPBACK

final int io.agora.rtc2.Constants.ERR_ADM_START_LOOPBACK = 1023
static

Audio Device Module: Error in starting the loopback device.

◆ ERR_ADM_NO_PERMISSION

final int io.agora.rtc2.Constants.ERR_ADM_NO_PERMISSION = 1027
static

Audio Device Module: No recording permission. Please check if the recording permission is granted.

◆ ERR_ADM_NO_RECORDING_DEVICE

final int io.agora.rtc2.Constants.ERR_ADM_NO_RECORDING_DEVICE = 1359
static

Audio Device Module: No recording device.

◆ ERR_ADM_NO_PLAYOUT_DEVICE

final int io.agora.rtc2.Constants.ERR_ADM_NO_PLAYOUT_DEVICE = 1360
static

Audio Device Module: No playback device.

◆ ERR_VDM_CAMERA_NOT_AUTHORIZED

final int io.agora.rtc2.Constants.ERR_VDM_CAMERA_NOT_AUTHORIZED = 1501
static

Video Device Module: The camera is not authorized.

◆ ERR_VCM_UNKNOWN_ERROR

final int io.agora.rtc2.Constants.ERR_VCM_UNKNOWN_ERROR = 1600
static

Video Device Module: Unknown error.

◆ ERR_VCM_ENCODER_INIT_ERROR

final int io.agora.rtc2.Constants.ERR_VCM_ENCODER_INIT_ERROR = 1601
static

Video Device Module: Error in initializing the video encoder.

◆ ERR_VCM_ENCODER_ENCODE_ERROR

final int io.agora.rtc2.Constants.ERR_VCM_ENCODER_ENCODE_ERROR = 1602
static

Video Device Module: Error in encoding.

◆ ERR_VCM_ENCODER_SET_ERROR

final int io.agora.rtc2.Constants.ERR_VCM_ENCODER_SET_ERROR = 1603
static

Video Device Module: Error in setting the video encoder.

◆ VIDEO_PROFILE_120P

final int io.agora.rtc2.Constants.VIDEO_PROFILE_120P = 0
static

0, 160 x 120 @ 15 fps, 65 kbit/s

◆ VIDEO_PROFILE_120P_3

final int io.agora.rtc2.Constants.VIDEO_PROFILE_120P_3 = 2
static

120 x 120 @ 15 fps, 50 kbit/s

◆ VIDEO_PROFILE_180P

final int io.agora.rtc2.Constants.VIDEO_PROFILE_180P = 10
static

320 x 180 @ 15 fps, 140 kbit/s

◆ VIDEO_PROFILE_180P_3

final int io.agora.rtc2.Constants.VIDEO_PROFILE_180P_3 = 12
static

180 x 180 @ 15 fps, 100 kbit/s

◆ VIDEO_PROFILE_180P_4

final int io.agora.rtc2.Constants.VIDEO_PROFILE_180P_4 = 13
static

240 x 180 @ 15 fps, 120 kbit/s

◆ VIDEO_PROFILE_240P

final int io.agora.rtc2.Constants.VIDEO_PROFILE_240P = 20
static

320 x 240 @ 15 fps, 200 kbit/s

◆ VIDEO_PROFILE_240P_3

final int io.agora.rtc2.Constants.VIDEO_PROFILE_240P_3 = 22
static

240 x 240 @ 15 fps, 140 kbit/s

◆ VIDEO_PROFILE_240P_4

final int io.agora.rtc2.Constants.VIDEO_PROFILE_240P_4 = 23
static

424 x 240 @ 15 fps, 220 kbit/s

◆ VIDEO_PROFILE_360P

final int io.agora.rtc2.Constants.VIDEO_PROFILE_360P = 30
static

640 x 360 @ 15 fps, 400 kbit/s

◆ VIDEO_PROFILE_360P_3

final int io.agora.rtc2.Constants.VIDEO_PROFILE_360P_3 = 32
static

360 x 360 @ 15 fps, 260 kbit/s

◆ VIDEO_PROFILE_360P_4

final int io.agora.rtc2.Constants.VIDEO_PROFILE_360P_4 = 33
static

640 x 360 @ 30 fps, 600 kbit/s

◆ VIDEO_PROFILE_360P_6

final int io.agora.rtc2.Constants.VIDEO_PROFILE_360P_6 = 35
static

360 x 360 @ 30 fps, 400 kbit/s

◆ VIDEO_PROFILE_360P_7

final int io.agora.rtc2.Constants.VIDEO_PROFILE_360P_7 = 36
static

480 x 360 @ 15 fps, 320 kbit/s

◆ VIDEO_PROFILE_360P_8

final int io.agora.rtc2.Constants.VIDEO_PROFILE_360P_8 = 37
static

480 x 360 @ 30 fps, 490 kbit/s

◆ VIDEO_PROFILE_360P_9

final int io.agora.rtc2.Constants.VIDEO_PROFILE_360P_9 = 38
static

640 x 360 @ 15 fps, 600 kbit/s

◆ VIDEO_PROFILE_360P_10

final int io.agora.rtc2.Constants.VIDEO_PROFILE_360P_10 = 39
static

640 x 360 @ 24 fps, 800 kbit/s

◆ VIDEO_PROFILE_360P_11

final int io.agora.rtc2.Constants.VIDEO_PROFILE_360P_11 = 100
static

640 x 360 @ 24 fps, 1000 kbit/s

◆ VIDEO_PROFILE_480P

final int io.agora.rtc2.Constants.VIDEO_PROFILE_480P = 40
static

640 x 480 @ 15 fps, 500 kbit/s

◆ VIDEO_PROFILE_480P_3

final int io.agora.rtc2.Constants.VIDEO_PROFILE_480P_3 = 42
static

480 x 480 @ 15 fps, 400 kbit/s

◆ VIDEO_PROFILE_480P_4

final int io.agora.rtc2.Constants.VIDEO_PROFILE_480P_4 = 43
static

640 x 480 @ 30 fps, 750 kbit/s

◆ VIDEO_PROFILE_480P_6

final int io.agora.rtc2.Constants.VIDEO_PROFILE_480P_6 = 45
static

480 x 480 @ 30 fps, 600 kbit/s

◆ VIDEO_PROFILE_480P_8

final int io.agora.rtc2.Constants.VIDEO_PROFILE_480P_8 = 47
static

848 x 480 @ 15 fps, 610 kbit/s

◆ VIDEO_PROFILE_480P_9

final int io.agora.rtc2.Constants.VIDEO_PROFILE_480P_9 = 48
static

848 x 480 @ 30 fps, 930 kbit/s

◆ VIDEO_PROFILE_480P_10

final int io.agora.rtc2.Constants.VIDEO_PROFILE_480P_10 = 49
static

640 x 480 @ 10 fps, 400 kbit/s

◆ VIDEO_PROFILE_720P

final int io.agora.rtc2.Constants.VIDEO_PROFILE_720P = 50
static

1280 x 720 @ 15 fps, 1130 kbit/s

◆ VIDEO_PROFILE_720P_3

final int io.agora.rtc2.Constants.VIDEO_PROFILE_720P_3 = 52
static

1280 x 720 @ 30 fps, 1710 kbit/s

◆ VIDEO_PROFILE_720P_5

final int io.agora.rtc2.Constants.VIDEO_PROFILE_720P_5 = 54
static

960 x 720 @ 15 fps, 910 kbit/s

◆ VIDEO_PROFILE_720P_6

final int io.agora.rtc2.Constants.VIDEO_PROFILE_720P_6 = 55
static

960 x 720 @ 30 fps, 1380 kbit/s

◆ VIDEO_PROFILE_1080P

final int io.agora.rtc2.Constants.VIDEO_PROFILE_1080P = 60
static

1920 x 1080 @ 15 fps, 2080 kbit/s

◆ VIDEO_PROFILE_1080P_3

final int io.agora.rtc2.Constants.VIDEO_PROFILE_1080P_3 = 62
static

1920 x 1080 @ 30 fps, 3150 kbit/s

◆ VIDEO_PROFILE_1080P_5

final int io.agora.rtc2.Constants.VIDEO_PROFILE_1080P_5 = 64
static

1920 x 1080 @ 60 fps, 4780 kbit/s

◆ VIDEO_PROFILE_1440P

final int io.agora.rtc2.Constants.VIDEO_PROFILE_1440P = 66
static

2560 x 1440 @ 30 fps, 4850 kbit/s

◆ VIDEO_PROFILE_1440P_2

final int io.agora.rtc2.Constants.VIDEO_PROFILE_1440P_2 = 67
static

2560 x 1440 @ 60 fps, 7350 kbit/s

◆ VIDEO_PROFILE_4K

final int io.agora.rtc2.Constants.VIDEO_PROFILE_4K = 70
static

3840 x 2160 @ 30 fps, 8910 kbit/s

◆ VIDEO_PROFILE_4K_3

final int io.agora.rtc2.Constants.VIDEO_PROFILE_4K_3 = 72
static

3840 x 2160 @ 60 fps, 13500 kbit/s

◆ VIDEO_PROFILE_DEFAULT

final int io.agora.rtc2.Constants.VIDEO_PROFILE_DEFAULT = VIDEO_PROFILE_360P
static

Default video profile: 640 x 360 @ 15 fps, 400 kbit/s

◆ AUDIO_PROFILE_DEFAULT

final int io.agora.rtc2.Constants.AUDIO_PROFILE_DEFAULT = 0
static

0: The default audio profile.

  • In the Communication profile, the default value is the same with AUDIO_PROFILE_SPEECH_STANDARD(1).
  • In the Live-broadcast profile, it represents a sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.

◆ AUDIO_PROFILE_SPEECH_STANDARD

final int io.agora.rtc2.Constants.AUDIO_PROFILE_SPEECH_STANDARD = 1
static

1: A sample rate of 32 kHz, audio encoding, mono, and a bitrate up to 18 Kbps.

◆ AUDIO_PROFILE_MUSIC_STANDARD

final int io.agora.rtc2.Constants.AUDIO_PROFILE_MUSIC_STANDARD = 2
static

2: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.

◆ AUDIO_PROFILE_MUSIC_STANDARD_STEREO

final int io.agora.rtc2.Constants.AUDIO_PROFILE_MUSIC_STANDARD_STEREO = 3
static

3: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 80 Kbps.

◆ AUDIO_PROFILE_MUSIC_HIGH_QUALITY

final int io.agora.rtc2.Constants.AUDIO_PROFILE_MUSIC_HIGH_QUALITY = 4
static

4: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 96 Kbps.

◆ AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO

final int io.agora.rtc2.Constants.AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO = 5
static

5: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 128 Kbps.

◆ AUDIO_SCENARIO_DEFAULT

final int io.agora.rtc2.Constants.AUDIO_SCENARIO_DEFAULT = 0
static

0: (Recommended) The default audio scenario.

◆ AUDIO_SCENARIO_GAME_STREAMING

final int io.agora.rtc2.Constants.AUDIO_SCENARIO_GAME_STREAMING = 3
static

3: (Recommended) The live gaming scenario, which needs to enable the gaming audio effects in the speaker mode in a live broadcast scenario. Choose this scenario to achieve high-fidelity music playback.

◆ AUDIO_SCENARIO_CHATROOM

final int io.agora.rtc2.Constants.AUDIO_SCENARIO_CHATROOM = 5
static

5: The chatroom scenario, which needs to keep recording when setClientRole to audience. Normally, app developer can also use mute api to achieve the same result, and we implement this 'non-orthogonal' behavior only to make API backward compatible.

◆ AUDIO_SCENARIO_HIGH_DEFINITION

final int io.agora.rtc2.Constants.AUDIO_SCENARIO_HIGH_DEFINITION = 6
static

6: (Recommended) The scenario requiring high-quality audio.

◆ AUDIO_SCENARIO_CHORUS

final int io.agora.rtc2.Constants.AUDIO_SCENARIO_CHORUS = 7
static

7: The chorus scenario.

◆ VOICE_CHANGER_OFF

final int io.agora.rtc2.Constants.VOICE_CHANGER_OFF = 0x00000000
static

Turn off the local voice changer, that is, to use the original voice.

◆ VOICE_CHANGER_OLDMAN

final int io.agora.rtc2.Constants.VOICE_CHANGER_OLDMAN = 0x02020200
static

The voice of an old man.

◆ VOICE_CHANGER_BABYBOY

final int io.agora.rtc2.Constants.VOICE_CHANGER_BABYBOY = 0x02020300
static

The voice of a little boy.

◆ VOICE_CHANGER_BABYGIRL

final int io.agora.rtc2.Constants.VOICE_CHANGER_BABYGIRL = 0x02020500
static

The voice of a little girl.

◆ VOICE_CHANGER_ZHUBAJIE

final int io.agora.rtc2.Constants.VOICE_CHANGER_ZHUBAJIE = 0x02020600
static

The voice of Zhu Bajie, a character in Journey to the West who has a voice like that of a growling bear.

◆ VOICE_CHANGER_ETHEREAL

final int io.agora.rtc2.Constants.VOICE_CHANGER_ETHEREAL = 0x02010700
static

The ethereal voice.

◆ VOICE_CHANGER_HULK

final int io.agora.rtc2.Constants.VOICE_CHANGER_HULK = 0x02020700
static

The voice of Hulk.

◆ VOICE_BEAUTY_VIGOROUS

final int io.agora.rtc2.Constants.VOICE_BEAUTY_VIGOROUS = 0x01030100
static

A more vigorous voice.

◆ VOICE_BEAUTY_DEEP

final int io.agora.rtc2.Constants.VOICE_BEAUTY_DEEP = 0x01030200
static

A deeper voice.

◆ VOICE_BEAUTY_MELLOW

final int io.agora.rtc2.Constants.VOICE_BEAUTY_MELLOW = 0x01030300
static

A mellower voice.

◆ VOICE_BEAUTY_FALSETTO

final int io.agora.rtc2.Constants.VOICE_BEAUTY_FALSETTO = 0x01030400
static

Falsetto.

◆ VOICE_BEAUTY_FULL

final int io.agora.rtc2.Constants.VOICE_BEAUTY_FULL = 0x01030500
static

A fuller voice.

◆ VOICE_BEAUTY_CLEAR

final int io.agora.rtc2.Constants.VOICE_BEAUTY_CLEAR = 0x01030600
static

A clearer voice.

◆ VOICE_BEAUTY_RESOUNDING

final int io.agora.rtc2.Constants.VOICE_BEAUTY_RESOUNDING = 0x01030700
static

A more resounding voice.

◆ VOICE_BEAUTY_RINGING

final int io.agora.rtc2.Constants.VOICE_BEAUTY_RINGING = 0x01030800
static

A more ringing voice.

◆ VOICE_BEAUTY_SPACIAL

final int io.agora.rtc2.Constants.VOICE_BEAUTY_SPACIAL = 0x02010600
static

A more spatially resonant voice.

◆ GENERAL_BEAUTY_VOICE_MALE_MAGNETIC

final int io.agora.rtc2.Constants.GENERAL_BEAUTY_VOICE_MALE_MAGNETIC = 0x01010100
static

(For male only) A more magnetic voice. Do not use it when the speaker is a female; otherwise, voice distortion occurs.

◆ GENERAL_BEAUTY_VOICE_FEMALE_FRESH

final int io.agora.rtc2.Constants.GENERAL_BEAUTY_VOICE_FEMALE_FRESH = 0x01010200
static

(For female only) A fresher voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs.

◆ GENERAL_BEAUTY_VOICE_FEMALE_VITALITY

final int io.agora.rtc2.Constants.GENERAL_BEAUTY_VOICE_FEMALE_VITALITY = 0x01010300
static

(For female only) A more vital voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs.

◆ AUDIO_REVERB_OFF

final int io.agora.rtc2.Constants.AUDIO_REVERB_OFF = 0x00000000
static

Turn off local voice reverberation, that is, to use the original voice.

◆ AUDIO_REVERB_FX_KTV

final int io.agora.rtc2.Constants.AUDIO_REVERB_FX_KTV = 0x02010100
static

The reverberation style typical of a KTV venue (enhanced).

◆ AUDIO_REVERB_FX_VOCAL_CONCERT

final int io.agora.rtc2.Constants.AUDIO_REVERB_FX_VOCAL_CONCERT = 0x02010200
static

The reverberation style typical of a concert hall (enhanced).

◆ AUDIO_REVERB_FX_UNCLE

final int io.agora.rtc2.Constants.AUDIO_REVERB_FX_UNCLE = 0x02020100
static

The reverberation style typical of an uncle's voice.

◆ AUDIO_REVERB_FX_SISTER

final int io.agora.rtc2.Constants.AUDIO_REVERB_FX_SISTER = 0x02020400
static

The reverberation style typical of a little sister's voice.

◆ AUDIO_REVERB_FX_STUDIO

final int io.agora.rtc2.Constants.AUDIO_REVERB_FX_STUDIO = 0x02010300
static

The reverberation style typical of a recording studio (enhanced).

◆ AUDIO_REVERB_FX_POPULAR

final int io.agora.rtc2.Constants.AUDIO_REVERB_FX_POPULAR = 0x02030200
static

The reverberation style typical of popular music (enhanced).

◆ AUDIO_REVERB_FX_RNB

final int io.agora.rtc2.Constants.AUDIO_REVERB_FX_RNB = 0x02030100
static

The reverberation style typical of R&B music (enhanced).

◆ AUDIO_REVERB_FX_PHONOGRAPH

final int io.agora.rtc2.Constants.AUDIO_REVERB_FX_PHONOGRAPH = 0x02010400
static

The reverberation style typical of the vintage phonograph.

◆ VOICE_BEAUTIFIER_OFF

final int io.agora.rtc2.Constants.VOICE_BEAUTIFIER_OFF = 0x00000000
static

Turn off voice beautifier effects and use the original voice.

◆ AUDIO_EFFECT_OFF

final int io.agora.rtc2.Constants.AUDIO_EFFECT_OFF = 0x00000000
static

Turn off audio effects and use the original voice.

◆ CHAT_BEAUTIFIER_MAGNETIC

final int io.agora.rtc2.Constants.CHAT_BEAUTIFIER_MAGNETIC = 0x01010100
static

A more magnetic voice.

Note
Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may experience vocal distortion.

◆ CHAT_BEAUTIFIER_FRESH

final int io.agora.rtc2.Constants.CHAT_BEAUTIFIER_FRESH = 0x01010200
static

A fresher voice.

Note
Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.

◆ CHAT_BEAUTIFIER_VITALITY

final int io.agora.rtc2.Constants.CHAT_BEAUTIFIER_VITALITY = 0x01010300
static

A more vital voice.

Note
Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.

◆ SINGING_BEAUTIFIER

final int io.agora.rtc2.Constants.SINGING_BEAUTIFIER = 0x01020100
static

Singing beautifier effect.

Since
v3.3.0

◆ TIMBRE_TRANSFORMATION_VIGOROUS

final int io.agora.rtc2.Constants.TIMBRE_TRANSFORMATION_VIGOROUS = 0x01030100
static

A more vigorous voice.

◆ TIMBRE_TRANSFORMATION_DEEP

final int io.agora.rtc2.Constants.TIMBRE_TRANSFORMATION_DEEP = 0x01030200
static

A deeper voice.

◆ TIMBRE_TRANSFORMATION_MELLOW

final int io.agora.rtc2.Constants.TIMBRE_TRANSFORMATION_MELLOW = 0x01030300
static

A mellower voice.

◆ TIMBRE_TRANSFORMATION_FALSETTO

final int io.agora.rtc2.Constants.TIMBRE_TRANSFORMATION_FALSETTO = 0x01030400
static

A falsetto voice.

◆ TIMBRE_TRANSFORMATION_FULL

final int io.agora.rtc2.Constants.TIMBRE_TRANSFORMATION_FULL = 0x01030500
static

A fuller voice.

◆ TIMBRE_TRANSFORMATION_CLEAR

final int io.agora.rtc2.Constants.TIMBRE_TRANSFORMATION_CLEAR = 0x01030600
static

A clearer voice.

◆ TIMBRE_TRANSFORMATION_RESOUNDING

final int io.agora.rtc2.Constants.TIMBRE_TRANSFORMATION_RESOUNDING = 0x01030700
static

A more resounding voice.

◆ TIMBRE_TRANSFORMATION_RINGING

final int io.agora.rtc2.Constants.TIMBRE_TRANSFORMATION_RINGING = 0x01030800
static

A more ringing voice.

◆ ROOM_ACOUSTICS_KTV

final int io.agora.rtc2.Constants.ROOM_ACOUSTICS_KTV = 0x02010100
static

◆ ROOM_ACOUSTICS_VOCAL_CONCERT

final int io.agora.rtc2.Constants.ROOM_ACOUSTICS_VOCAL_CONCERT = 0x02010200
static

An audio effect typical of a concert hall.

Note
To achieve better audio effect quality, Agora recommends calling {setAudioProfile} and setting the profile parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4) or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5) before setting this enumerator.

◆ ROOM_ACOUSTICS_STUDIO

final int io.agora.rtc2.Constants.ROOM_ACOUSTICS_STUDIO = 0x02010300
static

An audio effect typical of a recording studio.

Note
To achieve better audio effect quality, Agora recommends calling {setAudioProfile} and setting the profile parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4) or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5) before setting this enumerator.

◆ ROOM_ACOUSTICS_PHONOGRAPH

final int io.agora.rtc2.Constants.ROOM_ACOUSTICS_PHONOGRAPH = 0x02010400
static

An audio effect typical of a vintage phonograph.

Note
To achieve better audio effect quality, Agora recommends calling {setAudioProfile} and setting the profile parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4) or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5) before setting this enumerator.

◆ ROOM_ACOUSTICS_VIRTUAL_STEREO

final int io.agora.rtc2.Constants.ROOM_ACOUSTICS_VIRTUAL_STEREO = 0x02010500
static

A virtual stereo effect that renders monophonic audio as stereo audio.

Note
Call setAudioProfile and set the profile parameter to AUDIO_PROFILE_MUSIC_STANDARD_STEREO(3) or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.

◆ ROOM_ACOUSTICS_SPACIAL

final int io.agora.rtc2.Constants.ROOM_ACOUSTICS_SPACIAL = 0x02010600
static

◆ ROOM_ACOUSTICS_ETHEREAL

final int io.agora.rtc2.Constants.ROOM_ACOUSTICS_ETHEREAL = 0x02010700
static

◆ ROOM_ACOUSTICS_3D_VOICE

final int io.agora.rtc2.Constants.ROOM_ACOUSTICS_3D_VOICE = 0x02010800
static

◆ VOICE_CHANGER_EFFECT_UNCLE

final int io.agora.rtc2.Constants.VOICE_CHANGER_EFFECT_UNCLE = 0x02020100
static

The voice of a middle-aged man.

Note

◆ VOICE_CHANGER_EFFECT_OLDMAN

final int io.agora.rtc2.Constants.VOICE_CHANGER_EFFECT_OLDMAN = 0x02020200
static

The voice of an old man.

Note

◆ VOICE_CHANGER_EFFECT_BOY

final int io.agora.rtc2.Constants.VOICE_CHANGER_EFFECT_BOY = 0x02020300
static

The voice of a boy.

Note

◆ VOICE_CHANGER_EFFECT_SISTER

final int io.agora.rtc2.Constants.VOICE_CHANGER_EFFECT_SISTER = 0x02020400
static

The voice of a young woman.

Note

◆ VOICE_CHANGER_EFFECT_GIRL

final int io.agora.rtc2.Constants.VOICE_CHANGER_EFFECT_GIRL = 0x02020500
static

The voice of a girl.

Note

◆ VOICE_CHANGER_EFFECT_PIGKING

final int io.agora.rtc2.Constants.VOICE_CHANGER_EFFECT_PIGKING = 0x02020600
static

The voice of Pig King, a character in Journey to the West who has a voice like a growling bear.

Note
To achieve better audio effect quality, Agora recommends calling {setAudioProfile} and setting the profile parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4) or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5) before setting this enumerator.

◆ VOICE_CHANGER_EFFECT_HULK

final int io.agora.rtc2.Constants.VOICE_CHANGER_EFFECT_HULK = 0x02020700
static

◆ STYLE_TRANSFORMATION_RNB

final int io.agora.rtc2.Constants.STYLE_TRANSFORMATION_RNB = 0x02030100
static

An audio effect typical of R&B music.

Note
Call setAudioProfile and set the profile parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4) or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.

◆ STYLE_TRANSFORMATION_POPULAR

final int io.agora.rtc2.Constants.STYLE_TRANSFORMATION_POPULAR = 0x02030200
static

An audio effect typical of popular music.

Note
Call setAudioProfile and set the profile parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4) or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.

◆ PITCH_CORRECTION

final int io.agora.rtc2.Constants.PITCH_CORRECTION = 0x02040100
static

◆ VOICE_CONVERSION_OFF

final int io.agora.rtc2.Constants.VOICE_CONVERSION_OFF = 0x00000000
static

Turn off voice conversion effects and use the original voice.

Since
v3.3.1.

◆ VOICE_CHANGER_NEUTRAL

final int io.agora.rtc2.Constants.VOICE_CHANGER_NEUTRAL = 0x03010100
static

A gender-neutral voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.

Since
v3.3.1.

◆ VOICE_CHANGER_SWEET

final int io.agora.rtc2.Constants.VOICE_CHANGER_SWEET = 0x03010200
static

A sweet voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.

Since
v3.3.1.

◆ VOICE_CHANGER_SOLID

final int io.agora.rtc2.Constants.VOICE_CHANGER_SOLID = 0x03010300
static

A steady voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.

Since
v3.3.1.

◆ VOICE_CHANGER_BASS

final int io.agora.rtc2.Constants.VOICE_CHANGER_BASS = 0x03010400
static

A deep voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.

Since
v3.3.1.

◆ CHANNEL_PROFILE_COMMUNICATION

final int io.agora.rtc2.Constants.CHANNEL_PROFILE_COMMUNICATION = 0
static

0: Communication. Use this profile when there are two users in the channel.

◆ CHANNEL_PROFILE_LIVE_BROADCASTING

final int io.agora.rtc2.Constants.CHANNEL_PROFILE_LIVE_BROADCASTING = 1
static

1: (Default) Live Broadcast. Use this profile when there are more than two users in the channel.

◆ CHANNEL_PROFILE_GAME

final int io.agora.rtc2.Constants.CHANNEL_PROFILE_GAME = 2
static

2: Gaming. This profile is deprecated.

◆ CHANNEL_PROFILE_CLOUD_GAMING

final int io.agora.rtc2.Constants.CHANNEL_PROFILE_CLOUD_GAMING = 3
static

3: Cloud Gaming.

This profile is for the interactive streaming scenario, which is highly sensitive to end-to-end latency, and any delay in render impacts the end-user experience. These use cases prioritize reducing delay over any smoothing done at the receiver.

We recommend using this profile in scenarios there users need to interact with each other.

◆ CHANNEL_PROFILE_COMMUNICATION_1v1

final int io.agora.rtc2.Constants.CHANNEL_PROFILE_COMMUNICATION_1v1 = 4
static

4: Communication 1v1.

This profile uses a special network transport strategy for communication 1v1

◆ CHANNEL_PROFILE_LIVE_BROADCASTING_2

final int io.agora.rtc2.Constants.CHANNEL_PROFILE_LIVE_BROADCASTING_2 = 5
static

5: Live Broadcast 2.

This profile technical preview.

◆ CLIENT_ROLE_BROADCASTER

final int io.agora.rtc2.Constants.CLIENT_ROLE_BROADCASTER = 1
static

The broadcaster.

◆ CLIENT_ROLE_AUDIENCE

final int io.agora.rtc2.Constants.CLIENT_ROLE_AUDIENCE = 2
static

The audience.

◆ USER_OFFLINE_QUIT

final int io.agora.rtc2.Constants.USER_OFFLINE_QUIT = 0
static

0: The user has quit the call.

◆ USER_OFFLINE_DROPPED

final int io.agora.rtc2.Constants.USER_OFFLINE_DROPPED = 1
static
  1. The SDK timed out and the user dropped offline because it has not received any data package for a period of time.

◆ USER_OFFLINE_BECOME_AUDIENCE

final int io.agora.rtc2.Constants.USER_OFFLINE_BECOME_AUDIENCE = 2
static
  1. Triggered when the client role has changed from the broadcaster to the audience.

◆ INJECT_STREAM_STATUS_START_SUCCESS

final int io.agora.rtc2.Constants.INJECT_STREAM_STATUS_START_SUCCESS = 0
static

The external video stream imported successfully.

◆ INJECT_STREAM_STATUS_START_ALREADY_EXISTS

final int io.agora.rtc2.Constants.INJECT_STREAM_STATUS_START_ALREADY_EXISTS = 1
static

The external video stream already exists.

◆ INJECT_STREAM_STATUS_START_UNAUTHORIZED

final int io.agora.rtc2.Constants.INJECT_STREAM_STATUS_START_UNAUTHORIZED = 2
static

The external video stream import is unauthorized

◆ INJECT_STREAM_STATUS_START_TIMEDOUT

final int io.agora.rtc2.Constants.INJECT_STREAM_STATUS_START_TIMEDOUT = 3
static

Import external video stream timeout.

◆ INJECT_STREAM_STATUS_START_FAILED

final int io.agora.rtc2.Constants.INJECT_STREAM_STATUS_START_FAILED = 4
static

The external video stream failed to import.

◆ INJECT_STREAM_STATUS_STOP_SUCCESS

final int io.agora.rtc2.Constants.INJECT_STREAM_STATUS_STOP_SUCCESS = 5
static

The xternal video stream imports successfully.

◆ INJECT_STREAM_STATUS_STOP_NOT_FOUND

final int io.agora.rtc2.Constants.INJECT_STREAM_STATUS_STOP_NOT_FOUND = 6
static

No external video stream is found.

◆ INJECT_STREAM_STATUS_STOP_UNAUTHORIZED

final int io.agora.rtc2.Constants.INJECT_STREAM_STATUS_STOP_UNAUTHORIZED = 7
static

The external video stream is stopped from being unauthorized.

◆ INJECT_STREAM_STATUS_STOP_TIMEDOUT

final int io.agora.rtc2.Constants.INJECT_STREAM_STATUS_STOP_TIMEDOUT = 8
static

Importing the external video stream timeout.

◆ INJECT_STREAM_STATUS_STOP_FAILED

final int io.agora.rtc2.Constants.INJECT_STREAM_STATUS_STOP_FAILED = 9
static

Importing the external video stream failed.

◆ INJECT_STREAM_STATUS_BROKEN

final int io.agora.rtc2.Constants.INJECT_STREAM_STATUS_BROKEN = 10
static

The external video stream is broken.

◆ QUALITY_REPORT_FORMAT_JSON

final int io.agora.rtc2.Constants.QUALITY_REPORT_FORMAT_JSON = 0
static

The quality report in JSON format.

◆ QUALITY_REPORT_FORMAT_HTML

final int io.agora.rtc2.Constants.QUALITY_REPORT_FORMAT_HTML = 1
static

The quality report in HTML format.

◆ RENDER_MODE_HIDDEN

final int io.agora.rtc2.Constants.RENDER_MODE_HIDDEN = 1
static

1: Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.

◆ RENDER_MODE_FIT

final int io.agora.rtc2.Constants.RENDER_MODE_FIT = 2
static

2: Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio will be filled with black.

◆ RENDER_MODE_ADAPTIVE

final int io.agora.rtc2.Constants.RENDER_MODE_ADAPTIVE = 3
static

3: This mode is deprecated.

◆ VIDEO_MIRROR_MODE_AUTO

final int io.agora.rtc2.Constants.VIDEO_MIRROR_MODE_AUTO = 0
static

The default mirror mode, that is, the mode set by the SDK.

◆ VIDEO_MIRROR_MODE_ENABLED

final int io.agora.rtc2.Constants.VIDEO_MIRROR_MODE_ENABLED = 1
static

Enable the mirror mode.

◆ VIDEO_MIRROR_MODE_DISABLED

final int io.agora.rtc2.Constants.VIDEO_MIRROR_MODE_DISABLED = 2
static

Disable the mirror mode

◆ VIDEO_SOURCE_CAMERA_PRIMARY

final int io.agora.rtc2.Constants.VIDEO_SOURCE_CAMERA_PRIMARY = 0
static

Video captured by the camera.

◆ VIDEO_SOURCE_CAMERA_SECONDARY

final int io.agora.rtc2.Constants.VIDEO_SOURCE_CAMERA_SECONDARY = 1
static

Video captured by the secondary camera.

◆ VIDEO_SOURCE_SCREEN_PRIMARY

final int io.agora.rtc2.Constants.VIDEO_SOURCE_SCREEN_PRIMARY = 2
static

Video for screen sharing.

◆ VIDEO_SOURCE_SCREEN_SECONDARY

final int io.agora.rtc2.Constants.VIDEO_SOURCE_SCREEN_SECONDARY = 3
static

Video for secondary screen sharing.

◆ VIDEO_SOURCE_CUSTOM

final int io.agora.rtc2.Constants.VIDEO_SOURCE_CUSTOM = 4
static

Not define.

◆ VIDEO_SOURCE_MEDIA_PLAYER

final int io.agora.rtc2.Constants.VIDEO_SOURCE_MEDIA_PLAYER = 5
static

Video for media player sharing.

◆ VIDEO_SOURCE_RTC_IMAGE_PNG

final int io.agora.rtc2.Constants.VIDEO_SOURCE_RTC_IMAGE_PNG = 6
static

Video for png image.

◆ VIDEO_SOURCE_RTC_IMAGE_JPEG

final int io.agora.rtc2.Constants.VIDEO_SOURCE_RTC_IMAGE_JPEG = 7
static

Video for png image.

◆ VIDEO_SOURCE_RTC_IMAGE_GIF

final int io.agora.rtc2.Constants.VIDEO_SOURCE_RTC_IMAGE_GIF = 8
static

Video for png image.

◆ VIDEO_SOURCE_REMOTE

final int io.agora.rtc2.Constants.VIDEO_SOURCE_REMOTE = 9
static

Remote video received from network.

◆ VIDEO_SOURCE_TRANSCODED

final int io.agora.rtc2.Constants.VIDEO_SOURCE_TRANSCODED = 10
static

Video for transcoded.

◆ LOG_FILTER_OFF

final int io.agora.rtc2.Constants.LOG_FILTER_OFF = 0
static

Do not output any log.

◆ LOG_FILTER_DEBUG

final int io.agora.rtc2.Constants.LOG_FILTER_DEBUG = 0x80f
static

Output all the API logs.

◆ LOG_FILTER_INFO

final int io.agora.rtc2.Constants.LOG_FILTER_INFO = 0x0f
static

Output logs of the CRITICAL, ERROR, WARNING, and INFO level.

◆ LOG_FILTER_WARNING

final int io.agora.rtc2.Constants.LOG_FILTER_WARNING = 0x0e
static

Output logs of the CRITICAL, ERROR, and WARNING level.

◆ LOG_FILTER_ERROR

final int io.agora.rtc2.Constants.LOG_FILTER_ERROR = 0x0c
static

Output logs of the CRITICAL and ERROR level.

◆ LOG_FILTER_CRITICAL

final int io.agora.rtc2.Constants.LOG_FILTER_CRITICAL = 0x08
static

Output logs of the CRITICAL level.

◆ AUDIO_ROUTE_DEFAULT

final int io.agora.rtc2.Constants.AUDIO_ROUTE_DEFAULT = -1
static

-1: The default audio route.

◆ AUDIO_ROUTE_HEADSET

final int io.agora.rtc2.Constants.AUDIO_ROUTE_HEADSET = 0
static

0: Headset.

◆ AUDIO_ROUTE_EARPIECE

final int io.agora.rtc2.Constants.AUDIO_ROUTE_EARPIECE = 1
static

1: Earpiece. The SDK uses the in-call volume.

◆ AUDIO_ROUTE_HEADSETNOMIC

final int io.agora.rtc2.Constants.AUDIO_ROUTE_HEADSETNOMIC = 2
static

2: Headset with no microphone.

◆ AUDIO_ROUTE_SPEAKERPHONE

final int io.agora.rtc2.Constants.AUDIO_ROUTE_SPEAKERPHONE = 3
static

3: Speakerphone.

◆ AUDIO_ROUTE_LOUDSPEAKER

final int io.agora.rtc2.Constants.AUDIO_ROUTE_LOUDSPEAKER = 4
static

4: Loudspeaker

◆ AUDIO_ROUTE_HEADSETBLUETOOTH

final int io.agora.rtc2.Constants.AUDIO_ROUTE_HEADSETBLUETOOTH = 5
static

5: Bluetooth headset.

◆ VIDEO_STREAM_HIGH

final int io.agora.rtc2.Constants.VIDEO_STREAM_HIGH = 0
static

0: The high-stream video, that is, the video stream featuring in high resolution and high bitrate.

◆ VIDEO_STREAM_LOW

final int io.agora.rtc2.Constants.VIDEO_STREAM_LOW = 1
static

1: The low-stream video, that is, the video stream featuring in low resolution and low bitrate.

◆ USER_PRIORITY_HIGH

final int io.agora.rtc2.Constants.USER_PRIORITY_HIGH = 50
static

High Priority, if you set a user with high priority, then streams of this user will have high priority than streams of other users with normal default priority. i.e., the SDK will take priority into account when deciding which user's stream need to fallback when network congestion occurs.

◆ USER_PRIORITY_NORANL

final int io.agora.rtc2.Constants.USER_PRIORITY_NORANL = 100
static

Default priority.

◆ HARDWARE_ENCODER

final int io.agora.rtc2.Constants.HARDWARE_ENCODER = 0
static

Hardware encoder.

◆ SOFTWARE_ENCODER

final int io.agora.rtc2.Constants.SOFTWARE_ENCODER = 1
static

Software encoder.

◆ RAW_AUDIO_FRAME_OP_MODE_READ_ONLY

final int io.agora.rtc2.Constants.RAW_AUDIO_FRAME_OP_MODE_READ_ONLY = 0
static

Read-only mode, users only read the AudioFrame data without modifying anything. For example, when users acquire data with the Agora SDK, and push RTMP streams by themselves.

◆ RAW_AUDIO_FRAME_OP_MODE_WRITE_ONLY

final int io.agora.rtc2.Constants.RAW_AUDIO_FRAME_OP_MODE_WRITE_ONLY = 1
static

Write-only mode, users replace the AudioFrame data with their own data and pass it to the SDK for encoding. For example, when users acquire data by themselves.

◆ RAW_AUDIO_FRAME_OP_MODE_READ_WRITE

final int io.agora.rtc2.Constants.RAW_AUDIO_FRAME_OP_MODE_READ_WRITE = 2
static

Read and write mode, users read the data from AudioFrame, modify it and then play it. For example, when users have their own sound-effect processing module, and want to do voice pre-processing, such as a voice change.

◆ NETWORK_TYPE_UNKNOWN

final int io.agora.rtc2.Constants.NETWORK_TYPE_UNKNOWN = -1
static

-1: The network type is unknown.

◆ NETWORK_TYPE_DISCONNECTED

final int io.agora.rtc2.Constants.NETWORK_TYPE_DISCONNECTED = 0
static

0: The SDK disconnects from the network.

◆ NETWORK_TYPE_LAN

final int io.agora.rtc2.Constants.NETWORK_TYPE_LAN = 1
static

1: The network type is LAN.

◆ NETWORK_TYPE_WIFI

final int io.agora.rtc2.Constants.NETWORK_TYPE_WIFI = 2
static

2: The network type is Wi-Fi (including hotspots).

◆ NETWORK_TYPE_MOBILE_2G

final int io.agora.rtc2.Constants.NETWORK_TYPE_MOBILE_2G = 3
static

3: The network type is mobile 2G.

◆ NETWORK_TYPE_MOBILE_3G

final int io.agora.rtc2.Constants.NETWORK_TYPE_MOBILE_3G = 4
static

4: The network type is mobile 3G.

◆ NETWORK_TYPE_MOBILE_4G

final int io.agora.rtc2.Constants.NETWORK_TYPE_MOBILE_4G = 5
static

5: The network type is mobile 4G.

◆ STREAM_LIFE_CYCLE_BIND2CHANNEL

final int io.agora.rtc2.Constants.STREAM_LIFE_CYCLE_BIND2CHANNEL = 1
static

Bound to the channel lifecycle.

◆ STREAM_LIFE_CYCLE_BIND2OWNER

final int io.agora.rtc2.Constants.STREAM_LIFE_CYCLE_BIND2OWNER = 2
static

Bound to the owner of the RTMP stream.

◆ AUDIO_FILE_RECORDING_MIC

final int io.agora.rtc2.Constants.AUDIO_FILE_RECORDING_MIC = 1
static

1: mic audio file recording.

◆ AUDIO_FILE_RECORDING_PLAYBACK

final int io.agora.rtc2.Constants.AUDIO_FILE_RECORDING_PLAYBACK = 2
static

2: playback audio file recording.

◆ AUDIO_FILE_RECORDING_MIXED

final int io.agora.rtc2.Constants.AUDIO_FILE_RECORDING_MIXED = 3
static

3: mixed audio file recording, include mic and playback.

◆ AUDIO_RECORDING_QUALITY_LOW

final int io.agora.rtc2.Constants.AUDIO_RECORDING_QUALITY_LOW = 0
static

Low quality, file size is around 1.2 MB after 10 minutes of recording.

◆ AUDIO_RECORDING_QUALITY_MEDIUM

final int io.agora.rtc2.Constants.AUDIO_RECORDING_QUALITY_MEDIUM = 1
static

Medium quality, file size is around 2 MB after 10 minutes of recording.

◆ AUDIO_RECORDING_QUALITY_HIGH

final int io.agora.rtc2.Constants.AUDIO_RECORDING_QUALITY_HIGH = 2
static

High quality, file size is around 3.75 MB after 10 minutes of recording.

◆ AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIC

final int io.agora.rtc2.Constants.AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIC = 1
static

1: mic audio frame observer

◆ AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK

final int io.agora.rtc2.Constants.AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK = 2
static

2: playback audio frame observer

◆ AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED

final int io.agora.rtc2.Constants.AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED = 3
static

3: mixed audio frame observer

◆ AUDIO_ENCODING_TYPE_AAC_16000_LOW

final int io.agora.rtc2.Constants.AUDIO_ENCODING_TYPE_AAC_16000_LOW = 0x010101
static

1: codecType AAC; sampleRate 16000; quality low which around 1.2 MB after 10 minutes

◆ AUDIO_ENCODING_TYPE_AAC_16000_MEDIUM

final int io.agora.rtc2.Constants.AUDIO_ENCODING_TYPE_AAC_16000_MEDIUM = 0x010102
static

2: codecType AAC; sampleRate 16000; quality medium which around 2 MB after 10 minutes

◆ AUDIO_ENCODING_TYPE_AAC_32000_LOW

final int io.agora.rtc2.Constants.AUDIO_ENCODING_TYPE_AAC_32000_LOW = 0x010201
static

3: codecType AAC; sampleRate 32000; quality low which around 1.2 MB after 10 minutes

◆ AUDIO_ENCODING_TYPE_AAC_32000_MEDIUM

final int io.agora.rtc2.Constants.AUDIO_ENCODING_TYPE_AAC_32000_MEDIUM = 0x010202
static

4: codecType AAC; sampleRate 32000; quality medium which around 2 MB after 10 minutes

◆ AUDIO_ENCODING_TYPE_AAC_32000_HIGH

final int io.agora.rtc2.Constants.AUDIO_ENCODING_TYPE_AAC_32000_HIGH = 0x010203
static

5: codecType AAC; sampleRate 32000; quality high which around 3.5 MB after 10 minutes

◆ AUDIO_ENCODING_TYPE_AAC_48000_MEDIUM

final int io.agora.rtc2.Constants.AUDIO_ENCODING_TYPE_AAC_48000_MEDIUM = 0x010302
static

6: codecType AAC; sampleRate 48000; quality medium which around 2 MB after 10 minutes

◆ AUDIO_ENCODING_TYPE_AAC_48000_HIGH

final int io.agora.rtc2.Constants.AUDIO_ENCODING_TYPE_AAC_48000_HIGH = 0x010303
static

7: codecType AAC; sampleRate 48000; quality high which around 3.5 MB after 10 minutes

◆ AUDIO_ENCODING_TYPE_OPUS_16000_LOW

final int io.agora.rtc2.Constants.AUDIO_ENCODING_TYPE_OPUS_16000_LOW = 0x020101
static

11: codecType OPUS; sampleRate 16000; quality low which around 1.2 MB after 10 minutes

◆ AUDIO_ENCODING_TYPE_OPUS_16000_MEDIUM

final int io.agora.rtc2.Constants.AUDIO_ENCODING_TYPE_OPUS_16000_MEDIUM = 0x020102
static

12: codecType OPUS; sampleRate 16000; quality medium which around 2 MB after 10 minutes

◆ AUDIO_ENCODING_TYPE_OPUS_48000_MEDIUM

final int io.agora.rtc2.Constants.AUDIO_ENCODING_TYPE_OPUS_48000_MEDIUM = 0x020302
static

13: codecType OPUS; sampleRate 48000; quality medium which around 2 MB after 10 minutes

◆ AUDIO_ENCODING_TYPE_OPUS_48000_HIGH

final int io.agora.rtc2.Constants.AUDIO_ENCODING_TYPE_OPUS_48000_HIGH = 0x020303
static

14: codecType OPUS; sampleRate 48000; quality high which around 3.5 MB after 10 minutes

◆ MEDIA_TYPE_NONE

final int io.agora.rtc2.Constants.MEDIA_TYPE_NONE = 0
static

None

◆ MEDIA_TYPE_AUDIO_ONLY

final int io.agora.rtc2.Constants.MEDIA_TYPE_AUDIO_ONLY = 1
static

Audio only

◆ MEDIA_TYPE_VIDEO_ONLY

final int io.agora.rtc2.Constants.MEDIA_TYPE_VIDEO_ONLY = 2
static

Video only

◆ MEDIA_TYPE_AUDIO_AND_VIDEO

final int io.agora.rtc2.Constants.MEDIA_TYPE_AUDIO_AND_VIDEO = 3
static

Audio and video

◆ LOCAL_VIDEO_STREAM_STATE_STOPPED

final int io.agora.rtc2.Constants.LOCAL_VIDEO_STREAM_STATE_STOPPED = 0
static

Local video state types Initial state

◆ LOCAL_VIDEO_STREAM_STATE_CAPTURING

final int io.agora.rtc2.Constants.LOCAL_VIDEO_STREAM_STATE_CAPTURING = 1
static

The capturer starts successfully.

◆ LOCAL_VIDEO_STREAM_STATE_ENCODING

final int io.agora.rtc2.Constants.LOCAL_VIDEO_STREAM_STATE_ENCODING = 2
static

The first video frame is successfully encoded.

◆ LOCAL_VIDEO_STREAM_STATE_FAILED

final int io.agora.rtc2.Constants.LOCAL_VIDEO_STREAM_STATE_FAILED = 3
static

The local video fails to start.

◆ LOCAL_VIDEO_STREAM_ERROR_OK

final int io.agora.rtc2.Constants.LOCAL_VIDEO_STREAM_ERROR_OK = 0
static

Reasons for the local video failure. 0: The local video is normal.

◆ LOCAL_VIDEO_STREAM_ERROR_FAILURE

final int io.agora.rtc2.Constants.LOCAL_VIDEO_STREAM_ERROR_FAILURE = 1
static

1: No specified reason for the local video failure.

◆ LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION

final int io.agora.rtc2.Constants.LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION = 2
static

2: No permission to use the local video device.

◆ LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY

final int io.agora.rtc2.Constants.LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY = 3
static

3: The local video capturer is in use.

◆ LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE

final int io.agora.rtc2.Constants.LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE = 4
static

4: The local video capture fails. Check whether the capturer is working properly.

◆ LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE

final int io.agora.rtc2.Constants.LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE = 5
static

5: The local video encoding fails.

◆ REMOTE_VIDEO_STATE_STOPPED

final int io.agora.rtc2.Constants.REMOTE_VIDEO_STATE_STOPPED = 0
static

Remote video state. Default state

◆ REMOTE_VIDEO_STATE_STARTING

final int io.agora.rtc2.Constants.REMOTE_VIDEO_STATE_STARTING = 1
static

1: video packet has been received, but not decoded yet.

◆ REMOTE_VIDEO_STATE_PLAYING

final int io.agora.rtc2.Constants.REMOTE_VIDEO_STATE_PLAYING = 2
static

2: Remote video is playing.

◆ REMOTE_VIDEO_STATE_FROZEN

final int io.agora.rtc2.Constants.REMOTE_VIDEO_STATE_FROZEN = 3
static

3: Remote video is frozen, probably due to network issue.

◆ REMOTE_VIDEO_STATE_FAILED

final int io.agora.rtc2.Constants.REMOTE_VIDEO_STATE_FAILED = 4
static

4: Failed.

◆ REMOTE_VIDEO_STATE_REASON_INTERNAL

final int io.agora.rtc2.Constants.REMOTE_VIDEO_STATE_REASON_INTERNAL = 0
static

Reasons for a remote video state change. 0: Internal reasons.

◆ REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION

final int io.agora.rtc2.Constants.REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION = 1
static

1: Network congestion.

◆ REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY

final int io.agora.rtc2.Constants.REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY = 2
static

2: Network recovery.

◆ REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED

final int io.agora.rtc2.Constants.REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED = 3
static

3: The local user stops receiving the remote video stream or disables the video module.

◆ REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED

final int io.agora.rtc2.Constants.REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED = 4
static

4: The local user resumes receiving the remote video stream or enables the video module.

◆ REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED

final int io.agora.rtc2.Constants.REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED = 5
static

5: The remote user stops sending the video stream or disables the video module.

◆ REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED

final int io.agora.rtc2.Constants.REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED = 6
static

6: The remote user resumes sending the video stream or enables the video module.

◆ REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE

final int io.agora.rtc2.Constants.REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE = 7
static

7: The remote user leaves the channel.

◆ REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK

final int io.agora.rtc2.Constants.REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK = 8
static

8: The remote media stream falls back to the audio-only stream due to poor network conditions.

◆ REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY

final int io.agora.rtc2.Constants.REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY = 9
static

9: The remote media stream switches back to the video stream after the network conditions improve.

◆ AUDIO_MIXING_STATE_PLAYING

final int io.agora.rtc2.Constants.AUDIO_MIXING_STATE_PLAYING = 710
static

The audio mixing state types 710: The audio mixing file is playing.

◆ AUDIO_MIXING_STATE_PAUSED

final int io.agora.rtc2.Constants.AUDIO_MIXING_STATE_PAUSED = 711
static

711: The audio mixing file pauses playing.

◆ AUDIO_MIXING_STATE_STOPPED

final int io.agora.rtc2.Constants.AUDIO_MIXING_STATE_STOPPED = 713
static

713: The audio mixing file stops playing.

◆ AUDIO_MIXING_STATE_FAILED

final int io.agora.rtc2.Constants.AUDIO_MIXING_STATE_FAILED = 714
static

714: An exception occurs when playing the audio mixing file. See the errorCode for details.

◆ AUDIO_MIXING_STATE_COMPLETED

final int io.agora.rtc2.Constants.AUDIO_MIXING_STATE_COMPLETED = 715
static

715: The audio mixing file is played once.

◆ AUDIO_MIXING_STATE_ALL_LOOPS_COMPLETED

final int io.agora.rtc2.Constants.AUDIO_MIXING_STATE_ALL_LOOPS_COMPLETED = 716
static

716: The audio mixing file is all played out.

◆ AUDIO_MIXING_ERROR_CAN_NOT_OPEN

final int io.agora.rtc2.Constants.AUDIO_MIXING_ERROR_CAN_NOT_OPEN = 701
static

The audio mixing error type. 701: An error occurs in opening the audio mixing file.

◆ AUDIO_MIXING_ERROR_TOO_FREQUENT_CALL

final int io.agora.rtc2.Constants.AUDIO_MIXING_ERROR_TOO_FREQUENT_CALL = 702
static

702: The SDK opens the audio mixing file too frequently.

◆ AUDIO_MIXING_ERROR_INTERRUPTED_EOF

final int io.agora.rtc2.Constants.AUDIO_MIXING_ERROR_INTERRUPTED_EOF = 703
static

703: The audio mixing file playback is interrupted.

◆ AUDIO_MIXING_ERROR_OK

final int io.agora.rtc2.Constants.AUDIO_MIXING_ERROR_OK = 0
static

0: No error.

◆ VIDEO_CODEC_VP8

final int io.agora.rtc2.Constants.VIDEO_CODEC_VP8 = 1
static

Video codec types VIDEO_CODEC_TYPE

◆ PACKETIZE_MODE_H264_NON_INTERLEAVED

final int io.agora.rtc2.Constants.PACKETIZE_MODE_H264_NON_INTERLEAVED = 0
static

Packetize Mode H264PacketizeMode

◆ VIDEO_FRAME_TYPE_BLANK_FRAME

final int io.agora.rtc2.Constants.VIDEO_FRAME_TYPE_BLANK_FRAME = 0
static

Video Frame Type. VIDEO_FRAME_TYPE

◆ VIDEO_ORIENTATION_0

final int io.agora.rtc2.Constants.VIDEO_ORIENTATION_0 = 0
static

clockwise rotation. VIDEO_ORIENTATION 0: No rotation.

◆ VIDEO_ORIENTATION_90

final int io.agora.rtc2.Constants.VIDEO_ORIENTATION_90 = 90
static

90: 90 degrees.

◆ VIDEO_ORIENTATION_180

final int io.agora.rtc2.Constants.VIDEO_ORIENTATION_180 = 180
static

180: 180 degrees.

◆ VIDEO_ORIENTATION_270

final int io.agora.rtc2.Constants.VIDEO_ORIENTATION_270 = 270
static

270: 270 degrees.

◆ DEFAULT_CONNECTION_ID

final int io.agora.rtc2.Constants.DEFAULT_CONNECTION_ID = 0
static

The default connection ID.

◆ CONNECTION_STATE_DISCONNECTED

final int io.agora.rtc2.Constants.CONNECTION_STATE_DISCONNECTED = 1
static

1: The SDK is disconnected from Agora edge server.

  • This is the initial state before calling the joinChannel method.
  • The SDK also enters this state when the app calls the leaveChannel method.

◆ CONNECTION_STATE_CONNECTING

final int io.agora.rtc2.Constants.CONNECTION_STATE_CONNECTING = 2
static

2: The SDK is connecting to Agora edge server.

◆ CONNECTION_STATE_CONNECTED

final int io.agora.rtc2.Constants.CONNECTION_STATE_CONNECTED = 3
static

3: The SDK is connected to Agora edge server and has joined a channel. You can now publish or subscribe to a media stream in the channel. If the connection to the channel is lost because, for example, the network is down or switched, the SDK triggers:

◆ CONNECTION_STATE_RECONNECTING

final int io.agora.rtc2.Constants.CONNECTION_STATE_RECONNECTING = 4
static

4: The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.

◆ CONNECTION_STATE_FAILED

final int io.agora.rtc2.Constants.CONNECTION_STATE_FAILED = 5
static

5: The SDK fails to connect to Agora edge server or join the channel. You must call the leaveChannel method to leave this state and call the joinChannel method again to rejoin the channel. If the SDK is banned from joining the channel by the Agora server (through the RESTful API), the SDK triggers the {onConnectionBanned} and { IRtcEngineEventHandler#onConnectionStateChanged onConnectionStateChanged} callbacks.

◆ CONNECTION_CHANGED_CONNECTING

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_CONNECTING = 0
static

0: The SDK is connecting to Agora edge server.

◆ CONNECTION_CHANGED_JOIN_SUCCESS

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_JOIN_SUCCESS = 1
static

1: The SDK has joined the channel successfully.

◆ CONNECTION_CHANGED_INTERRUPTED

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_INTERRUPTED = 2
static

2: The connection between the SDK and Agora edge server is interrupted.

◆ CONNECTION_CHANGED_BANNED_BY_SERVER

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_BANNED_BY_SERVER = 3
static

3: The connection between the SDK and Agora edge server is banned by Agora edge server.

◆ CONNECTION_CHANGED_JOIN_FAILED

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_JOIN_FAILED = 4
static

4: The SDK fails to join the channel for more than 20 minutes and stops reconnecting to the channel.

◆ CONNECTION_CHANGED_LEAVE_CHANNEL

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_LEAVE_CHANNEL = 5
static

5: The SDK has left the channel.

◆ CONNECTION_CHANGED_INVALID_APP_ID

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_INVALID_APP_ID = 6
static

6: The specified App ID is invalid. Try to rejoin the channel with a valid App ID.

◆ CONNECTION_CHANGED_INVALID_CHANNEL_NAME

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_INVALID_CHANNEL_NAME = 7
static

7: The specified channel name is invalid. Try to rejoin the channel with a valid channel name.

◆ CONNECTION_CHANGED_INVALID_TOKEN

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_INVALID_TOKEN = 8
static

8: The generated token is invalid probably due to the following reasons:

  • The App Certificate for the project is enabled in Console, but you do not use the token.
  • The uid that you specify in the joinChannel method is different from the uid that you pass for generating the token.

◆ CONNECTION_CHANGED_TOKEN_EXPIRED

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_TOKEN_EXPIRED = 9
static

9: The token has expired. Generate a new token from your server.

◆ CONNECTION_CHANGED_REJECTED_BY_SERVER

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_REJECTED_BY_SERVER = 10
static

10: The user is banned by the server.

◆ CONNECTION_CHANGED_SETTING_PROXY_SERVER

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_SETTING_PROXY_SERVER = 11
static

11: The SDK tries to reconnect after setting a proxy server.

◆ CONNECTION_CHANGED_RENEW_TOKEN

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_RENEW_TOKEN = 12
static

12: The token renews.

◆ CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED = 13
static

13: The client IP address has changed, probably due to a change of the network type, IP address, or network port.

◆ CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT = 14
static

14: Timeout for the keep-alive of the connection between the SDK and Agora edge server. The connection state changes to Constants#CONNECTION_STATE_RECONNECTING(4).

◆ CONNECTION_CHANGED_REJOIN_SUCCESS

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_REJOIN_SUCCESS = 15
static

15: The SDK has rejoined the channel successfully.

◆ CONNECTION_CHANGED_LOST

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_LOST = 16
static

16: The connection between the SDK and the server is lost.

◆ CONNECTION_CHANGED_ECHO_TEST

final int io.agora.rtc2.Constants.CONNECTION_CHANGED_ECHO_TEST = 17
static

17: The change of connection state is caused by echo test.

◆ RELAY_OK

final int io.agora.rtc2.Constants.RELAY_OK = 0
static

0: The state is normal.

◆ RELAY_ERROR_SERVER_ERROR_RESPONSE

final int io.agora.rtc2.Constants.RELAY_ERROR_SERVER_ERROR_RESPONSE = 1
static

1: An error occurs in the server response.

◆ RELAY_ERROR_SERVER_NO_RESPONSE

final int io.agora.rtc2.Constants.RELAY_ERROR_SERVER_NO_RESPONSE = 2
static

2: No server response. You can call the leaveChannel method to leave the channel.

◆ RELAY_ERROR_NO_RESOURCE_AVAILABLE

final int io.agora.rtc2.Constants.RELAY_ERROR_NO_RESOURCE_AVAILABLE = 3
static

3: The SDK fails to access the service, probably due to limited resources of the server.

◆ RELAY_ERROR_FAILED_JOIN_SRC

final int io.agora.rtc2.Constants.RELAY_ERROR_FAILED_JOIN_SRC = 4
static

4: Fails to send the relay request.

◆ RELAY_ERROR_FAILED_JOIN_DEST

final int io.agora.rtc2.Constants.RELAY_ERROR_FAILED_JOIN_DEST = 5
static

5: Fails to accept the relay request.

◆ RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC

final int io.agora.rtc2.Constants.RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC = 6
static

6: The server fails to receive the media stream.

◆ RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST

final int io.agora.rtc2.Constants.RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST = 7
static

7: The server fails to send the media stream.

◆ RELAY_ERROR_SERVER_CONNECTION_LOST

final int io.agora.rtc2.Constants.RELAY_ERROR_SERVER_CONNECTION_LOST = 8
static

8: The SDK disconnects from the server due to poor network connections. You can call the leaveChannel method to leave the channel.

◆ RELAY_ERROR_INTERNAL_ERROR

final int io.agora.rtc2.Constants.RELAY_ERROR_INTERNAL_ERROR = 9
static

9: An internal error occurs in the server.

◆ RELAY_ERROR_SRC_TOKEN_EXPIRED

final int io.agora.rtc2.Constants.RELAY_ERROR_SRC_TOKEN_EXPIRED = 10
static

10: The token of the source channel has expired.

◆ RELAY_ERROR_DEST_TOKEN_EXPIRED

final int io.agora.rtc2.Constants.RELAY_ERROR_DEST_TOKEN_EXPIRED = 11
static

11: The token of the destination channel has expired.

◆ RELAY_EVENT_NETWORK_DISCONNECTED

final int io.agora.rtc2.Constants.RELAY_EVENT_NETWORK_DISCONNECTED = 0
static

0: The user disconnects from the server due to poor network connections.

◆ RELAY_EVENT_NETWORK_CONNECTED

final int io.agora.rtc2.Constants.RELAY_EVENT_NETWORK_CONNECTED = 1
static

1: The network reconnects.

◆ RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL

final int io.agora.rtc2.Constants.RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL = 2
static

2: The user joins the source channel.

◆ RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL

final int io.agora.rtc2.Constants.RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL = 3
static

3: The user joins the destination channel.

◆ RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL

final int io.agora.rtc2.Constants.RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL = 4
static

4: The SDK starts relaying the media stream to the destination channel.

◆ RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC

final int io.agora.rtc2.Constants.RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC = 5
static

5: The server receives the video stream from the source channel.

◆ RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC

final int io.agora.rtc2.Constants.RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC = 6
static

6: The server receives the audio stream from the source channel.

◆ RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL

final int io.agora.rtc2.Constants.RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL = 7
static

7: The destination channel is updated.

◆ RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED

final int io.agora.rtc2.Constants.RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED = 8
static

8: The destination channel update fails due to internal reasons.

◆ RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE

final int io.agora.rtc2.Constants.RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE = 9
static

9: The destination channel does not change, which means that the destination channel fails to be updated.

◆ RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL

final int io.agora.rtc2.Constants.RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL = 10
static

10: The destination channel name is NULL.

◆ RELAY_EVENT_VIDEO_PROFILE_UPDATE

final int io.agora.rtc2.Constants.RELAY_EVENT_VIDEO_PROFILE_UPDATE = 11
static

11: The video profile is sent to the server.

◆ RELAY_STATE_IDLE

final int io.agora.rtc2.Constants.RELAY_STATE_IDLE = 0
static

0: The SDK is initializing.

◆ RELAY_STATE_CONNECTING

final int io.agora.rtc2.Constants.RELAY_STATE_CONNECTING = 1
static

1: The SDK tries to relay the media stream to the destination channel.

◆ RELAY_STATE_RUNNING

final int io.agora.rtc2.Constants.RELAY_STATE_RUNNING = 2
static

2: The SDK successfully relays the media stream to the destination channel.

◆ RELAY_STATE_FAILURE

final int io.agora.rtc2.Constants.RELAY_STATE_FAILURE = 3
static

3: A failure occurs.

◆ MAX_CROSS_DEST_CHANNEL_SIZE

final int io.agora.rtc2.Constants.MAX_CROSS_DEST_CHANNEL_SIZE = 4
static

media relay max dest channel size

◆ EAR_MONITORING_FILTER_NONE

final int io.agora.rtc2.Constants.EAR_MONITORING_FILTER_NONE = (1 << 0)
static

1: Do not add an audio filter to the in-ear monitor.

◆ EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS

final int io.agora.rtc2.Constants.EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS = (1 << 1)
static

2: Add an audio filter to the in-ear monitor.

◆ EAR_MONITORING_FILTER_NOISE_SUPPRESSION

final int io.agora.rtc2.Constants.EAR_MONITORING_FILTER_NOISE_SUPPRESSION = (1 << 2)
static

4: Enable noise suppression to the in-ear monitor.