Agora Java API Reference for Android
|
Classes | |
enum | AUDIO_EQUALIZATION_BAND_FREQUENCY |
enum | AUDIO_REVERB_TYPE |
enum | AudioMixingDualMonoMode |
enum | AudioProfile |
enum | AudioScenario |
enum | ExternalVideoSourceType |
enum | LogLevel |
enum | MediaSourceType |
enum | MediaType |
enum | SimulcastStreamMode |
enum | ThreadPriorityType |
enum | VideoSourceType |
Rating of the media or network quality.
|
static |
1: The last-mile probe result is complete.
|
static |
2: The last-mile network probe test is incomplete and the bandwidth estimation is not available, probably due to limited test resources.
|
static |
3: The last-mile network probe test is not carried out, probably due to poor network conditions.
|
static |
The quality is unknown.
|
static |
The quality is excellent.
|
static |
The quality is quite good, but the bitrate may be slightly lower than excellent.
|
static |
Users can feel the communication slightly impaired.
|
static |
Users can communicate not very smoothly.
|
static |
The quality is so bad that users can barely communicate.
|
static |
Users cannot communicate at all.
|
static |
7: (For future use) The network quality cannot be detected.
|
static |
8: Detecting the network quality.
|
static |
The specified view is invalid. It is required to specify a view when using the video call function.
|
static |
Failed to initialize the video function.
|
static |
The request is pending, usually due to some module not being ready, and the SDK postponed processing the request.
|
static |
No channel resources are available. Maybe because the server cannot allocate any channel resource.
|
static |
A timeout when looking up the channel. When joining a channel, the SDK looks up the specified channel. The warning usually occurs when the network condition is too poor to connect to the server.
|
static |
The server rejected the request to look up the channel. The server cannot process this request or the request is illegal.
|
static |
A timeout when opening the channel. Once the specific channel is found, the SDK opens the channel. The warning usually occurs when the network condition is too poor to connect to the server.
|
static |
The server rejected the request to open the channel. The server cannot process this request or the request is illegal.
|
static |
A timeout when switching the live video.
|
static |
A timeout when setting the client role in the broadcast mode.
|
static |
The client role is not authorized.
|
static |
The ticket to open the channel is invalid.
|
static |
Try connecting to another server.
|
static |
Error in opening the audio mixing.
|
static |
Audio Device Module: A warning in the runtime playback device.
|
static |
Audio Device Module: A warning in the runtime recording device.
|
static |
Audio Device Module: No valid audio data is collected.
|
static |
Audio Device Module: The recorded audio volume is too low.
|
static |
Audio Device Module: The playback audio volume is too low.
|
static |
Audio Device Module: The recording device is occupied.
|
static |
Audio Device Module: Howling is detected.
|
static |
Audio Device Module: The device is in the glitch state.
|
static |
Audio Device Module: The settings are improper.
|
static |
No error occurs.
|
static |
A general error occurs (no specified reason).
|
static |
An invalid parameter is used. For example, the specific channel name includes illegal characters.
|
static |
The SDK module is not ready. We recommend the following methods to solve this error:
|
static |
The SDK does not support this function.
|
static |
The request is rejected. This is for internal SDK internal use only, and it will not return to the application through any API or callback event.
|
static |
The buffer size is not big enough to store the returned data.
|
static |
The SDK is not initialized before calling this API.
|
static |
The state is invalid.
|
static |
No permission. Check if the user has granted access to the audio or video device.
|
static |
An API timeout. Some APIs require the SDK to return the execution result, and this error occurs if the request takes too long for the SDK to process.
|
static |
The request is cancelled. This is for internal SDK internal use only, and it will not return to the application through any API or callback event.
|
static |
The call frequency is too high. This is for internal SDK internal use only, and it will not return to the application through any API or callback event.
|
static |
The SDK fails to bind to the network socket. This is for internal SDK internal use only, and is not returned to the app through any method or callback.
|
static |
The network is unavailable. This is for internal SDK internal use only, and it will not return to the application through any API or callback event.
|
static |
The request to join the channel is rejected. This error usually occurs when the user is already in the channel, and still calls the API to join the channel, for example, {}.
|
static |
The request to leave the channel is rejected. This error usually occurs when the user has already left the channel, and still calls the API to leave the channel, for example, {}.
|
static |
Resources are occupied, and cannot be reused.
|
static |
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.
|
static |
On Windows, specific firewall settings can cause the SDK to fail to initialize and crash.
|
static |
The app uses too much of the system resource and the SDK fails to allocate any resource.
|
static |
The specified App ID is invalid.
|
static |
The specified channel name is invalid.
|
static |
Fails to get server resources in the specified region.
|
static |
The Token expired due to one of the following reasons:
|
static |
The Token is invalid due to one of the following reasons: The App Certificate for the project is enabled on the Dashboard, but the user is still using the App ID. Once the App Certificate is enabled, the user must use a Token. The uid field is mandatory, and users must set the same uid when setting the uid parameter when calling joinChannel.
|
static |
The CONNECTION_INTERRUPTED callback. This applies to the Agora Web SDK only.
|
static |
The CONNECTION_LOST callback. This applies to the Agora Web SDK only.
|
static |
The user is not in the channel.
|
static |
The data size is too big.
|
static |
The bitrate is limited.
|
static |
Too many data streams.
|
static |
A timeout occurs for the data stream transmission.
|
static |
Switching the user role fails. Please try to rejoin the channel.
|
static |
Failed to decrypt.
|
static |
The user ID is invalid.
|
static |
The client is banned by the server.
|
static |
Encryption is enabled when the user calls the {addPublishStreamUrl} method (CDN live streaming does not support encrypted streams).
|
static |
License credential is invalid
|
static |
The user account is invalid, usually because the data format of the user account is incorrect.
|
static |
The extension library is not integrated, such as the library for enabling deep-learning noise reduction.
|
static |
Failed to load the media engine.
|
static |
General error on the Audio Device Module (no classified reason).
|
static |
Audio Device Module: Error in initializing the playback device.
|
static |
Audio Device Module: Error in starting the playback device.
|
static |
Audio Device Module: Error in stopping the playback device.
|
static |
Audio Device Module: Error in initializing the recording device.
|
static |
Audio Device Module: Error in starting the recording device.
|
static |
Audio Device Module: Error in stopping the recording device.
|
static |
Video Device Module: The camera is not authorized.
|
static |
0, 160 x 120 @ 15 fps, 65 kbit/s
|
static |
120 x 120 @ 15 fps, 50 kbit/s
|
static |
320 x 180 @ 15 fps, 140 kbit/s
|
static |
180 x 180 @ 15 fps, 100 kbit/s
|
static |
240 x 180 @ 15 fps, 120 kbit/s
|
static |
320 x 240 @ 15 fps, 200 kbit/s
|
static |
240 x 240 @ 15 fps, 140 kbit/s
|
static |
424 x 240 @ 15 fps, 220 kbit/s
|
static |
640 x 360 @ 15 fps, 400 kbit/s
|
static |
360 x 360 @ 15 fps, 260 kbit/s
|
static |
640 x 360 @ 30 fps, 600 kbit/s
|
static |
360 x 360 @ 30 fps, 400 kbit/s
|
static |
480 x 360 @ 15 fps, 320 kbit/s
|
static |
480 x 360 @ 30 fps, 490 kbit/s
|
static |
640 x 360 @ 15 fps, 600 kbit/s
|
static |
640 x 360 @ 24 fps, 800 kbit/s
|
static |
640 x 360 @ 24 fps, 1000 kbit/s
|
static |
640 x 480 @ 15 fps, 500 kbit/s
|
static |
480 x 480 @ 15 fps, 400 kbit/s
|
static |
640 x 480 @ 30 fps, 750 kbit/s
|
static |
480 x 480 @ 30 fps, 600 kbit/s
|
static |
848 x 480 @ 15 fps, 610 kbit/s
|
static |
848 x 480 @ 30 fps, 930 kbit/s
|
static |
640 x 480 @ 10 fps, 400 kbit/s
|
static |
1280 x 720 @ 15 fps, 1130 kbit/s
|
static |
1280 x 720 @ 30 fps, 1710 kbit/s
|
static |
960 x 720 @ 15 fps, 910 kbit/s
|
static |
960 x 720 @ 30 fps, 1380 kbit/s
|
static |
1920 x 1080 @ 15 fps, 2080 kbit/s
|
static |
1920 x 1080 @ 30 fps, 3150 kbit/s
|
static |
1920 x 1080 @ 60 fps, 4780 kbit/s
|
static |
2560 x 1440 @ 30 fps, 4850 kbit/s
|
static |
2560 x 1440 @ 60 fps, 7350 kbit/s
|
static |
3840 x 2160 @ 30 fps, 8910 kbit/s
|
static |
3840 x 2160 @ 60 fps, 13500 kbit/s
|
static |
Default video profile: 640 x 360 @ 15 fps, 400 kbit/s
|
static |
0: The default audio profile.
AUDIO_PROFILE_SPEECH_STANDARD
(1).
|
static |
1: A sample rate of 32 kHz, audio encoding, mono, and a bitrate up to 18 Kbps.
|
static |
2: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 64 Kbps.
|
static |
3: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 80 Kbps.
|
static |
4: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 96 Kbps.
|
static |
5: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 128 Kbps.
|
static |
0: (Recommended) The default audio scenario.
|
static |
3: (Recommended) The live gaming scenario, which needs to enable the gaming audio effects in the speaker mode in a live broadcast scenario. Choose this scenario to achieve high-fidelity music playback.
|
static |
5: The chatroom scenario, which needs to keep recording when setClientRole to audience. Normally, app developer can also use mute api to achieve the same result, and we implement this 'non-orthogonal' behavior only to make API backward compatible.
|
static |
7: The chorus scenario.
|
static |
8: The Meeting scenario.
|
static |
Turn off voice beautifier effects and use the original voice.
|
static |
Turn off audio effects and use the original voice.
|
static |
A more magnetic voice.
|
static |
A fresher voice.
|
static |
A more vital voice.
|
static |
Singing beautifier effect.
setVoiceBeautifierPreset(SINGING_BEAUTIFIER)
to process a female-sounding voice; otherwise, you may experience vocal distortion.
|
static |
A more vigorous voice.
|
static |
A deeper voice.
|
static |
A mellower voice.
|
static |
A falsetto voice.
|
static |
A fuller voice.
|
static |
A clearer voice.
|
static |
A more resounding voice.
|
static |
A more ringing voice.
|
static |
A ultra high quality voice.
|
static |
An audio effect typical of a KTV venue.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator.
|
static |
An audio effect typical of a concert hall.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator.
|
static |
An audio effect typical of a recording studio.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator.
|
static |
An audio effect typical of a vintage phonograph.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator.
|
static |
A virtual stereo effect that renders monophonic audio as stereo audio.
profile
parameter to AUDIO_PROFILE_MUSIC_STANDARD_STEREO(3)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator; otherwise, the enumerator setting does not take effect.
|
static |
A more spatial audio effect.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator.
|
static |
A more ethereal audio effect.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator.
|
static |
A 3D voice effect that makes the voice appear to be moving around the user. The default cycle period of the 3D voice effect is 10 seconds. To change the cycle period, call {setAudioEffectParameters} after this method. Call RtcEngine#setAudioProfile setAudioProfile} and set the profile
parameter to AUDIO_PROFILE_MUSIC_STANDARD_STEREO(3)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator; otherwise, the enumerator setting does not take effectIf the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.
|
static |
virtual suround sound.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator.
|
static |
The voice of a middle-aged man.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator.
|
static |
The voice of an old man.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator.
|
static |
The voice of a boy.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator.
|
static |
The voice of a young woman.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator.
|
static |
The voice of a girl.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator.
|
static |
The voice of Pig King, a character in Journey to the West who has a voice like a growling bear.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator.
|
static |
The voice of Hulk.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator.
|
static |
An audio effect typical of R&B music.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator; otherwise, the enumerator setting does not take effect.
|
static |
An audio effect typical of popular music.
profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator; otherwise, the enumerator setting does not take effect.
|
static |
A pitch correction effect that corrects the user's pitch based on the pitch of the natural C major scale. To change the basic mode and tonic pitch, call {setAudioEffectParameters} after this method. To achieve better audio effect quality, Agora recommends calling { RtcEngine#setAudioProfile setAudioProfile} and setting the profile
parameter to AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
or AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
before setting this enumerator.
|
static |
Turn off voice conversion effects and use the original voice.
|
static |
A gender-neutral voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
|
static |
A sweet voice. To avoid audio distortion, ensure that you use this enumerator to process a female-sounding voice.
|
static |
A steady voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.
|
static |
A deep voice. To avoid audio distortion, ensure that you use this enumerator to process a male-sounding voice.
|
static |
Turn off headphone EQ and use the original voice.
|
static |
For over-ear headphones.
|
static |
For in-ear headphones.
|
static |
0: Communication. Use this profile when there are two users in the channel.
|
static |
1: (Default) Live Broadcast. Use this profile when there are more than two users in the channel.
|
static |
2: Gaming. This profile is deprecated.
|
static |
3: Cloud Gaming. This profile is deprecated.
|
static |
4: Communication 1v1. This profile is deprecated.
|
static |
The broadcaster.
|
static |
The audience.
|
static |
1: Low latency. A low latency audience's jitter buffer is 1.2 second.
|
static |
2: Ultra low latency. An ultra low latency audience's jitter buffer is 0.5 second.
|
static |
0: The user has quit the call.
|
static |
|
static |
|
static |
-1: The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level from CAPTURE_BRIGHTNESS_LEVEL_TYPE
in the next callback.
|
static |
0: The brightness level of the video image is normal.
|
static |
1: The brightness level of the video image is too bright.
|
static |
2: The brightness level of the video image is too dark.
|
static |
The external video stream imported successfully.
|
static |
The external video stream already exists.
|
static |
The external video stream import is unauthorized
|
static |
Import external video stream timeout.
|
static |
The external video stream failed to import.
|
static |
The xternal video stream imports successfully.
|
static |
No external video stream is found.
|
static |
The external video stream is stopped from being unauthorized.
|
static |
Importing the external video stream timeout.
|
static |
Importing the external video stream failed.
|
static |
The external video stream is broken.
|
static |
The quality report in JSON format.
|
static |
The quality report in HTML format.
|
static |
1: Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.
|
static |
2: Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio will be filled with black.
|
static |
3: This mode is deprecated.
|
static |
The default mirror mode, that is, the mode set by the SDK.
|
static |
Enable the mirror mode.
|
static |
Disable the mirror mode
|
static |
0: No content hint.
|
static |
1: Motion-intensive content. Choose this option if you prefer smoothness or when you are sharing a video clip, movie, or video game.
|
static |
2: Motionless content. Choose this option if you prefer sharpness or when you are sharing a picture, PowerPoint slide, or text.
|
static |
Video captured by the camera.
|
static |
Video captured by the secondary camera.
|
static |
Video for screen sharing.
|
static |
Video for secondary screen sharing.
|
static |
Not define.
|
static |
Video for media player sharing.
|
static |
Video for png image.
|
static |
Video for png image.
|
static |
Video for png image.
|
static |
Remote video received from network.
|
static |
Video for transcoded.
|
static |
Do not output any log.
|
static |
Output all the API logs.
|
static |
Output logs of the CRITICAL, ERROR, WARNING, and INFO level.
|
static |
Output logs of the CRITICAL, ERROR, and WARNING level.
|
static |
Output logs of the CRITICAL and ERROR level.
|
static |
Output logs of the CRITICAL level.
|
static |
-1: The default audio route.
|
static |
0: Headset.
|
static |
1: Earpiece. The SDK uses the in-call volume.
|
static |
2: Headset with no microphone.
|
static |
3: Speakerphone.
|
static |
4: Loudspeaker
|
static |
5: Bluetooth headset.
|
static |
0: The high-stream video, that is, the video stream featuring in high resolution and high bitrate.
|
static |
1: The low-stream video, that is, the video stream featuring in low resolution and low bitrate.
|
static |
High Priority, if you set a user with high priority, then streams of this user will have high priority than streams of other users with normal default priority. i.e., the SDK will take priority into account when deciding which user's stream need to fallback when network congestion occurs.
|
static |
Default priority.
|
static |
Hardware encoder.
|
static |
Software encoder.
|
static |
Read-only mode, users only read the AudioFrame data without modifying anything. For example, when users acquire data with the Agora SDK, and push RTMP streams by themselves.
|
static |
Read and write mode, users read the data from AudioFrame, modify it and then play it. For example, when users have their own sound-effect processing module, and want to do voice pre-processing, such as a voice change.
|
static |
0x01
: The position for observing the playback audio of all remote users after mixing, which enables the SDK to trigger the onPlaybackFrame callback.
|
static |
0x01 << 1
: The position for observing the recorded audio of the local user, which enables the SDK to trigger the onRecordFrame callback.
|
static |
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.
|
static |
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.
|
static |
0x01 << 4
: The position for observing the ear monitoring audio of the local user, which enables the SDK to trigger the onEarMonitoringAudioFrame callback.
|
static |
-1: The network type is unknown.
|
static |
0: The SDK disconnects from the network.
|
static |
1: The network type is LAN.
|
static |
2: The network type is Wi-Fi (including hotspots).
|
static |
3: The network type is mobile 2G.
|
static |
4: The network type is mobile 3G.
|
static |
5: The network type is mobile 4G.
|
static |
6: The network type is mobile 5G.
|
static |
Bound to the channel lifecycle.
|
static |
Bound to the owner of the RTMP stream.
|
static |
1: mic audio file recording.
|
static |
2: playback audio file recording.
|
static |
3: mixed audio file recording, include mic and playback.
|
static |
Low quality, file size is around 1.2 MB after 10 minutes of recording.
|
static |
Medium quality, file size is around 2 MB after 10 minutes of recording.
|
static |
High quality, file size is around 3.75 MB after 10 minutes of recording.
|
static |
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.
|
static |
1: mic audio frame observer
|
static |
2: playback audio frame observer
|
static |
3: mixed audio frame observer
|
static |
1: codecType AAC; sampleRate 16000; quality low which around 1.2 MB after 10 minutes
|
static |
2: codecType AAC; sampleRate 16000; quality medium which around 2 MB after 10 minutes
|
static |
3: codecType AAC; sampleRate 32000; quality low which around 1.2 MB after 10 minutes
|
static |
4: codecType AAC; sampleRate 32000; quality medium which around 2 MB after 10 minutes
|
static |
5: codecType AAC; sampleRate 32000; quality high which around 3.5 MB after 10 minutes
|
static |
6: codecType AAC; sampleRate 48000; quality medium which around 2 MB after 10 minutes
|
static |
7: codecType AAC; sampleRate 48000; quality high which around 3.5 MB after 10 minutes
|
static |
11: codecType OPUS; sampleRate 16000; quality low which around 1.2 MB after 10 minutes
|
static |
12: codecType OPUS; sampleRate 16000; quality medium which around 2 MB after 10 minutes
|
static |
13: codecType OPUS; sampleRate 48000; quality medium which around 2 MB after 10 minutes
|
static |
14: codecType OPUS; sampleRate 48000; quality high which around 3.5 MB after 10 minutes
|
static |
None
|
static |
Audio only
|
static |
Video only
|
static |
Audio and video
|
static |
Local video state types Initial state
|
static |
The capturer starts successfully.
|
static |
The first video frame is successfully encoded.
|
static |
The local video fails to start.
|
static |
Reasons for the local video failure. 0: The local video is normal.
|
static |
1: No specified reason for the local video failure.
|
static |
2: No permission to use the local video device.
|
static |
3: The local video capturer is in use.
|
static |
4: The local video capture fails. Check whether the capturer is working properly.
|
static |
5: The local video encoding fails.
|
static |
8: The local video device not found.
|
static |
Local audio state types 0: The local audio is in the initial state.
|
static |
1: The capturer starts successfully.
|
static |
2: The first audio frame is successfully encoded.
|
static |
3: The local audio fails to start.
|
static |
Reasons for the local audio failure. 0: The local audio is normal.
|
static |
1: No specified reason for the local audio failure.
|
static |
2: No permission to use the local audio device.
|
static |
3: The microphone is in use.
|
static |
4: The local audio capture failed. Check whether the audio capture device is working properly.
|
static |
5: The local audio encoding fails.
|
static |
Remote audio state 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).
|
static |
1: The first remote audio packet is received.
|
static |
2: The remote audio stream is decoded and plays normally, probably due to REMOTE_AUDIO_REASON_NETWORK_RECOVERY(2), REMOTE_AUDIO_REASON_LOCAL_ENABLE_AUDIO(4), or REMOTE_AUDIO_REASON_REMOTE_UNMUTED(6).
|
static |
3: The remote audio is frozen, probably due to REMOTE_AUDIO_REASON_NETWORK_CONGESTION(1).
|
static |
4: The remote audio fails to start, probably due to REMOTE_AUDIO_REASON_INTERNAL(0).
|
static |
Reasons for a remote audio state change. 0: Internal reasons.
|
static |
1: Network congestion.
|
static |
2: Network recovery.
|
static |
3: The local user stops receiving the remote audio stream or disables the audio module.
|
static |
4: The local user resumes receiving the remote audio stream or enables the audio module.
|
static |
5: The remote user stops sending the audio stream or disables the audio module.
|
static |
6: The remote user resumes sending the audio stream or enables the audio module.
|
static |
7: The remote user leaves the channel.
|
static |
Remote video state. Default state
|
static |
1: video packet has been received, but not decoded yet.
|
static |
2: Remote video is playing.
|
static |
3: Remote video is frozen, probably due to network issue.
|
static |
4: Failed.
|
static |
Reasons for a remote video state change. 0: Internal reasons.
|
static |
1: Network congestion.
|
static |
2: Network recovery.
|
static |
3: The local user stops receiving the remote video stream or disables the video module.
|
static |
4: The local user resumes receiving the remote video stream or enables the video module.
|
static |
5: The remote user stops sending the video stream or disables the video module.
|
static |
6: The remote user resumes sending the video stream or enables the video module.
|
static |
7: The remote user leaves the channel.
|
static |
8: The remote media stream falls back to the audio-only stream due to poor network conditions.
|
static |
9: The remote media stream switches back to the video stream after the network conditions improve.
|
static |
12: The remote user sdk(only for iOS) in background.
|
static |
The audio mixing state types 710: The audio mixing file is playing.
|
static |
711: The audio mixing file pauses playing.
|
static |
713: The audio mixing file stops playing.
|
static |
714: An exception occurs when playing the audio mixing file. See the errorCode for details.
|
static |
The audio mixing error type. 701: An error occurs in opening the audio mixing file.
|
static |
702: The SDK opens the audio mixing file too frequently.
|
static |
715: The audio mixing file is played once.
|
static |
716: The audio mixing file is all played out.
|
static |
716: The audio mixing file stopped by user
|
static |
703: The audio mixing file playback is interrupted.
|
static |
0: No error.
|
static |
Video codec types VIDEO_CODEC_TYPE
|
static |
Transport CC enabled
|
static |
Packetize Mode H264PacketizeMode
|
static |
Video Frame Type. VIDEO_FRAME_TYPE
|
static |
clockwise rotation. VIDEO_ORIENTATION 0: No rotation.
|
static |
90: 90 degrees.
|
static |
180: 180 degrees.
|
static |
270: 270 degrees.
|
static |
The state of the rhythm player. 810: The rhythm player is idle.
|
static |
811: The rhythm player is opening files.
|
static |
812: Files opened successfully, the rhythm player starts decoding files.
|
static |
813: Files decoded successfully, the rhythm player starts mixing the two files and playing back them locally.
|
static |
814: The rhythm player is starting to fail, and you need to check the error code for detailed failure reasons
|
static |
Reasons for a license verify fail. 1: Invalid license
|
static |
2: License expired
|
static |
3: Exceed license minutes limit
|
static |
4: License use in limited period
|
static |
5: Same license used in different devices at the same time
|
static |
99: SDK internal error
|
static |
The error codes of the rhythm player. 0: The rhythm player works well.
|
static |
1: he rhythm player occurs a internal error.
|
static |
801: The rhythm player can not open the file.
|
static |
802: The rhythm player can not play the file.
|
static |
803: The file duration over the limit. The file duration limit is 1.2 seconds.
|
static |
The stream publish state. 0: The initial publishing state after joining the channel.
|
static |
1: Fails to publish the local stream.
|
static |
2: Publishing the local stream.
|
static |
3: Successfully publishes the local stream.
|
static |
The stream subscribe state. 0: The initial subscribing state after joining the channel.
|
static |
1: Fails to subscribing to the remote stream.
|
static |
2: Subscribing.
|
static |
3: Subscribes to and receives the remote stream successfully.
|
static |
Events during the RTMP or RTMPS streaming. 1: An error occurs when you add a background image or a watermark image to the RTMP or RTMPS stream.
|
static |
2: The streaming URL is already being used for CDN live streaming. If you want to start new streaming, use a new streaming URL.
|
static |
3: advanced feature not support
|
static |
4: Client request too frequently.
|
static |
The RTMP or RTMPS streaming state. 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
.
|
static |
1: The SDK is connecting to the streaming server and the RTMP server.
This state is reported after you call addPublishStreamUrl
.
|
static |
2: The RTMP streaming publishes. The SDK successfully publishes the RTMP streaming and returns this state.
|
static |
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.
RTMP_STREAM_PUBLISH_STATE_RUNNING(2)
is reported.RTMP_STREAM_PUBLISH_STATE_FAILURE(4)
is reported. You can also reconnect to the server by calling removePublishStreamUrl
and addPublishStreamUrl
.
|
static |
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.
|
static |
5: The SDK is disconnecting to Agora's streaming server and the CDN server. This state is triggered after you call the removePublishStreamUrl method.
|
static |
Error codes of the RTMP streaming. 0: The RTMP or RTMPS streaming publishes successfully.
|
static |
|
static |
2: The RTMP or RTMPS streaming is encrypted and cannot be published.
|
static |
|
static |
addPublishStreamUrl
method to publish the streaming again.
|
static |
5: An error occurs in the CDN server.
|
static |
6: The RTMP or RTMPS streaming publishes too frequently.
|
static |
7: The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones.
|
static |
8: The host manipulates other hosts' URLs. Check your app logic.
|
static |
9: Agora server fails to find the RTMP or RTMPS streaming.
|
static |
10: The format of the RTMP or RTMPS streaming URL is not supported. Check whether the URL format is correct.
|
static |
11: Current role is not broadcaster. Check whether the role of the current channel.
|
static |
13: Call updateTranscoding, but no mix stream.
|
static |
14: Network error.
|
static |
15: User AppId have not authorized to push stream.
|
static |
16: invalid privilege.
|
static |
100: The streaming has been stopped normally. After you call removePublishStreamUrl to stop streaming, the SDK returns this value.
|
static |
Error type of encryption.
|
static |
Type of permission.
|
static |
The default connection ID.
|
static |
1: The SDK is disconnected from Agora edge server.
joinChannel
method.
|
static |
2: The SDK is connecting to Agora edge server.
joinChannel
method, the SDK starts to establish a connection to the specified channel, triggers the onConnectionStateChanged callback, and switches to the {CONNECTION_STATE_CONNECTING} state. When a user successfully joins a channel, the SDK triggers the {onConnectionStateChanged} callback and switches to the Constants#CONNECTION_STATE_CONNECTED CONNECTION_STATE_CONNECTED} state. After the SDK joins the channel and when it finishes initializing the media engine, the SDK triggers the onJoinChannelSuccess callback.
|
static |
3: The SDK is connected to Agora edge server and has joined a channel. You can now publish or subscribe to a media stream in the channel. If the connection to the channel is lost because, for example, the network is down or switched, the SDK triggers:
|
static |
4: The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.
|
static |
5: The SDK fails to connect to Agora edge server or join the channel. You must call the leaveChannel method to leave this state and call the joinChannel
method again to rejoin the channel. If the SDK is banned from joining the channel by the Agora server (through the RESTful API), the SDK triggers the {onConnectionBanned} and { IRtcEngineEventHandler#onConnectionStateChanged onConnectionStateChanged} callbacks.
|
static |
0: The SDK is connecting to Agora edge server.
|
static |
1: The SDK has joined the channel successfully.
|
static |
2: The connection between the SDK and Agora edge server is interrupted.
|
static |
3: The connection between the SDK and Agora edge server is banned by Agora edge server.
|
static |
4: The SDK fails to join the channel for more than 20 minutes and stops reconnecting to the channel.
|
static |
5: The SDK has left the channel.
|
static |
6: The specified App ID is invalid. Try to rejoin the channel with a valid App ID.
|
static |
7: The specified channel name is invalid. Try to rejoin the channel with a valid channel name.
|
static |
8: The generated token is invalid probably due to the following reasons:
joinChannel
method is different from the uid that you pass for generating the token.
|
static |
9: The token has expired. Generate a new token from your server.
|
static |
10: The user is banned by the server.
|
static |
11: The SDK tries to reconnect after setting a proxy server.
|
static |
12: The token renews.
|
static |
13: The client IP address has changed, probably due to a change of the network type, IP address, or network port.
|
static |
14: Timeout for the keep-alive of the connection between the SDK and Agora edge server. The connection state changes to Constants#CONNECTION_STATE_RECONNECTING(4).
|
static |
15: The SDK has rejoined the channel successfully.
|
static |
16: The connection between the SDK and the server is lost.
|
static |
17: The change of connection state is caused by echo test.
|
static |
18: The local IP Address is changed by user.
|
static |
/* 19: There is a disconnection due to joining channel on another device with the same uid.
|
static |
20: The connection is failed due to too many broadcasters in the channel.
|
static |
0: WIFI signal is weak.
|
static |
1: Channel congestion.
|
static |
0: Please get close to AP.
|
static |
1: The user is advised to connect to the prompted SSID.
|
static |
2: The user is advised to check whether the AP supports 5G band and enable 5G band (the aciton link is attached), or purchases an AP that supports 5G. AP does not support 5G band.
|
static |
3: The user is advised to change the SSID of the 2.4G or 5G band (the aciton link is attached). The SSID of the 2.4G band AP is the same as that of the 5G band.
|
static |
0: The state is normal.
|
static |
1: An error occurs in the server response.
|
static |
2: No server response. You can call the leaveChannel method to leave the channel.
|
static |
3: The SDK fails to access the service, probably due to limited resources of the server.
|
static |
4: Fails to send the relay request.
|
static |
5: Fails to accept the relay request.
|
static |
6: The server fails to receive the media stream.
|
static |
7: The server fails to send the media stream.
|
static |
8: The SDK disconnects from the server due to poor network connections. You can call the leaveChannel method to leave the channel.
|
static |
9: An internal error occurs in the server.
|
static |
10: The token of the source channel has expired.
|
static |
11: The token of the destination channel has expired.
|
static |
0: The user disconnects from the server due to poor network connections.
|
static |
1: The network reconnects.
|
static |
2: The user joins the source channel.
|
static |
3: The user joins the destination channel.
|
static |
4: The SDK starts relaying the media stream to the destination channel.
|
static |
5: The server receives the video stream from the source channel.
|
static |
6: The server receives the audio stream from the source channel.
|
static |
7: The destination channel is updated.
|
static |
8: The destination channel update fails due to internal reasons.
|
static |
9: The destination channel does not change, which means that the destination channel fails to be updated.
|
static |
10: The destination channel name is NULL.
|
static |
11: The video profile is sent to the server.
|
static |
12: pause send packet to dest channel success.
|
static |
13: pause send packet to dest channel failed.
|
static |
14: resume send packet to dest channel success.
|
static |
15: pause send packet to dest channel failed.
|
static |
0: The SDK is initializing.
|
static |
1: The SDK tries to relay the media stream to the destination channel.
|
static |
2: The SDK successfully relays the media stream to the destination channel.
|
static |
3: A failure occurs.
|
static |
media relay max dest channel size
|
static |
1: Do not add an audio filter to the in-ear monitor.
|
static |
2: Add an audio filter to the in-ear monitor.
|
static |
4: Enable noise suppression to the in-ear monitor.
|
static |
0: connectivity first
|
static |
1: local only
|
static |
0: QoE of the local user is good.
|
static |
1: QoE of the local user is poor.
|
static |
0: No reason, indicating good QoE of the local user.
|
static |
1: The remote user's network quality is poor.
|
static |
2: The local user's network quality is poor.
|
static |
4: The local user's Wi-Fi or mobile network signal is weak.
|
static |
8: The local user enables both Wi-Fi and bluetooth, and their signals interfere with each other. As a result, audio transmission quality is undermined.
|
static |
0: The automatic mode. In this mode, the SDK attempts a direct connection to SD-RTN™ and automatically switches to TLS 443 if the attempt fails. As of v3.6.2, the SDK has this mode enabled by default.
|
static |
1: The cloud proxy for the UDP protocol, that is, the Force UDP cloud proxy mode. In this mode, the SDK always transmits data over UDP.
|
static |
2: The cloud proxy for the TCP (encryption) protocol, that is, the Force TCP cloud proxy mode. In this mode, the SDK always transmits data over TLS 443.
|
static |
0: Reserved for future use.
|
static |
1: The cloud proxy for the UDP protocol, that is, the Force UDP cloud proxy mode. In this mode, the SDK always transmits data over UDP.
|
static |
2: The cloud proxy for the TCP (encryption) protocol, that is, the Force TCP cloud proxy mode. In this mode, the SDK always transmits data over TLS 443.
|
static |
3: Reserved for future use.
|
static |
4: The automatic mode. In this mode, the SDK attempts a direct connection to SD-RTN™ and automatically switches to TLS 443 if the attempt fails.
|
static |
16: The user refuses to grant screen capture permission to the application.
|
static |
2: Due to system limitations, screen capture is not available on systems earlier than Android 5 (that is, Android API level 21). The SDK reports this error code when you call startScreenCapture on systems earlier than Android 5.
|
static |
3: Due to system limitations, system audio cannot be captured on systems earlier than Android 10 (that is, API level 29). The SDK reports this error when you call {startScreenCapture} and set captureAudio
as true
on systems later than Android 5 (API level 21) and earlier than Android 10 (API level 29). v3.7.0