The information of the target channel. See
When you successfully call this method, the SDK returns a media player cache manager instance. The cache manager is a singleton pattern. Therefore, multiple calls to this method returns the same instance.
-Make sure the
Before calling any APIs in the
Make sure the
The cache manager is a singleton pattern. Therefore, multiple calls to this method returns the same instance.
+The
This method tests whether the audio device for local playback works properly. Once a user starts the test, the SDK plays an audio file specified by the user. If the user can hear the audio, the playback device works properly.
After calling this method, the SDK triggers the
The difference between this method and the
This method tests whether the audio capturing device works properly. After calling this method, the SDK triggers the
The difference between this method and the
This method stops the audio playback device test. You must call this method to stop the test after calling the
This method stops the audio capturing device test. You must call this method to stop the test after calling the
To publish a custom audio source, see the following steps:
Before calling this method, call
After a successful call of this method, the app pulls the decoded and mixed audio data for playback.
-Call this method after joining a channel.
+Before calling this method, call
Both this method and the
This method is only used for retrieving audio data after remote mixing. If you need to get audio data from different audio processing stages such as capture and playback, you can register the corresponding callbacks by calling
Call this method to push external audio frames through the audio track.
+Before calling this method to push external audio data, perform the following steps:
None.
+When the method call succeeds, there is no return value; when fails, the
You can push the video frame either by calling this method or by calling
You can push the video frame either by calling this method or by calling
Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger
Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger the
Call this method before joining a channel.
+None.
+The observer instance.
You can call this method to register the
If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one
When calling this method to register a video observer, you can register callbacks in the
After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as virtual backgrounds and image enhacement by yourself.
+Agora provides an open source sample project
Call this method before joining a channel.
+When handling the video data returned in the callbacks, pay attention to the changes in the
This method applies to scenarios where you want to use external audio data for playback. After you set the external audio sink, you can call
After enabling the external audio sink, you can call
This method applies to scenarios where you want to use external audio data for playback.
+Call this method before joining a channel.
+Once you enable the external audio sink, the app will not retrieve any audio data from the
Whether to enable or disable the external audio sink:
The sample rate (Hz) of the external audio sink, which can be set as 16000, 32000, 44100, or 48000.
-When the method call succeeds, there is no return value; when fails, the
Call this method before joining a channel.
+None.
+Whether to enable the external audio source:
Whether to play the external audio source:
Whether to publish audio to the remote users:
After calling this method to enable an external video source, you can call
Call this method before joining a channel.
+Dynamic switching of video sources is not supported within the channel. To switch from an external video source to an internal video source, you must first leave the channel, call this method to disable the external video source, and then rejoin the channel.
+When the method call succeeds, there is no return value; when fails, the
On the Android platform, if you need to open a file in URI format, use
This method supports playing URI files starting with
This method supports playing URI files starting with
If you want to choose the CDN route for playing the media resource, you can call the
This method supports opening media files of different sources, including a custom media source, and allows you to configure the playback scenarios.
- +This method supports opening media files of different sources, including a custom media source, and allows you to configure the playback scenarios.
+This method supports opening different types of media files, including URI files starting with
This method supports opening different types of media files, including files starting with
You can call this method either before or after joining a channel.
+This method is called asynchronously. If you need to play a media file, make sure you receive the
The audio frame observer, reporting the reception of each audio frame. See
The audio frame observer, reporting the reception of each audio frame. See
The audio frame observer, reporting the reception of each audio frame. See
The use mode of the audio frame. See
The use mode of the audio frame:
The use mode of the audio frame:
Sets the render mode of the view. See
Sets the render mode of the view:
Sets the render mode of the view:
Before calling any APIs in the
You can call this method either before or after joining a channel.
+None.
+An
When video screenshot and upload function is enabled, the SDK takes screenshots and uploads videos sent by local users based on the type and frequency of the module you set in
This method can be called either before or after joining the channel.
+Before calling this method, ensure that you have contacted
In scenarios requiring high security, Agora recommends calling this method to enable the built-in encryption before joining a channel.
-All users in the same channel must use the same encryption mode and encryption key. After the user leaves the channel, the SDK automatically disables the built-in encryption. To enable the built-in encryption, call this method before the user joins the channel again.
-After the user leaves the channel, the SDK automatically disables the built-in encryption. To enable the built-in encryption, call this method before the user joins the channel again.
+Scenarios with higher security requirements.
+Call this method before joining a channel.
+You can call this method either before or after joining a channel.
-Once face detection is enabled, the SDK triggers the
This method needs to be called after the camera is started (for example, by calling
None.
+After successfully calling this method, the SDK enables the instant frame rendering mode, which can speed up the first frame rendering speed after the user joins the channel.
-
-
After successfully calling this method, the SDK enables the instant frame rendering mode, which can speed up the first frame rendering after the user joins the channel.
Agora recommends that you enable this mode for the audience in a live streaming scenario.
Agora recommends that you call this method before joining a channel.
+Once the method is successfully called, you can only cancel instant rendering by calling
When the method call succeeds, there is no return value; when fails, the
+
The voice AI tuner supports enhancing sound quality and adjusting tone style.
+Social entertainment scenes including online KTV, online podcast and live streaming in showrooms, where high sound quality is required.
+This method can be called either before or after joining the channel.
+None.
+When the method call succeeds, there is no return value; when fails, the
When a user joins a channel on a client, a
Call this method after joining a channel.
+None.
+When the method call succeeds, there is no return value; when fails, the
The type of the advanced feature.
Whether to stop subscribing to the audio streams of all remote users:
Whether to stop subscribing to the video streams of all remote users.
Whether to stop publishing the local audio stream:
Whether to stop publishing the local video stream.
Whether to subscribe to the specified remote user's audio stream.
Whether to subscribe to the specified remote user's video stream.
When the method call succeeds, there is no return value; when fails, the
After calling
Call this method after joining a channel.
None.
+When the method call succeeds, there is no return value; when fails, the
To play multiple audio effect files at the same time, call this method multiple times with different
To play multiple audio effect files at the same time, call this method multiple times with different
Agora supports URL addresses, absolute paths, or file paths that start with
The absolute path or URL address (including the suffixes of the filename) of the audio effect file. You might encounter permission issues if you use an absolute path to access a local file, so Agora recommends using a URI address instead. For example,
To play multiple audio effect files at the same time, call this method multiple times with different
To play multiple audio effect files at the same time, call this method multiple times with different
You can call this method either before or after joining a channel.
+If you need to play an online audio effect file, Agora recommends that you cache the online audio effect file to your local device, call
The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example,
The file path. The SDK supports URLs and absolute path of local files. The absolute path needs to be accurate to the file name and extension. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP.
The file path. The SDK supports URI addresses starting with
The file path. The SDK supports file paths starting with
The channel name that you want to preload. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
To ensure smooth communication, It is recommended that you limit the size of the audio effect file. You can call this method to preload the audio effect before calling
Ensure the size of all preloaded files does not exceed the limit.
For the audio file formats supported by this method, see
Agora recommends that you call this method before joining a channel.
+None.
+Call this method to push external audio frames through the audio track.
+Before calling this method to push external audio data, perform the following steps:
None.
+After calling the
You can push the video frame either by calling this method or by calling
You can push the video frame either by calling this method or by calling
This method removes the specified callback handler. For callback events that you want to listen for only once, call this method to remove the relevant callback handler after you have received them.
+This method removes the specified callback handler. For callback events that you want to listen for only once, call this method to remove the relevant callback handler after you have received them.
You can call this method too remove all added callback events.
When the method call succeeds, there is no return value; when fails, the
After you call
Call this method after
None.
+When the method call succeeds, there is no return value; when fails, the
This method resumes playing and mixing the music file. Call this method when you are in a channel.
+After calling
Call this method after joining a channel.
+None.
Sends data stream messages to all users in a channel. The SDK has the following restrictions on this method:
After calling
The SDK has the following restrictions on this method:
A successful method call triggers the
A successful method call triggers the
You can call this method to enable AI noise suppression function. Once enabled, the SDK automatically detects and reduces stationary and non-stationary noise from your audio on the premise of ensuring the quality of human voice. Stationary noise refers to noise signal with constant average statistical properties and negligibly small fluctuations of level within the period of observation. Common sources of stationary noises are:
In scenarios such as co-streaming, online education and video meeting, this function can detect and reduce background noises to improve experience.
You can call this method either before or after joining a channel.
+The AI noise suppression modes. See
The AI noise suppression modes:
The AI noise suppression modes:
When a local music file is mixed with a local human voice, call this method to set the pitch of the local music file only.
-When a local music file is mixed with a local human voice, call this method to set the pitch of the local music file only.
+You need to call this method after calling
None.
+If you need to set the audio scenario, you can either call
If you need to set the audio scenario, you can either call
You can call this method either before or after joining a channel.
-Enables or disables image enhancement, and sets the options.
-Call this method after calling
Enables or disables image enhancement, and sets the options.
Both this method and
Call this method after calling
The SDK disables face autofocus by default. To set face autofocus, call this method.
+The SDK disables face autofocus by default. To set face autofocus, call this method.
The SDK enables face autofocus by default. To set face autofocus, call this method.
By default, the SDK disables face autofocus on Android and enables face autofocus on iOS. To set face autofocus, call this method.
The camera exposure value. The default value is 0, which means using the default exposure of the camera. The larger the value, the greater the exposure. When the video image is overexposed, you can reduce the exposure value; when the video image is underexposed and the dark details are lost, you can increase the exposure value. If the exposure value you specified is beyond the range supported by the device, the SDK will automatically adjust it to the actual supported range of the device.
-The value range is [-20, 20].
+The value range is [-20, 20].
The value range is [-8.0, 8.0].
On Android, the value range is [-20.0, 20.0]. On iOS, the value range is [-8.0, 8.0].
Ensure that you call this method before joining a channel.
+Call this method before joining a channel.
The channel profile. See
The channel profile.
The channel profile.
The user role. See
The user role:
The user role:
The type of the cloud proxy. See
Most mobile phones have two audio routes: an earpiece at the top, and a speakerphone at the bottom. The earpiece plays at a lower volume, and the speakerphone at a higher volume. When setting the default audio route, you determine whether audio playback comes through the earpiece or speakerphone when no external audio device is connected.
@@ -46,7 +46,7 @@You can call this method to change the default audio route. After a successful method call, the SDK triggers the
The system audio route changes when an external audio device, such as a headphone or a Bluetooth audio device, is connected. See
When the method call succeeds, there is no return value; when fails, the
The use mode of the audio frame. See
The use mode of the audio frame. See
After successfully deploying the Agora private media server and integrating the RTC SDK on the intranet terminal, you can call this method to specify the Local Access Point and assign the access module to the SDK.
-After successfully deploying the Agora private media server and integrating the RTC 4.x SDK on the intranet terminal, you can call this method to specify the Local Access Point and assign the access module to the SDK.
+Call this method before joining a channel.
+This method takes effect only after the Agora hybrid cloud solution is deployed. You can contact
The local video display mode. See
The local video display mode.
The local video display mode.
After initializing the local video view, you can call this method to update its rendering and mirror modes. It affects only the video view that the local user sees, not the published local video stream.
-After initializing the local video view, you can call this method to update its rendering and mirror modes. It affects only the video view that the local user sees and does not impact the publishing of the local video.
+This method only takes effect on the primary camera
None.
+The local video display mode. See
The local video display mode.
The local video display mode.
The mirror mode of the local video view. See
For the local user:
For the local user:
The local video mirror mode. See
+
The local voice reverberation option. The default value is
The local voice reverberation option. To achieve better voice effects, Agora recommends the enumeration whose name begins with
The local voice reverberation option. To achieve better voice effects, Agora recommends the enumeration whose name begins with
Specifies an SDK output log file. The log file records all log data for the SDK’s operation. Ensure that the directory for the log file exists and is writable.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita index dadc6856da1..fccee3cbd84 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setmixedaudioframeparameters.dita @@ -2,7 +2,7 @@Call this method before joining a channel.
+None.
+The sample rate (Hz) of the audio data, which can be set as
The number of channels of the audio data, which can be set as
Sets the number of samples. In Media Push scenarios, set it as
The SDK triggers the
When the method call succeeds, there is no return value; when fails, the
The SDK triggers the
Call this method before joining a channel.
+None.
+The sample rate (Hz) of the audio data, which can be set as
The number of channels of the audio data, which can be set as
Sets the data format for the
Call this method before joining a channel.
+None.
+The number of channels returned in the
The use mode of the audio frame. See
Sets the audio format for the
Call this method before joining a channel.
+None.
+The number of channels returned in the
The number of channels returned by the SDK. You can set the value as 1 or 2:
The use mode of the audio frame. See
The use mode of the audio frame. See
Call this method before joining a channel. The SDK does not support changing the default subscribed video stream type after joining a channel.
+If you call both this method and
The default video-stream type. See
The default video-stream type:
The default video-stream type:
+
The rendering mode of the remote user view. For details, see
The rendering mode of the remote user view.
The rendering mode of the remote user view.
The rendering mode of the remote user view. For details, see
The rendering mode of the remote user view.
The rendering mode of the remote user view.
The mirror mode of the remote user view. See
The mirror mode of the remote user view.
The mirror mode of the remote user view.
An unstable network affects the audio and video quality in a video call or interactive live video streaming. If
When the subscribed video stream falls back to an audio-only stream, or recovers from an audio-only stream to an audio-video stream, the SDK triggers the
An unstable network affects the audio and video quality in a video call or interactive live video streaming. If
When the subscribed video stream falls back to an audio-only stream, or recovers from an audio-only stream to an audio-video stream, the SDK triggers the
+
The priority of the remote user.
The priority of the remote user.
The SDK defaults to enabling low-quality video stream adaptive mode (
The SDK will dynamically adjust the size of the corresponding video stream based on the size of the video window to save bandwidth and computing resources. The default aspect ratio of the low-quality video stream is the same as that of the high-quality video stream. According to the current aspect ratio of the high-quality video stream, the system will automatically allocate the resolution, frame rate, and bitrate of the low-quality video stream.
-The video stream type, see
The video stream type:
The video stream type:
+
This method is used to switch the audio route from Bluetooth headphones to earpiece, wired headphones or speakers in communication audio mode (
This method initializes the video view of a local stream on the local device. It affects only the video view that the local user sees, not the published local video stream. Call this method to bind the local video stream to a video view (
After initialization, call this method to set the local video and then join the channel. The local video still binds to the view after you leave the channel. To unbind the local video from the view, set the
In real-time interactive scenarios, if you need to simultaneously view multiple preview frames in the local video preview, and each frame is at a different observation position along the video link, you can repeatedly call this method to set different
This method initializes the video view of a local stream on the local device. It only affects the video seen by the local user and does not impact the publishing of the local video. Call this method to bind the local video stream to a video view (
The binding remains valid after leaving the channel. To stop rendering or unbind the local video from the view, set
After initialization, call this method to set the local video and then join the channel.
+In real-time interactive scenarios, if you need to simultaneously view multiple preview frames in the local video preview, and each frame is at a different observation position along the video link, you can repeatedly call this method to set different
You can call this method either before or after joining a channel.
+None.
+In the scenarios of custom layout for mixed videos on the mobile end, you can call this method and set a separate
After successfully calling this method, the SDK will automatically enable the best practice strategies and adjust key performance metrics based on the specified scenario, to optimize the video experience.
-Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting a voice beautifier effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios.
To achieve better vocal effects, it is recommended that you call the following APIs before calling this method:
Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting a voice beautifier effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios.
This method can be called either before or after joining the channel.
+To achieve better vocal effects, it is recommended that you call the following APIs before calling this method:
The preset voice beautifier effect options:
The preset voice beautifier effect options.
The preset voice beautifier effect options.
The options for the preset voice beautifier effects:
The options for SDK preset voice conversion effects.
The options for SDK preset voice conversion effects.
This method mixes the specified local or online audio file with the audio from the microphone, or replaces the microphone's audio with the specified local or remote audio file. A successful method call triggers the
This method supports playing URI files starting with
For the audio file formats supported by this method, see
This method supports playing URI files starting with
Whether to only play music files on the local client:
The number of times the music file plays.
When the method call succeeds, there is no return value; when fails, the
This method mixes the specified local or online audio file with the audio from the microphone, or replaces the microphone's audio with the specified local or remote audio file. A successful method call triggers the
This method supports playing URI files starting with
For the audio file formats supported by this method, see
This method supports playing URI files starting with
You can call this method either before or after joining a channel.
+Whether to only play music files on the local client:
The number of times the music file plays.
The Agora SDK allows recording during a call. After successfully calling this method, you can record the audio of all the users in the channel and get an audio recording file. Supported formats of the recording file are as follows:
The Agora SDK allows recording during a call. After successfully calling this method, you can record the audio of all the users in the channel and get an audio recording file. Supported formats of audio files are as follows:
The Agora SDK allows recording during a call. After successfully calling this method, you can record the audio of users in the channel and get an audio recording file. Supported formats of the recording file are as follows:
The Agora SDK allows recording during a call. After successfully calling this method, you can record the audio of users in the channel and get an audio recording file. Supported formats of audio files are as follows:
Once the user leaves the channel, the recording automatically stops.
-Call this method after joining a channel.
+None.
+Agora does not support setting the value of
If you want to push audio and video streams captured by the host from a custom source, the media setting options should be set as follows:
To test whether the user's local sending and receiving streams are normal, you can call this method to perform an audio and video call loop test, which tests whether the audio and video devices and the user's upstream and downstream networks are working properly.
-After starting the test, the user needs to make a sound or face the camera. The audio or video is output after about two seconds. If the audio playback is normal, the audio device and the user's upstream and downstream networks are working properly; if the video playback is normal, the video device and the user's upstream and downstream networks are working properly.
-
After starting the test, the user needs to make a sound or face the camera. The audio or video is output after about two seconds. If the audio playback is normal, the audio device and the user's upstream and downstream networks are working properly; if the video playback is normal, the video device and the user's upstream and downstream networks are working properly.
You can call this method either before or after joining a channel.
+This method starts the last-mile network probe test before joining a channel to get the uplink and downlink last mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT).
+Do not call other methods before receiving the
None.
+When the method call succeeds, there is no return value; when fails, the
When you no longer need to play the audio effect, you can call this method to stop the playback. If you only need to pause the playback, call
None.
+When the method call succeeds, there is no return value; when fails, the
This method stops the audio mixing. Call this method when you are in a channel.
+After calling
Call this method after joining a channel.
+None.
When the method call succeeds, there is no return value; when fails, the
When the method call succeeds, there is no return value; when fails, the
After calling
When the method call succeeds, there is no return value; when fails, the
When you no longer need to play the audio effect, you can call this method to stop the playback. If you only need to pause the playback, call
Call this method after
Call this method after the
None.
+This method can take screenshots for multiple video streams and upload them. When video screenshot and upload function is enabled, the SDK takes screenshots and uploads videos sent by local users based on the type and frequency of the module you set in
This method can be called either before or after joining the channel.
+Before calling this method, ensure that you have contacted
After the user leaves the channel, the SDK automatically disables the built-in encryption. To enable the built-in encryption, call this method before the user joins the channel again.
None.
+Call this method after
Whether to stop subscribing to the audio streams of all remote users:
Whether to stop publishing the local audio stream:
Whether to stop receiving the audio stream of the specified user:
Whether to stop receiving the video stream of the specified user:
When the method call succeeds, there is no return value; when fails, the
When the method call succeeds, there is no return value; when fails, the
After calling
The SDK has the following restrictions on this method:
A successful method call triggers the
The video display mode of the remote user. See
The video display mode of the remote user:
The video display mode of the remote user:
The mirror mode of the remote user view. See
The mirror mode of the remote user view:
The mirror mode of the remote user view:
+
To unbind the remote user from the view, set the
Once the remote user leaves the channel, the SDK unbinds the remote user.
To update the rendering or mirror mode of the remote video view during a call, use the
Call this method after
Call this method after
When the method call succeeds, there is no return value; when fails, the
Passes in the audio data after setting the
Passes in the audio data after setting the
Without practical meaning.
The metadata that you want to send in the format of byte. Ensure that you set the return value.
+The metadata that you want to send in the format of byte. Ensure that you set the return value.
+
+
The current connection state. The reason for a connection state change. See
+
The results of video content moderation:
+ In case of extension enabling failure or runtime errors, the extension triggers this callback and reports the error code along with the reasons.
+ To listen for events while the extension is running, you need to register this callback.
+ The callback is triggered after the extension is successfully enabled.
+ The callback is triggered after the extension is successfully disabled. The state of the local video, see
+
The reasons for changes in local video state. See
+
The type of the local network connection. See Network types: Network types: The state of the remote video. See The state of the remote video: The state of the remote video: The reason for the remote video state change. See Remote audio state reasons: Remote audio state reasons:
+
@@ -98,7 +98,7 @@ elapseSinceLastState:(int)elapseSinceLastState;
+
diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita
index 2d5544b4334..d647e76aa83 100644
--- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita
+++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita
@@ -64,13 +64,13 @@ NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:));
+
+
+
+
+
+
+
-
@@ -78,7 +78,7 @@
-
diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionerrorwithcontext.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionerrorwithcontext.dita
new file mode 100644
index 00000000000..2dc7f13c286
--- /dev/null
+++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionerrorwithcontext.dita
@@ -0,0 +1,74 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The SDK triggers this callback once every two seconds after the user joins the channel.
diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita index cdae10a3902..696fd5667de 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita @@ -37,9 +37,9 @@There are two reasons for users to become offline:
There are generally two reasons for users to become offline:
This callback is triggered when a remote user (in the communication profile) or host (in the live streaming profile) leaves a channel.
+None.
+Reasons why the user goes offline:
Reasons why a remote user (COMMUNICATION) or a host (LIVE_BROADCASTING) goes offline:
Reasons why a remote user (in the communication profile) or host (in the live streaming profile) goes offline. See
Reasons why a remote user (in the communication profile) or host (in the live streaming profile) goes offline:
The connection mode. See
Select one of the following connection modes:
Select one of the following connection modes:
Audio profile. See
Audio profile:
Audio profile:
Audio encoding type. See
Audio encoding type:
Audio encoding type:
The number of audio channels (the data are interleaved if it is stereo).
Ensure that the directory for the log files exists and is writable.
The recording content. See
Recording content:
Recording content:
Recording quality. See
Recording quality:
Recording quality:
The contrast level, used with the
The contrast level, used with the
The brightening level, in the range [0.0,1.0], where 0.0 means the original brightening. The default value is
The brightening level, in the range [0.0,1.0], where 0.0 means the original brightening. The default value is
The smoothness level, in the range [0.0,1.0], where 0.0 means the original smoothness. The default value is
The smoothness level, in the range [0.0,1.0], where 0.0 means the original smoothness. The default value is
The redness level, in the range [0.0,1.0], where 0.0 means the original redness. The default value is
The redness level, in the range [0.0,1.0], where 0.0 means the original redness. The default value is
The sharpness level, in the range [0.0,1.0], where 0.0 means the original sharpness. The default value is
The sharpness level, in the range [0.0,1.0], where 0.0 means the original sharpness. The default value is
The video codec types:
@@ -130,7 +130,7 @@ class ContentInspectConfig {
@@ -79,7 +79,7 @@ struct FContentInspectModule {
Types of functional modules: The codec type of the video: The codec type of the video:
+ The width of the video in pixels. The default value is 360.
+
+
+
+
+
+
+
+
-
+
The height of the video in pixels. The default value is 640.
@@ -706,7 +706,7 @@ struct FLiveTranscodingFrame rate (fps) of the output video stream set for Media Push. The default value is 15. The value range is (0,30].
Reserved property. Extra user-defined information to send SEI for the H.264/H.265 video stream to the CDN live client. Maximum length: 4096 bytes. For more information on SEI, see
+
+
The default path is
The default path is
The default path is
The default path is:
The user ID.
+
The context of Android Activity. The context. Specifies the storage directory for the Sets the log file size. See By default, the SDK generates five SDK log files and five API call log files with the following rules:
-
@@ -226,23 +227,23 @@ class RtcEngineContext {
Whether to enable domain name restriction:
Whether to automatically register the Agora extensions when initializing
Only available for scenarios where
Only available for scenarios where
The mirror mode of the view. See
+
Alpha mask rendering can create images with transparent effects and extract portraits from videos. When used in combination with other methods, you can implement effects such as portrait-in-picture and watermarking.
Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. See
Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees.
Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees.
Indicates the alpha channel data output by the portrait segmentation algorithm, which is consistent with the size of the video frame. The value range of each pixel is [0,255], where 0 represents the background; 255 represents the foreground (portrait).
-In the costom video renderer scenario, you can use this parameter to render the video background into various effects, such as: transparent, solid color, picture, video and so on.
The alpha channel data output by using portrait segmentation algorithm. This data matches the size of the video frame, with each pixel value ranging from [0,255], where 0 represents the background and 255 represents the foreground (portrait).
+By setting this parameter, you can render the video background into various effects, such as transparent, solid color, image, video, etc.
+The meta information in the video frame. To use this parameter, please
The meta information in the video frame. To use this parameter, please contact
1: The number of hosts in the channel is already at the upper limit.
+1: The number of hosts in the channel exceeds the limit.
3: The request is timed out. Agora recommends you prompt the user to check the network connection and try to switch their user role again.
3: The request is timed out. Agora recommends you prompt the user to check the network connection and try to switch their user role again.
+4: The SDK connection fails. You can use
4: The SDK is disconnected from the Agora edge server. You can troubleshoot the failure through the
6: Generic.
@@ -34,7 +34,7 @@This type consumes minimum computing resources and applies to IoT devices.
This page introduces the Unreal C++ API references. If you use Unreal Blueprint SDK, refer to the
This group of method is for Android and iOS only.
The deprecated APIs are expected to be officially deleted in approximately one year. Agora recommends that you promptly replace them with the recommended APIs to avoid any impact on your online services.
+