Agora Java API Reference for Android
Classes | |
| enum | AudioExternalSourcePos |
| enum | AudioMixingDualMonoMode |
| enum | AudioProfile |
| enum | AudioScenario |
| enum | LogLevel |
| enum | MediaType |
Detailed Description
The Constants Class.
Member Data Documentation
◆ ADAPT_NONE
|
static |
Indicates the adaption of current media quality, i.e., video bitrate or video framerate. The quality of the local video stays the same.
◆ ADAPT_UP_BANDWIDTH
|
static |
The quality improves because the network bandwidth increases.
◆ ADAPT_DOWN_BANDWIDTH
|
static |
The quality worsens because the network bandwidth decreases.
◆ LASTMILE_PROBE_RESULT_COMPLETE
|
static |
1: The last-mile probe result is complete.
◆ LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE
|
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
|
static |
3: The last-mile network probe test is not carried out, probably due to poor network conditions.
◆ QUALITY_UNKNOWN
|
static |
0: The quality is unknown.
◆ QUALITY_EXCELLENT
|
static |
1: The quality is excellent.
◆ QUALITY_GOOD
|
static |
2: The quality is quite good, but the bitrate may be slightly lower than excellent.
◆ QUALITY_POOR
|
static |
3: Users can feel the communication slightly impaired.
◆ QUALITY_BAD
|
static |
4: Users can communicate not very smoothly.
◆ QUALITY_VBAD
|
static |
5: The quality is so bad that users can barely communicate.
◆ QUALITY_DOWN
|
static |
6: The network is disconnected and users cannot communicate at all.
◆ QUALITY_UNSUPPORTED
|
static |
7: Users cannot detect the network quality. (Not in use.)
◆ QUALITY_DETECTING
|
static |
8: Detecting the network quality.
◆ EXPERIENCE_QUALITY_GOOD
|
static |
0: QoE of the local user is good.
◆ EXPERIENCE_QUALITY_BAD
|
static |
1: QoE of the local user is poor.
◆ EXPERIENCE_REASON_NONE
|
static |
0: No reason, indicating good QoE of the local user.
◆ REMOTE_NETWORK_QUALITY_POOR
|
static |
1: The remote user's network quality is poor.
◆ LOCAL_NETWORK_QUALITY_POOR
|
static |
2: The local user's network quality is poor.
◆ WIRELESS_SIGNAL_POOR
|
static |
4: The local user's Wi-Fi or mobile network signal is weak.
◆ WIFI_BLUETOOTH_COEXIST
|
static |
8: The local user enables both Wi-Fi and bluetooth, and their signals interfere with each other. As a result, audio transmission quality is undermined.
◆ WARN_INVALID_VIEW
|
static |
8: The specified view is invalid. Specify a view when using the video call function.
◆ WARN_INIT_VIDEO
|
static |
16: Fails 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_PENDING
|
static |
20: The request is pending, usually due to some module not being ready, and the SDK postponed processing the request.
◆ WARN_NO_AVAILABLE_CHANNEL
|
static |
103: No channel resources are available. Maybe because the server cannot allocate any channel resource.
◆ WARN_LOOKUP_CHANNEL_TIMEOUT
|
static |
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_REJECTED
|
static |
- Deprecated:
- This error code is deprecated. Use
CONNECTION_CHANGED_REJECTED_BY_SERVER(10)in theonConnectionStateChangedcallback instead. 105: The server rejects the request to look up the channel. The server cannot process this request or the request is illegal.
◆ WARN_OPEN_CHANNEL_TIMEOUT
|
static |
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_REJECTED
|
static |
107: The server rejects the request to open the channel. The server cannot process this request or the request is illegal.
◆ WARN_SWITCH_LIVE_VIDEO_TIMEOUT
|
static |
111: A timeout occurs when switching to the live video.
◆ WARN_SET_CLIENT_ROLE_TIMEOUT
|
static |
118: A timeout occurs when setting the user role in the LIVE_BROADCASTING profile.
◆ WARN_SET_CLIENT_ROLE_NOT_AUTHORIZED
|
static |
119: The user role is unauthorized.
- Deprecated:
- Deprecated as of v3.7.0. Use
reasonreported inonClientRoleChangeFailedinstead.
◆ WARN_OPEN_CHANNEL_INVALID_TICKET
|
static |
121: The SDK fails to join a channel.
◆ WARN_OPEN_CHANNEL_TRY_NEXT_VOS
|
static |
122: Try connecting to another server.
◆ WARN_AUDIO_MIXING_OPEN_ERROR
|
static |
701: An error occurs in opening the audio mixing file.
◆ WARN_ADM_RUNTIME_PLAYOUT_WARNING
|
static |
1014: Audio Device Module: A warning occurs in the playback device.
◆ WARN_ADM_RUNTIME_RECORDING_WARNING
|
static |
1016: Audio Device Module: A warning occurs in the sampling device.
◆ WARN_ADM_RECORD_AUDIO_SILENCE
|
static |
1019: Audio Device Module: No valid audio data is collected.
◆ WARN_ADM_PLAYOUT_ABNORMAL_FREQUENCY
|
static |
1020: Audio device module: The audio playback frequency is abnormal, which may cause audio freezes. This abnormality is caused by high CPU usage. Agora recommends stopping other apps.
◆ WARN_ADM_RECORD_ABNORMAL_FREQUENCY
|
static |
1021: Audio device module: The audio sampling frequency is abnormal, which may cause audio freezes. This abnormality is caused by high CPU usage. Agora recommends stopping other apps.
◆ WARN_ADM_CALL_INTERRUPTION
|
static |
1025: The local audio capture is interrupted by a system call or alarm clock. Remind your user to end the phone call or alarm clock if the local audio capture is required.
◆ WARN_ADM_RECORD_AUDIO_LOWLEVEL
|
static |
1031: Audio Device Module: The recorded audio volume is too low.
◆ WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL
|
static |
1032: Audio Device Module: The playback audio volume is too low.
◆ WARN_ADM_RECORD_IS_OCCUPIED
|
static |
1033: The local audio capture device is occupied by another application. Remind your user to leave the channel, stop the audio capture in another application, and rejoin the channel in sequence.
◆ WARN_APM_HOWLING
|
static |
1051: (Communication profile only) Audio processing module: A howling sound is detected when sampling the audio data.
◆ WARN_ADM_GLITCH_STATE
|
static |
1052: Audio Device Module: The device is in the glitch state.
◆ WARN_APM_RESIDUAL_ECHO
|
static |
1053: Audio Processing Module: Possible residual echo can be perceived.
◆ WARN_SUPER_RESOLUTION_STREAM_OVER_LIMITATION
|
static |
1610: Super-resolution warning: the original video dimensions of the remote user exceed 640 × 360.
◆ WARN_SUPER_RESOLUTION_USER_COUNT_OVER_LIMITATION
|
static |
1611: Super-resolution warning: another user is using super resolution.
◆ WARN_SUPER_RESOLUTION_DEVICE_NOT_SUPPORTED
|
static |
1612: Super-resolution warning: The device is not supported.
◆ ERR_OK
|
static |
0: No error occurs.
◆ ERR_FAILED
|
static |
1: A general error occurs (no specified reason).
◆ ERR_INVALID_ARGUMENT
|
static |
2: An invalid parameter is used. For example, the specific channel name includes illegal characters.
◆ ERR_NOT_READY
|
static |
3: 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
|
static |
4: The SDK does not support this function.
◆ ERR_REFUSED
|
static |
5: The request is rejected.
◆ ERR_BUFFER_TOO_SMALL
|
static |
6: The buffer size is not big enough to store the returned data.
◆ ERR_NOT_INITIALIZED
|
static |
7: The SDK is not initialized before calling this method.
◆ ERR_NO_PERMISSION
|
static |
9: No permission exists. Check if the user has granted access to the audio or video device.
◆ ERR_TIMEDOUT
|
static |
10: An API timeout occurs. Some API methods 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
|
static |
11: The request is canceled. This is for internal SDK use only, and is not returned to the app through any API method or callback.
◆ ERR_TOO_OFTEN
|
static |
12: This method is called too often. This is for internal SDK use only, and is not returned to the app through any API method or callback.
◆ ERR_BIND_SOCKET
|
static |
13: The SDK fails to bind to the network socket. This is for internal SDK use only, and is not returned to the app through any API method or callback.
◆ ERR_NET_DOWN
|
static |
14: The network is unavailable. This is for internal SDK use only, and is not returned to the app through any API method or callback.
◆ ERR_NET_NOBUFS
|
static |
15: No network buffers are available. This is for internal SDK use only, and is not returned to the app through any API method or callback.
◆ ERR_JOIN_CHANNEL_REJECTED
|
static |
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 joinChannel method to join the channel, or when the user tries to join the channel with a token that is expired.
◆ ERR_LEAVE_CHANNEL_REJECTED
|
static |
18: The request to leave the channel is rejected. This error usually occurs:
-
When the user has left the channel and still calls the
leaveChannelmethod to leave the channel. This error stops once the user stops calling this method. -
When the user calls the
leaveChannelmethod before joining a channel. No extra operation is needed.
◆ ERR_ALREADY_IN_USE
|
static |
19: The resources are occupied and cannot be reused.
◆ ERR_INVALID_APP_ID
|
static |
101: The specified App ID is invalid. Please try to rejoin the channel with a valid App ID.
◆ ERR_INVALID_CHANNEL_NAME
|
static |
102: The specified channel name is invalid. Please try to rejoin the channel with a valid channel name.
◆ ERR_NO_SERVER_RESOURCES
|
static |
103: Fails to get server resources in the specified region. Please try to specify another region when calling create.
◆ ERR_TOKEN_EXPIRED
|
static |
109: 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 Agora service within 24 hours after the token is generated. If the user does not access the Agora service after five minutes, this token will no longer be valid.
- Call Expiration Timestamp expired: The timestamp is 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 a value is set for the Call Expiration Timestamp, it does not mean that the Dynamic Key will expire, but that the user will be banned from the channel.
- Deprecated:
- From v2.4.1. Use
CONNECTION_CHANGED_TOKEN_EXPIRED(9)in theonConnectionStateChangedcallback instead.
◆ ERR_INVALID_TOKEN
|
static |
110: 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
joinChannelmethod.
- Deprecated:
- From v2.4.1. Use
CONNECTION_CHANGED_INVALID_TOKEN(8)in theonConnectionStateChangedcallback instead.
◆ ERR_CONNECTION_INTERRUPTED
|
static |
111: The Internet connection is interrupted. This applies to the Agora Web SDK only.
◆ ERR_CONNECTION_LOST
|
static |
112: The Internet connection is lost. This applies to the Agora Web SDK only.
◆ ERR_NOT_IN_CHANNEL
|
static |
113: The user is not in the channel.
◆ ERR_SIZE_TOO_LARGE
|
static |
114: The size of the sent data is over 1024 bytes when the user calls the sendStreamMessage method.
◆ ERR_BITRATE_LIMIT
|
static |
115: The bitrate of the sent data exceeds the limit of 6 Kbps when the user calls the sendStreamMessage method.
◆ ERR_TOO_MANY_DATA_STREAMS
|
static |
116: Too many data streams (over five streams) are created when the user calls the createDataStream method.
◆ ERR_DECRYPTION_FAILED
|
static |
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_CLIENT_IS_BANNED_BY_SERVER
|
static |
123: The user is banned by the server. This error occurs when the user is kicked out the channel from the server.
◆ ERR_WATERMARK_PARAM
|
static |
124: Incorrect watermark file parameter.
◆ ERR_WATERMARK_PATH
|
static |
125: Incorrect watermark file path.
◆ ERR_WATERMARK_PNG
|
static |
126: Incorrect watermark file format.
◆ ERR_WATERMARKR_INFO
|
static |
127: Incorrect watermark file information.
◆ ERR_WATERMARK_ARGB
|
static |
128: Incorrect watermark file data format.
◆ ERR_WATERMARK_READ
|
static |
129: An error occurs in reading the watermark file.
◆ ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISHED
|
static |
130: Encryption is enabled when the user calls the addPublishStreamUrl method (CDN live streaming does not support encrypted streams).
◆ ERR_INVALID_USER_ACCOUNT
|
static |
134: The user account is invalid.
◆ ERR_PUBLISH_STREAM_CDN_ERROR
|
static |
151: CDN related errors. Remove the original URL address and add a new one by calling the removePublishStreamUrl and addPublishStreamUrl methods.
◆ ERR_PUBLISH_STREAM_NUM_REACH_LIMIT
|
static |
152: The host manipulates more than 10 URLs. Delete the unnecessary URLs before adding new ones.
◆ ERR_PUBLISH_STREAM_NOT_AUTHORIZED
|
static |
153: The host manipulates other hosts' URLs. Check your app logic.
◆ ERR_PUBLISH_STREAM_INTERNAL_SERVER_ERROR
|
static |
154: An error occurs in Agora streaming server. Call the addPublishStreamUrl method to publish the streaming again.
◆ ERR_PUBLISH_STREAM_NOT_FOUND
|
static |
155: The server fails to find the stream.
◆ ERR_PUBLISH_STREAM_FORMAT_NOT_SUPPORTED
|
static |
156: The format of the CDN streaming URL is not supported. Check whether the URL format is correct.
◆ ERR_MODULE_NOT_FOUND
|
static |
157: The extension library is not integrated, such as the library for enabling deep-learning noise reduction.
◆ ERR_ALREADY_IN_RECORDING
|
static |
160: The client is already recording audio. To start a new recording, call stopAudioRecording to stop the current recording first, and then call startAudioRecording.
- Since
- v3.4.0
◆ RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE
|
static |
1: An error occurs when you add a background image or a watermark image to the RTMP or RTMPS stream.
◆ RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE
|
static |
2: The streaming URL is already being used for CDN live streaming. If you want to start new streaming, use a new streaming URL.
- Since
- v3.4.5
◆ RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT
|
static |
3: The feature is not supported.
- Since
- v3.6.0
◆ RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN
|
static |
4: Reserved.
- Since
- v3.6.0
◆ ERR_LOAD_MEDIA_ENGINE
|
static |
1001: Fails to load the media engine.
◆ ERR_START_CALL
|
static |
1002: Fails to start the call after enabling the media engine.
◆ ERR_START_CAMERA
|
static |
1003: Fails to start the camera.
- Deprecated:
- From v2.4.1. Use
LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE(4)in theonLocalVideoStateChangedcallback instead.
◆ ERR_START_VIDEO_RENDER
|
static |
1004: Fails to start the video rendering module.
◆ ERR_ADM_GENERAL_ERROR
|
static |
1005: Audio Device Module: A general error occurs in the Audio Device Module (no classified reason). Check if the audio device is used by another application, or try rejoining the channel.
◆ ERR_ADM_JAVA_RESOURCE
|
static |
1006: Audio Device Module: An error occurs in using the Java resources.
◆ ERR_ADM_SAMPLE_RATE
|
static |
1007: Audio Device Module: An error occurs in setting the sampling frequency.
◆ ERR_ADM_INIT_PLAYOUT
|
static |
1008: Audio Device Module: An error occurs in initializing the playback device.
◆ ERR_ADM_START_PLAYOUT
|
static |
1009: Audio Device Module: An error occurs in starting the playback device.
◆ ERR_ADM_STOP_PLAYOUT
|
static |
1010: Audio Device Module: An error occurs in stopping the playback device.
◆ ERR_ADM_INIT_RECORDING
|
static |
1011: Audio Device Module: An error occurs in initializing the sampling device.
◆ ERR_ADM_START_RECORDING
|
static |
1012: Audio Device Module: An error occurs in starting the sampling device.
◆ ERR_ADM_STOP_RECORDING
|
static |
1013: Audio Device Module: An error occurs in stopping the sampling device.
◆ ERR_ADM_RUNTIME_PLAYOUT_ERROR
|
static |
1015: Audio Device Module: A playback error occurs. Check your playback device or try rejoining the channel.
◆ ERR_ADM_RUNTIME_RECORDING_ERROR
|
static |
1017: Audio Device Module: A sampling error occurs.
◆ ERR_ADM_RECORD_AUDIO_FAILED
|
static |
1018: Audio Device Module: Fails to record.
◆ ERR_ADM_INIT_LOOPBACK
|
static |
1022: Audio Device Module: An error occurs in initializing the loopback device.
◆ ERR_ADM_START_LOOPBACK
|
static |
1023: Audio Device Module: An error occurs in starting the loopback device.
◆ ERR_AUDIO_BT_SCO_FAILED
|
static |
1030: Audio Routing: Fails to route the audio to the connected Bluetooth device. The default route is used.
◆ ERR_ADM_NO_RECORDING_DEVICE
|
static |
1359: Audio Device Module: No sampling device exists.
◆ ERR_ADM_NO_PLAYOUT_DEVICE
|
static |
1360: Audio Device Module: No playback device exists.
◆ ERR_VDM_CAMERA_NOT_AUTHORIZED
|
static |
1501: Video Device Module: The camera is unauthorized.
◆ ERR_VCM_UNKNOWN_ERROR
|
static |
1600: Video Device Module: Unknown error.
◆ ERR_VCM_ENCODER_INIT_ERROR
|
static |
1601: Video Device Module: Error in initializing the video encoder. This is a serious error and you can try to rejoin the channel.
◆ ERR_VCM_ENCODER_ENCODE_ERROR
|
static |
1602: Video Device Module: Error in the video encoder. This is a serious error and you can try to rejoin the channel.
◆ ERR_VCM_ENCODER_SET_ERROR
|
static |
- Deprecated:
- This error code is deprecated. 1603: Video Device Module: Error in setting the video encoder.
◆ ERR_AUDIO_BT_NO_ROUTE
|
static |
1800: Audio Routing: neither a2dp nor sco could be used for bluetooth
◆ VIDEO_PROFILE_120P
|
static |
- Deprecated:
- 0: Resolution: 160 × 120; Frame rate: 15 fps; Bitrate: 65 Kbps
◆ VIDEO_PROFILE_120P_3
|
static |
- Deprecated:
- 2: Resolution: 120 × 120; Frame rate: 15 fps; Bitrate 50 Kbps
◆ VIDEO_PROFILE_180P
|
static |
- Deprecated:
- 10: Resolution: 320 × 180; Frame rate: 15 fps; Bitrate: 140 Kbps
◆ VIDEO_PROFILE_180P_3
|
static |
- Deprecated:
- 12: Resolution: 180 × 180; Frame rate: 15 fps; Bitrate: 100 Kbps
◆ VIDEO_PROFILE_180P_4
|
static |
- Deprecated:
- 13: Resolution: 240 × 180; Frame rate: 15 fps; Bitrate: 120 Kbps
◆ VIDEO_PROFILE_240P
|
static |
- Deprecated:
- 20: Resolution: 320 × 240; Frame rate: 15 fps; Bitrate: 200 Kbps
◆ VIDEO_PROFILE_240P_3
|
static |
- Deprecated:
- 22: Resolution: 240 × 240; Frame rate: 15 fps; Bitrate: 140 Kbps
◆ VIDEO_PROFILE_240P_4
|
static |
- Deprecated:
- 23: Resolution: 424 × 240; Frame rate: 15 fps; Bitrate: 220 Kbps
◆ VIDEO_PROFILE_360P
|
static |
- Deprecated:
- 30: Resolution: 640 × 360; Frame rate: 15 fps; Bitrate: 400 Kbps
◆ VIDEO_PROFILE_360P_3
|
static |
- Deprecated:
- 32: Resolution: 360 × 360; Frame rate: 15 fps; Bitrate: 260 Kbps
◆ VIDEO_PROFILE_360P_4
|
static |
- Deprecated:
- 33: Resolution: 640 × 360; Frame rate: 30 fps; Bitrate: 600 Kbps
◆ VIDEO_PROFILE_360P_6
|
static |
- Deprecated:
- 35: Resolution: 360 × 360; Frame rate: 30 fps; Bitrate: 400 Kbps
◆ VIDEO_PROFILE_360P_7
|
static |
- Deprecated:
- 36: Resolution: 480 × 360; Frame rate: 15 fps; Bitrate: 320 Kbps
◆ VIDEO_PROFILE_360P_8
|
static |
- Deprecated:
- 37: Resolution: 480 × 360; Frame rate: 30 fps; Bitrate: 490 Kbps
◆ VIDEO_PROFILE_360P_9
|
static |
- Deprecated:
- 38: Resolution: 640 × 360; Frame rate: 15 fps; Bitrate: 800 Kbps
- Note
- This profile applies to the LI profile profile only.
◆ VIDEO_PROFILE_360P_10
|
static |
- Deprecated:
- 39: Resolution: 640 × 360; Frame rate: 24 fps; Bitrate: 800 Kbps
- Note
- This profile applies to the
LIVE_BROADCASTINGprofile only.
◆ VIDEO_PROFILE_360P_11
|
static |
- Deprecated:
- 100: Resolution: 640 × 360; Frame rate: 24 fps; Bitrate: 1000 Kbps
- Note
- This profile applies to the
LIVE_BROADCASTINGprofile only.
◆ VIDEO_PROFILE_480P
|
static |
- Deprecated:
- 40: Resolution: 640 × 480; Frame rate: 15 fps; Bitrate: 500 Kbps
◆ VIDEO_PROFILE_480P_3
|
static |
- Deprecated:
- 42: Resolution: 480 × 480; Frame rate: 15 fps; Bitrate: 400 Kbps
◆ VIDEO_PROFILE_480P_4
|
static |
- Deprecated:
- 43: Resolution: 640 × 480; Frame rate: 30 fps; Bitrate: 750 Kbps
◆ VIDEO_PROFILE_480P_6
|
static |
- Deprecated:
- 45: Resolution: 480 × 480; Frame rate: 30 fps; Bitrate: 600 Kbps
◆ VIDEO_PROFILE_480P_8
|
static |
- Deprecated:
- 47: Resolution: 848 × 480; Frame rate: 15 fps; Bitrate: 610 Kbps
◆ VIDEO_PROFILE_480P_9
|
static |
- Deprecated:
- 48: Resolution: 848 × 480; Frame rate: 30 fps; Bitrate: 930 Kbps
◆ VIDEO_PROFILE_480P_10
|
static |
- Deprecated:
- 49: Resolution: 640 × 480; Frame rate: 10 fps; Bitrate: 400 Kbps
◆ VIDEO_PROFILE_720P
|
static |
- Deprecated:
- 50: Resolution: 1280 × 720; Frame rate: 15 fps; Bitrate: 1130 Kbps
◆ VIDEO_PROFILE_720P_3
|
static |
- Deprecated:
- 52: Resolution: 1280 × 720; Frame rate: 30 fps; Bitrate: 1710 Kbps
◆ VIDEO_PROFILE_720P_5
|
static |
- Deprecated:
- 54: Resolution: 960 × 720; Frame rate: 15 fps; Bitrate: 910 Kbps
◆ VIDEO_PROFILE_720P_6
|
static |
- Deprecated:
- 55: Resolution: 960 × 720; Frame rate: 30 fps; Bitrate: 1380 Kbps
◆ VIDEO_PROFILE_DEFAULT
|
static |
- Deprecated:
- Default video profile: Resolution: 640 × 360; Frame rate: 15 fps; Bitrate: 400 Kbps
◆ AUDIO_PROFILE_DEFAULT
|
static |
0: Default audio profile.
- In the
COMMUNICATIONprofile, the default audio profile represents a sample rate of 32 kHz, audio encoding, mono, and a bitrate of up to 18 Kbps. - In the
LIVE_BROADCASTINGprofile, the default audio profile represents a sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.
◆ AUDIO_PROFILE_SPEECH_STANDARD
|
static |
1: A sample rate of 32 kHz, audio encoding, mono, and a bitrate of up to 18 Kbps.
◆ AUDIO_PROFILE_MUSIC_STANDARD
|
static |
2: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.
◆ AUDIO_PROFILE_MUSIC_STANDARD_STEREO
|
static |
3: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 80 Kbps.
◆ AUDIO_PROFILE_MUSIC_HIGH_QUALITY
|
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
|
static |
5: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 128 Kbps.
◆ AUDIO_SCENARIO_DEFAULT
|
static |
0: Default audio scenario.
◆ AUDIO_SCENARIO_CHATROOM_ENTERTAINMENT
|
static |
1: Entertainment scenario where users need to frequently switch the user role.
◆ AUDIO_SCENARIO_EDUCATION
|
static |
2: Education scenario where users want smoothness and stability.
◆ AUDIO_SCENARIO_GAME_STREAMING
|
static |
3: High-quality audio chatroom scenario where hosts mainly play music.
◆ AUDIO_SCENARIO_SHOWROOM
|
static |
4: Showroom scenario where a single host wants high-quality audio.
◆ AUDIO_SCENARIO_CHATROOM_GAMING
|
static |
5: Gaming scenario for group chat that only contains the human voice.
◆ AUDIO_SCENARIO_IOT
|
static |
6: IoT (Internet of Things) scenario where users use IoT devices with low power consumption.
◆ AUDIO_SCENARIO_MEETING
|
static |
8: Meeting scenario that mainly contains the human voice.
- Since
- v3.2.0
◆ AUDIO_SCENARIO_NUM
|
static |
The number of elements in the enumeration.
◆ AUDIO_EQUALIZATION_BAND_31
|
static |
0: 31 Hz
◆ AUDIO_EQUALIZATION_BAND_62
|
static |
1: 62 Hz
◆ AUDIO_EQUALIZATION_BAND_125
|
static |
2: 125 Hz
◆ AUDIO_EQUALIZATION_BAND_250
|
static |
3: 250 Hz
◆ AUDIO_EQUALIZATION_BAND_500
|
static |
4: 500 Hz
◆ AUDIO_EQUALIZATION_BAND_1K
|
static |
5: 1 kHz
◆ AUDIO_EQUALIZATION_BAND_2K
|
static |
6: 2 kHz
◆ AUDIO_EQUALIZATION_BAND_4K
|
static |
7: 4 kHz
◆ AUDIO_EQUALIZATION_BAND_8K
|
static |
8: 8 kHz
◆ AUDIO_EQUALIZATION_BAND_16K
|
static |
9: 16 kHz
◆ AUDIO_REVERB_DRY_LEVEL
|
static |
0: Level of the dry signal (-20 to 10 dB).
◆ AUDIO_REVERB_WET_LEVEL
|
static |
1: Level of the early reflection signal (wet signal) (-20 to 10 dB).
◆ AUDIO_REVERB_ROOM_SIZE
|
static |
2: Room size of the reflection (0 to 100 dB).
◆ AUDIO_REVERB_WET_DELAY
|
static |
3: Length of the initial delay of the wet signal (0 to 200 ms).
◆ AUDIO_REVERB_STRENGTH
|
static |
4: Strength of the late reverberation (0 to 100).
◆ VOICE_CHANGER_OFF
|
static |
- Deprecated:
- Deprecated from v3.2.0. Turn off the local voice changer, that is, to use the original voice.
◆ VOICE_CHANGER_OLDMAN
|
static |
- Deprecated:
- Deprecated from v3.2.0. The voice of an old man.
◆ VOICE_CHANGER_BABYBOY
|
static |
- Deprecated:
- Deprecated from v3.2.0. The voice of a little boy.
◆ VOICE_CHANGER_BABYGIRL
|
static |
- Deprecated:
- Deprecated from v3.2.0. The voice of a little girl.
◆ VOICE_CHANGER_ZHUBAJIE
|
static |
- Deprecated:
- Deprecated from v3.2.0. 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
|
static |
- Deprecated:
- Deprecated from v3.2.0. The ethereal voice.
◆ VOICE_CHANGER_HULK
|
static |
- Deprecated:
- Deprecated from v3.2.0. The voice of Hulk.
◆ VOICE_BEAUTY_VIGOROUS
|
static |
- Deprecated:
- Deprecated from v3.2.0. A more vigorous voice.
◆ VOICE_BEAUTY_DEEP
|
static |
- Deprecated:
- Deprecated from v3.2.0. A deeper voice.
◆ VOICE_BEAUTY_MELLOW
|
static |
- Deprecated:
- Deprecated from v3.2.0. A mellower voice.
◆ VOICE_BEAUTY_FALSETTO
|
static |
- Deprecated:
- Deprecated from v3.2.0. Falsetto.
◆ VOICE_BEAUTY_FULL
|
static |
- Deprecated:
- Deprecated from v3.2.0. A fuller voice.
◆ VOICE_BEAUTY_CLEAR
|
static |
- Deprecated:
- Deprecated from v3.2.0. A clearer voice.
◆ VOICE_BEAUTY_RESOUNDING
|
static |
- Deprecated:
- Deprecated from v3.2.0. A more resounding voice.
◆ VOICE_BEAUTY_RINGING
|
static |
- Deprecated:
- Deprecated from v3.2.0. A more ringing voice.
◆ VOICE_BEAUTY_SPACIAL
|
static |
- Deprecated:
- Deprecated from v3.2.0. A more spatially resonant voice.
◆ GENERAL_BEAUTY_VOICE_MALE_MAGNETIC
|
static |
- Deprecated:
- Deprecated from v3.2.0. (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
|
static |
- Deprecated:
- Deprecated from v3.2.0. (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
|
static |
- Deprecated:
- Deprecated from v3.2.0. (For female only) A more vital voice. Do not use it when the speaker is a male; otherwise, voice distortion occurs.
◆ AUDIO_REVERB_OFF
|
static |
- Deprecated:
- Deprecated from v3.2.0. Turn off local voice reverberation, that is, to use the original voice.
◆ AUDIO_REVERB_FX_KTV
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation style typical of a KTV venue (enhanced).
◆ AUDIO_REVERB_FX_VOCAL_CONCERT
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation style typical of a concert hall (enhanced).
◆ AUDIO_REVERB_FX_UNCLE
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation style typical of an uncle's voice.
◆ AUDIO_REVERB_FX_SISTER
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation style typical of a little sister's voice.
◆ AUDIO_REVERB_FX_STUDIO
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation style typical of a recording studio (enhanced).
◆ AUDIO_REVERB_FX_POPULAR
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation style typical of popular music (enhanced).
◆ AUDIO_REVERB_FX_RNB
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation style typical of R&B music (enhanced).
◆ AUDIO_REVERB_FX_PHONOGRAPH
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation style typical of the vintage phonograph.
◆ AUDIO_REVERB_POPULAR
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation style typical of popular music.
◆ AUDIO_REVERB_RNB
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation style typical of R&B music.
◆ AUDIO_REVERB_ROCK
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation style typical of rock music.
◆ AUDIO_REVERB_HIPHOP
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation style typical of hip-hop music.
◆ AUDIO_REVERB_VOCAL_CONCERT
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation style typical of a concert hall.
◆ AUDIO_REVERB_KTV
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation style typical of a KTV venue.
◆ AUDIO_REVERB_STUDIO
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation style typical of a recording studio.
◆ AUDIO_VIRTUAL_STEREO
|
static |
- Deprecated:
- Deprecated from v3.2.0. The reverberation of the virtual stereo. The virtual stereo is an effect that renders the monophonic audio as the stereo audio, so that all users in the channel can hear the stereo voice effect. To achieve better virtual stereo reverberation, Agora recommends setting profile in
setAudioProfileasAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO.
◆ AUDIO_ELECTRONIC_VOICE
|
static |
- Deprecated:
- Deprecated from v3.2.0. A pitch correction effect that corrects the user's pitch based on the pitch of the natural C major scale.
◆ AUDIO_THREEDIM_VOICE
|
static |
- Deprecated:
- Deprecated from v3.2.0. A 3D voice effect that makes the voice appear to be moving around the user.
◆ VOICE_BEAUTIFIER_OFF
|
static |
Turn off voice beautifier effects and use the original voice.
◆ AUDIO_EFFECT_OFF
|
static |
Turn off audio effects and use the original voice.
◆ CHAT_BEAUTIFIER_MAGNETIC
|
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
|
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
|
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
|
static |
Singing beautifier effect.
- If you call
setVoiceBeautifierPreset(SINGING_BEAUTIFIER), you can beautify a male-sounding voice and add a reverberation effect that sounds like singing in a small room. Agora recommends not usingsetVoiceBeautifierPreset(SINGING_BEAUTIFIER)to process a female-sounding voice; otherwise, you may experience vocal distortion. - If you call
setVoiceBeautifierParameters(SINGING_BEAUTIFIER, param1, param2), you can beautify a male- or female-sounding voice and add a reverberation effect.
- Since
- v3.3.0
◆ TIMBRE_TRANSFORMATION_VIGOROUS
|
static |
A more vigorous voice.
◆ TIMBRE_TRANSFORMATION_DEEP
|
static |
A deeper voice.
◆ TIMBRE_TRANSFORMATION_MELLOW
|
static |
A mellower voice.
◆ TIMBRE_TRANSFORMATION_FALSETTO
|
static |
A falsetto voice.
◆ TIMBRE_TRANSFORMATION_FULL
|
static |
A fuller voice.
◆ TIMBRE_TRANSFORMATION_CLEAR
|
static |
A clearer voice.
◆ TIMBRE_TRANSFORMATION_RESOUNDING
|
static |
A more resounding voice.
◆ TIMBRE_TRANSFORMATION_RINGING
|
static |
A more ringing voice.
◆ ROOM_ACOUSTICS_KTV
|
static |
An audio effect typical of a KTV venue.
- Note
- To achieve better audio effect quality, Agora recommends calling
setAudioProfileand setting theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator.
◆ ROOM_ACOUSTICS_VOCAL_CONCERT
|
static |
An audio effect typical of a concert hall.
- Note
- To achieve better audio effect quality, Agora recommends calling
setAudioProfileand setting theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator.
◆ ROOM_ACOUSTICS_STUDIO
|
static |
An audio effect typical of a recording studio.
- Note
- To achieve better audio effect quality, Agora recommends calling
setAudioProfileand setting theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator.
◆ ROOM_ACOUSTICS_PHONOGRAPH
|
static |
An audio effect typical of a vintage phonograph.
- Note
- To achieve better audio effect quality, Agora recommends calling
setAudioProfileand setting theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator.
◆ ROOM_ACOUSTICS_VIRTUAL_STEREO
|
static |
A virtual stereo effect that renders monophonic audio as stereo audio.
- Note
- Call
setAudioProfileand set theprofileparameter toAUDIO_PROFILE_MUSIC_STANDARD_STEREO(3)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator; otherwise, the enumerator setting does not take effect.
◆ ROOM_ACOUSTICS_SPACIAL
|
static |
A more spatial audio effect.
- Note
- To achieve better audio effect quality, Agora recommends calling
setAudioProfileand setting theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator.
◆ ROOM_ACOUSTICS_ETHEREAL
|
static |
A more ethereal audio effect.
- Note
- To achieve better audio effect quality, Agora recommends calling
setAudioProfileand setting theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator.
◆ ROOM_ACOUSTICS_3D_VOICE
|
static |
A 3D voice effect that makes the voice appear to be moving around the user. The default cycle period of the 3D voice effect is 10 seconds. To change the cycle period, call setAudioEffectParameters after this method.
- Note
- Call
setAudioProfileand set theprofileparameter toAUDIO_PROFILE_MUSIC_STANDARD_STEREO(3)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator; otherwise, the enumerator setting does not take effect - If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.
- Call
◆ VOICE_CHANGER_EFFECT_UNCLE
|
static |
The voice of a middle-aged man.
- Note
- Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
- To achieve better audio effect quality, Agora recommends calling
setAudioProfileand setting theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator.
◆ VOICE_CHANGER_EFFECT_OLDMAN
|
static |
The voice of an old man.
- Note
- Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
- To achieve better audio effect quality, Agora recommends calling
setAudioProfileand setting theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator.
◆ VOICE_CHANGER_EFFECT_BOY
|
static |
The voice of a boy.
- Note
- Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
- To achieve better audio effect quality, Agora recommends calling
setAudioProfileand setting theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator.
◆ VOICE_CHANGER_EFFECT_SISTER
|
static |
The voice of a young woman.
- Note
- Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
- To achieve better audio effect quality, Agora recommends calling
setAudioProfileand setting theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator.
◆ VOICE_CHANGER_EFFECT_GIRL
|
static |
The voice of a girl.
- Note
- Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
- To achieve better audio effect quality, Agora recommends calling
setAudioProfileand setting theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator.
◆ VOICE_CHANGER_EFFECT_PIGKING
|
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
setAudioProfileand setting theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator.
◆ VOICE_CHANGER_EFFECT_HULK
|
static |
The voice of Hulk.
- Note
- To achieve better audio effect quality, Agora recommends calling
setAudioProfileand setting theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator.
◆ STYLE_TRANSFORMATION_RNB
|
static |
An audio effect typical of R&B music.
- Note
- Call
setAudioProfileand set theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator; otherwise, the enumerator setting does not take effect.
◆ STYLE_TRANSFORMATION_POPULAR
|
static |
An audio effect typical of popular music.
- Note
- Call
setAudioProfileand set theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator; otherwise, the enumerator setting does not take effect.
◆ PITCH_CORRECTION
|
static |
A pitch correction effect that corrects the user's pitch based on the pitch of the natural C major scale. To change the basic mode and tonic pitch, call setAudioEffectParameters after this method.
- Note
- To achieve better audio effect quality, Agora recommends calling
setAudioProfileand setting theprofileparameter toAUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)orAUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)before setting this enumerator.
◆ VOICE_CONVERSION_OFF
|
static |
Turn off voice conversion effects and use the original voice.
- Since
- v3.3.1.
◆ VOICE_CHANGER_NEUTRAL
|
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
|
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
|
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
|
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
|
static |
0: The channel profile is Communication.
This is used in one-on-one calls or group calls, where all users in the channel can talk freely.
◆ CHANNEL_PROFILE_LIVE_BROADCASTING
|
static |
1: The channel profile is LIVE_BROADCASTING.
Host and audience roles that can be set by calling the setClientRole method. The host sends and receives voice/video, while the audience only receives voice/video.
◆ CHANNEL_PROFILE_GAME
|
static |
2: The Gaming profile. Agora does not recommend using this profile.
◆ CLIENT_ROLE_BROADCASTER
|
static |
1: Host. A host can both send and receive streams.
◆ CLIENT_ROLE_AUDIENCE
|
static |
2: Audience. An audience member can only receive streams.
◆ AUDIENCE_LATENCY_LEVEL_LOW_LATENCY
|
static |
1: Low latency.
◆ AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY
|
static |
2: (Default) Ultra low latency.
◆ VIDEO_CODEC_VP8
|
static |
1: The standard VP8.
◆ VIDEO_CODEC_H264
|
static |
2: The standard H264.
◆ VIDEO_CODEC_EVP
|
static |
3: The enhanced VP8.
◆ VIDEO_CODEC_E264
|
static |
4: The enhanced H264.
◆ USER_OFFLINE_QUIT
|
static |
0: The user quits the call.
◆ USER_OFFLINE_DROPPED
|
static |
1: The SDK timed out and the user dropped offline because it has not received any data packet for a period of time.
- Note
- If a user quits the call and the message is not passed to the SDK (due to an unreliable channel), the SDK assumes the user has dropped offline.
- On Android, after the user kills the app by a gesture swipe, the SDK reports
USER_OFFLINE_DROPPED(1)instead ofUSER_OFFLINE_QUIT(0)due to system limitation.
◆ USER_OFFLINE_BECOME_AUDIENCE
|
static |
2: The client role switches from a host to an audience.
◆ CAPTURE_BRIGHTNESS_LEVEL_INVALID
|
static |
-1: The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level from CAPTURE_BRIGHTNESS_LEVEL_TYPE in the next callback.
◆ CAPTURE_BRIGHTNESS_LEVEL_NORMAL
|
static |
0: The brightness level of the video image is normal.
◆ CAPTURE_BRIGHTNESS_LEVEL_BRIGHT
|
static |
1: The brightness level of the video image is too bright.
◆ CAPTURE_BRIGHTNESS_LEVEL_DARK
|
static |
2: The brightness level of the video image is too dark.
◆ QUALITY_REPORT_FORMAT_JSON
|
static |
0: The quality report is in JSON format.
◆ QUALITY_REPORT_FORMAT_HTML
|
static |
1: The quality report is in HTML format.
◆ RENDER_MODE_HIDDEN
|
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
|
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 are filled with black.
◆ RENDER_MODE_ADAPTIVE
|
static |
- Deprecated:
- 3: Adaptive mode: If both callers use the same screen orientation, such as both use vertical screens or both use horizontal screens, the
RENDER_MODE_HIDDENmode applies; if they use different screen orientations, such as one vertical and one horizontal, theRENDER_MODE_FITmode applies.
◆ VIDEO_MIRROR_MODE_AUTO
|
static |
0: The default mirror mode (the SDK determines the mirror mode).
◆ VIDEO_MIRROR_MODE_ENABLED
|
static |
1: Enable the mirror mode.
◆ VIDEO_MIRROR_MODE_DISABLED
|
static |
2: Disable the mirror mode
◆ SCREEN_CAPTURE_CONTENT_HINT_NONE
|
static |
0: No content hint.
◆ SCREEN_CAPTURE_CONTENT_HINT_MOTION
|
static |
1: Motion-intensive content. Choose this option if you prefer smoothness or when you are sharing a video clip, movie, or video game.
◆ SCREEN_CAPTURE_CONTENT_HINT_DETAILS
|
static |
2: Motionless content. Choose this option if you prefer sharpness or when you are sharing a picture, PowerPoint slide, or text.
◆ LOG_FILTER_OFF
|
static |
0: Do not output any log.
◆ LOG_FILTER_DEBUG
|
static |
0x80f: Output all API logs. Set your log filter as DEBUG if you want to get the most complete log file.
◆ LOG_FILTER_INFO
|
static |
0x0f: Output logs of the CRITICAL, ERROR, WARNING, and INFO level. We recommend setting your log filter as this level.
◆ LOG_FILTER_WARNING
|
static |
0x0e: Output logs of the CRITICAL, ERROR, and WARNING level.
◆ LOG_FILTER_ERROR
|
static |
0x0c: Output logs of the CRITICAL and ERROR level.
◆ LOG_FILTER_CRITICAL
|
static |
0x08: Output logs of the CRITICAL level.
◆ AUDIO_ROUTE_DEFAULT
|
static |
-1: Default audio route.
◆ AUDIO_ROUTE_HEADSET
|
static |
0: The audio route is a headset with a microphone.
◆ AUDIO_ROUTE_EARPIECE
|
static |
1: The audio route is an earpiece.
◆ AUDIO_ROUTE_HEADSETNOMIC
|
static |
2: The audio route is a headset without a microphone.
◆ AUDIO_ROUTE_SPEAKERPHONE
|
static |
3: The audio route is the speaker that comes with the device.
◆ AUDIO_ROUTE_LOUDSPEAKER
|
static |
4: (For future use) The audio route is an external speaker.
◆ AUDIO_ROUTE_HEADSETBLUETOOTH
|
static |
5: The audio route is a Bluetooth headset.
◆ VIDEO_STREAM_HIGH
|
static |
0: High-stream (high-resolution, high-bitrate) video.
◆ VIDEO_STREAM_LOW
|
static |
1: Low-stream (low-resolution, low-bitrate) video.
◆ USER_PRIORITY_HIGH
|
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_NORMAL
|
static |
Default priority.
◆ HARDWARE_ENCODER
|
static |
0: Hardware encoder.
◆ SOFTWARE_ENCODER
|
static |
1: Software encoder.
◆ RAW_AUDIO_FRAME_OP_MODE_READ_ONLY
|
static |
0: Read-only mode. Users only read the Agora Audio Frame data without modifying anything. For example, when users acquire data with the Agora SDK and push RTMP or RTMPS streams by themselves.
◆ RAW_AUDIO_FRAME_OP_MODE_WRITE_ONLY
|
static |
1: Write-only mode. Users replace the Agora Audio Frame 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
|
static |
2: Read and write mode. Users read the data from the Agora Audio Frame, 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.
◆ MEDIA_ENGINE_AUDIO_ERROR_MIXING_OPEN
|
static |
701: The SDK cannot open the audio mixing file.
- Deprecated:
- Deprecated from v3.4.0. Use related constants prefixed with
AUDIO_MIXING_REASONinstead.
◆ MEDIA_ENGINE_AUDIO_ERROR_MIXING_TOO_FREQUENT
|
static |
702: The SDK opens the audio mixing file too frequently.
- Deprecated:
- Deprecated from v3.4.0. Use related constants prefixed with
AUDIO_MIXING_REASONinstead.
◆ MEDIA_ENGINE_AUDIO_ERROR_MIXING_INTERRUPTED_EOF
|
static |
703: The audio mixing file playback is interrupted.
- Deprecated:
- Deprecated from v3.4.0. Use related constants prefixed with
AUDIO_MIXING_REASONinstead.
◆ MEDIA_ENGINE_AUDIO_EVENT_MIXING_PLAY
|
static |
710: The music file is playing. This state comes with one of the following associated reasons:
AUDIO_MIXING_REASON_STARTED_BY_USER(720): Successfully callsstartAudioMixingto play a music file.AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED(721): The music file completes a loop playback.AUDIO_MIXING_REASON_START_NEW_LOOP(722): The music file starts a new loop playback.AUDIO_MIXING_REASON_RESUMED_BY_USER(726): Successfully callsresumeAudioMixingto resume playing the music file.
◆ MEDIA_ENGINE_AUDIO_EVENT_MIXING_PAUSED
|
static |
711: The audio mixing file pauses playing after the method call of pauseAudioMixing succeeds.
◆ MEDIA_ENGINE_AUDIO_EVENT_MIXING_STOPPED
|
static |
713: The audio mixing file stops playing after the method call of stopAudioMixing succeeds.
◆ MEDIA_ENGINE_AUDIO_EVENT_MIXING_ERROR
|
static |
714: An exception occurs during the playback of the music file. This state comes with one of the following associated reasons:
AUDIO_MIXING_REASON_CAN_NOT_OPEN(701): The SDK cannot open the music file. Possible causes include the local music file does not exist, the SDK does not support the file format, or the SDK cannot access the music file URL.AUDIO_MIXING_REASON_TOO_FREQUENT_CALL(702): The SDK opens the music file too frequently. If you need to callstartAudioMixingmultiple times, ensure that the call interval is longer than 500 ms.AUDIO_MIXING_REASON_INTERRUPTED_EOF(703): The music file playback is interrupted.
◆ MEDIA_ENGINE_AUDIO_EVENT_MIXING_STARTED_BY_USER
|
static |
720: For internal use.
◆ MEDIA_ENGINE_AUDIO_EVENT_MIXING_ONE_LOOP_COMPLETED
|
static |
721: For internal use.
◆ MEDIA_ENGINE_AUDIO_EVENT_MIXING_START_NEW_LOOP
|
static |
722: For internal use.
◆ MEDIA_ENGINE_AUDIO_EVENT_MIXING_ALL_LOOPS_COMPLETED
|
static |
723: For internal use.
◆ MEDIA_ENGINE_AUDIO_EVENT_MIXING_STOPPED_BY_USER
|
static |
724: For internal use.
◆ MEDIA_ENGINE_AUDIO_EVENT_MIXING_PAUSED_BY_USER
|
static |
725: For internal use.
◆ MEDIA_ENGINE_AUDIO_EVENT_MIXING_RESUMED_BY_USER
|
static |
726: For internal use.
◆ AUDIO_MIXING_REASON_CAN_NOT_OPEN
|
static |
701: The SDK cannot open the music file. Possible causes include the local music file does not exist, the SDK does not support the file format, or the SDK cannot access the music file URL.
◆ AUDIO_MIXING_REASON_TOO_FREQUENT_CALL
|
static |
702: The SDK opens the music file too frequently. If you need to call startAudioMixing multiple times, ensure that the call interval is longer than 500 ms.
◆ AUDIO_MIXING_REASON_INTERRUPTED_EOF
|
static |
703: The music file playback is interrupted.
◆ AUDIO_MIXING_REASON_STARTED_BY_USER
|
static |
720: Successfully calls startAudioMixing to play a music file.
◆ AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED
|
static |
721: The music file completes a loop playback.
◆ AUDIO_MIXING_REASON_START_NEW_LOOP
|
static |
722: The music file starts a new loop playback.
◆ AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED
|
static |
723: The music file completes all loop playback.
◆ AUDIO_MIXING_REASON_STOPPED_BY_USER
|
static |
724: Successfully calls stopAudioMixing to stop playing the music file.
◆ AUDIO_MIXING_REASON_PAUSED_BY_USER
|
static |
725: Successfully calls pauseAudioMixing to pause playing the music file.
◆ AUDIO_MIXING_REASON_RESUMED_BY_USER
|
static |
726: Successfully calls resumeAudioMixing to resume playing the music file.
◆ CONNECTION_STATE_DISCONNECTED
|
static |
1: The SDK is disconnected from Agora edge server.
-
This is the initial state before calling the
joinChannelmethod. -
The SDK also enters this state when the app calls the
leaveChannelmethod.
◆ CONNECTION_STATE_CONNECTING
|
static |
2: The SDK is connecting to Agora edge server.
-
When the app calls the
joinChannelmethod, the SDK starts to establish a connection to the specified channel, triggers theonConnectionStateChangedcallback, and switches to theCONNECTION_STATE_CONNECTINGstate. -
When a user successfully joins a channel, the SDK triggers the
onConnectionStateChangedcallback and switches to theCONNECTION_STATE_CONNECTEDstate. -
After the SDK joins the channel and when it finishes initializing the media engine, the SDK triggers the
onJoinChannelSuccesscallback.
◆ CONNECTION_STATE_CONNECTED
|
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:
-
The
onConnectionInterrupted(deprecated) callback. -
The
onConnectionStateChangedcallback, and switches to theCONNECTION_STATE_RECONNECTINGstate.
◆ CONNECTION_STATE_RECONNECTING
|
static |
4: The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.
-
If the SDK cannot join the channel within 10 seconds after being disconnected from Agora edge server, the SDK triggers the
onConnectionLost(deprecated) callback, stays in theCONNECTION_STATE_RECONNECTINGstate, and keeps rejoining the channel. -
If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora edge server, the SDK triggers the
onConnectionStateChangedcallback, switches to theCONNECTION_STATE_FAILEDstate, and stops rejoining the channel.
◆ CONNECTION_STATE_FAILED
|
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 onConnectionStateChanged callbacks.
◆ CONNECTION_CHANGED_CONNECTING
|
static |
0: The SDK is connecting to Agora edge server.
◆ CONNECTION_CHANGED_JOIN_SUCCESS
|
static |
1: The SDK has joined the channel successfully.
◆ CONNECTION_CHANGED_INTERRUPTED
|
static |
2: The connection between the SDK and Agora edge server is interrupted.
◆ CONNECTION_CHANGED_BANNED_BY_SERVER
|
static |
3: The connection is banned by the server. This occurs when the server calls the Banning user privileges API to kick the user out of the channel. You can display a pop-up box in the application that says: "The user has been banned from this channel."
◆ CONNECTION_CHANGED_JOIN_FAILED
|
static |
4: The SDK fails to join the channel. This occurs when the SDK fails to rejoin the channel within 20 minutes after receiving the onConnectionStateChanged(connection_state_reconnecting, connection_changed_interrupted) callback and stops trying. You can display a pop-up box in the application that says: "Failed to join the channel due to
network issues. Please try to rejoin the channel after switching to a different network."
◆ CONNECTION_CHANGED_LEAVE_CHANNEL
|
static |
5: The SDK has left the channel.
◆ CONNECTION_CHANGED_INVALID_APP_ID
|
static |
6: The specified App ID is invalid. Check whether the App ID used by the user is the same as the App ID obtained from the Agora Console, and then try to rejoin the channel with a valid App ID.
◆ CONNECTION_CHANGED_INVALID_CHANNEL_NAME
|
static |
7: The specified channel name is invalid. The channel name cannot be empty nor longer than 64 bytes in length. For supported characters, see the channelName parameter in joinChannel. You can display a pop-up box in the application that says: "The channel name is invalid.
Please try to rejoin the channel with a valid channel name."
◆ CONNECTION_CHANGED_INVALID_TOKEN
|
static |
8: The token is invalid, probably due to the following reasons:
- The App Certificate for the project is enabled in the Agora Console, but you do not use a token to authenticate the user when calling
joinChannel. When the App Certificate for a project is enabled, you must use tokens to authenticate users. - The user ID that you specify in the
joinChannelmethod is different from the user ID that you pass for generating the token. Check whether the token used by the user is the same as the token generated at your app server, and then try to rejoin the channel with a valid token.
◆ CONNECTION_CHANGED_TOKEN_EXPIRED
|
static |
9: The token has expired. The user using the expired token is forced to leave the channel. The app client needs to request a new token from the app server and then try to rejoin the channel with the new token.
◆ CONNECTION_CHANGED_REJECTED_BY_SERVER
|
static |
10: The user is banned by the server. This error usually occurs in the following situations:
-
When the user is already in the channel, and still calls the method to join the channel, for example,
joinChannel. -
When the user tries to join a channel during a call test (
startEchoTest). Once you callstartEchoTest, you need to callstopEchoTestbefore joining a channel.
◆ CONNECTION_CHANGED_SETTING_PROXY_SERVER
|
static |
11: The SDK tries to reconnect after setting a proxy server.
◆ CONNECTION_CHANGED_RENEW_TOKEN
|
static |
12: The token renews.
◆ CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED
|
static |
13: Due to a change of the network type, IP address, or network port, the client IP address has changed, and the SDK tries to reconnect. If this state occurs multiple times, you can display a pop-up box in the application that says: "The network connection is not stable. Please switch to another network."
◆ CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT
|
static |
14: Timeout for the keep-alive of the connection between the SDK and Agora edge server. The connection state changes to CONNECTION_STATE_RECONNECTING(4).
◆ CONNECTION_CHANGED_SAME_UID_LOGIN
|
static |
19: Join the same channel from different devices using the same user ID.
- Since
- v3.7.0
◆ CONNECTION_CHANGED_TOO_MANY_BROADCASTERS
|
static |
20: The number of hosts in the channel is already at the upper limit.
- Note
- This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
- Since
- v3.7.0
◆ NETWORK_TYPE_UNKNOWN
|
static |
-1: The network type is unknown.
◆ NETWORK_TYPE_DISCONNECTED
|
static |
0: The SDK disconnects from the network.
◆ NETWORK_TYPE_LAN
|
static |
1: The network type is LAN.
◆ NETWORK_TYPE_WIFI
|
static |
2: The network type is Wi-Fi (including hotspots).
◆ NETWORK_TYPE_MOBILE_2G
|
static |
3: The network type is mobile 2G.
◆ NETWORK_TYPE_MOBILE_3G
|
static |
4: The network type is mobile 3G.
◆ NETWORK_TYPE_MOBILE_4G
|
static |
5: The network type is mobile 4G.
◆ NETWORK_TYPE_MOBILE_5G
|
static |
6: The network type is mobile 5G.
- Since
- v3.5.1
◆ STREAM_LIFE_CYCLE_BIND2CHANNEL
|
static |
- Deprecated:
- 1: Binds the RTMP or RTMPS stream lifecycle to the channel lifecycle. If all hosts leave the channel, CDN live streaming stops after 30 seconds.
◆ STREAM_LIFE_CYCLE_BIND2OWNER
|
static |
- Deprecated:
- 2: Binds the RTMP or RTMPS stream lifecycle to the owner of the RTMP or RTMPS stream. If the owner leaves the channel, CDN live streaming stops immediately.
◆ AUDIO_RECORDING_QUALITY_LOW
|
static |
0: Low quality. For example, the size of an AAC file with a sample rate of 32,000 Hz and 10-minute recording is approximately 1.2 MB.
◆ AUDIO_RECORDING_QUALITY_MEDIUM
|
static |
1: (Default) Medium quality. For example, the size of an AAC file with a sample rate of 32,000 Hz and 10-minute recording is approximately 2 MB.
◆ AUDIO_RECORDING_QUALITY_HIGH
|
static |
2: High quality. For example, the size of an AAC file with a sample rate of 32,000 Hz and 10-minute recording is approximately 3.75 MB.
◆ AUDIO_RECORDING_QUALITY_ULTRA_HIGH
|
static |
3: Ultra-high quality. For example, the size of an AAC file with a sample rate of 32,000 Hz and a 10-minute recording is approximately 7.5 MB.
- Since
- v3.6.2
◆ AUDIO_RECORDING_POSITION_MIXED_RECORDING_AND_PLAYBACK
|
static |
0: (Default) Records the mixed audio of the local user and all remote users.
◆ AUDIO_RECORDING_POSITION_RECORDING
|
static |
1: Records the audio of the local user only.
◆ AUDIO_RECORDING_POSITION_MIXED_PLAYBACK
|
static |
2: Records the audio of all remote users only.
◆ MEDIA_TYPE_NONE
|
static |
0: None.
◆ MEDIA_TYPE_AUDIO_ONLY
|
static |
1: Audio only.
◆ MEDIA_TYPE_VIDEO_ONLY
|
static |
2: Video only.
◆ MEDIA_TYPE_AUDIO_AND_VIDEO
|
static |
3: Audio and video.
◆ MAX_CROSS_DEST_CHANNEL_SIZE
|
static |
4: The maximum number of destination channels.
◆ STREAM_FALLBACK_OPTION_DISABLED
|
static |
0: No fallback behavior for the local/remote streams when the uplink/downlink network condition is poor. The quality of the stream is not guaranteed.
◆ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW
|
static |
1: Under poor downlink network conditions, the remotely subscribed stream falls back to the low-stream (low-resolution and low-bitrate) video. You can only set this option in the setRemoteSubscribeFallbackOption method. Nothing happens when you set this in the setLocalPublishFallbackOption method.
◆ STREAM_FALLBACK_OPTION_AUDIO_ONLY
|
static |
2:
- Under poor uplink network conditions, the locally published stream falls back audio only.
- Under poor downlink network conditions, the remotely subscribed stream first falls back to the low-stream (low-resolution and low-bitrate) video; and then to an audio-only stream if the network condition deteriorates.
◆ LOCAL_VIDEO_STREAM_STATE_STOPPED
|
static |
0: The local video is in the initial state.
◆ LOCAL_VIDEO_STREAM_STATE_CAPTURING
|
static |
1: The local video capturer starts successfully.
◆ LOCAL_VIDEO_STREAM_STATE_ENCODING
|
static |
2: The first local video frame encodes successfully.
◆ LOCAL_VIDEO_STREAM_STATE_FAILED
|
static |
3: The local video fails to start.
◆ LOCAL_VIDEO_STREAM_ERROR_OK
|
static |
0: The local video is normal.
◆ LOCAL_VIDEO_STREAM_ERROR_FAILURE
|
static |
1: No specified reason for the local video failure.
◆ LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION
|
static |
2: The application does not have permission to start the local video capture device. Remind your user to grant permission and rejoin the channel.
◆ LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY
|
static |
3: The local video capture device is in use. Remind your user to check whether another application occupies the camera.
◆ LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE
|
static |
4: The local video capture failed. Check whether the video capture device is working properly, check whether the camera is occupied by another application, or try to rejoin the channel.
◆ LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE
|
static |
5: The local video encoding fails.
◆ LOCAL_VIDEO_STREAM_ERROR_DEVICE_NOT_FOUND
|
static |
8: The SDK cannot find the local video capture device. Check whether the camera is connected to the device properly, check whether the camera is working properly, or try to rejoin the channel.
- Since
- v3.4.0
◆ LOCAL_AUDIO_STREAM_STATE_STOPPED
|
static |
0: The local audio is in the initial state.
◆ LOCAL_AUDIO_STREAM_STATE_CAPTURING
|
static |
1: The sampling device starts successfully.
◆ LOCAL_AUDIO_STREAM_STATE_ENCODING
|
static |
2: The first local audio frame encodes successfully.
◆ LOCAL_AUDIO_STREAM_STATE_FAILED
|
static |
3: The local audio fails to start.
◆ LOCAL_AUDIO_STREAM_ERROR_OK
|
static |
0: The local audio is normal.
◆ LOCAL_AUDIO_STREAM_ERROR_FAILURE
|
static |
1: No specified reason for the local audio error. Remind your user to try to rejoin the channel.
◆ LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION
|
static |
2: The application does not have permission to start the local audio capture device. Remind your user to grant permission.
◆ LOCAL_AUDIO_STREAM_ERROR_DEVICE_BUSY
|
static |
3: The local audio capture device is used. Remind your user to check whether another application occupies the microphone. Local audio capture automatically resumes after the microphone is idle for about five seconds. You can also try to rejoin the channel after the microphone is idle.
◆ LOCAL_AUDIO_STREAM_ERROR_CAPTURE_FAILURE
|
static |
4: The local audio capture failed.
◆ LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE
|
static |
5: The local audio encoding fails.
◆ LOCAL_AUDIO_STREAM_ERROR_INTERRUPTED
|
static |
8: The local audio capture is interrupted by a system call or alarm clock. Remind your user to end the phone call or alarm clock if the local audio capture is required.
- Since
- v3.4.5
◆ REMOTE_AUDIO_STATE_STOPPED
|
static |
0: The remote audio is in the default state, probably due to REMOTE_AUDIO_REASON_LOCAL_DISABLE_AUDIO(3), REMOTE_AUDIO_REASON_REMOTE_MUTED(5), or REMOTE_AUDIO_REASON_REMOTE_OFFLINE(7).
◆ REMOTE_AUDIO_STATE_STARTING
|
static |
1: The first remote audio packet is received.
◆ REMOTE_AUDIO_STATE_DECODING
|
static |
2: The remote audio stream is decoded and plays normally, probably due to REMOTE_AUDIO_REASON_NETWORK_RECOVERY(2), REMOTE_AUDIO_REASON_LOCAL_ENABLE_AUDIO(4), or REMOTE_AUDIO_REASON_REMOTE_UNMUTED(6).
◆ REMOTE_AUDIO_STATE_FROZEN
|
static |
3: The remote audio is frozen, probably due to REMOTE_AUDIO_REASON_NETWORK_CONGESTION(1).
◆ REMOTE_AUDIO_STATE_FAILED
|
static |
4: The remote audio fails to start, probably due to REMOTE_AUDIO_REASON_INTERNAL(0).
◆ REMOTE_AUDIO_REASON_INTERNAL
|
static |
0: Internal reasons.
◆ REMOTE_AUDIO_REASON_NETWORK_CONGESTION
|
static |
1: The remote user's network is congested. If the network conditions are persistently poor, display a pop-up box in the application that says "The remote user's network conditions are poor".
◆ REMOTE_AUDIO_REASON_NETWORK_RECOVERY
|
static |
2: The remote user's network conditions are restored from congested to normal. You can display a pop-up box in the application that says "The remote user's network conditions have improved".
◆ REMOTE_AUDIO_REASON_LOCAL_MUTED
|
static |
3: The local user stops receiving the remote audio stream or disables the audio module. You can display a pop-up box in the application that says "You have muted the remote user".
◆ REMOTE_AUDIO_REASON_LOCAL_UNMUTED
|
static |
4: The local user resumes receiving the remote audio stream or enables the audio module. You can display a pop-up box in the application that says "You have unmuted the remote user".
◆ REMOTE_AUDIO_REASON_REMOTE_MUTED
|
static |
5: The remote user stops sending the audio stream or disables the audio module. You can use an icon in the list of users in the application user interface to show that the remote user is muted and display a pop-up box in the application that says "The remote user has muted themselves".
◆ REMOTE_AUDIO_REASON_REMOTE_UNMUTED
|
static |
6: The remote user resumes sending the audio stream or enables the audio module. You can use an icon in the list of users in the application user interface to show that the remote user is unmuted and display a pop-up box in the application that says "The remote user has unmuted themselves".
◆ REMOTE_AUDIO_REASON_REMOTE_OFFLINE
|
static |
7: The remote user leaves the channel. You can remove the remote user from the user list in the application user interface.
◆ REMOTE_VIDEO_STATE_STOPPED
|
static |
0: The remote video is in the default state, probably due to REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED(3), REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED(5), or REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE(7).
◆ REMOTE_VIDEO_STATE_STARTING
|
static |
1: The first remote video packet is received.
◆ REMOTE_VIDEO_STATE_DECODING
|
static |
2: The remote video stream is decoded and plays normally, probably due to REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY(2), REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED(4), REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED(6), or REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY(9).
◆ REMOTE_VIDEO_STATE_FROZEN
|
static |
3: The remote video is frozen, probably due to REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION(1) or REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK(8).
◆ REMOTE_VIDEO_STATE_FAILED
|
static |
4: The remote video fails to start, probably due to REMOTE_VIDEO_STATE_REASON_INTERNAL(0).
◆ REMOTE_VIDEO_STATE_REASON_INTERNAL
|
static |
0: Internal reasons.
◆ REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION
|
static |
1: The remote user's network is congested. If the network conditions are persistently poor, display a pop-up box in the application that says "The remote user's network conditions are poor".
◆ REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY
|
static |
2: The remote user's network conditions are restored from congested to normal. You can display a pop-up box in the application that says "The remote user's network conditions have improved".
◆ REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED
|
static |
3: The local user stops receiving the remote video stream or disables the video module. You can close the window to render the remote user's video and display a pop-up box in the application that says "You have stopped receiving video from the remote user".
◆ REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED
|
static |
4: The local user resumes receiving the remote video stream or enables the video module. You can restore the window to render the remote user's video and display a pop-up box in the application that says "You have resumed receiving video from the remote user".
◆ REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED
|
static |
5: he remote user stops sending the video stream or disables the video module. You can close the window to render the remote user's video, use an icon in the list of users in the application user interface to show that the remote user has stopped sending video, and display a pop-up box in the application that says "The remote user has disabled the camera".
◆ REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED
|
static |
6: The remote user resumes sending the video stream or enables the video module. You can restore the window to render the remote user's video, use an icon in the list of users in the application user interface to show that the remote user has resumed sending video, and display a pop-up box in the application that says "The remote user has enabled the camera".
◆ REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE
|
static |
7: The remote user leaves the channel. You can close the window to render the remote user's video and remove the remote user from the user list in the application user interface.
◆ REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK
|
static |
8: The remote audio-and-video stream falls back to the audio-only stream due to poor network conditions. You can close the window to render the remote user's video and display a pop-up box in the application that says "The remote user's network conditions are poor".
◆ REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY
|
static |
9: The remote audio-only stream switches back to the audio-and-video stream after the network conditions improve. You can restore the window to render the remote user's video and display a pop-up box in the application that says "The remote user's network conditions are poor".
◆ REMOTE_VIDEO_STATE_REASON_SDK_IN_BACKGROUND
|
static |
10: The SDK reports this error code to the local user when a remote user is using the iOS app and the app is in the background. In this case, the local user sees the remote user's video stuck.
◆ PUB_STATE_IDLE
|
static |
0: The initial publishing state after joining the channel.
◆ PUB_STATE_NO_PUBLISHED
|
static |
1: Fails to publish the local stream. Possible reasons:
- The local user calls
muteLocalAudioStream(true) ormuteLocalVideoStream(true) to stop sending local streams. - The local user calls
disableAudioordisableVideoto disable the entire audio or video module. - The local user calls
enableLocalAudio(false) orenableLocalVideo(false) to disable the local audio sampling or video capturing. - The role of the local user is
AUDIENCE.
◆ PUB_STATE_PUBLISHING
|
static |
2: Publishing the local stream.
◆ PUB_STATE_PUBLISHED
|
static |
3: Successfully publishes the local stream.
◆ SUB_STATE_IDLE
|
static |
0: The initial subscribing state after joining the channel.
◆ SUB_STATE_NO_SUBSCRIBED
|
static |
1: Fails to subscribing to the remote stream. Possible reasons:
- The remote user:
- Calls
muteLocalAudioStream(true) ormuteLocalVideoStream(true) to stop sending local streams. - Calls
disableAudioordisableVideoto disable the entire audio or video modules. - Calls
enableLocalAudio(false) orenableLocalVideo(false) to disable the local audio sampling or video capturing. - The role of the remote user is
AUDIENCE.
- Calls
- The local user calls the following methods to stop receiving remote streams:
- Calls
muteRemoteAudioStream(true),muteAllRemoteAudioStreams(true), orsetDefaultMuteAllRemoteAudioStreams(true) to stop receiving remote audio streams. - Calls
muteRemoteVideoStream(true),muteAllRemoteVideoStreams(true), orsetDefaultMuteAllRemoteVideoStreams(true) to stop receiving remote video streams.
- Calls
◆ SUB_STATE_SUBSCRIBING
|
static |
2: Subscribing.
◆ SUB_STATE_SUBSCRIBED
|
static |
3: Subscribes to and receives the remote stream successfully.
◆ SR_STATE_REASON_SUCCESS
|
static |
0: Super resolution is successfully enabled.
◆ SR_STATE_REASON_STREAM_OVER_LIMITATION
|
static |
1: The original resolution of the remote video is beyond the range where super resolution can be applied.
◆ SR_STATE_REASON_USER_COUNT_OVER_LIMITATION
|
static |
2: Super resolution is already being used to boost another remote user's video.
◆ SR_STATE_REASON_DEVICE_NOT_SUPPORTED
|
static |
3: The device does not support using super resolution.
◆ SR_STATE_REASON_INSUFFICIENT_PERFORMANCE
|
static |
4: When the super resolution feature is enabled or is running, the SDK detects that device performance is not qualified. When you receive this reason code, Agora recommends that the user disable super resolution.
- Since
- v3.7.1
◆ SR_MODE_MANUAL
|
static |
0: Enables super resolution for the remote user you specify.
- Since
- v3.7.1
◆ SR_MODE_AUTO
|
static |
1: Enables super resolution for the remote user corresponding to the largest rendering window in the channel.
- Since
- v3.7.1
◆ RTMP_STREAM_PUBLISH_STATE_IDLE
|
static |
0: The RTMP or RTMPS streaming has not started or has ended.
◆ RTMP_STREAM_PUBLISH_STATE_CONNECTING
|
static |
1: The SDK is connecting to Agora streaming server and the CDN server. This state is triggered after you call the addPublishStreamUrl method.
◆ RTMP_STREAM_PUBLISH_STATE_RUNNING
|
static |
2: The RTMP or RTMPS streaming publishes. The SDK successfully publishes the RTMP or RTMPS streaming and returns this state.
◆ RTMP_STREAM_PUBLISH_STATE_RECOVERING
|
static |
3: The RTMP or RTMPS streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK attempts to resume RTMP or RTMPS streaming and returns this state.
-
If the SDK successfully resumes the streaming,
RTMP_STREAM_PUBLISH_STATE_RUNNING(2)returns. -
If the streaming does not resume within 60 seconds or server errors occur,
RTMP_STREAM_PUBLISH_STATE_FAILURE(4)returns. You can also reconnect to the server by calling theremovePublishStreamUrlandaddPublishStreamUrlmethods.
◆ RTMP_STREAM_PUBLISH_STATE_FAILURE
|
static |
4: The RTMP or RTMPS streaming fails. See the errCode parameter for the detailed error information. You can also call the addPublishStreamUrl method to publish the RTMP or RTMPS streaming again.
◆ RTMP_STREAM_PUBLISH_STATE_DISCONNECTING
|
static |
5: The SDK is disconnecting from the Agora streaming server and CDN. When you call remove or stop to stop the streaming normally, the SDK reports the streaming state as DISCONNECTING, IDLE in sequence.
- Since
- v3.6.0
◆ RTMP_STREAM_PUBLISH_ERROR_OK
|
static |
0: The RTMP or RTMPS streaming publishes successfully.
◆ RTMP_STREAM_PUBLISH_ERROR_INVALID_ARGUMENT
|
static |
1: Invalid argument used. If, for example, you do not call the setLiveTranscoding method to configure the LiveTranscoding parameters before calling the addPublishStreamUrl method, the SDK returns this error. Check whether you set the parameters in the setLiveTranscoding method properly.
◆ RTMP_STREAM_PUBLISH_ERROR_ENCRYPTED_STREAM_NOT_ALLOWED
|
static |
2: The RTMP or RTMPS streaming is encrypted and cannot be published.
◆ RTMP_STREAM_PUBLISH_ERROR_CONNECTION_TIMEOUT
|
static |
3: Timeout for the RTMP or RTMPS streaming. Call the ddPublishStreamUrl method to publish the streaming again.
◆ RTMP_STREAM_PUBLISH_ERROR_INTERNAL_SERVER_ERROR
|
static |
4: An error occurs in Agora streaming server. Call the addPublishStreamUrl method to publish the streaming again.
◆ RTMP_STREAM_PUBLISH_ERROR_RTMP_SERVER_ERROR
|
static |
5: An error occurs in the CDN server.
◆ RTMP_STREAM_PUBLISH_ERROR_TOO_OFTEN
|
static |
6: Reserved.
◆ RTMP_STREAM_PUBLISH_ERROR_REACH_LIMIT
|
static |
7: The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones.
◆ RTMP_STREAM_PUBLISH_ERROR_NOT_AUTHORIZED
|
static |
8: The host manipulates other hosts' URLs. Check your app logic.
◆ RTMP_STREAM_PUBLISH_ERROR_STREAM_NOT_FOUND
|
static |
9: Agora server fails to find the RTMP or RTMPS streaming.
◆ RTMP_STREAM_PUBLISH_ERROR_FORMAT_NOT_SUPPORTED
|
static |
10: The format of the CDN streaming URL is not supported. Check whether the URL format is correct.
◆ RTMP_STREAM_PUBLISH_ERROR_NOT_BROADCASTER
|
static |
11: The user role is not host, so the user cannot use the CDN live streaming function. Check your application code logic.
- Since
- v3.6.0
◆ RTMP_STREAM_PUBLISH_ERROR_TRANSCODING_NO_MIX_STREAM
|
static |
13: The updateRtmpTranscoding or setLiveTranscoding method is called to update the transcoding configuration in a scenario where there is streaming without transcoding. Check your application code logic.
- Since
- v3.6.0
◆ RTMP_STREAM_PUBLISH_ERROR_NET_DOWN
|
static |
14: Errors occurred in the host's network.
- Since
- v3.6.0
◆ RTMP_STREAM_PUBLISH_ERROR_INVALID_APPID
|
static |
15: Your App ID does not have permission to use the CDN live streaming function. Refer to Prerequisites to enable the CDN live streaming permission.
- Since
- v3.6.0
◆ RTMP_STREAM_UNPUBLISH_ERROR_OK
|
static |
100: The streaming has been stopped normally. After you call removePublishStreamUrl to stop streaming, the SDK returns this value.
- Since
- v3.4.5
◆ RELAY_OK
|
static |
0: The state is normal.
◆ RELAY_ERROR_SERVER_ERROR_RESPONSE
|
static |
1: An error occurs in the server response.
◆ RELAY_ERROR_SERVER_NO_RESPONSE
|
static |
2: No server response. This error can also occur if your project has not enabled the service for cohosting across channels. Contact support@agora.io to enable the service for cohosting across channels before starting a channel media relay.
You can call the leaveChannel method to leave the channel.
◆ RELAY_ERROR_NO_RESOURCE_AVAILABLE
|
static |
3: The SDK fails to access the service, probably due to limited resources of the server.
◆ RELAY_ERROR_FAILED_JOIN_SRC
|
static |
4: Fails to send the relay request.
◆ RELAY_ERROR_FAILED_JOIN_DEST
|
static |
5: Fails to accept the relay request.
◆ RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC
|
static |
6: The server fails to receive the media stream.
◆ RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST
|
static |
7: The server fails to send the media stream.
◆ RELAY_ERROR_SERVER_CONNECTION_LOST
|
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
|
static |
9: An internal error occurs in the server.
◆ RELAY_ERROR_SRC_TOKEN_EXPIRED
|
static |
10: The token of the source channel has expired.
◆ RELAY_ERROR_DEST_TOKEN_EXPIRED
|
static |
11: The token of the destination channel has expired.
◆ RELAY_EVENT_NETWORK_DISCONNECTED
|
static |
0: The user disconnects from the server due to poor network connections.
◆ RELAY_EVENT_NETWORK_CONNECTED
|
static |
1: The network reconnects.
◆ RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL
|
static |
2: The user joins the source channel.
◆ RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL
|
static |
3: The user joins the destination channel.
◆ RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL
|
static |
4: The SDK starts relaying the media stream to the destination channel.
◆ RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC
|
static |
5: The server receives the video stream from the source channel.
◆ RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC
|
static |
6: The server receives the audio stream from the source channel.
◆ RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL
|
static |
7: The destination channel is updated.
◆ RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED
|
static |
8: The destination channel update fails due to internal reasons.
◆ RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE
|
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
|
static |
10: The destination channel name is NULL.
◆ RELAY_EVENT_VIDEO_PROFILE_UPDATE
|
static |
11: The video profile is sent to the server.
◆ RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS
|
static |
12: The SDK successfully pauses relaying the media stream to destination channels.
◆ RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_FAILED
|
static |
13: The SDK fails to pause relaying the media stream to destination channels.
◆ RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS
|
static |
14: The SDK successfully resumes relaying the media stream to destination channels.
◆ RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_FAILED
|
static |
15: The SDK fails to resume relaying the media stream to destination channels.
◆ RELAY_STATE_IDLE
|
static |
0: The initial state. After you successfully stop the channel media relay by calling stopChannelMediaRelay, the onChannelMediaRelayStateChanged callback returns this state.
◆ RELAY_STATE_CONNECTING
|
static |
1: The SDK tries to relay the media stream to the destination channel.
◆ RELAY_STATE_RUNNING
|
static |
2: The SDK successfully relays the media stream to the destination channel.
◆ RELAY_STATE_FAILURE
|
static |
3: A failure occurs.
◆ VBS_STATE_REASON_SUCCESS
|
static |
0: The virtual background is successfully enabled.
◆ VBS_STATE_REASON_IMAGE_NOT_EXIST
|
static |
1: The custom background image does not exist. Please check the value of source in VirtualBackgroundSource.
◆ VBS_STATE_REASON_COLOR_FORMAT_NOT_SUPPORTED
|
static |
2: The color format of the custom background image is invalid. Please check the value of color in VirtualBackgroundSource.
◆ VBS_STATE_REASON_DEVICE_NOT_SUPPORTED
|
static |
3: The device does not support using the virtual background.
◆ VBS_STATE_REASON_INSUFFICIENT_PERFORMANCE
|
static |
4: When the virtual background feature is enabled or is running, the SDK detects that device performance is not qualified. When you receive this reason code, Agora recommends that the user disable virtual background.
- Since
- v3.7.1
◆ ERROR_SUCCESS
|
static |
Snaptshot has been taken successfully .
◆ ERROR_OPEN_FAILED
|
static |
Open the file path failed.
◆ ERROR_NO_STREAM
|
static |
No stream captured.
◆ RTC_APP_TYPE_NATIVE
|
static |
0: Default
◆ RTC_APP_TYPE_COCOS
|
static |
1: COCOS
◆ RTC_APP_TYPE_UNITY
|
static |
2: UNITY
◆ RTC_APP_TYPE_ELECTRON
|
static |
3: ELECTRON
◆ RTC_APP_TYPE_FLUTTER
|
static |
4: FLUTTER
◆ RTC_APP_TYPE_UNREAL
|
static |
5: UNREAL
◆ RTC_APP_TYPE_XAMARIN
|
static |
6: XAMARIN
◆ RTC_APP_TYPE_APICLOUD
|
static |
7: APICLOUD
◆ TRANSPORT_TYPE_NONE_PROXY
|
static |
0: The automatic mode. In this mode, the SDK attempts a direct connection to SD-RTN™ and automatically switches to TLS 443 if the attempt fails. As of v3.6.2, the SDK has this mode enabled by default.
◆ TRANSPORT_TYPE_UDP_PROXY
|
static |
1: The cloud proxy for the UDP protocol, that is, the Force UDP cloud proxy mode. In this mode, the SDK always transmits data over UDP.
◆ TRANSPORT_TYPE_TCP_PROXY
|
static |
2: The cloud proxy for the TCP (encryption) protocol, that is, the Force TCP cloud proxy mode. In this mode, the SDK always transmits data over TLS 443.
- Since
- v3.6.2
◆ PROXY_TYPE_NONE_PROXY
|
static |
0: Reserved for future use.
- Since
- v3.6.2
◆ PROXY_TYPE_UDP_CLOUD_PROXY
|
static |
1: The cloud proxy for the UDP protocol, that is, the Force UDP cloud proxy mode. In this mode, the SDK always transmits data over UDP.
- Since
- v3.6.2
◆ PROXY_TYPE_TCP_CLOUD_PROXY
|
static |
2: The cloud proxy for the TCP (encryption) protocol, that is, the Force TCP cloud proxy mode. In this mode, the SDK always transmits data over TLS 443.
- Since
- v3.6.2
◆ PROXY_TYPE_LOCAL_PROXY
|
static |
3: Reserved for future use.
- Since
- v3.6.2
◆ PROXY_TYPE_TCP_AUTO_FALLBACK
|
static |
4: The automatic mode. In this mode, the SDK attempts a direct connection to SD-RTN™ and automatically switches to TLS 443 if the attempt fails.
- Since
- v3.6.2
◆ AUDIO_FILE_INFO_ERROR_OK
|
static |
0: Successfully get the information of an audio file.
◆ AUDIO_FILE_INFO_ERROR_FAILURE
|
static |
1: Fail to get the information of an audio file.
◆ LOCAL_RPOXY_CONNECTIVITY_FIRST
|
static |
0: connectivity first
◆ LOCAL_RPOXY_LOCAL_ONLY
|
static |
1: local only
◆ CLIENT_ROLE_CHANGE_FAILED_BY_TOO_MANY_BROADCASTERS
|
static |
1: The number of hosts in the channel is already at the upper limit.
- Note
- This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
- Since
- v3.7.0
◆ CLIENT_ROLE_CHANGE_FAILED_BY_NOT_AUTHORIZED
|
static |
2: The request is rejected by the Agora server. Agora recommends you prompt the user to try to switch their user role again.
- Since
- v3.7.0
◆ CLIENT_ROLE_CHANGE_FAILED_BY_REQUEST_TIME_OUT
|
static |
3: The request is timed out. Agora recommends you prompt the user to check the network connection and try to switch their user role again.
- Since
- v3.7.0
◆ CLIENT_ROLE_CHANGE_FAILED_BY_CONNECTION_FAILED
|
static |
4: The SDK connection fails. You can use reason reported in the onConnectionStateChanged callback to troubleshoot the failure.
- Since
- v3.7.0
◆ ERR_SCREEN_CAPTURE_PERMISSION_DENIED
|
static |
16: The user refuses to grant screen capture permission to the application.
- Since
- v3.7.0
◆ ERR_SCREEN_CAPTURE_SYSTEM_NOT_SUPPORTED
|
static |
2: Due to system limitations, screen capture is not available on systems earlier than Android 5 (that is, Android API level 21). The SDK reports this error code when you call startScreenCapture on systems earlier than Android 5.
- Since
- v3.7.0
◆ ERR_SCREEN_CAPTURE_SYSTEM_AUDIO_NOT_SUPPORTED
|
static |
3: Due to system limitations, system audio cannot be captured on systems earlier than Android 10 (that is, API level 29). The SDK reports this error when you call startScreenCapture and set captureAudio as true on systems later than Android 5 (API level 21) and earlier than Android 10 (API level 29).
- Since
- v3.7.0
