Package io.agora.rtc2

Class Constants

java.lang.Object
io.agora.rtc2.Constants

public class Constants extends Object
Rating of the media or network quality.
  • Field Details

    • LASTMILE_PROBE_RESULT_COMPLETE

      public static final int LASTMILE_PROBE_RESULT_COMPLETE
      1: The last-mile probe result is complete.
      See Also:
    • LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE

      public static final int LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE
      2: The last-mile network probe test is incomplete and the bandwidth estimation is not available, probably due to limited test resources.
      See Also:
    • LASTMILE_PROBE_RESULT_UNAVAILABLE

      public static final int LASTMILE_PROBE_RESULT_UNAVAILABLE
      3: The last-mile network probe test is not carried out, probably due to poor network conditions.
      See Also:
    • QUALITY_UNKNOWN

      public static final int QUALITY_UNKNOWN
      The quality is unknown.
      See Also:
    • QUALITY_EXCELLENT

      public static final int QUALITY_EXCELLENT
      The quality is excellent.
      See Also:
    • QUALITY_GOOD

      public static final int QUALITY_GOOD
      The quality is quite good, but the bitrate may be slightly lower than excellent.
      See Also:
    • QUALITY_POOR

      public static final int QUALITY_POOR
      Users can feel the communication slightly impaired.
      See Also:
    • QUALITY_BAD

      public static final int QUALITY_BAD
      Users can communicate not very smoothly.
      See Also:
    • QUALITY_VBAD

      public static final int QUALITY_VBAD
      The quality is so bad that users can barely communicate.
      See Also:
    • QUALITY_DOWN

      public static final int QUALITY_DOWN
      Users cannot communicate at all.
      See Also:
    • QUALITY_UNSUPPORTED

      public static final int QUALITY_UNSUPPORTED
      7: (For future use) The network quality cannot be detected.
      See Also:
    • QUALITY_DETECTING

      public static final int QUALITY_DETECTING
      8: Detecting the network quality.
      See Also:
    • WARN_INVALID_VIEW

      public static final int WARN_INVALID_VIEW
      The specified view is invalid. It is required to specify a view when using the video call function.
      See Also:
    • WARN_INIT_VIDEO

      public static final int WARN_INIT_VIDEO
      Failed to initialize the video function.
      See Also:
    • WARN_PENDING

      public static final int WARN_PENDING
      The request is pending, usually due to some module not being ready, and the SDK postponed processing the request.
      See Also:
    • WARN_NO_AVAILABLE_CHANNEL

      public static final int WARN_NO_AVAILABLE_CHANNEL
      No channel resources are available. Maybe because the server cannot allocate any channel resource.
      See Also:
    • WARN_LOOKUP_CHANNEL_TIMEOUT

      public static final int WARN_LOOKUP_CHANNEL_TIMEOUT
      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.
      See Also:
    • WARN_LOOKUP_CHANNEL_REJECTED

      public static final int WARN_LOOKUP_CHANNEL_REJECTED
      The server rejected the request to look up the channel. The server cannot process this request or the request is illegal.
      See Also:
    • WARN_OPEN_CHANNEL_TIMEOUT

      public static final int WARN_OPEN_CHANNEL_TIMEOUT
      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.
      See Also:
    • WARN_OPEN_CHANNEL_REJECTED

      public static final int WARN_OPEN_CHANNEL_REJECTED
      The server rejected the request to open the channel. The server cannot process this request or the request is illegal.
      See Also:
    • WARN_SWITCH_LIVE_VIDEO_TIMEOUT

      public static final int WARN_SWITCH_LIVE_VIDEO_TIMEOUT
      A timeout when switching the live video.
      See Also:
    • WARN_SET_CLIENT_ROLE_TIMEOUT

      public static final int WARN_SET_CLIENT_ROLE_TIMEOUT
      A timeout when setting the client role in the broadcast mode.
      See Also:
    • WARN_SET_CLIENT_ROLE_NOT_AUTHORIZED

      public static final int WARN_SET_CLIENT_ROLE_NOT_AUTHORIZED
      The client role is not authorized.
      See Also:
    • WARN_OPEN_CHANNEL_INVALID_TICKET

      public static final int WARN_OPEN_CHANNEL_INVALID_TICKET
      The ticket to open the channel is invalid.
      See Also:
    • WARN_OPEN_CHANNEL_TRY_NEXT_VOS

      public static final int WARN_OPEN_CHANNEL_TRY_NEXT_VOS
      Try connecting to another server.
      See Also:
    • WARN_AUDIO_MIXING_OPEN_ERROR

      public static final int WARN_AUDIO_MIXING_OPEN_ERROR
      Error in opening the audio mixing.
      See Also:
    • WARN_ADM_RUNTIME_PLAYOUT_WARNING

      public static final int WARN_ADM_RUNTIME_PLAYOUT_WARNING
      Audio Device Module: A warning in the runtime playback device.
      See Also:
    • WARN_ADM_RUNTIME_RECORDING_WARNING

      public static final int WARN_ADM_RUNTIME_RECORDING_WARNING
      Audio Device Module: A warning in the runtime recording device.
      See Also:
    • WARN_ADM_RECORD_AUDIO_SILENCE

      public static final int WARN_ADM_RECORD_AUDIO_SILENCE
      Audio Device Module: No valid audio data is collected.
      See Also:
    • WARN_ADM_RECORD_AUDIO_LOWLEVEL

      public static final int WARN_ADM_RECORD_AUDIO_LOWLEVEL
      Audio Device Module: The recorded audio volume is too low.
      See Also:
    • WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL

      public static final int WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL
      Audio Device Module: The playback audio volume is too low.
      See Also:
    • WARN_ADM_RECORD_IS_OCCUPIED

      public static final int WARN_ADM_RECORD_IS_OCCUPIED
      Audio Device Module: The recording device is occupied.
      See Also:
    • WARN_APM_HOWLING

      public static final int WARN_APM_HOWLING
      Audio Device Module: Howling is detected.
      See Also:
    • WARN_ADM_GLITCH_STATE

      public static final int WARN_ADM_GLITCH_STATE
      Audio Device Module: The device is in the glitch state.
      See Also:
    • WARN_ADM_IMPROPER_SETTINGS

      public static final int WARN_ADM_IMPROPER_SETTINGS
      Audio Device Module: The settings are improper.
      See Also:
    • WARN_ADM_POP_STATE

      public static final int WARN_ADM_POP_STATE
      Audio Device Module: The device is in the pop state.
      See Also:
    • ERR_OK

      public static final int ERR_OK
      No error occurs.
      See Also:
    • ERR_FAILED

      public static final int ERR_FAILED
      A general error occurs (no specified reason).
      See Also:
    • ERR_INVALID_ARGUMENT

      public static final int ERR_INVALID_ARGUMENT
      An invalid parameter is used. For example, the specific channel name includes illegal characters.
      See Also:
    • ERR_NOT_READY

      public static final int ERR_NOT_READY
      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.
      See Also:
    • ERR_NOT_SUPPORTED

      public static final int ERR_NOT_SUPPORTED
      The SDK does not support this function.
      See Also:
    • ERR_REFUSED

      public static final int ERR_REFUSED
      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.
      See Also:
    • ERR_BUFFER_TOO_SMALL

      public static final int ERR_BUFFER_TOO_SMALL
      The buffer size is not big enough to store the returned data.
      See Also:
    • ERR_NOT_INITIALIZED

      public static final int ERR_NOT_INITIALIZED
      The SDK is not initialized before calling this API.
      See Also:
    • ERR_INVALID_STATE

      public static final int ERR_INVALID_STATE
      The state is invalid.
      See Also:
    • ERR_NO_PERMISSION

      public static final int ERR_NO_PERMISSION
      No permission. Check if the user has granted access to the audio or video device.
      See Also:
    • ERR_TIMEDOUT

      public static final int ERR_TIMEDOUT
      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.
      See Also:
    • ERR_CANCELED

      public static final int ERR_CANCELED
      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.
      See Also:
    • ERR_TOO_OFTEN

      public static final int ERR_TOO_OFTEN
      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.
      See Also:
    • ERR_BIND_SOCKET

      public static final int ERR_BIND_SOCKET
      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.
      See Also:
    • ERR_NET_DOWN

      public static final int ERR_NET_DOWN
      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.
      See Also:
    • ERR_JOIN_CHANNEL_REJECTED

      public static final int ERR_JOIN_CHANNEL_REJECTED
      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, joinChannel().
      See Also:
    • ERR_LEAVE_CHANNEL_REJECTED

      public static final int ERR_LEAVE_CHANNEL_REJECTED
      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, leaveChannel().
      See Also:
    • ERR_ALREADY_IN_USE

      public static final int ERR_ALREADY_IN_USE
      Resources are occupied, and cannot be reused.
      See Also:
    • ERR_ABORTED

      public static final int ERR_ABORTED
      The SDK gives up the request due to too many requests. This is for internal use only, and does not return to the app through any method or callback.
      See Also:
    • ERR_INIT_NET_ENGINE

      public static final int ERR_INIT_NET_ENGINE
      On Windows, specific firewall settings can cause the SDK to fail to initialize and crash.
      See Also:
    • ERR_RESOURCE_LIMITED

      public static final int ERR_RESOURCE_LIMITED
      The app uses too much of the system resource and the SDK fails to allocate any resource.
      See Also:
    • ERR_INVALID_APP_ID

      public static final int ERR_INVALID_APP_ID
      The specified App ID is invalid.
      See Also:
    • ERR_INVALID_CHANNEL_NAME

      public static final int ERR_INVALID_CHANNEL_NAME
      The specified channel name is invalid.
      See Also:
    • ERR_NO_SERVER_RESOURCES

      public static final int ERR_NO_SERVER_RESOURCES
      Fails to get server resources in the specified region.
      See Also:
    • ERR_TOKEN_EXPIRED

      public static final int ERR_TOKEN_EXPIRED

      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.
      See Also:
    • ERR_INVALID_TOKEN

      public static final int ERR_INVALID_TOKEN
      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.
      See Also:
    • ERR_CONNECTION_INTERRUPTED

      public static final int ERR_CONNECTION_INTERRUPTED
      The CONNECTION_INTERRUPTED callback. This applies to the Agora Web SDK only.
      See Also:
    • ERR_CONNECTION_LOST

      public static final int ERR_CONNECTION_LOST
      The CONNECTION_LOST callback. This applies to the Agora Web SDK only.
      See Also:
    • ERR_NOT_IN_CHANNEL

      public static final int ERR_NOT_IN_CHANNEL
      The user is not in the channel.
      See Also:
    • ERR_SIZE_TOO_LARGE

      public static final int ERR_SIZE_TOO_LARGE
      The data size is too big.
      See Also:
    • ERR_BITRATE_LIMIT

      public static final int ERR_BITRATE_LIMIT
      The bitrate is limited.
      See Also:
    • ERR_TOO_MANY_DATA_STREAMS

      public static final int ERR_TOO_MANY_DATA_STREAMS
      Too many data streams.
      See Also:
    • ERR_STREAM_MESSAGE_TIMEOUT

      public static final int ERR_STREAM_MESSAGE_TIMEOUT
      A timeout occurs for the data stream transmission.
      See Also:
    • ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED

      public static final int ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED
      Switching the user role fails. Please try to rejoin the channel.
      See Also:
    • ERR_DECRYPTION_FAILED

      public static final int ERR_DECRYPTION_FAILED
      Failed to decrypt mediastream.
      See Also:
    • ERR_INVALID_USER_ID

      public static final int ERR_INVALID_USER_ID
      The user ID is invalid.
      See Also:
    • ERR_DATASTREAM_DECRYPTION_FAILED

      public static final int ERR_DATASTREAM_DECRYPTION_FAILED
      Failed to decrypt datastream.
      See Also:
    • ERR_CLIENT_IS_BANNED_BY_SERVER

      public static final int ERR_CLIENT_IS_BANNED_BY_SERVER
      The client is banned by the server.
      See Also:
    • ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH

      public static final int ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH
      Encryption is enabled when the user calls the addPublishStreamUrl method (CDN live streaming does not support encrypted streams).
      See Also:
    • ERR_LICENSE_CREDENTIAL_INVALID

      public static final int ERR_LICENSE_CREDENTIAL_INVALID
      License credential is invalid
      See Also:
    • ERR_INVALID_USER_ACCOUNT

      public static final int ERR_INVALID_USER_ACCOUNT
      The user account is invalid, usually because the data format of the user account is incorrect.
      See Also:
    • ERR_MODULE_NOT_FOUND

      public static final int ERR_MODULE_NOT_FOUND
      The extension library is not integrated, such as the library for enabling deep-learning noise reduction.
      See Also:
    • ERR_RDT_USER_NOT_EXIST

      public static final int ERR_RDT_USER_NOT_EXIST
      250: The user does not exist
      See Also:
    • ERR_RDT_USER_NOT_READY

      public static final int ERR_RDT_USER_NOT_READY
      251: The RDT state with the user is not ready
      See Also:
    • ERR_RDT_DATA_BLOCKED

      public static final int ERR_RDT_DATA_BLOCKED
      252: The RDT data stream is blocked
      See Also:
    • ERR_RDT_CMD_EXCEED_LIMIT

      public static final int ERR_RDT_CMD_EXCEED_LIMIT
      253: The RDT CMD stream exceeds the limit (size <= 256 Bytes, freq <= 100/sec)
      See Also:
    • ERR_RDT_DATA_EXCEED_LIMIT

      public static final int ERR_RDT_DATA_EXCEED_LIMIT
      254: The RDT DATA stream exceeds the limit (size <= 128 KBytes, speed <= 4 Mbps)
      See Also:
    • ERR_RDT_ENCRYPTION

      public static final int ERR_RDT_ENCRYPTION
      255: The RDT encryption error. The SDK Failed to process RDT data encryption/decryption
      See Also:
    • ERR_LOAD_MEDIA_ENGINE

      public static final int ERR_LOAD_MEDIA_ENGINE
      Failed to load the media engine.
      See Also:
    • ERR_ADM_GENERAL_ERROR

      public static final int ERR_ADM_GENERAL_ERROR
      General error on the Audio Device Module (no classified reason).
      See Also:
    • ERR_ADM_INIT_PLAYOUT

      public static final int ERR_ADM_INIT_PLAYOUT
      Audio Device Module: Error in initializing the playback device.
      See Also:
    • ERR_ADM_START_PLAYOUT

      public static final int ERR_ADM_START_PLAYOUT
      Audio Device Module: Error in starting the playback device.
      See Also:
    • ERR_ADM_STOP_PLAYOUT

      public static final int ERR_ADM_STOP_PLAYOUT
      Audio Device Module: Error in stopping the playback device.
      See Also:
    • ERR_ADM_INIT_RECORDING

      public static final int ERR_ADM_INIT_RECORDING
      Audio Device Module: Error in initializing the recording device.
      See Also:
    • ERR_ADM_START_RECORDING

      public static final int ERR_ADM_START_RECORDING
      Audio Device Module: Error in starting the recording device.
      See Also:
    • ERR_ADM_STOP_RECORDING

      public static final int ERR_ADM_STOP_RECORDING
      Audio Device Module: Error in stopping the recording device.
      See Also:
    • ERR_AUDIO_BT_SCO_FAILED

      public static final int ERR_AUDIO_BT_SCO_FAILED
      See Also:
    • ERR_VDM_CAMERA_NOT_AUTHORIZED

      public static final int ERR_VDM_CAMERA_NOT_AUTHORIZED
      Video Device Module: The camera is not authorized.
      See Also:
    • VIDEO_PROFILE_120P

      @Deprecated public static final int VIDEO_PROFILE_120P
      Deprecated.
      0, 160 x 120 @ 15 fps, 65 kbit/s
      See Also:
    • VIDEO_PROFILE_120P_3

      @Deprecated public static final int VIDEO_PROFILE_120P_3
      Deprecated.
      120 x 120 @ 15 fps, 50 kbit/s
      See Also:
    • VIDEO_PROFILE_180P

      @Deprecated public static final int VIDEO_PROFILE_180P
      Deprecated.
      320 x 180 @ 15 fps, 140 kbit/s
      See Also:
    • VIDEO_PROFILE_180P_3

      @Deprecated public static final int VIDEO_PROFILE_180P_3
      Deprecated.
      180 x 180 @ 15 fps, 100 kbit/s
      See Also:
    • VIDEO_PROFILE_180P_4

      @Deprecated public static final int VIDEO_PROFILE_180P_4
      Deprecated.
      240 x 180 @ 15 fps, 120 kbit/s
      See Also:
    • VIDEO_PROFILE_240P

      @Deprecated public static final int VIDEO_PROFILE_240P
      Deprecated.
      320 x 240 @ 15 fps, 200 kbit/s
      See Also:
    • VIDEO_PROFILE_240P_3

      @Deprecated public static final int VIDEO_PROFILE_240P_3
      Deprecated.
      240 x 240 @ 15 fps, 140 kbit/s
      See Also:
    • VIDEO_PROFILE_240P_4

      @Deprecated public static final int VIDEO_PROFILE_240P_4
      Deprecated.
      424 x 240 @ 15 fps, 220 kbit/s
      See Also:
    • VIDEO_PROFILE_360P

      @Deprecated public static final int VIDEO_PROFILE_360P
      Deprecated.
      640 x 360 @ 15 fps, 400 kbit/s
      See Also:
    • VIDEO_PROFILE_360P_3

      @Deprecated public static final int VIDEO_PROFILE_360P_3
      Deprecated.
      360 x 360 @ 15 fps, 260 kbit/s
      See Also:
    • VIDEO_PROFILE_360P_4

      @Deprecated public static final int VIDEO_PROFILE_360P_4
      Deprecated.
      640 x 360 @ 30 fps, 600 kbit/s
      See Also:
    • VIDEO_PROFILE_360P_6

      @Deprecated public static final int VIDEO_PROFILE_360P_6
      Deprecated.
      360 x 360 @ 30 fps, 400 kbit/s
      See Also:
    • VIDEO_PROFILE_360P_7

      @Deprecated public static final int VIDEO_PROFILE_360P_7
      Deprecated.
      480 x 360 @ 15 fps, 320 kbit/s
      See Also:
    • VIDEO_PROFILE_360P_8

      @Deprecated public static final int VIDEO_PROFILE_360P_8
      Deprecated.
      480 x 360 @ 30 fps, 490 kbit/s
      See Also:
    • VIDEO_PROFILE_360P_9

      @Deprecated public static final int VIDEO_PROFILE_360P_9
      Deprecated.
      640 x 360 @ 15 fps, 600 kbit/s
      See Also:
    • VIDEO_PROFILE_360P_10

      @Deprecated public static final int VIDEO_PROFILE_360P_10
      Deprecated.
      640 x 360 @ 24 fps, 800 kbit/s
      See Also:
    • VIDEO_PROFILE_360P_11

      @Deprecated public static final int VIDEO_PROFILE_360P_11
      Deprecated.
      640 x 360 @ 24 fps, 1000 kbit/s
      See Also:
    • VIDEO_PROFILE_480P

      @Deprecated public static final int VIDEO_PROFILE_480P
      Deprecated.
      640 x 480 @ 15 fps, 500 kbit/s
      See Also:
    • VIDEO_PROFILE_480P_3

      @Deprecated public static final int VIDEO_PROFILE_480P_3
      Deprecated.
      480 x 480 @ 15 fps, 400 kbit/s
      See Also:
    • VIDEO_PROFILE_480P_4

      @Deprecated public static final int VIDEO_PROFILE_480P_4
      Deprecated.
      640 x 480 @ 30 fps, 750 kbit/s
      See Also:
    • VIDEO_PROFILE_480P_6

      @Deprecated public static final int VIDEO_PROFILE_480P_6
      Deprecated.
      480 x 480 @ 30 fps, 600 kbit/s
      See Also:
    • VIDEO_PROFILE_480P_8

      @Deprecated public static final int VIDEO_PROFILE_480P_8
      Deprecated.
      848 x 480 @ 15 fps, 610 kbit/s
      See Also:
    • VIDEO_PROFILE_480P_9

      @Deprecated public static final int VIDEO_PROFILE_480P_9
      Deprecated.
      848 x 480 @ 30 fps, 930 kbit/s
      See Also:
    • VIDEO_PROFILE_480P_10

      @Deprecated public static final int VIDEO_PROFILE_480P_10
      Deprecated.
      640 x 480 @ 10 fps, 400 kbit/s
      See Also:
    • VIDEO_PROFILE_720P

      @Deprecated public static final int VIDEO_PROFILE_720P
      Deprecated.
      1280 x 720 @ 15 fps, 1130 kbit/s
      See Also:
    • VIDEO_PROFILE_720P_3

      @Deprecated public static final int VIDEO_PROFILE_720P_3
      Deprecated.
      1280 x 720 @ 30 fps, 1710 kbit/s
      See Also:
    • VIDEO_PROFILE_720P_5

      @Deprecated public static final int VIDEO_PROFILE_720P_5
      Deprecated.
      960 x 720 @ 15 fps, 910 kbit/s
      See Also:
    • VIDEO_PROFILE_720P_6

      @Deprecated public static final int VIDEO_PROFILE_720P_6
      Deprecated.
      960 x 720 @ 30 fps, 1380 kbit/s
      See Also:
    • VIDEO_PROFILE_1080P

      @Deprecated public static final int VIDEO_PROFILE_1080P
      Deprecated.
      1920 x 1080 @ 15 fps, 2080 kbit/s
      See Also:
    • VIDEO_PROFILE_1080P_3

      @Deprecated public static final int VIDEO_PROFILE_1080P_3
      Deprecated.
      1920 x 1080 @ 30 fps, 3150 kbit/s
      See Also:
    • VIDEO_PROFILE_1080P_5

      @Deprecated public static final int VIDEO_PROFILE_1080P_5
      Deprecated.
      1920 x 1080 @ 60 fps, 4780 kbit/s
      See Also:
    • VIDEO_PROFILE_1440P

      @Deprecated public static final int VIDEO_PROFILE_1440P
      Deprecated.
      2560 x 1440 @ 30 fps, 4850 kbit/s
      See Also:
    • VIDEO_PROFILE_1440P_2

      @Deprecated public static final int VIDEO_PROFILE_1440P_2
      Deprecated.
      2560 x 1440 @ 60 fps, 7350 kbit/s
      See Also:
    • VIDEO_PROFILE_4K

      @Deprecated public static final int VIDEO_PROFILE_4K
      Deprecated.
      3840 x 2160 @ 30 fps, 8910 kbit/s
      See Also:
    • VIDEO_PROFILE_4K_3

      @Deprecated public static final int VIDEO_PROFILE_4K_3
      Deprecated.

      3840 x 2160 @ 60 fps, 13500 kbit/s

      See Also:
    • VIDEO_PROFILE_DEFAULT

      @Deprecated public static final int VIDEO_PROFILE_DEFAULT
      Deprecated.

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

      See Also:
    • AUDIO_PROFILE_DEFAULT

      public static final int AUDIO_PROFILE_DEFAULT
      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.
      See Also:
    • AUDIO_PROFILE_SPEECH_STANDARD

      public static final int AUDIO_PROFILE_SPEECH_STANDARD
      1: A sample rate of 32 kHz, audio encoding, mono, and a bitrate up to 18 Kbps.
      See Also:
    • AUDIO_PROFILE_MUSIC_STANDARD

      public static final int AUDIO_PROFILE_MUSIC_STANDARD
      2: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.
      See Also:
    • AUDIO_PROFILE_MUSIC_STANDARD_STEREO

      public static final int AUDIO_PROFILE_MUSIC_STANDARD_STEREO
      3: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 80 Kbps.
      See Also:
    • AUDIO_PROFILE_MUSIC_HIGH_QUALITY

      public static final int AUDIO_PROFILE_MUSIC_HIGH_QUALITY
      4: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 96 Kbps.
      See Also:
    • AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO

      public static final int AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO
      5: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 128 Kbps.
      See Also:
    • AUDIO_SCENARIO_DEFAULT

      public static final int AUDIO_SCENARIO_DEFAULT
      0: (Recommended) The default audio scenario.
      See Also:
    • AUDIO_SCENARIO_GAME_STREAMING

      public static final int AUDIO_SCENARIO_GAME_STREAMING
      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.
      See Also:
    • AUDIO_SCENARIO_CHATROOM

      public static final int AUDIO_SCENARIO_CHATROOM
      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.
      See Also:
    • AUDIO_SCENARIO_CHORUS

      public static final int AUDIO_SCENARIO_CHORUS
      7: The chorus scenario.
      See Also:
    • AUDIO_SCENARIO_MEETING

      public static final int AUDIO_SCENARIO_MEETING
      8: The Meeting scenario.
      See Also:
    • AUDIO_SCENARIO_AI_SERVER

      public static final int AUDIO_SCENARIO_AI_SERVER
      9: The AI server scenario.
      See Also:
    • AUDIO_SCENARIO_AI_CLIENT

      public static final int AUDIO_SCENARIO_AI_CLIENT
      10: The AI client scenario.
      See Also:
    • VOICE_BEAUTIFIER_OFF

      public static final int VOICE_BEAUTIFIER_OFF
      Turn off voice beautifier effects and use the original voice.
      See Also:
    • AUDIO_EFFECT_OFF

      public static final int AUDIO_EFFECT_OFF
      Turn off audio effects and use the original voice.
      See Also:
    • CHAT_BEAUTIFIER_MAGNETIC

      public static final int CHAT_BEAUTIFIER_MAGNETIC
      A more magnetic voice.
      See Also:
    • CHAT_BEAUTIFIER_FRESH

      public static final int CHAT_BEAUTIFIER_FRESH
      A fresher voice.
      See Also:
    • CHAT_BEAUTIFIER_VITALITY

      public static final int CHAT_BEAUTIFIER_VITALITY
      A more vital voice.
      See Also:
    • SINGING_BEAUTIFIER

      public static final int SINGING_BEAUTIFIER
      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 using `setVoiceBeautifierPreset(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
      See Also:
    • TIMBRE_TRANSFORMATION_VIGOROUS

      public static final int TIMBRE_TRANSFORMATION_VIGOROUS
      A more vigorous voice.
      See Also:
    • TIMBRE_TRANSFORMATION_DEEP

      public static final int TIMBRE_TRANSFORMATION_DEEP
      A deeper voice.
      See Also:
    • TIMBRE_TRANSFORMATION_MELLOW

      public static final int TIMBRE_TRANSFORMATION_MELLOW
      A mellower voice.
      See Also:
    • TIMBRE_TRANSFORMATION_FALSETTO

      public static final int TIMBRE_TRANSFORMATION_FALSETTO
      A falsetto voice.
      See Also:
    • TIMBRE_TRANSFORMATION_FULL

      public static final int TIMBRE_TRANSFORMATION_FULL
      A fuller voice.
      See Also:
    • TIMBRE_TRANSFORMATION_CLEAR

      public static final int TIMBRE_TRANSFORMATION_CLEAR
      A clearer voice.
      See Also:
    • TIMBRE_TRANSFORMATION_RESOUNDING

      public static final int TIMBRE_TRANSFORMATION_RESOUNDING
      A more resounding voice.
      See Also:
    • TIMBRE_TRANSFORMATION_RINGING

      public static final int TIMBRE_TRANSFORMATION_RINGING
      A more ringing voice.
      See Also:
    • ULTRA_HIGH_QUALITY_VOICE

      public static final int ULTRA_HIGH_QUALITY_VOICE
      A ultra high quality voice.
      See Also:
    • ROOM_ACOUSTICS_KTV

      public static final int ROOM_ACOUSTICS_KTV
      An audio effect typical of a KTV venue.
      See Also:
    • ROOM_ACOUSTICS_VOCAL_CONCERT

      public static final int ROOM_ACOUSTICS_VOCAL_CONCERT
      An audio effect typical of a concert hall.
      See Also:
    • ROOM_ACOUSTICS_STUDIO

      public static final int ROOM_ACOUSTICS_STUDIO
      An audio effect typical of a recording studio.
      See Also:
    • ROOM_ACOUSTICS_PHONOGRAPH

      public static final int ROOM_ACOUSTICS_PHONOGRAPH
      An audio effect typical of a vintage phonograph.
      See Also:
    • ROOM_ACOUSTICS_VIRTUAL_STEREO

      public static final int ROOM_ACOUSTICS_VIRTUAL_STEREO
      A virtual stereo effect that renders monophonic audio as stereo audio.
      See Also:
    • ROOM_ACOUSTICS_SPACIAL

      public static final int ROOM_ACOUSTICS_SPACIAL
      A more spatial audio effect.
      See Also:
    • ROOM_ACOUSTICS_ETHEREAL

      public static final int ROOM_ACOUSTICS_ETHEREAL
      A more ethereal audio effect.
      See Also:
    • ROOM_ACOUSTICS_3D_VOICE

      public static final int ROOM_ACOUSTICS_3D_VOICE
      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.
      See Also:
    • ROOM_ACOUSTICS_VIRTUAL_SURROUND_SOUND

      public static final int ROOM_ACOUSTICS_VIRTUAL_SURROUND_SOUND
      virtual suround sound.
      See Also:
    • ROOM_ACOUSTICS_CHORUS

      public static final int ROOM_ACOUSTICS_CHORUS
      An audio effect for chorus.
      See Also:
    • VOICE_CHANGER_EFFECT_UNCLE

      public static final int VOICE_CHANGER_EFFECT_UNCLE
      The voice of a middle-aged man.
      See Also:
    • VOICE_CHANGER_EFFECT_OLDMAN

      public static final int VOICE_CHANGER_EFFECT_OLDMAN
      The voice of an old man.
      See Also:
    • VOICE_CHANGER_EFFECT_BOY

      public static final int VOICE_CHANGER_EFFECT_BOY
      The voice of a boy.
      See Also:
    • VOICE_CHANGER_EFFECT_SISTER

      public static final int VOICE_CHANGER_EFFECT_SISTER
      The voice of a young woman.
      See Also:
    • VOICE_CHANGER_EFFECT_GIRL

      public static final int VOICE_CHANGER_EFFECT_GIRL
      The voice of a girl.
      See Also:
    • VOICE_CHANGER_EFFECT_PIGKING

      public static final int VOICE_CHANGER_EFFECT_PIGKING
      The voice of Pig King, a character in Journey to the West who has a voice like a growling bear.
      See Also:
    • VOICE_CHANGER_EFFECT_HULK

      public static final int VOICE_CHANGER_EFFECT_HULK
      The voice of Hulk.
      See Also:
    • STYLE_TRANSFORMATION_RNB

      public static final int STYLE_TRANSFORMATION_RNB
      An audio effect typical of R&B music.
      See Also:
    • PITCH_CORRECTION

      public static final int PITCH_CORRECTION
      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.
      See Also:
    • VOICE_CONVERSION_OFF

      public static final int VOICE_CONVERSION_OFF
      Turn off voice conversion effects and use the original voice.
      Since:
      v3.3.1.
      See Also:
    • VOICE_CHANGER_NEUTRAL

      public static final int VOICE_CHANGER_NEUTRAL
      A gender-neutral voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
      Since:
      v3.3.1.
      See Also:
    • VOICE_CHANGER_SWEET

      public static final int VOICE_CHANGER_SWEET
      A sweet voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
      Since:
      v3.3.1.
      See Also:
    • VOICE_CHANGER_SOLID

      public static final int VOICE_CHANGER_SOLID
      A steady voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.
      Since:
      v3.3.1.
      See Also:
    • VOICE_CHANGER_BASS

      public static final int VOICE_CHANGER_BASS
      A deep voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.
      Since:
      v3.3.1.
      See Also:
    • VOICE_CHANGER_CARTOON

      public static final int VOICE_CHANGER_CARTOON
      A voice like a cartoon character.
      Since:
      v4.1.0.
      See Also:
    • VOICE_CHANGER_CHILDLIKE

      public static final int VOICE_CHANGER_CHILDLIKE
      A voice like a child.
      Since:
      v4.1.0.
      See Also:
    • VOICE_CHANGER_PHONE_OPERATOR

      public static final int VOICE_CHANGER_PHONE_OPERATOR
      A voice like a phone operator.
      Since:
      v4.1.0.
      See Also:
    • VOICE_CHANGER_MONSTER

      public static final int VOICE_CHANGER_MONSTER
      A monster voice.
      Since:
      v4.1.0.
      See Also:
    • VOICE_CHANGER_TRANSFORMERS

      public static final int VOICE_CHANGER_TRANSFORMERS
      A voice like Transformers.
      Since:
      v4.1.0.
      See Also:
    • VOICE_CHANGER_GROOT

      public static final int VOICE_CHANGER_GROOT
      A voice like Groot.
      Since:
      v4.1.0.
      See Also:
    • VOICE_CHANGER_DARTH_VADER

      public static final int VOICE_CHANGER_DARTH_VADER
      A voice like Darth Vader.
      Since:
      v4.1.0.
      See Also:
    • VOICE_CHANGER_IRON_LADY

      public static final int VOICE_CHANGER_IRON_LADY
      A rough female voice.
      Since:
      v4.1.0.
      See Also:
    • VOICE_CHANGER_SHIN_CHAN

      public static final int VOICE_CHANGER_SHIN_CHAN
      A voice like Crayon Shin-chan.
      Since:
      v4.1.0.
      See Also:
    • VOICE_CHANGER_GIRLISH_MAN

      public static final int VOICE_CHANGER_GIRLISH_MAN
      A voice like a castrato.
      Since:
      v4.1.0.
      See Also:
    • VOICE_CHANGER_CHIPMUNK

      public static final int VOICE_CHANGER_CHIPMUNK
      A voice like chipmunk.
      Since:
      v4.1.0.
      See Also:
    • HEADPHONE_EQUALIZER_OFF

      public static final int HEADPHONE_EQUALIZER_OFF
      Turn off headphone EQ and use the original voice.
      See Also:
    • HEADPHONE_EQUALIZER_OVEREAR

      public static final int HEADPHONE_EQUALIZER_OVEREAR
      For over-ear headphones.
      See Also:
    • HEADPHONE_EQUALIZER_INEAR

      public static final int HEADPHONE_EQUALIZER_INEAR
      For in-ear headphones.
      See Also:
    • CHANNEL_PROFILE_COMMUNICATION

      public static final int CHANNEL_PROFILE_COMMUNICATION
      0: Communication. Use this profile when there are two users in the channel.
      See Also:
    • CHANNEL_PROFILE_LIVE_BROADCASTING

      public static final int CHANNEL_PROFILE_LIVE_BROADCASTING
      1: (Default) Live Broadcast. Use this profile when there are more than two users in the channel.
      See Also:
    • CHANNEL_PROFILE_GAME

      public static final int CHANNEL_PROFILE_GAME
      2: Gaming. This profile is deprecated.
      See Also:
    • CHANNEL_PROFILE_CLOUD_GAMING

      public static final int CHANNEL_PROFILE_CLOUD_GAMING
      3: Cloud Gaming. This profile is deprecated.
      See Also:
    • CHANNEL_PROFILE_COMMUNICATION_1v1

      public static final int CHANNEL_PROFILE_COMMUNICATION_1v1
      4: Communication 1v1. This profile is deprecated.
      See Also:
    • CLIENT_ROLE_BROADCASTER

      public static final int CLIENT_ROLE_BROADCASTER
      The broadcaster.
      See Also:
    • CLIENT_ROLE_AUDIENCE

      public static final int CLIENT_ROLE_AUDIENCE
      The audience.
      See Also:
    • AUDIENCE_LATENCY_LEVEL_LOW_LATENCY

      public static final int AUDIENCE_LATENCY_LEVEL_LOW_LATENCY
      1: Low latency. A low latency audience's jitter buffer is 1.2 second.
      See Also:
    • AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY

      public static final int AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY
      2: Ultra low latency. An ultra low latency audience's jitter buffer is 0.5 second.
      See Also:
    • USER_OFFLINE_QUIT

      public static final int USER_OFFLINE_QUIT
      0: The user has quit the call.
      See Also:
    • USER_OFFLINE_DROPPED

      public static final int USER_OFFLINE_DROPPED
      1. The SDK timed out and the user dropped offline because it has not received any data package for a period of time.
      See Also:
    • USER_OFFLINE_BECOME_AUDIENCE

      public static final int USER_OFFLINE_BECOME_AUDIENCE
      2. Triggered when the client role has changed from the broadcaster to the audience.
      See Also:
    • CAPTURE_BRIGHTNESS_LEVEL_INVALID

      public static final int CAPTURE_BRIGHTNESS_LEVEL_INVALID
      -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.
      See Also:
    • CAPTURE_BRIGHTNESS_LEVEL_NORMAL

      public static final int CAPTURE_BRIGHTNESS_LEVEL_NORMAL
      0: The brightness level of the video image is normal.
      See Also:
    • CAPTURE_BRIGHTNESS_LEVEL_BRIGHT

      public static final int CAPTURE_BRIGHTNESS_LEVEL_BRIGHT
      1: The brightness level of the video image is too bright.
      See Also:
    • CAPTURE_BRIGHTNESS_LEVEL_DARK

      public static final int CAPTURE_BRIGHTNESS_LEVEL_DARK
      2: The brightness level of the video image is too dark.
      See Also:
    • INJECT_STREAM_STATUS_START_SUCCESS

      public static final int INJECT_STREAM_STATUS_START_SUCCESS
      The external video stream imported successfully.
      See Also:
    • INJECT_STREAM_STATUS_START_ALREADY_EXISTS

      public static final int INJECT_STREAM_STATUS_START_ALREADY_EXISTS
      The external video stream already exists.
      See Also:
    • INJECT_STREAM_STATUS_START_UNAUTHORIZED

      public static final int INJECT_STREAM_STATUS_START_UNAUTHORIZED
      The external video stream import is unauthorized
      See Also:
    • INJECT_STREAM_STATUS_START_TIMEDOUT

      public static final int INJECT_STREAM_STATUS_START_TIMEDOUT
      Import external video stream timeout.
      See Also:
    • INJECT_STREAM_STATUS_START_FAILED

      public static final int INJECT_STREAM_STATUS_START_FAILED
      The external video stream failed to import.
      See Also:
    • INJECT_STREAM_STATUS_STOP_SUCCESS

      public static final int INJECT_STREAM_STATUS_STOP_SUCCESS
      The xternal video stream imports successfully.
      See Also:
    • INJECT_STREAM_STATUS_STOP_NOT_FOUND

      public static final int INJECT_STREAM_STATUS_STOP_NOT_FOUND
      No external video stream is found.
      See Also:
    • INJECT_STREAM_STATUS_STOP_UNAUTHORIZED

      public static final int INJECT_STREAM_STATUS_STOP_UNAUTHORIZED
      The external video stream is stopped from being unauthorized.
      See Also:
    • INJECT_STREAM_STATUS_STOP_TIMEDOUT

      public static final int INJECT_STREAM_STATUS_STOP_TIMEDOUT
      Importing the external video stream timeout.
      See Also:
    • INJECT_STREAM_STATUS_STOP_FAILED

      public static final int INJECT_STREAM_STATUS_STOP_FAILED
      Importing the external video stream failed.
      See Also:
    • INJECT_STREAM_STATUS_BROKEN

      public static final int INJECT_STREAM_STATUS_BROKEN
      The external video stream is broken.
      See Also:
    • QUALITY_REPORT_FORMAT_JSON

      public static final int QUALITY_REPORT_FORMAT_JSON
      The quality report in JSON format.
      See Also:
    • QUALITY_REPORT_FORMAT_HTML

      public static final int QUALITY_REPORT_FORMAT_HTML
      The quality report in HTML format.
      See Also:
    • RENDER_MODE_HIDDEN

      public static final int RENDER_MODE_HIDDEN
      1: Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.
      See Also:
    • RENDER_MODE_FIT

      public static final int RENDER_MODE_FIT
      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.
      See Also:
    • RENDER_MODE_ADAPTIVE

      public static final int RENDER_MODE_ADAPTIVE
      3: This mode is deprecated.
      See Also:
    • VIDEO_MIRROR_MODE_AUTO

      public static final int VIDEO_MIRROR_MODE_AUTO
      The default mirror mode, that is, the mode set by the SDK.
      See Also:
    • VIDEO_MIRROR_MODE_ENABLED

      public static final int VIDEO_MIRROR_MODE_ENABLED
      Enable the mirror mode.
      See Also:
    • VIDEO_MIRROR_MODE_DISABLED

      public static final int VIDEO_MIRROR_MODE_DISABLED
      Disable the mirror mode
      See Also:
    • SCREEN_CAPTURE_CONTENT_HINT_NONE

      public static final int SCREEN_CAPTURE_CONTENT_HINT_NONE
      0: No content hint.
      See Also:
    • SCREEN_CAPTURE_CONTENT_HINT_MOTION

      public static final int SCREEN_CAPTURE_CONTENT_HINT_MOTION
      1: Motion-intensive content. Choose this option if you prefer smoothness or when you are sharing a video clip, movie, or video game.
      See Also:
    • SCREEN_CAPTURE_CONTENT_HINT_DETAILS

      public static final int SCREEN_CAPTURE_CONTENT_HINT_DETAILS
      2: Motionless content. Choose this option if you prefer sharpness or when you are sharing a picture, PowerPoint slide, or text.
      See Also:
    • VIDEO_SOURCE_CAMERA_PRIMARY

      public static final int VIDEO_SOURCE_CAMERA_PRIMARY
      Video captured by the camera.
      See Also:
    • VIDEO_SOURCE_CAMERA_SECONDARY

      public static final int VIDEO_SOURCE_CAMERA_SECONDARY
      Video captured by the secondary camera.
      See Also:
    • VIDEO_SOURCE_SCREEN_PRIMARY

      public static final int VIDEO_SOURCE_SCREEN_PRIMARY
      Video for screen sharing.
      See Also:
    • VIDEO_SOURCE_SCREEN_SECONDARY

      public static final int VIDEO_SOURCE_SCREEN_SECONDARY
      Video for secondary screen sharing.
      See Also:
    • VIDEO_SOURCE_CUSTOM

      public static final int VIDEO_SOURCE_CUSTOM
      Not define.
      See Also:
    • VIDEO_SOURCE_MEDIA_PLAYER

      public static final int VIDEO_SOURCE_MEDIA_PLAYER
      Video for media player sharing.
      See Also:
    • VIDEO_SOURCE_RTC_IMAGE_PNG

      public static final int VIDEO_SOURCE_RTC_IMAGE_PNG
      Video for png image.
      See Also:
    • VIDEO_SOURCE_RTC_IMAGE_JPEG

      public static final int VIDEO_SOURCE_RTC_IMAGE_JPEG
      Video for png image.
      See Also:
    • VIDEO_SOURCE_RTC_IMAGE_GIF

      public static final int VIDEO_SOURCE_RTC_IMAGE_GIF
      Video for png image.
      See Also:
    • VIDEO_SOURCE_REMOTE

      public static final int VIDEO_SOURCE_REMOTE
      Remote video received from network.
      See Also:
    • VIDEO_SOURCE_TRANSCODED

      public static final int VIDEO_SOURCE_TRANSCODED
      Video for transcoded.
      See Also:
    • VIDEO_SOURCE_UNKNOWN

      public static final int VIDEO_SOURCE_UNKNOWN
      See Also:
    • LOG_FILTER_OFF

      public static final int LOG_FILTER_OFF
      Do not output any log.
      See Also:
    • LOG_FILTER_DEBUG

      public static final int LOG_FILTER_DEBUG
      Output all the API logs.
      See Also:
    • LOG_FILTER_INFO

      public static final int LOG_FILTER_INFO
      Output logs of the CRITICAL, ERROR, WARNING, and INFO level.
      See Also:
    • LOG_FILTER_WARNING

      public static final int LOG_FILTER_WARNING
      Output logs of the CRITICAL, ERROR, and WARNING level.
      See Also:
    • LOG_FILTER_ERROR

      public static final int LOG_FILTER_ERROR
      Output logs of the CRITICAL and ERROR level.
      See Also:
    • LOG_FILTER_CRITICAL

      public static final int LOG_FILTER_CRITICAL
      Output logs of the CRITICAL level.
      See Also:
    • LOG_LEVEL_NONE

      public static final int LOG_LEVEL_NONE
      Do not output any log file.
      See Also:
    • LOG_LEVEL_INFO

      public static final int LOG_LEVEL_INFO
      (Recommended) Output log files of the Info level.
      See Also:
    • LOG_LEVEL_WARNING

      public static final int LOG_LEVEL_WARNING
      Output log files of the Warning level.
      See Also:
    • LOG_LEVEL_ERROR

      public static final int LOG_LEVEL_ERROR
      Output log files of the Error level.
      See Also:
    • LOG_LEVEL_FATAL

      public static final int LOG_LEVEL_FATAL
      Output log files of the Critical level.
      See Also:
    • AUDIO_ROUTE_DEFAULT

      public static final int AUDIO_ROUTE_DEFAULT
      -1: The default audio route.
      See Also:
    • AUDIO_ROUTE_HEADSET

      public static final int AUDIO_ROUTE_HEADSET
      0: Headset.
      See Also:
    • AUDIO_ROUTE_EARPIECE

      public static final int AUDIO_ROUTE_EARPIECE
      1: Earpiece. The SDK uses the in-call volume.
      See Also:
    • AUDIO_ROUTE_HEADSETNOMIC

      public static final int AUDIO_ROUTE_HEADSETNOMIC
      2: Headset with no microphone.
      See Also:
    • AUDIO_ROUTE_SPEAKERPHONE

      public static final int AUDIO_ROUTE_SPEAKERPHONE
      3: Speakerphone.
      See Also:
    • AUDIO_ROUTE_LOUDSPEAKER

      public static final int AUDIO_ROUTE_LOUDSPEAKER
      4: Loudspeaker
      See Also:
    • AUDIO_ROUTE_BLUETOOTH_DEVICE_HFP

      public static final int AUDIO_ROUTE_BLUETOOTH_DEVICE_HFP
      5: Bluetooth Device HFP.
      See Also:
    • AUDIO_ROUTE_USBDEVICE

      public static final int AUDIO_ROUTE_USBDEVICE
      6: USB device.
      See Also:
    • AUDIO_ROUTE_HDMI

      public static final int AUDIO_ROUTE_HDMI
      7: HDMI device.
      See Also:
    • AUDIO_ROUTE_USB_HEADSET

      public static final int AUDIO_ROUTE_USB_HEADSET
      8: USB headset.
      See Also:
    • AUDIO_ROUTE_BLUETOOTH_DEVICE_A2DP

      public static final int AUDIO_ROUTE_BLUETOOTH_DEVICE_A2DP
      10: Bluetooth Device A2DP.
      See Also:
    • VIDEO_STREAM_HIGH

      public static final int VIDEO_STREAM_HIGH
      0: The high-stream video, that is, the video stream featuring in high resolution and high bitrate.
      See Also:
    • VIDEO_STREAM_LOW

      public static final int VIDEO_STREAM_LOW
      1: The low-stream video, that is, the video stream featuring in low resolution and low bitrate.
      See Also:
    • USER_PRIORITY_HIGH

      public static final int USER_PRIORITY_HIGH
      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.
      See Also:
    • USER_PRIORITY_NORANL

      public static final int USER_PRIORITY_NORANL
      Default priority.
      See Also:
    • HARDWARE_ENCODER

      public static final int HARDWARE_ENCODER
      Hardware encoder.
      See Also:
    • SOFTWARE_ENCODER

      public static final int SOFTWARE_ENCODER
      Software encoder.
      See Also:
    • RAW_AUDIO_FRAME_OP_MODE_READ_ONLY

      public static final int RAW_AUDIO_FRAME_OP_MODE_READ_ONLY
      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.
      See Also:
    • RAW_AUDIO_FRAME_OP_MODE_READ_WRITE

      public static final int RAW_AUDIO_FRAME_OP_MODE_READ_WRITE
      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.
      See Also:
    • POSITION_PLAYBACK

      public static final int POSITION_PLAYBACK
      `0x01`: The position for observing the playback audio of all remote users after mixing, which enables the SDK to trigger the onPlaybackFrame callback.
      See Also:
    • POSITION_RECORD

      public static final int POSITION_RECORD
      `0x01 << 1`: The position for observing the recorded audio of the local user, which enables the SDK to trigger the onRecordFrame callback.
      See Also:
    • POSITION_MIXED

      public static final int POSITION_MIXED
      `0x01 << 2`: The position for observing the mixed audio of the local user and all remote users, which enables the SDK to trigger the onMixedFrame callback.
      See Also:
    • POSITION_BEFORE_MIXING

      public static final int POSITION_BEFORE_MIXING
      `0x01 << 3`: The position for observing the audio of a single remote user before mixing, which enables the SDK to trigger the onPlaybackFrameBeforeMixing or onPlaybackFrameBeforeMixingEx callback.
      See Also:
    • POSITION_EAR_MONITORING

      public static final int POSITION_EAR_MONITORING
      `0x01 << 4`: The position for observing the ear monitoring audio of the local user, which enables the SDK to trigger the onEarMonitoringAudioFrame callback.
      See Also:
    • MEDIA_ENGINE_RECORDING_ERROR

      public static final int MEDIA_ENGINE_RECORDING_ERROR
      See Also:
    • MEDIA_ENGINE_PLAYOUT_ERROR

      public static final int MEDIA_ENGINE_PLAYOUT_ERROR
      See Also:
    • MEDIA_ENGINE_RECORDING_WARNING

      public static final int MEDIA_ENGINE_RECORDING_WARNING
      See Also:
    • MEDIA_ENGINE_PLAYOUT_WARNING

      public static final int MEDIA_ENGINE_PLAYOUT_WARNING
      See Also:
    • MEDIA_ENGINE_AUDIO_FILE_MIX_FINISH

      public static final int MEDIA_ENGINE_AUDIO_FILE_MIX_FINISH
      See Also:
    • MEDIA_ENGINE_ROLE_BROADCASTER_SOLO

      public static final int MEDIA_ENGINE_ROLE_BROADCASTER_SOLO
      See Also:
    • MEDIA_ENGINE_ROLE_BROADCASTER_INTERACTIVE

      public static final int MEDIA_ENGINE_ROLE_BROADCASTER_INTERACTIVE
      See Also:
    • MEDIA_ENGINE_ROLE_AUDIENCE

      public static final int MEDIA_ENGINE_ROLE_AUDIENCE
      See Also:
    • MEDIA_ENGINE_ROLE_COMM_PEER

      public static final int MEDIA_ENGINE_ROLE_COMM_PEER
      See Also:
    • NETWORK_TYPE_UNKNOWN

      public static final int NETWORK_TYPE_UNKNOWN
      -1: The network type is unknown.
      See Also:
    • NETWORK_TYPE_DISCONNECTED

      public static final int NETWORK_TYPE_DISCONNECTED
      0: The SDK disconnects from the network.
      See Also:
    • NETWORK_TYPE_LAN

      public static final int NETWORK_TYPE_LAN
      1: The network type is LAN.
      See Also:
    • NETWORK_TYPE_WIFI

      public static final int NETWORK_TYPE_WIFI
      2: The network type is Wi-Fi (including hotspots).
      See Also:
    • NETWORK_TYPE_MOBILE_2G

      public static final int NETWORK_TYPE_MOBILE_2G
      3: The network type is mobile 2G.
      See Also:
    • NETWORK_TYPE_MOBILE_3G

      public static final int NETWORK_TYPE_MOBILE_3G
      4: The network type is mobile 3G.
      See Also:
    • NETWORK_TYPE_MOBILE_4G

      public static final int NETWORK_TYPE_MOBILE_4G
      5: The network type is mobile 4G.
      See Also:
    • NETWORK_TYPE_MOBILE_5G

      public static final int NETWORK_TYPE_MOBILE_5G
      6: The network type is mobile 5G.
      See Also:
    • STREAM_LIFE_CYCLE_BIND2CHANNEL

      public static final int STREAM_LIFE_CYCLE_BIND2CHANNEL
      Bound to the channel lifecycle.
      See Also:
    • STREAM_LIFE_CYCLE_BIND2OWNER

      public static final int STREAM_LIFE_CYCLE_BIND2OWNER
      Bound to the owner of the RTMP stream.
      See Also:
    • AUDIO_FILE_RECORDING_MIC

      public static final int AUDIO_FILE_RECORDING_MIC
      1: mic audio file recording.
      See Also:
    • AUDIO_FILE_RECORDING_PLAYBACK

      public static final int AUDIO_FILE_RECORDING_PLAYBACK
      2: playback audio file recording.
      See Also:
    • AUDIO_FILE_RECORDING_MIXED

      public static final int AUDIO_FILE_RECORDING_MIXED
      3: mixed audio file recording, include mic and playback.
      See Also:
    • AUDIO_RECORDING_QUALITY_LOW

      public static final int AUDIO_RECORDING_QUALITY_LOW
      Low quality, file size is around 1.2 MB after 10 minutes of recording.
      See Also:
    • AUDIO_RECORDING_QUALITY_MEDIUM

      public static final int AUDIO_RECORDING_QUALITY_MEDIUM
      Medium quality, file size is around 2 MB after 10 minutes of recording.
      See Also:
    • AUDIO_RECORDING_QUALITY_HIGH

      public static final int AUDIO_RECORDING_QUALITY_HIGH
      High quality, file size is around 3.75 MB after 10 minutes of recording.
      See Also:
    • AUDIO_RECORDING_QUALITY_ULTRA_HIGH

      public static final int AUDIO_RECORDING_QUALITY_ULTRA_HIGH
      3: Ultra High quality. For example, the size of an AAC file with a sample rate of 32,000 Hz and 10-minute recording is approximately 7.5 MB.
      See Also:
    • AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIC

      public static final int AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIC
      1: mic audio frame observer
      See Also:
    • AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK

      public static final int AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK
      2: playback audio frame observer
      See Also:
    • AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED

      public static final int AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED
      3: mixed audio frame observer
      See Also:
    • AUDIO_ENCODING_TYPE_AAC_16000_LOW

      public static final int AUDIO_ENCODING_TYPE_AAC_16000_LOW
      1: codecType AAC; sampleRate 16000; quality low which around 1.2 MB after 10 minutes
      See Also:
    • AUDIO_ENCODING_TYPE_AAC_16000_MEDIUM

      public static final int AUDIO_ENCODING_TYPE_AAC_16000_MEDIUM
      2: codecType AAC; sampleRate 16000; quality medium which around 2 MB after 10 minutes
      See Also:
    • AUDIO_ENCODING_TYPE_AAC_32000_LOW

      public static final int AUDIO_ENCODING_TYPE_AAC_32000_LOW
      3: codecType AAC; sampleRate 32000; quality low which around 1.2 MB after 10 minutes
      See Also:
    • AUDIO_ENCODING_TYPE_AAC_32000_MEDIUM

      public static final int AUDIO_ENCODING_TYPE_AAC_32000_MEDIUM
      4: codecType AAC; sampleRate 32000; quality medium which around 2 MB after 10 minutes
      See Also:
    • AUDIO_ENCODING_TYPE_AAC_32000_HIGH

      public static final int AUDIO_ENCODING_TYPE_AAC_32000_HIGH
      5: codecType AAC; sampleRate 32000; quality high which around 3.5 MB after 10 minutes
      See Also:
    • AUDIO_ENCODING_TYPE_AAC_48000_MEDIUM

      public static final int AUDIO_ENCODING_TYPE_AAC_48000_MEDIUM
      6: codecType AAC; sampleRate 48000; quality medium which around 2 MB after 10 minutes
      See Also:
    • AUDIO_ENCODING_TYPE_AAC_48000_HIGH

      public static final int AUDIO_ENCODING_TYPE_AAC_48000_HIGH
      7: codecType AAC; sampleRate 48000; quality high which around 3.5 MB after 10 minutes
      See Also:
    • AUDIO_ENCODING_TYPE_OPUS_16000_LOW

      public static final int AUDIO_ENCODING_TYPE_OPUS_16000_LOW
      11: codecType OPUS; sampleRate 16000; quality low which around 1.2 MB after 10 minutes
      See Also:
    • AUDIO_ENCODING_TYPE_OPUS_16000_MEDIUM

      public static final int AUDIO_ENCODING_TYPE_OPUS_16000_MEDIUM
      12: codecType OPUS; sampleRate 16000; quality medium which around 2 MB after 10 minutes
      See Also:
    • AUDIO_ENCODING_TYPE_OPUS_48000_MEDIUM

      public static final int AUDIO_ENCODING_TYPE_OPUS_48000_MEDIUM
      13: codecType OPUS; sampleRate 48000; quality medium which around 2 MB after 10 minutes
      See Also:
    • AUDIO_ENCODING_TYPE_OPUS_48000_HIGH

      public static final int AUDIO_ENCODING_TYPE_OPUS_48000_HIGH
      14: codecType OPUS; sampleRate 48000; quality high which around 3.5 MB after 10 minutes
      See Also:
    • MEDIA_TYPE_NONE

      public static final int MEDIA_TYPE_NONE
      None
      See Also:
    • MEDIA_TYPE_AUDIO_ONLY

      public static final int MEDIA_TYPE_AUDIO_ONLY
      Audio only
      See Also:
    • MEDIA_TYPE_VIDEO_ONLY

      public static final int MEDIA_TYPE_VIDEO_ONLY
      Video only
      See Also:
    • MEDIA_TYPE_AUDIO_AND_VIDEO

      public static final int MEDIA_TYPE_AUDIO_AND_VIDEO
      Audio and video
      See Also:
    • STREAM_FALLBACK_OPTION_DISABLED

      public static final int STREAM_FALLBACK_OPTION_DISABLED
      See Also:
    • STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW

      public static final int STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW
      See Also:
    • STREAM_FALLBACK_OPTION_AUDIO_ONLY

      public static final int STREAM_FALLBACK_OPTION_AUDIO_ONLY
      See Also:
    • LOCAL_VIDEO_STREAM_STATE_STOPPED

      public static final int LOCAL_VIDEO_STREAM_STATE_STOPPED
      Initial state
      See Also:
    • LOCAL_VIDEO_STREAM_STATE_CAPTURING

      public static final int LOCAL_VIDEO_STREAM_STATE_CAPTURING
      The capturer starts successfully.
      See Also:
    • LOCAL_VIDEO_STREAM_STATE_ENCODING

      public static final int LOCAL_VIDEO_STREAM_STATE_ENCODING
      The first video frame is successfully encoded.
      See Also:
    • LOCAL_VIDEO_STREAM_STATE_FAILED

      public static final int LOCAL_VIDEO_STREAM_STATE_FAILED
      The local video fails to start.
      See Also:
    • LOCAL_VIDEO_STREAM_REASON_OK

      public static final int LOCAL_VIDEO_STREAM_REASON_OK
      0: The local video is normal.
      See Also:
    • LOCAL_VIDEO_STREAM_REASON_FAILURE

      public static final int LOCAL_VIDEO_STREAM_REASON_FAILURE
      1: No specified reason for the local video failure.
      See Also:
    • LOCAL_VIDEO_STREAM_REASON_DEVICE_NO_PERMISSION

      public static final int LOCAL_VIDEO_STREAM_REASON_DEVICE_NO_PERMISSION
      2: No permission to use the local video device.
      See Also:
    • LOCAL_VIDEO_STREAM_REASON_DEVICE_BUSY

      public static final int LOCAL_VIDEO_STREAM_REASON_DEVICE_BUSY
      3: The local video capturer is in use.
      See Also:
    • LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE

      public static final int LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE
      4: The local video capture fails. Check whether the capturer is working properly.
      See Also:
    • LOCAL_VIDEO_STREAM_REASON_CODEC_NOT_SUPPORT

      public static final int LOCAL_VIDEO_STREAM_REASON_CODEC_NOT_SUPPORT
      5: The local video encoding fails.
      See Also:
    • LOCAL_VIDEO_STREAM_REASON_DEVICE_NOT_FOUND

      public static final int LOCAL_VIDEO_STREAM_REASON_DEVICE_NOT_FOUND
      8: The local video device not found.
      See Also:
    • LOCAL_VIDEO_STREAM_REASON_DEVICE_INTERRUPT

      public static final int LOCAL_VIDEO_STREAM_REASON_DEVICE_INTERRUPT
      14: Video capture was interrupted, possibly due to the camera being occupied or some policy reasons such as background termination.
      See Also:
    • LOCAL_VIDEO_STREAM_REASON_DEVICE_FATAL_ERROR

      public static final int LOCAL_VIDEO_STREAM_REASON_DEVICE_FATAL_ERROR
      15: The device may need to be shut down and restarted to restore camera function, or there may be a persistent hardware problem.
      See Also:
    • LOCAL_AUDIO_STREAM_STATE_STOPPED

      public static final int LOCAL_AUDIO_STREAM_STATE_STOPPED
      0: The local audio is in the initial state.
      See Also:
    • LOCAL_AUDIO_STREAM_STATE_RECORDING

      public static final int LOCAL_AUDIO_STREAM_STATE_RECORDING
      1: The capturer starts successfully.
      See Also:
    • LOCAL_AUDIO_STREAM_STATE_ENCODING

      public static final int LOCAL_AUDIO_STREAM_STATE_ENCODING
      2: The first audio frame is successfully encoded.
      See Also:
    • LOCAL_AUDIO_STREAM_STATE_FAILED

      public static final int LOCAL_AUDIO_STREAM_STATE_FAILED
      3: The local audio fails to start.
      See Also:
    • LOCAL_AUDIO_STREAM_REASON_OK

      public static final int LOCAL_AUDIO_STREAM_REASON_OK
      0: The local audio is normal.
      See Also:
    • LOCAL_AUDIO_STREAM_REASON_FAILURE

      public static final int LOCAL_AUDIO_STREAM_REASON_FAILURE
      1: No specified reason for the local audio failure.
      See Also:
    • LOCAL_AUDIO_STREAM_REASON_DEVICE_NO_PERMISSION

      public static final int LOCAL_AUDIO_STREAM_REASON_DEVICE_NO_PERMISSION
      2: No permission to use the local audio device.
      See Also:
    • LOCAL_AUDIO_STREAM_REASON_DEVICE_BUSY

      public static final int LOCAL_AUDIO_STREAM_REASON_DEVICE_BUSY
      3: The microphone is in use.
      See Also:
    • LOCAL_AUDIO_STREAM_REASON_CAPTURE_FAILURE

      public static final int LOCAL_AUDIO_STREAM_REASON_CAPTURE_FAILURE
      4: The local audio capture failed. Check whether the audio capture device is working properly.
      See Also:
    • LOCAL_AUDIO_STREAM_REASON_ENCODE_FAILURE

      public static final int LOCAL_AUDIO_STREAM_REASON_ENCODE_FAILURE
      5: The local audio encoding fails.
      See Also:
    • LOCAL_AUDIO_STREAM_REASON_INTERRUPTED

      public static final int LOCAL_AUDIO_STREAM_REASON_INTERRUPTED
      8: The local audio capturing is interrupted by the system call.
      See Also:
    • REMOTE_AUDIO_STATE_STOPPED

      public static final int REMOTE_AUDIO_STATE_STOPPED
      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).
      See Also:
    • REMOTE_AUDIO_STATE_STARTING

      public static final int REMOTE_AUDIO_STATE_STARTING
      1: The first remote audio packet is received.
      See Also:
    • REMOTE_AUDIO_STATE_DECODING

      public static final int REMOTE_AUDIO_STATE_DECODING
      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).
      See Also:
    • REMOTE_AUDIO_STATE_FROZEN

      public static final int REMOTE_AUDIO_STATE_FROZEN
      3: The remote audio is frozen, probably due to REMOTE_AUDIO_REASON_NETWORK_CONGESTION(1).
      See Also:
    • REMOTE_AUDIO_STATE_FAILED

      public static final int REMOTE_AUDIO_STATE_FAILED
      4: The remote audio fails to start, probably due to REMOTE_AUDIO_REASON_INTERNAL(0).
      See Also:
    • REMOTE_AUDIO_REASON_INTERNAL

      public static final int REMOTE_AUDIO_REASON_INTERNAL
      0: Internal reasons.
      See Also:
    • REMOTE_AUDIO_REASON_NETWORK_CONGESTION

      public static final int REMOTE_AUDIO_REASON_NETWORK_CONGESTION
      1: Network congestion.
      See Also:
    • REMOTE_AUDIO_REASON_NETWORK_RECOVERY

      public static final int REMOTE_AUDIO_REASON_NETWORK_RECOVERY
      2: Network recovery.
      See Also:
    • REMOTE_AUDIO_REASON_LOCAL_MUTED

      public static final int REMOTE_AUDIO_REASON_LOCAL_MUTED
      3: The local user stops receiving the remote audio stream or disables the audio module.
      See Also:
    • REMOTE_AUDIO_REASON_LOCAL_UNMUTED

      public static final int REMOTE_AUDIO_REASON_LOCAL_UNMUTED
      4: The local user resumes receiving the remote audio stream or enables the audio module.
      See Also:
    • REMOTE_AUDIO_REASON_REMOTE_MUTED

      public static final int REMOTE_AUDIO_REASON_REMOTE_MUTED
      5: The remote user stops sending the audio stream or disables the audio module.
      See Also:
    • REMOTE_AUDIO_REASON_REMOTE_UNMUTED

      public static final int REMOTE_AUDIO_REASON_REMOTE_UNMUTED
      6: The remote user resumes sending the audio stream or enables the audio module.
      See Also:
    • REMOTE_AUDIO_REASON_REMOTE_OFFLINE

      public static final int REMOTE_AUDIO_REASON_REMOTE_OFFLINE
      7: The remote user leaves the channel.
      See Also:
    • REMOTE_AUDIO_REASON_NO_PACKET_RECEIVE

      public static final int REMOTE_AUDIO_REASON_NO_PACKET_RECEIVE
      8: The local user does not receive any audio packet from remote user.
      See Also:
    • REMOTE_AUDIO_REASON_LOCAL_PLAY_FAILED

      public static final int REMOTE_AUDIO_REASON_LOCAL_PLAY_FAILED
      9: The local user receives remote audio packet but fails to play.
      See Also:
    • REMOTE_VIDEO_STATE_STOPPED

      public static final int REMOTE_VIDEO_STATE_STOPPED
      Default state
      See Also:
    • REMOTE_VIDEO_STATE_STARTING

      public static final int REMOTE_VIDEO_STATE_STARTING
      1: video packet has been received, but not decoded yet.
      See Also:
    • REMOTE_VIDEO_STATE_DECODING

      public static final int REMOTE_VIDEO_STATE_DECODING
      2: Remote video stream is decoded and plays normally.
      See Also:
    • REMOTE_VIDEO_STATE_FROZEN

      public static final int REMOTE_VIDEO_STATE_FROZEN
      3: Remote video is frozen, probably due to network issue.
      See Also:
    • REMOTE_VIDEO_STATE_FAILED

      public static final int REMOTE_VIDEO_STATE_FAILED
      4: Failed.
      See Also:
    • REMOTE_VIDEO_STATE_REASON_INTERNAL

      public static final int REMOTE_VIDEO_STATE_REASON_INTERNAL
      0: Internal reasons.
      See Also:
    • REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION

      public static final int REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION
      1: Network congestion.
      See Also:
    • REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY

      public static final int REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY
      2: Network recovery.
      See Also:
    • REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED

      public static final int REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED
      3: The local user stops receiving the remote video stream or disables the video module.
      See Also:
    • REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED

      public static final int REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED
      4: The local user resumes receiving the remote video stream or enables the video module.
      See Also:
    • REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED

      public static final int REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED
      5: The remote user stops sending the video stream or disables the video module.
      See Also:
    • REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED

      public static final int REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED
      6: The remote user resumes sending the video stream or enables the video module.
      See Also:
    • REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE

      public static final int REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE
      7: The remote user leaves the channel.
      See Also:
    • REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK

      public static final int REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK
      8: The remote media stream falls back to the audio-only stream due to poor network conditions.
      See Also:
    • REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY

      public static final int REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY
      9: The remote media stream switches back to the video stream after the network conditions improve.
      See Also:
    • REMOTE_VIDEO_STATE_REASON_SDK_IN_BACKGROUND

      public static final int REMOTE_VIDEO_STATE_REASON_SDK_IN_BACKGROUND
      12: The remote user sdk(only for iOS) in background.
      See Also:
    • REMOTE_VIDEO_STATE_REASON_CODEC_NOT_SUPPORT

      public static final int REMOTE_VIDEO_STATE_REASON_CODEC_NOT_SUPPORT
      13: The remote video stream is not supported by the decoder.
      See Also:
    • AUDIO_MIXING_STATE_PLAYING

      public static final int AUDIO_MIXING_STATE_PLAYING
      710: The audio mixing file is playing.
      See Also:
    • AUDIO_MIXING_STATE_PAUSED

      public static final int AUDIO_MIXING_STATE_PAUSED
      711: The audio mixing file pauses playing.
      See Also:
    • AUDIO_MIXING_STATE_STOPPED

      public static final int AUDIO_MIXING_STATE_STOPPED
      713: The audio mixing file stops playing.
      See Also:
    • AUDIO_MIXING_STATE_FAILED

      public static final int AUDIO_MIXING_STATE_FAILED
      714: An exception occurs when playing the audio mixing file. See the errorCode for details.
      See Also:
    • AUDIO_MIXING_REASON_CAN_NOT_OPEN

      public static final int AUDIO_MIXING_REASON_CAN_NOT_OPEN
      701: An error occurs in opening the audio mixing file.
      See Also:
    • AUDIO_MIXING_REASON_TOO_FREQUENT_CALL

      public static final int AUDIO_MIXING_REASON_TOO_FREQUENT_CALL
      702: The SDK opens the audio mixing file too frequently.
      See Also:
    • AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED

      public static final int AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED
      721: The audio mixing file is played once.
      See Also:
    • AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED

      public static final int AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED
      723: The audio mixing file is all played out.
      See Also:
    • AUDIO_MIXING_REASON_STOPPED_BY_USER

      public static final int AUDIO_MIXING_REASON_STOPPED_BY_USER
      724: The audio mixing file stopped by user
      See Also:
    • AUDIO_MIXING_REASON_RESUMED_BY_USER

      public static final int AUDIO_MIXING_REASON_RESUMED_BY_USER
      726: The audio mixing playback has resumed by user
      See Also:
    • AUDIO_MIXING_REASON_INTERRUPTED_EOF

      public static final int AUDIO_MIXING_REASON_INTERRUPTED_EOF
      703: The audio mixing file playback is interrupted.
      See Also:
    • AUDIO_MIXING_REASON_OK

      public static final int AUDIO_MIXING_REASON_OK
      0: No error.
      See Also:
    • VIDEO_CODEC_VP8

      public static final int VIDEO_CODEC_VP8
      Video codec types VIDEO_CODEC_TYPE
      See Also:
    • VIDEO_CODEC_H264

      public static final int VIDEO_CODEC_H264
      See Also:
    • VIDEO_CODEC_H265

      public static final int VIDEO_CODEC_H265
      See Also:
    • VIDEO_CODEC_VP9

      public static final int VIDEO_CODEC_VP9
      See Also:
    • VIDEO_CODEC_GENERIC

      public static final int VIDEO_CODEC_GENERIC
      See Also:
    • VIDEO_CODEC_GENERIC_H264

      public static final int VIDEO_CODEC_GENERIC_H264
      See Also:
    • VIDEO_CODEC_GENERIC_JPEG

      public static final int VIDEO_CODEC_GENERIC_JPEG
      See Also:
    • TCC_ENABLED

      public static final int TCC_ENABLED
      Transport CC enabled
      See Also:
    • TCC_DISABLED

      public static final int TCC_DISABLED
      See Also:
    • AUDIO_CODEC_OPUS

      public static final int AUDIO_CODEC_OPUS
      See Also:
    • AUDIO_CODEC_AACLC

      public static final int AUDIO_CODEC_AACLC
      See Also:
    • AUDIO_CODEC_HEAAC

      public static final int AUDIO_CODEC_HEAAC
      See Also:
    • AUDIO_CODEC_HEAAC2

      public static final int AUDIO_CODEC_HEAAC2
      See Also:
    • PACKETIZE_MODE_H264_NON_INTERLEAVED

      public static final int PACKETIZE_MODE_H264_NON_INTERLEAVED
      Packetize Mode H264PacketizeMode
      See Also:
    • PACKETIZE_MODE_H264_SINGLE_NAL_UNIT

      public static final int PACKETIZE_MODE_H264_SINGLE_NAL_UNIT
      See Also:
    • VIDEO_FRAME_TYPE_BLANK_FRAME

      public static final int VIDEO_FRAME_TYPE_BLANK_FRAME
      Video Frame Type. VIDEO_FRAME_TYPE
      See Also:
    • VIDEO_FRAME_TYPE_KEY_FRAME

      public static final int VIDEO_FRAME_TYPE_KEY_FRAME
      See Also:
    • VIDEO_FRAME_TYPE_DELTA_FRAME

      public static final int VIDEO_FRAME_TYPE_DELTA_FRAME
      See Also:
    • VIDEO_FRAME_TYPE_B_FRAME

      public static final int VIDEO_FRAME_TYPE_B_FRAME
      See Also:
    • VIDEO_FRAME_TYPE_UNKNOWN

      public static final int VIDEO_FRAME_TYPE_UNKNOWN
      See Also:
    • VIDEO_ORIENTATION_0

      public static final int VIDEO_ORIENTATION_0
      0: No rotation.
      See Also:
    • VIDEO_ORIENTATION_90

      public static final int VIDEO_ORIENTATION_90
      90: 90 degrees.
      See Also:
    • VIDEO_ORIENTATION_180

      public static final int VIDEO_ORIENTATION_180
      180: 180 degrees.
      See Also:
    • VIDEO_ORIENTATION_270

      public static final int VIDEO_ORIENTATION_270
      270: 270 degrees.
      See Also:
    • RHYTHM_PLAYER_STATE_IDLE

      public static final int RHYTHM_PLAYER_STATE_IDLE
      810: The rhythm player is idle.
      See Also:
    • RHYTHM_PLAYER_STATE_OPENING

      public static final int RHYTHM_PLAYER_STATE_OPENING
      811: The rhythm player is opening files.
      See Also:
    • RHYTHM_PLAYER_STATE_DECODING

      public static final int RHYTHM_PLAYER_STATE_DECODING
      812: Files opened successfully, the rhythm player starts decoding files.
      See Also:
    • RHYTHM_PLAYER_STATE_PLAYING

      public static final int RHYTHM_PLAYER_STATE_PLAYING
      813: Files decoded successfully, the rhythm player starts mixing the two files and playing back them locally.
      See Also:
    • RHYTHM_PLAYER_STATE_FAILED

      public static final int RHYTHM_PLAYER_STATE_FAILED
      814: The rhythm player is starting to fail, and you need to check the error code for detailed failure reasons
      See Also:
    • LICENSE_ERR_INVALID

      public static final int LICENSE_ERR_INVALID
      1: Invalid license
      See Also:
    • LICENSE_ERR_EXPIRE

      public static final int LICENSE_ERR_EXPIRE
      2: License expired
      See Also:
    • LICENSE_ERR_MINUTES_EXCEED

      public static final int LICENSE_ERR_MINUTES_EXCEED
      3: Exceed license minutes limit
      See Also:
    • LICENSE_ERR_LIMITED_PERIOD

      public static final int LICENSE_ERR_LIMITED_PERIOD
      4: License use in limited period
      See Also:
    • LICENSE_ERR_DIFF_DEVICES

      public static final int LICENSE_ERR_DIFF_DEVICES
      5: Same license used in different devices at the same time
      See Also:
    • LICENSE_ERR_INTERNAL

      public static final int LICENSE_ERR_INTERNAL
      99: SDK internal error
      See Also:
    • RHYTHM_PLAYER_REASON_OK

      public static final int RHYTHM_PLAYER_REASON_OK
      0: The rhythm player works well.
      See Also:
    • RHYTHM_PLAYER_REASON_FAILED

      public static final int RHYTHM_PLAYER_REASON_FAILED
      1: he rhythm player occurs a internal error.
      See Also:
    • RHYTHM_PLAYER_REASON_CAN_NOT_OPEN

      public static final int RHYTHM_PLAYER_REASON_CAN_NOT_OPEN
      801: The rhythm player can not open the file.
      See Also:
    • RHYTHM_PLAYER_REASON_CAN_NOT_PLAY

      public static final int RHYTHM_PLAYER_REASON_CAN_NOT_PLAY
      802: The rhythm player can not play the file.
      See Also:
    • RHYTHM_PLAYER_REASON_FILE_OVER_DURATION_LIMIT

      public static final int RHYTHM_PLAYER_REASON_FILE_OVER_DURATION_LIMIT
      803: The file duration over the limit. The file duration limit is 1.2 seconds.
      See Also:
    • PUB_STATE_IDLE

      public static final int PUB_STATE_IDLE
      0: The initial publishing state after joining the channel.
      See Also:
    • PUB_STATE_NO_PUBLISHED

      public static final int PUB_STATE_NO_PUBLISHED
      1: Fails to publish the local stream.
      See Also:
    • PUB_STATE_PUBLISHING

      public static final int PUB_STATE_PUBLISHING
      2: Publishing the local stream.
      See Also:
    • PUB_STATE_PUBLISHED

      public static final int PUB_STATE_PUBLISHED
      3: Successfully publishes the local stream.
      See Also:
    • SUB_STATE_IDLE

      public static final int SUB_STATE_IDLE
      0: The initial subscribing state after joining the channel.
      See Also:
    • SUB_STATE_NO_SUBSCRIBED

      public static final int SUB_STATE_NO_SUBSCRIBED
      1: Fails to subscribing to the remote stream.
      See Also:
    • SUB_STATE_SUBSCRIBING

      public static final int SUB_STATE_SUBSCRIBING
      2: Subscribing.
      See Also:
    • SUB_STATE_SUBSCRIBED

      public static final int SUB_STATE_SUBSCRIBED
      3: Subscribes to and receives the remote stream successfully.
      See Also:
    • RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE

      public static final int RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE
      1: An error occurs when you add a background image or a watermark image to the RTMP or RTMPS stream.
      See Also:
    • RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE

      public static final int RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE
      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
      See Also:
    • RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT

      public static final int RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT
      3: advanced feature not support
      See Also:
    • RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN

      public static final int RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN
      4: Client request too frequently.
      See Also:
    • RTMP_STREAM_PUBLISH_STATE_IDLE

      public static final int RTMP_STREAM_PUBLISH_STATE_IDLE
      0: The RTMP streaming has not started or has ended. This state is also reported after you remove an RTMP address from the CDN by calling `removePublishStreamUrl`.
      See Also:
    • RTMP_STREAM_PUBLISH_STATE_CONNECTING

      public static final int RTMP_STREAM_PUBLISH_STATE_CONNECTING
      1: The SDK is connecting to the streaming server and the RTMP server. This state is reported after you call `addPublishStreamUrl`.
      See Also:
    • RTMP_STREAM_PUBLISH_STATE_RUNNING

      public static final int RTMP_STREAM_PUBLISH_STATE_RUNNING
      2: The RTMP streaming publishes. The SDK successfully publishes the RTMP streaming and returns this state.
      See Also:
    • RTMP_STREAM_PUBLISH_STATE_RECOVERING

      public static final int RTMP_STREAM_PUBLISH_STATE_RECOVERING
      3: The RTMP streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK tries to resume RTMP streaming and reports this state. - If the SDK successfully resumes the streaming, `RTMP_STREAM_PUBLISH_STATE_RUNNING(2)` is reported. - If the streaming does not resume within 60 seconds or server errors occur, `RTMP_STREAM_PUBLISH_STATE_FAILURE(4)` is reported. You can also reconnect to the server by calling `removePublishStreamUrl` and `addPublishStreamUrl`.
      See Also:
    • RTMP_STREAM_PUBLISH_STATE_FAILURE

      public static final int RTMP_STREAM_PUBLISH_STATE_FAILURE
      4: The RTMP streaming fails. See the `errCode` parameter for the detailed error information. You can also call `addPublishStreamUrl` to publish the RTMP streaming again.
      See Also:
    • RTMP_STREAM_PUBLISH_STATE_DISCONNECTING

      public static final int RTMP_STREAM_PUBLISH_STATE_DISCONNECTING
      5: The SDK is disconnecting to Agora's streaming server and the CDN server. This state is triggered after you call the \ref IRtcEngine::removePublishStreamUrl "removePublishStreamUrl" method.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_OK

      public static final int RTMP_STREAM_PUBLISH_REASON_OK
      0: The RTMP or RTMPS streaming publishes successfully.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_INVALID_ARGUMENT

      public static final int RTMP_STREAM_PUBLISH_REASON_INVALID_ARGUMENT
      1. Invalid argument used. If, for example, you do not call the \ref IRtcEngine::setLiveTranscoding "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.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_ENCRYPTED_STREAM_NOT_ALLOWED

      public static final int RTMP_STREAM_PUBLISH_REASON_ENCRYPTED_STREAM_NOT_ALLOWED
      2: The RTMP or RTMPS streaming is encrypted and cannot be published.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_CONNECTION_TIMEOUT

      public static final int RTMP_STREAM_PUBLISH_REASON_CONNECTION_TIMEOUT
      3. Timeout for the RTMP or RTMPS streaming. Call the \ref IRtcEngine::addPublishStreamUrl "addPublishStreamUrl" method to publish the streaming again.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_INTERNAL_SERVER_ERROR

      public static final int RTMP_STREAM_PUBLISH_REASON_INTERNAL_SERVER_ERROR
      4. An error occurs in Agora's streaming server. Call the `addPublishStreamUrl` method to publish the streaming again.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_RTMP_SERVER_ERROR

      public static final int RTMP_STREAM_PUBLISH_REASON_RTMP_SERVER_ERROR
      5: An error occurs in the CDN server.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_TOO_OFTEN

      public static final int RTMP_STREAM_PUBLISH_REASON_TOO_OFTEN
      6: The RTMP or RTMPS streaming publishes too frequently.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_REACH_LIMIT

      public static final int RTMP_STREAM_PUBLISH_REASON_REACH_LIMIT
      7: The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_NOT_AUTHORIZED

      public static final int RTMP_STREAM_PUBLISH_REASON_NOT_AUTHORIZED
      8: The host manipulates other hosts' URLs. Check your app logic.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_STREAM_NOT_FOUND

      public static final int RTMP_STREAM_PUBLISH_REASON_STREAM_NOT_FOUND
      9: Agora server fails to find the RTMP or RTMPS streaming.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_FORMAT_NOT_SUPPORTED

      public static final int RTMP_STREAM_PUBLISH_REASON_FORMAT_NOT_SUPPORTED
      10: The format of the RTMP or RTMPS streaming URL is not supported. Check whether the URL format is correct.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_NOT_BROADCASTER

      public static final int RTMP_STREAM_PUBLISH_REASON_NOT_BROADCASTER
      11: Current role is not broadcaster. Check whether the role of the current channel.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_TRANSCODING_NO_MIX_STREAM

      public static final int RTMP_STREAM_PUBLISH_REASON_TRANSCODING_NO_MIX_STREAM
      13: Call updateTranscoding, but no mix stream.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_NET_DOWN

      public static final int RTMP_STREAM_PUBLISH_REASON_NET_DOWN
      14: Network error.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_INVALID_APPID

      public static final int RTMP_STREAM_PUBLISH_REASON_INVALID_APPID
      15: User AppId have not authorized to push stream.
      See Also:
    • RTMP_STREAM_PUBLISH_REASON_INVALID_PRIVILEGE

      public static final int RTMP_STREAM_PUBLISH_REASON_INVALID_PRIVILEGE
      16: invalid privilege.
      See Also:
    • RTMP_STREAM_UNPUBLISH_REASON_OK

      public static final int RTMP_STREAM_UNPUBLISH_REASON_OK
      100: The streaming has been stopped normally. After you call \ref IRtcEngine::removePublishStreamUrl "removePublishStreamUrl" to stop streaming, the SDK returns this value.
      Since:
      v3.4.5
      See Also:
    • ENCRYPTION_ERROR_INTERNAL_FAILURE

      public static final int ENCRYPTION_ERROR_INTERNAL_FAILURE
      0: Internal reason.
      See Also:
    • ENCRYPTION_ERROR_DECRYPTION_FAILURE

      public static final int ENCRYPTION_ERROR_DECRYPTION_FAILURE
      1: MediaStream decryption errors. Ensure that the receiver and the sender use the same encryption mode and key.
      See Also:
    • ENCRYPTION_ERROR_ENCRYPTION_FAILURE

      public static final int ENCRYPTION_ERROR_ENCRYPTION_FAILURE
      2: MediaStream encryption errors.
      See Also:
    • ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE

      public static final int ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE
      3: DataStream decryption errors. Ensure that the receiver and the sender use the same encryption mode and key.
      See Also:
    • ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE

      public static final int ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE
      4: DataStream encryption errors.
      See Also:
    • USER_STATE_MUTE_AUDIO

      public static final int USER_STATE_MUTE_AUDIO
      See Also:
    • USER_STATE_MUTE_VIDEO

      public static final int USER_STATE_MUTE_VIDEO
      See Also:
    • USER_STATE_ENABLE_VIDEO

      public static final int USER_STATE_ENABLE_VIDEO
      See Also:
    • USER_STATE_ENABLE_LOCAL_VIDEO

      public static final int USER_STATE_ENABLE_LOCAL_VIDEO
      See Also:
    • RECORD_AUDIO

      public static final int RECORD_AUDIO
      Type of permission.
      See Also:
    • CAMERA

      public static final int CAMERA
      See Also:
    • SCREEN_CAPTURE

      public static final int SCREEN_CAPTURE
      See Also:
    • DEFAULT_CONNECTION_ID

      public static final int DEFAULT_CONNECTION_ID
      The default connection ID.
      See Also:
    • CONNECTION_STATE_DISCONNECTED

      public static final int CONNECTION_STATE_DISCONNECTED
      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.
      See Also:
    • CONNECTION_STATE_CONNECTING

      public static final int CONNECTION_STATE_CONNECTING
      2: The SDK is connecting to Agora edge server.
      See Also:
    • CONNECTION_STATE_CONNECTED

      public static final int CONNECTION_STATE_CONNECTED
      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:
      See Also:
    • CONNECTION_STATE_RECONNECTING

      public static final int CONNECTION_STATE_RECONNECTING
      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 the CONNECTION_STATE_RECONNECTING state, 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 onConnectionStateChanged callback, switches to the CONNECTION_STATE_FAILED state, and stops rejoining the channel.
      See Also:
    • CONNECTION_STATE_FAILED

      public static final int CONNECTION_STATE_FAILED
      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.
      See Also:
    • CONNECTION_CHANGED_CONNECTING

      public static final int CONNECTION_CHANGED_CONNECTING
      0: The SDK is connecting to Agora edge server.
      See Also:
    • CONNECTION_CHANGED_JOIN_SUCCESS

      public static final int CONNECTION_CHANGED_JOIN_SUCCESS
      1: The SDK has joined the channel successfully.
      See Also:
    • CONNECTION_CHANGED_INTERRUPTED

      public static final int CONNECTION_CHANGED_INTERRUPTED
      2: The connection between the SDK and Agora edge server is interrupted.
      See Also:
    • CONNECTION_CHANGED_BANNED_BY_SERVER

      public static final int CONNECTION_CHANGED_BANNED_BY_SERVER
      3: The connection between the SDK and Agora edge server is banned by Agora edge server.
      See Also:
    • CONNECTION_CHANGED_JOIN_FAILED

      public static final int CONNECTION_CHANGED_JOIN_FAILED
      4: The SDK fails to join the channel for more than 20 minutes and stops reconnecting to the channel.
      See Also:
    • CONNECTION_CHANGED_LEAVE_CHANNEL

      public static final int CONNECTION_CHANGED_LEAVE_CHANNEL
      5: The SDK has left the channel.
      See Also:
    • CONNECTION_CHANGED_INVALID_APP_ID

      public static final int CONNECTION_CHANGED_INVALID_APP_ID
      6: The specified App ID is invalid. Try to rejoin the channel with a valid App ID.
      See Also:
    • CONNECTION_CHANGED_INVALID_CHANNEL_NAME

      public static final int CONNECTION_CHANGED_INVALID_CHANNEL_NAME
      7: The specified channel name is invalid. Try to rejoin the channel with a valid channel name.
      See Also:
    • CONNECTION_CHANGED_INVALID_TOKEN

      public static final int CONNECTION_CHANGED_INVALID_TOKEN
      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.
      See Also:
    • CONNECTION_CHANGED_TOKEN_EXPIRED

      public static final int CONNECTION_CHANGED_TOKEN_EXPIRED
      9: The token has expired. Generate a new token from your server.
      See Also:
    • CONNECTION_CHANGED_REJECTED_BY_SERVER

      public static final int CONNECTION_CHANGED_REJECTED_BY_SERVER
      10: The user is banned by the server.
      See Also:
    • CONNECTION_CHANGED_SETTING_PROXY_SERVER

      public static final int CONNECTION_CHANGED_SETTING_PROXY_SERVER
      11: The SDK tries to reconnect after setting a proxy server.
      See Also:
    • CONNECTION_CHANGED_RENEW_TOKEN

      public static final int CONNECTION_CHANGED_RENEW_TOKEN
      12: The token renews.
      See Also:
    • CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED

      public static final int CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED
      13: The client IP address has changed, probably due to a change of the network type, IP address, or network port.
      See Also:
    • CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT

      public static final int CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT
      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).
      See Also:
    • CONNECTION_CHANGED_REJOIN_SUCCESS

      public static final int CONNECTION_CHANGED_REJOIN_SUCCESS
      15: The SDK has rejoined the channel successfully.
      See Also:
    • CONNECTION_CHANGED_LOST

      public static final int CONNECTION_CHANGED_LOST
      16: The connection between the SDK and the server is lost.
      See Also:
    • CONNECTION_CHANGED_ECHO_TEST

      public static final int CONNECTION_CHANGED_ECHO_TEST
      17: The change of connection state is caused by echo test.
      See Also:
    • CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED_BY_USER

      public static final int CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED_BY_USER
      18: The local IP Address is changed by user.
      See Also:
    • CONNECTION_CHANGED_SAME_UID_LOGIN

      public static final int CONNECTION_CHANGED_SAME_UID_LOGIN
      /* 19: There is a disconnection due to joining channel on another device with the same uid.
      See Also:
    • CONNECTION_CHANGED_TOO_MANY_BROADCASTERS

      public static final int CONNECTION_CHANGED_TOO_MANY_BROADCASTERS
      20: The connection is failed due to too many broadcasters in the channel.
      See Also:
    • CONNECTION_CHANGED_LICENSE_VALIDATION_FAILURE

      public static final int CONNECTION_CHANGED_LICENSE_VALIDATION_FAILURE
      21: The connection is failed due to license validation failure.
      See Also:
    • CONNECTION_CHANGED_CERTIFICATION_VERYFY_FAILURE

      public static final int CONNECTION_CHANGED_CERTIFICATION_VERYFY_FAILURE
      22: The connection is failed due to certification verify failure.
      See Also:
    • RELAY_OK

      public static final int RELAY_OK
      0: The state is normal.
      See Also:
    • RELAY_ERROR_SERVER_ERROR_RESPONSE

      public static final int RELAY_ERROR_SERVER_ERROR_RESPONSE
      1: An error occurs in the server response.
      See Also:
    • RELAY_ERROR_SERVER_NO_RESPONSE

      public static final int RELAY_ERROR_SERVER_NO_RESPONSE
      2: No server response. You can call the leaveChannel method to leave the channel.
      See Also:
    • RELAY_ERROR_NO_RESOURCE_AVAILABLE

      public static final int RELAY_ERROR_NO_RESOURCE_AVAILABLE
      3: The SDK fails to access the service, probably due to limited resources of the server.
      See Also:
    • RELAY_ERROR_FAILED_JOIN_SRC

      public static final int RELAY_ERROR_FAILED_JOIN_SRC
      4: Fails to send the relay request.
      See Also:
    • RELAY_ERROR_FAILED_JOIN_DEST

      public static final int RELAY_ERROR_FAILED_JOIN_DEST
      5: Fails to accept the relay request.
      See Also:
    • RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC

      public static final int RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC
      6: The server fails to receive the media stream.
      See Also:
    • RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST

      public static final int RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST
      7: The server fails to send the media stream.
      See Also:
    • RELAY_ERROR_SERVER_CONNECTION_LOST

      public static final int RELAY_ERROR_SERVER_CONNECTION_LOST
      8: The SDK disconnects from the server due to poor network connections. You can call the leaveChannel method to leave the channel.
      See Also:
    • RELAY_ERROR_INTERNAL_ERROR

      public static final int RELAY_ERROR_INTERNAL_ERROR
      9: An internal error occurs in the server.
      See Also:
    • RELAY_ERROR_SRC_TOKEN_EXPIRED

      public static final int RELAY_ERROR_SRC_TOKEN_EXPIRED
      10: The token of the source channel has expired.
      See Also:
    • RELAY_ERROR_DEST_TOKEN_EXPIRED

      public static final int RELAY_ERROR_DEST_TOKEN_EXPIRED
      11: The token of the destination channel has expired.
      See Also:
    • RELAY_EVENT_NETWORK_DISCONNECTED

      public static final int RELAY_EVENT_NETWORK_DISCONNECTED
      0: The user disconnects from the server due to poor network connections.
      See Also:
    • RELAY_EVENT_NETWORK_CONNECTED

      public static final int RELAY_EVENT_NETWORK_CONNECTED
      1: The network reconnects.
      See Also:
    • RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL

      public static final int RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL
      2: The user joins the source channel.
      See Also:
    • RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL

      public static final int RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL
      3: The user joins the destination channel.
      See Also:
    • RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL

      public static final int RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL
      4: The SDK starts relaying the media stream to the destination channel.
      See Also:
    • RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC

      public static final int RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC
      5: The server receives the video stream from the source channel.
      See Also:
    • RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC

      public static final int RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC
      6: The server receives the audio stream from the source channel.
      See Also:
    • RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL

      public static final int RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL
      7: The destination channel is updated.
      See Also:
    • RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED

      public static final int RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED
      8: The destination channel update fails due to internal reasons. Deprecated from 4.1.0
      See Also:
    • RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE

      public static final int RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE
      9: The destination channel does not change, which means that the destination channel fails to be updated.
      See Also:
    • RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL

      public static final int RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL
      10: The destination channel name is NULL.
      See Also:
    • RELAY_EVENT_VIDEO_PROFILE_UPDATE

      public static final int RELAY_EVENT_VIDEO_PROFILE_UPDATE
      11: The video profile is sent to the server.
      See Also:
    • RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS

      public static final int RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS
      12: pause send packet to dest channel success.
      See Also:
    • RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_FAILED

      public static final int RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_FAILED
      13: pause send packet to dest channel failed.
      See Also:
    • RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS

      public static final int RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS
      14: resume send packet to dest channel success.
      See Also:
    • RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_FAILED

      public static final int RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_FAILED
      15: pause send packet to dest channel failed.
      See Also:
    • RELAY_STATE_IDLE

      public static final int RELAY_STATE_IDLE
      0: The SDK is initializing.
      See Also:
    • RELAY_STATE_CONNECTING

      public static final int RELAY_STATE_CONNECTING
      1: The SDK tries to relay the media stream to the destination channel.
      See Also:
    • RELAY_STATE_RUNNING

      public static final int RELAY_STATE_RUNNING
      2: The SDK successfully relays the media stream to the destination channel.
      See Also:
    • RELAY_STATE_FAILURE

      public static final int RELAY_STATE_FAILURE
      3: A failure occurs.
      See Also:
    • EAR_MONITORING_FILTER_NONE

      public static final int EAR_MONITORING_FILTER_NONE
      1: Do not add an audio filter to the in-ear monitor.
      See Also:
    • EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS

      public static final int EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS
      2: Add an audio filter to the in-ear monitor.
      See Also:
    • EAR_MONITORING_FILTER_NOISE_SUPPRESSION

      public static final int EAR_MONITORING_FILTER_NOISE_SUPPRESSION
      4: Enable noise suppression to the in-ear monitor.
      See Also:
    • EAR_MONITORING_FILTER_REUSE_POST_PROCESSING_FILTER

      public static final int EAR_MONITORING_FILTER_REUSE_POST_PROCESSING_FILTER
      32768: Enable audio filters by reuse post-processing filter to the in-ear monitor. This bit is intended to be used in exclusive mode, which means, if this bit is set, all other bits will be disregarded.
      See Also:
    • LOCAL_RPOXY_CONNECTIVITY_FIRST

      public static final int LOCAL_RPOXY_CONNECTIVITY_FIRST
      0: connectivity first
      See Also:
    • LOCAL_RPOXY_LOCAL_ONLY

      public static final int LOCAL_RPOXY_LOCAL_ONLY
      1: local only
      See Also:
    • EXPERIENCE_QUALITY_GOOD

      public static final int EXPERIENCE_QUALITY_GOOD
      0: QoE of the local user is good.
      See Also:
    • EXPERIENCE_QUALITY_BAD

      public static final int EXPERIENCE_QUALITY_BAD
      1: QoE of the local user is poor.
      See Also:
    • EXPERIENCE_REASON_NONE

      public static final int EXPERIENCE_REASON_NONE
      0: No reason, indicating good QoE of the local user.
      See Also:
    • REMOTE_NETWORK_QUALITY_POOR

      public static final int REMOTE_NETWORK_QUALITY_POOR
      1: The remote user's network quality is poor.
      See Also:
    • LOCAL_NETWORK_QUALITY_POOR

      public static final int LOCAL_NETWORK_QUALITY_POOR
      2: The local user's network quality is poor.
      See Also:
    • WIRELESS_SIGNAL_POOR

      public static final int WIRELESS_SIGNAL_POOR
      4: The local user's Wi-Fi or mobile network signal is weak.
      See Also:
    • WIFI_BLUETOOTH_COEXIST

      public static final int WIFI_BLUETOOTH_COEXIST
      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.
      See Also:
    • TRANSPORT_TYPE_NONE_PROXY

      public static final int TRANSPORT_TYPE_NONE_PROXY
      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.
      See Also:
    • TRANSPORT_TYPE_UDP_PROXY

      public static final int TRANSPORT_TYPE_UDP_PROXY
      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.
      See Also:
    • TRANSPORT_TYPE_TCP_PROXY

      public static final int TRANSPORT_TYPE_TCP_PROXY
      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
      See Also:
    • PROXY_TYPE_NONE_PROXY

      public static final int PROXY_TYPE_NONE_PROXY
      0: Reserved for future use.
      Since:
      v3.6.2
      See Also:
    • PROXY_TYPE_UDP_CLOUD_PROXY

      public static final int PROXY_TYPE_UDP_CLOUD_PROXY
      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
      See Also:
    • PROXY_TYPE_TCP_CLOUD_PROXY

      public static final int PROXY_TYPE_TCP_CLOUD_PROXY
      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
      See Also:
    • PROXY_TYPE_LOCAL_PROXY

      public static final int PROXY_TYPE_LOCAL_PROXY
      3: Reserved for future use.
      Since:
      v3.6.2
      See Also:
    • PROXY_TYPE_TCP_AUTO_FALLBACK

      public static final int PROXY_TYPE_TCP_AUTO_FALLBACK
      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
      See Also:
    • PROXY_TYPE_HTTP

      public static final int PROXY_TYPE_HTTP
      5: The http proxy.
      Since:
      v4.2.0
      See Also:
    • PROXY_TYPE_HTTPS

      public static final int PROXY_TYPE_HTTPS
      6: The https proxy.
      Since:
      v4.2.0
      See Also:
    • ERR_SCREEN_CAPTURE_PERMISSION_DENIED

      public static final int ERR_SCREEN_CAPTURE_PERMISSION_DENIED
      16: The user refuses to grant screen capture permission to the application.
      Since:
      v3.7.0
      See Also:
    • ERR_SCREEN_CAPTURE_SYSTEM_NOT_SUPPORTED

      public static final int ERR_SCREEN_CAPTURE_SYSTEM_NOT_SUPPORTED
      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
      See Also:
    • ERR_SCREEN_CAPTURE_SYSTEM_AUDIO_NOT_SUPPORTED

      public static final int ERR_SCREEN_CAPTURE_SYSTEM_AUDIO_NOT_SUPPORTED
      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
      See Also:
    • CONTENT_INSPECT_NEUTRAL

      public static final int CONTENT_INSPECT_NEUTRAL
      See Also:
    • CONTENT_INSPECT_SEXY

      public static final int CONTENT_INSPECT_SEXY
      See Also:
    • CONTENT_INSPECT_PORN

      public static final int CONTENT_INSPECT_PORN
      See Also:
    • CODEC_CAPABILITY_LEVEL_UNSPECIFIED

      public static final int CODEC_CAPABILITY_LEVEL_UNSPECIFIED
      No specified level
      See Also:
    • CODEC_CAPABILITY_LEVEL_BASIC_SUPPORT

      public static final int CODEC_CAPABILITY_LEVEL_BASIC_SUPPORT
      Only provide basic support for the codec type
      See Also:
    • CODEC_CAPABILITY_LEVEL_1080P30FPS

      public static final int CODEC_CAPABILITY_LEVEL_1080P30FPS
      Can process 1080p video at a rate of approximately 30 fps.
      See Also:
    • CODEC_CAPABILITY_LEVEL_1080P60FPS

      public static final int CODEC_CAPABILITY_LEVEL_1080P60FPS
      Can process 1080p video at a rate of approximately 60 fps.
      See Also:
    • CODEC_CAPABILITY_LEVEL_4K60FPS

      public static final int CODEC_CAPABILITY_LEVEL_4K60FPS
      Can process 4k video at a rate of approximately 30 fps.
      See Also:
    • FEATURE_VIDEO_VIRTUAL_BACKGROUND

      public static final int FEATURE_VIDEO_VIRTUAL_BACKGROUND
      FeatureType
      Since:
      v4.1.1.3
      See Also:
    • FEATURE_VIDEO_BEAUTY_EFFECT

      public static final int FEATURE_VIDEO_BEAUTY_EFFECT
      See Also:
    • VT_ERR_VIDEO_SOURCE_NOT_READY

      public static final int VT_ERR_VIDEO_SOURCE_NOT_READY
      The video track of the video source is not started.
      See Also:
    • VT_ERR_INVALID_VIDEO_SOURCE_TYPE

      public static final int VT_ERR_INVALID_VIDEO_SOURCE_TYPE
      The video source type is not supported.
      See Also:
    • VT_ERR_INVALID_IMAGE_PATH

      public static final int VT_ERR_INVALID_IMAGE_PATH
      The image url is not correctly of image source.
      See Also:
    • VT_ERR_UNSUPPORT_IMAGE_FORMAT

      public static final int VT_ERR_UNSUPPORT_IMAGE_FORMAT
      The image format not the type png/jpeg/gif of image source.
      See Also:
    • VT_ERR_INVALID_LAYOUT

      public static final int VT_ERR_INVALID_LAYOUT
      The layout is invalid such as width is zero.
      See Also:
    • VT_ERR_INTERNAL

      public static final int VT_ERR_INTERNAL
      Internal error.
      See Also:
    • RDT_STREAM_CMD

      public static final int RDT_STREAM_CMD
      Command stream type. Characterized by: reliability, high priority, and not affected by congestion control. Transmission limits: a maximum of 256 bytes per packet, and 100 packets per second.
      See Also:
    • RDT_STREAM_DATA

      public static final int RDT_STREAM_DATA
      Data stream type. Characterized by: reliability, low priority, and affected by congestion control. Transmission limits: a maximum of 128 KBytes per packet, with a rate of 4 Mbps.
      See Also:
    • RDT_STREAM_COUNT

      public static final int RDT_STREAM_COUNT
      Reliable Data Transmission stream type count
      See Also:
    • RDT_STATE_CLOSED

      public static final int RDT_STATE_CLOSED
      The RDT tunnel is in the initial or is closed.
      See Also:
    • RDT_STATE_OPENED

      public static final int RDT_STATE_OPENED
      The RDT tunnel is open, and data can only be sent in this state.
      See Also:
    • RDT_STATE_BLOCKED

      public static final int RDT_STATE_BLOCKED
      The send buffer of the RDT tunnel is full. RDT_STREAM_DATA cannot be sent, but RDT_STREAM_CMD can be sent, as the latter is not affected by congestion control.
      See Also:
    • RDT_STATE_PENDING

      public static final int RDT_STATE_PENDING
      The RDT tunnel is in a suspended state because SDK has disconnected. It will automatically resume to the RDT_STATE_OPENED state after rejoining the channel.
      See Also:
    • RDT_STATE_BROKEN

      public static final int RDT_STATE_BROKEN
      The RDT channel is broken, and the data being sent and received will be cleared. It will automatically resume to the RDT_STATE_OPENED state later. Reason for occurrence: The remote user actively called the API to leave the channel and then rejoined the channel, without being detected by this end.
      See Also:
  • Constructor Details

    • Constants

      public Constants()