The details about the default audio capture device. See .
+
The details about the default audio capture device. See .
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita
index d39782b61b8..41be2d7b2b0 100644
--- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita
+++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_updateplayerpositioninfo.dita
@@ -25,9 +25,9 @@
playerId: number,
positionInfo: RemoteVoicePositionInfo
): number;
- Future<void> updatePlayerPositionInfo(
+ Future<void> updatePlayerPositionInfo(
{required int playerId, required RemoteVoicePositionInfo positionInfo});
-
+ Details
@@ -42,15 +42,15 @@
positionInfo
- The spatial position of the media player. See .
+ The spatial position of the media player. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita
index c535e0b3930..8b80ee04d57 100644
--- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita
+++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_initialize.dita
@@ -1,12 +1,12 @@
- <ph keyref="initialize_ILocalSpatialAudioEngine"/>
- Initializes .
+ <ph keyref="initialize_ILocalSpatialAudioEngine" />
+ Initializes .
-
+
@@ -19,32 +19,32 @@
abstract initialize(): number;public abstract int Initialize();abstract initialize(): number;
- Future<void> initialize();
-
+ Future<void> initialize();
+ Details
-
Call this method after calling ().
-
Call this method after calling .
-
Before calling other methods of the class, you need to call this method to initialize .
-
The SDK supports creating only one instance for an app.
+
Call this method after calling ().
+
Call this method after calling .
+
Before calling other methods of the class, you need to call this method to initialize .
+
The SDK supports creating only one instance for an app.
Parametersconfig
- The configuration of . See .
+ The configuration of . See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita
index c88449f8031..ab6fb4932a0 100644
--- a/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita
+++ b/en-US/dita/RTC-NG/API/api_ilocalspatialaudioengine_updateremoteposition.dita
@@ -25,9 +25,9 @@
uid: number,
posInfo: RemoteVoicePositionInfo
): number;
- Future<void> updateRemotePosition(
+ Future<void> updateRemotePosition(
{required int uid, required RemoteVoicePositionInfo posInfo});
-
+ Details
@@ -46,11 +46,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita
index f97153f4d5e..0e006691d30 100644
--- a/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaengine_addlistener.dita
@@ -1,49 +1,49 @@
- <ph keyref="addListener_IMediaEngine"/>
- Adds one listener.
+ <ph keyref="addListener_IMediaEngine" />
+ Adds one listener.
-
+
After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.
+
After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.
ParameterseventType
- The name of the target event to listen for. See .
+ The name of the target event to listen for. See .listener
- The callback function for eventType. Take adding a listener for as an example:const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {};
+ The callback function for eventType. Take adding a listener for as an example:const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {};
engine.addListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita
index 6c268bd0b21..4b3d1d972c6 100644
--- a/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaengine_createcustomaudiotrack.dita
@@ -1,12 +1,12 @@
- <ph keyref="createCustomAudioTrack"/>
+ <ph keyref="createCustomAudioTrack" />Creates a custom audio track.
-
+
@@ -27,9 +27,9 @@
trackType: AudioTrackType,
config: AudioTrackConfig
): number;
- Future<int> createCustomAudioTrack(
+ Future<int> createCustomAudioTrack(
{required AudioTrackType trackType, required AudioTrackConfig config});
-
+ Details
@@ -41,8 +41,8 @@
To publish a custom audio source to multiple channels, see the following steps:
Call this method to create a custom audio track and get the audio track ID.
-
In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
-
If you call , and specify trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.
+
In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
+
If you call , and specify trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.
@@ -50,11 +50,11 @@
trackType
- The type of the custom audio track. See .If is specified for this parameter, you must set publishMicrophoneTrack to in when calling to join the channel; otherwise, joining the channel fails and returns the error code -2.
+ The type of the custom audio track. See .If is specified for this parameter, you must set publishMicrophoneTrack to in when calling to join the channel; otherwise, joining the channel fails and returns the error code -2.config
- The configuration of the custom audio track. See .
+ The configuration of the custom audio track. See .
@@ -64,4 +64,4 @@
If the method call fails, a negative value is returned.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita
index 6dc1f62db49..2ea5558608d 100644
--- a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe.dita
@@ -1,12 +1,12 @@
- <ph keyref="pushAudioFrame1"/>
+ <ph keyref="pushAudioFrame1" />Pushes the external audio frame.
-
+
@@ -18,19 +18,19 @@
samples:(NSInteger)samples
sourceId:(NSInteger)sourceId
timestamp:(NSTimeInterval)timestamp;
-
-
-
-
-
-
+
+
+
+
+
+ Parametersframe
- The external audio frame. See .
+ The external audio frame. See .
@@ -49,8 +49,8 @@
-
-
+
+
@@ -58,8 +58,8 @@
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita
index 67b8b41e30f..b654872595a 100644
--- a/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushaudioframe0.dita
@@ -19,8 +19,8 @@
abstract pushAudioFrame(frame: AudioFrame, trackId?: number): number;public abstract int PushAudioFrame(AudioFrame frame, uint trackId = 0);abstract pushAudioFrame(frame: AudioFrame, trackId?: number): number;
- Future<void> pushAudioFrame({required AudioFrame frame, int trackId = 0});
-
+ Future<void> pushAudioFrame({required AudioFrame frame, int trackId = 0});
+ Parameters
@@ -35,11 +35,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita
index 3089be0921a..956b45fb433 100644
--- a/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushencodedvideoimage.dita
@@ -1,12 +1,12 @@
- <ph keyref="pushEncodedVideoImage"/>
+ <ph keyref="pushEncodedVideoImage" />Pushes the external encoded video frame to the SDK.
-
+
@@ -16,7 +16,7 @@
public abstract int pushExternalEncodedVideoFrame(
ByteBuffer data, EncodedVideoFrameInfo frameInfo);
videoTrackId:(NSUInteger)videoTrackId;
-
+ virtual int pushEncodedVideoImage(const uint8_t* imageBuffer, size_t length,
const agora::rtc::EncodedVideoFrameInfo& videoEncodedFrameInfo) = 0;abstract pushEncodedVideoImage(
@@ -32,16 +32,16 @@
videoEncodedFrameInfo: EncodedVideoFrameInfo,
videoTrackId?: number
): number;
- Future<void> pushEncodedVideoImage(
+ Future<void> pushEncodedVideoImage(
{required Uint8List imageBuffer,
required int length,
required EncodedVideoFrameInfo videoEncodedFrameInfo,
int videoTrackId = 0});
-
+ Details
-
After calling to enable external video source and set the sourceType parameter to , you can call this method to push the encoded external video frame to the SDK.
+
After calling to enable external video source and set the sourceType parameter to , you can call this method to push the encoded external video frame to the SDK.
Parameters
@@ -58,19 +58,19 @@
frameInfovideoEncodedFrameInfo
- Information about externally encoded video frames. See .
+ Information about externally encoded video frames. See .
-
-
+
+
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Pushes the external encoded video frame to the SDK successfully.
< 0: Fails to push external encoded video frames to the SDK.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita
index 817e0b960b9..012364cc717 100644
--- a/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaengine_pushvideoframe.dita
@@ -25,20 +25,20 @@
frame: ExternalVideoFrame,
videoTrackId?: number
): number;
- Future<void> pushVideoFrame(
+ Future<void> pushVideoFrame(
{required ExternalVideoFrame frame, int videoTrackId = 0});
-
+ Details
Deprecated:
-
If you need to push video frames in I422 format, you need to use this method; otherwise, use instead.
+
If you need to push video frames in I422 format, you need to use this method; otherwise, use instead.
-
If you call and set the enabled parameter as and the encodedFrame parameter as , you can call this method to push the external raw video frame to the SDK. If you call method to get the video track ID, set the customVideoTrackId parameter to the video track ID you want to publish in the of each channel, and set the publishCustomVideoTrack parameter to , you can call this method to push the unencoded external video frame to the SDK.
-
You can push the video frame either by calling this method or by calling . The difference is that the method does not support video data in texture format.
+
If you call and set the enabled parameter as and the encodedFrame parameter as , you can call this method to push the external raw video frame to the SDK. If you call method to get the video track ID, set the customVideoTrackId parameter to the video track ID you want to publish in the of each channel, and set the publishCustomVideoTrack parameter to , you can call this method to push the unencoded external video frame to the SDK.
+
You can push the video frame either by calling this method or by calling . The difference is that the method does not support video data in texture format.
Applicable scenarios
@@ -55,19 +55,19 @@
videoTrackId
- The video track ID returned by calling the method. The default value is 0.
+ The video track ID returned by calling the method. The default value is 0.
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
: Pushes the external raw video frame to the SDK successfully.
-
: Fails to push external raw video frame to the SDK.
+
: Pushes the external raw video frame to the SDK successfully.
+
: Fails to push external raw video frame to the SDK.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita
index 25253e10759..58a6d0c220b 100644
--- a/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaengine_registeraudioframeobserver.dita
@@ -1,12 +1,12 @@
- <ph keyref="registerAudioFrameObserver"/>
+ <ph keyref="registerAudioFrameObserver" />Registers an audio frame observer object.
-
+
@@ -20,11 +20,11 @@
public abstract int RegisterAudioFrameObserver(IAudioFrameObserver audioFrameObserver, AUDIO_FRAME_POSITION position, OBSERVER_MODE mode = OBSERVER_MODE.INTPTR);abstract registerAudioFrameObserver(observer: IAudioFrameObserver): number;void registerAudioFrameObserver(AudioFrameObserver observer);
-
+ Details
-
Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger , , or callback, you need to use this method to register the callbacks.
+
Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger , , or callback, you need to use this method to register the callbacks.
Ensure that you call this method before joining a channel.Parameters
@@ -39,30 +39,30 @@
mode
- The audio data callback mode. See .
+ The audio data callback mode. See .positionThe frame position of the audio observer.
-
(0x0001): This position can observe the playback audio mixed by all remote users, corresponding to the callback.
-
(0x0002): This position can observe the collected local user's audio, corresponding to the callback.
-
(0x0004): This position can observe the playback audio mixed by the loacl user and all remote users, corresponding to the callback.
-
(0x0008): This position can observe the audio of a single remote user before mixing, corresponding to the callback.
-
(0x0010): This position can observe the in-ear monitoring audio of the local user, corresponding to the callback.
+
(0x0001): This position can observe the playback audio mixed by all remote users, corresponding to the callback.
+
(0x0002): This position can observe the collected local user's audio, corresponding to the callback.
+
(0x0004): This position can observe the playback audio mixed by the loacl user and all remote users, corresponding to the callback.
+
(0x0008): This position can observe the audio of a single remote user before mixing, corresponding to the callback.
+
(0x0010): This position can observe the in-ear monitoring audio of the local user, corresponding to the callback.
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
: Success.
-
: Failure. See for details and resolution suggestions.
+
: Success.
+
: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita
index a7dbcb2910f..ada50c18b18 100644
--- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoencodedframeobserver.dita
@@ -1,12 +1,12 @@
- <ph keyref="registerVideoEncodedFrameObserver"/>
+ <ph keyref="registerVideoEncodedFrameObserver" />Registers a receiver object for the encoded video image.
-
+
@@ -25,18 +25,18 @@
observer: IVideoEncodedFrameObserver
): number;void registerVideoEncodedFrameObserver(VideoEncodedFrameObserver observer);
-
+ Details
-
If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one class through this method.
+
If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one class through this method.
If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps:
-
Call to register the raw video frame observer before joining the channel.
-
Call to register the encoded video frame observer before joining the channel.
-
After joining the channel, get the user IDs of group B users through , and then call to set the encodedFrameOnly of this group of users to .
-
Call ()to start receiving the video streams of all remote users. Then:
-
The raw video data of group A users can be obtained through the callback in , and the SDK renders the data by default.
-
The encoded video data of group B users can be obtained through the callback in .
+
Call to register the raw video frame observer before joining the channel.
+
Call to register the encoded video frame observer before joining the channel.
+
After joining the channel, get the user IDs of group B users through , and then call to set the encodedFrameOnly of this group of users to .
+
Call ()to start receiving the video streams of all remote users. Then:
+
The raw video data of group A users can be obtained through the callback in , and the SDK renders the data by default.
+
The encoded video data of group B users can be obtained through the callback in .
@@ -51,24 +51,24 @@
receiverobservervideoEncodedImageReceiver
- The video frame observer object. See .
- The observer instance. See . Set the value as to release the instance.
+ The video frame observer object. See .
+ The observer instance. See . Set the value as to release the instance.mode
- The video data callback mode. See .
+ The video data callback mode. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
: Success.
-
: Failure. See for details and resolution suggestions.
+
: Success.
+
: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita
index abe21ecbe0a..dda5ec73c03 100644
--- a/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaengine_registervideoframeobserver.dita
@@ -1,12 +1,12 @@
- <ph keyref="registerVideoFrameObserver"/>
+ <ph keyref="registerVideoFrameObserver" />Registers a raw video frame observer object.
-
+
@@ -20,13 +20,13 @@
public abstract int RegisterVideoFrameObserver(IVideoFrameObserver videoFrameObserver, VIDEO_OBSERVER_FRAME_TYPE formatPreference, VIDEO_OBSERVER_POSITION position, OBSERVER_MODE mode = OBSERVER_MODE.INTPTR);abstract registerVideoFrameObserver(observer: IVideoFrameObserver): number;void registerVideoFrameObserver(VideoFrameObserver observer);
-
+ Details
-
If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one class with this method.
-
When calling this method to register a video observer, you can register callbacks in the class as needed. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.
-
+
If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one class with this method.
+
When calling this method to register a video observer, you can register callbacks in the class as needed. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.
+
Ensure that you call this method before joining a channel.
@@ -35,7 +35,7 @@
If the user adjusts the video profile, the resolution of the video returned in the callbacks also changes.
- After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as implementing virtual backgrounds and image enhacement scenarios by yourself, Agora provides an open source sample project on GitHub for your reference.
+ After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as implementing virtual backgrounds and image enhacement scenarios by yourself, Agora provides an open source sample project on GitHub for your reference.Parameters
@@ -47,27 +47,27 @@
mode
- The video data callback mode. See .
+ The video data callback mode. See .formatPreference
- The video frame type. See .
+ The video frame type. See .position
- A bit mask that controls the frame position of the video observer. See .
+ A bit mask that controls the frame position of the video observer. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
: Success.
-
: Failure. See for details and resolution suggestions.
+
: Success.
+
: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita
index 0c96f2ee242..9ce3923ca0f 100644
--- a/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaplayer_addlistener.dita
@@ -1,48 +1,48 @@
- <ph keyref="addListener_IMediaPlayer"/>
- Adds one listener.
+ <ph keyref="addListener_IMediaPlayer" />
+ Adds one listener.
-
+
After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.
+
After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.
ParameterseventType
- The name of the target event to listen for. See .
+ The name of the target event to listen for. See .listener
- The callback function for eventType. Take adding a listener for as an example:const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) => {};
+ The callback function for eventType. Take adding a listener for as an example:const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) => {};
engine.addListener('onPlayerSourceStateChanged', onPlayerSourceStateChanged);
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita
index 52b72c3ea03..382bad72cf6 100644
--- a/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaplayer_openwithcustomsource.dita
@@ -62,7 +62,7 @@
Returns
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita
index 265f22f4008..75da81cd9c3 100644
--- a/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registervideoframeobserver.dita
@@ -1,12 +1,12 @@
- <ph keyref="registerVideoFrameObserver_IMediaPlayer"/>
+ <ph keyref="registerVideoFrameObserver_IMediaPlayer" />Registers a video frame observer object.
-
+
@@ -14,7 +14,7 @@
You need to implement the class in this method and register callbacks according to your scenarios. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.
+
You need to implement the class in this method and register callbacks according to your scenarios. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.
Parameters
@@ -36,16 +36,16 @@
videoFrameObserverobserver
- The video observer, reporting the reception of each video frame. See .
- The video observer, reporting the reception of each video frame. See .
+ The video observer, reporting the reception of each video frame. See .
+ The video observer, reporting the reception of each video frame. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita
index 4f26670ac9b..ccfebbc3a14 100644
--- a/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setrendermode.dita
@@ -22,7 +22,7 @@
public abstract int SetRenderMode(RENDER_MODE_TYPE renderMode);abstract setRenderMode(renderMode: RenderModeType): number;Future<void> setRenderMode(RenderModeType renderMode);
-
+ Parameters
@@ -39,11 +39,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita
index d1d7c3bcf2b..10edd81c0d5 100644
--- a/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita
+++ b/en-US/dita/RTC-NG/API/api_imediaplayer_setspatialaudioparams.dita
@@ -20,7 +20,7 @@
public abstract int SetSpatialAudioParams(SpatialAudioParams spatial_audio_params);abstract setSpatialAudioParams(params: SpatialAudioParams): number;Future<void> setSpatialAudioParams(SpatialAudioParams params);
-
+ Details
@@ -37,11 +37,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita
index dc6238f2f49..344aa0cebdb 100644
--- a/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita
+++ b/en-US/dita/RTC-NG/API/api_imediarecorder_addlistener.dita
@@ -1,48 +1,48 @@
- <ph keyref="addListener_IMediaRecorder"/>
- Adds one listener.
+ <ph keyref="addListener_IMediaRecorder" />
+ Adds one listener.
-
+
After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.
+
After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.
ParameterseventType
- The name of the target event to listen for. See .
+ The name of the target event to listen for. See .listener
- The callback function for eventType. Take adding a listener for as an example:const onRecorderStateChanged = (state: RecorderState, error: RecorderErrorCode) => {};
+ The callback function for eventType. Take adding a listener for as an example:const onRecorderStateChanged = (state: RecorderState, error: RecorderErrorCode) => {};
engine.addListener('onRecorderStateChanged', onRecorderStateChanged);
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita
index 71e7e039395..e17f2cd5ec8 100644
--- a/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita
+++ b/en-US/dita/RTC-NG/API/api_imediarecorder_startrecording.dita
@@ -1,12 +1,12 @@
- <ph keyref="startRecording"/>
+ <ph keyref="startRecording" />Starts recording audio and video streams.
-
+
@@ -19,15 +19,15 @@
abstract startRecording(config: MediaRecorderConfiguration): number;public abstract int StartRecording(MediaRecorderConfiguration config);abstract startRecording(config: MediaRecorderConfiguration): number;
- Future<void> startRecording(MediaRecorderConfiguration config);
-
+ Future<void> startRecording(MediaRecorderConfiguration config);
+ Details
You can call this method to enable the recording function. Agora supports recording the media streams of local and remote users at the same time.
Before you call this method, ensure the following:
-
The recording object is created through .
-
The recording observer is registered through .
+
The recording object is created through .
+
The recording observer is registered through .
You have joined the channel which the remote user that you want to record is in.
Supported formats of recording are listed as below:
@@ -35,7 +35,7 @@
Video captured by a camera and encoded in H.264 or H.265.
Once the recording is started, if the video resolution is changed, the SDK stops the recording; if the sampling rate and audio channel changes, the SDK continues recording and generates audio files respectively.
-
The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than 5 seconds, the SDK stops the recording and triggers the (, ) callback.
+
The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than 5 seconds, the SDK stops the recording and triggers the (, ) callback.
@@ -47,23 +47,23 @@
config
- The recording configuration. See .
+ The recording configuration. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-2: The parameter is invalid. Ensure the following:
The specified path of the recording file exists and is writable.
The specified format of the recording file is supported.
The maximum recording duration is correctly set.
-
-4: does not support the request. The recording is ongoing or the recording stops because an error occurs.
-
-7: The method is called before is initialized. Ensure the object is created before calling this method.
+
-4: does not support the request. The recording is ongoing or the recording stops because an error occurs.
+
-7: The method is called before is initialized. Ensure the object is created before calling this method.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita
index 028041b353b..a21fcc70f63 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_addlistener.dita
@@ -1,48 +1,48 @@
- <ph keyref="addListener"/>
- Adds one listener.
+ <ph keyref="addListener" />
+ Adds one listener.
-
+
After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.
+
After calling this method, you can listen for the corresponding events in the object and obtain data through . Depending on your project needs, you can add multiple listeners for the same event.
ParameterseventType
- The name of the target event to listen for. See .
+ The name of the target event to listen for. See .listener
- The callback function for eventType. Take adding a listener for as an example:const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {};
+ The callback function for eventType. Take adding a listener for as an example:const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {};
engine.addListener('onJoinChannelSuccess', onJoinChannelSuccess);
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita
index 1d99052821f..3dcfc29a661 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_configrhythmplayer.dita
@@ -1,12 +1,12 @@
- <ph keyref="configRhythmPlayer"/>
+ <ph keyref="configRhythmPlayer" />Configures the virtual metronome.
-
+
@@ -19,28 +19,28 @@
abstract configRhythmPlayer(config: AgoraRhythmPlayerConfig): number;public abstract int ConfigRhythmPlayer(AgoraRhythmPlayerConfig config);abstract configRhythmPlayer(config: AgoraRhythmPlayerConfig): number;
- Future<void> configRhythmPlayer(AgoraRhythmPlayerConfig config);
-
+ Future<void> configRhythmPlayer(AgoraRhythmPlayerConfig config);
+ Details
-
After calling , you can call this method to reconfigure the virtual metronome.
-
After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.
-
+
After calling , you can call this method to reconfigure the virtual metronome.
+
After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.
+ Parametersconfig
- The metronome configuration. See .
+ The metronome configuration. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita
index d0e0c7ad951..a3ca1a6757b 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream2.dita
@@ -21,7 +21,7 @@
public abstract int CreateDataStream(ref int streamId, DataStreamConfig config);abstract createDataStream(config: DataStreamConfig): number;Future<int> createDataStream(DataStreamConfig config);
-
+ Details
@@ -45,7 +45,7 @@
0: The data stream is successfully created.
ID of the created data stream, if the method call succeeds.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita
index f79c8b4f19b..79876008572 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode2.dita
@@ -28,14 +28,14 @@
streamConfig?: SimulcastStreamConfig
): number;
Future<void> enableDualStreamMode(bool enabled);
-
+ Details
Deprecated:
-
This method is deprecated as of v4.2.0. Use instead.
+
This method is deprecated as of v4.2.0. Use instead.
You can call this method to enable or disable the dual-stream mode on the publisher side. Dual streams are a pairing of a high-quality video stream and a low-quality video stream:
@@ -46,7 +46,7 @@
This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-collected video streams.
-
If you need to enable dual video streams in a multi-channel scenario, you can call the method.
+
If you need to enable dual video streams in a multi-channel scenario, you can call the method.
You can call this method either before or after joining a channel.
@@ -72,7 +72,7 @@
Returns
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita
index 5ff70d41a58..57fd1fc4aba 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_enabledualstreammode3.dita
@@ -1,12 +1,12 @@
- <ph keyref="enableDualStreamMode3"/>
+ <ph keyref="enableDualStreamMode3" />Enables or disables the dual-stream mode on the sender and sets the low-quality video stream.
-
+
@@ -26,11 +26,11 @@
enabled: boolean,
streamConfig?: SimulcastStreamConfig
): number;
- Future<void> enableDualStreamMode(
+ Future<void> enableDualStreamMode(
{required bool enabled, SimulcastStreamConfig? streamConfig});
-
+
-
+
Parameters
@@ -38,24 +38,24 @@
enabled
Whether to enable dual-stream mode:
-
: Enable dual-stream mode.
-
: (Default) Disable dual-stream mode.
+
: Enable dual-stream mode.
+
: (Default) Disable dual-stream mode.
streamConfig
-
The configuration of the low-quality video stream. See .
+
The configuration of the low-quality video stream. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita
index 9c5a105c18c..5057d9504c5 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita
@@ -21,7 +21,7 @@
abstract enableEncryption(enabled: boolean, config: EncryptionConfig): number;Future<void> enableEncryption(
{required bool enabled, required EncryptionConfig config});
-
+ Details
@@ -46,8 +46,8 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
Details
@@ -44,28 +44,28 @@
enabledEnables or disables in-ear monitoring.
-
: Enables in-ear monitoring.
-
: (Default) Disables in-ear monitoring.
+
: Enables in-ear monitoring.
+
: (Default) Disables in-ear monitoring.
includeAudioFilters
- The audio filter of in-ear monitoring: See .
+ The audio filter of in-ear monitoring: See .The audio filter of in-ear monitoring:
-
(1 << 0): Do not add an audio filter to the in-ear monitor.
-
(1 << 1): Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
-
(1 << 2): Enable noise suppression to the in-ear monitor.
You can use the bitwise or operator (|) to specify multiple audio filters.If you set the enabled parameter to , you do not need to set the includeAudioFilters parameter.
+
(1 << 0): Do not add an audio filter to the in-ear monitor.
+
(1 << 1): Add an audio filter to the in-ear monitor. If you implement functions such as voice beautifier and audio effect, users can hear the voice after adding these effects.
+
(1 << 2): Enable noise suppression to the in-ear monitor.
You can use the bitwise or operator (|) to specify multiple audio filters.If you set the enabled parameter to , you do not need to set the includeAudioFilters parameter.
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
- 8: Make sure the current audio routing is Bluetooth or headset.
+
< 0: Failure. See for details and resolution suggestions.
- 8: Make sure the current audio routing is Bluetooth or headset.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita
index e165e6bc38a..ceca8316592 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablemulticamera.dita
@@ -1,19 +1,19 @@
- <ph keyref="enableMultiCamera"/>
+ <ph keyref="enableMultiCamera" />Enables or disables multi-camera capture.
-
+
In scenarios where there are existing cameras to capture video, Agora recommends that you use the following steps to capture and publish video with multiple cameras:
Call this method to enable multi-channel camera capture.
-
Call to start the local video preview.
-
Call , and set sourceType to start video capture with the second camera.
-
Call , and set publishSecondaryCameraTrack to to publish the video stream captured by the second camera in the channel.
+
Call to start the local video preview.
+
Call , and set sourceType to start video capture with the second camera.
+
Call , and set publishSecondaryCameraTrack to to publish the video stream captured by the second camera in the channel.
If you want to disable multi-channel camera capture, use the following steps:
-
Call .
-
Call this method with enabled set to .
+
Call .
+
Call this method with enabled set to .
-
You can call this method before and after to enable multi-camera capture:
-
If it is enabled before , the local video preview shows the image captured by the two cameras at the same time.
-
If it is enabled after , the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal.
+
You can call this method before and after to enable multi-camera capture:
+
If it is enabled before , the local video preview shows the image captured by the two cameras at the same time.
+
If it is enabled after , the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal.
This method applies to iOS only.
@@ -70,22 +70,22 @@
enabledWhether to enable multi-camera video capture mode:
-
: Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.
-
: Disable multi-camera capture mode; the SDK uses a single camera to capture video.
+
: Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.
+
: Disable multi-camera capture mode; the SDK uses a single camera to capture video.
config
- Capture configuration for the second camera. See .
+ Capture configuration for the second camera. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita
index 7af9752c219..3803ae2b685 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_getextensionproperty2.dita
@@ -1,12 +1,12 @@
- <ph keyref="getExtensionProperty2"/>
+ <ph keyref="getExtensionProperty2" />Gets detailed information on the extensions.
-
+
@@ -40,17 +40,17 @@
bufLen: number,
type?: MediaSourceType
): string;
- Future<String> getExtensionProperty(
+ Future<String> getExtensionProperty(
{required String provider,
required String extension,
required String key,
required int bufLen,
MediaSourceType type = MediaSourceType.unknownMediaSource});
-
+ Details
-
+
Parameters
@@ -77,7 +77,7 @@
sourceTypetype
- Source type of the extension. See .
+ Source type of the extension. See .buf_len
@@ -89,11 +89,11 @@
Returns
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
The extension information, if the method call succeeds.
An empty string, if the method call fails.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita
index 5225e69562d..24cd71b9cb2 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_getscreencapturesources.dita
@@ -32,7 +32,7 @@
{required Size thumbSize,
required Size iconSize,
required bool includeScreen});
-
+ Details
@@ -64,4 +64,4 @@
The array.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita
index d962196b1d8..770768f8c6e 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_initialize.dita
@@ -1,12 +1,12 @@
- <ph keyref="initialize"/>
- Creates and initializes . Initializes .
+ <ph keyref="initialize" />
+ Creates and initializes . Initializes .
-
+
@@ -22,17 +22,17 @@
public abstract int Initialize(RtcEngineContext context);abstract initialize(context: RtcEngineContext): number;Future<void> initialize(RtcEngineContext context);
-
+ Details
-
All called methods provided by the class are executed asynchronously. Agora recommends calling these methods in the same thread.
+
All called methods provided by the class are executed asynchronously. Agora recommends calling these methods in the same thread.
-
Before calling other APIs, you must call and to create and initialize the object.
-
Before calling other APIs, you must call this method to create the object.
-
You can create the instance either by calling this method or by calling . The difference between and this method is that this method supports more configurations when creating the instance, for example, specifying the region for connection and setting the log files.
-
The SDK supports creating only one instance for an app.
+
Before calling other APIs, you must call and to create and initialize the object.
+
Before calling other APIs, you must call this method to create the object.
+
You can create the instance either by calling this method or by calling . The difference between and this method is that this method supports more configurations when creating the instance, for example, specifying the region for connection and setting the log files.
+
The SDK supports creating only one instance for an app.
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
-
The instance, if the method call succeeds.
+
The instance, if the method call succeeds.
0: Success.
-
The method call fails and an exception is thrown, you need to catch the exception and handle it. See for details and resolution suggestions.
+
The method call fails and an exception is thrown, you need to catch the exception and handle it. See for details and resolution suggestions.
< 0: Failure.
-1: A general error occurs (no specified reason).
-2: The parameter is invalid.
@@ -64,6 +64,6 @@
-101: The App ID is invalid.
-
+
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita
index 99abe864cf4..be33f384296 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel2.dita
@@ -36,12 +36,12 @@
uid: number,
options: ChannelMediaOptions
): number;
- Future<void> joinChannel(
+ Future<void> joinChannel(
{required String token,
required String channelId,
required int uid,
required ChannelMediaOptions options});
-
+ Details
@@ -62,7 +62,7 @@
token
- The token generated on your server for authentication. See .If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See .
+ The token generated on your server for authentication. See .If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel. See .channelId
@@ -72,7 +72,7 @@
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
< 0: Failure.
@@ -106,4 +106,4 @@
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita
index c0e5242a4ba..6a271be7b98 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_muteallremoteaudiostreams.dita
@@ -28,7 +28,7 @@
Call this method after joining a channel.
-
If you do not want to subscribe the audio streams of remote users before joining a channel, you can set autoSubscribeAudio as when calling .
+
If you do not want to subscribe the audio streams of remote users before joining a channel, you can set autoSubscribeAudio as when calling .
See recommended settings in Set the Subscribing State.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita
index a140c6d0daf..1b04fbb0ef9 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_preloadchannel.dita
@@ -1,12 +1,12 @@
- <ph keyref="preloadChannel"/>
+ <ph keyref="preloadChannel" />Preloads a channel with token, channelIdchannelName, and uidoptionalUid.
-
+
@@ -29,7 +29,7 @@
channelId: string,
uid: number
): number;
- Future<void> preloadChannel(
+ Future<void> preloadChannel(
{required String token, required String channelId, required int uid});
@@ -41,9 +41,9 @@
When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host. As it may take a while for the SDK to preload a channel, Agora recommends that you call this method as soon as possible after obtaining the channel name and user ID to join a channel.
-
When calling this method, ensure you set the user role as audience and do not set the audio scenario as , otherwise, this method does not take effect.
+
When calling this method, ensure you set the user role as audience and do not set the audio scenario as , otherwise, this method does not take effect.
You also need to make sure that the channel name, user ID and token passed in for preloading are the same as the values passed in when joinning the channel, otherwise, this method does not take effect.
-
One instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
+
One instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
Failing to preload a channel does not mean that you can't join a channel, nor will it increase the time of joining a channel.
If you join a preloaded channel, leave it and want to rejoin the same channel, you do not need to call this method unless the token for preloading the channel expires.
@@ -52,8 +52,8 @@
token
- The token generated on your server for authentication. See .
When the token for preloading channels expires, you can update the token based on the number of channels you preload.
When preloading one channel, calling this method to pass in the new token.
-
When preloading more than one channels:
If you use a wildcard token for all preloaded channels, call to update the token.When generating a wildcard token, ensure the user ID is not set as 0. See .
+ The token generated on your server for authentication. See .
When the token for preloading channels expires, you can update the token based on the number of channels you preload.
When preloading one channel, calling this method to pass in the new token.
+
When preloading more than one channels:
If you use a wildcard token for all preloaded channels, call to update the token.When generating a wildcard token, ensure the user ID is not set as 0. See .
If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
< 0: Failure.
@@ -84,4 +84,4 @@
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita
index 3aff9269f23..cb13450015b 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushreverseaudioframe.dita
@@ -20,7 +20,7 @@
abstract pushReverseAudioFrame(frame: AudioFrame): number;Future<void> pushReverseAudioFrame(AudioFrame frame);
-
+ Details
@@ -44,11 +44,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita
index 8b9d50bb20c..532e8c7ddcc 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushvideoframe2.dita
@@ -1,12 +1,12 @@
- <ph keyref="pushVideoFrame2"/>
+ <ph keyref="pushVideoFrame2" />Pushes the external video frame.
-
+
@@ -14,32 +14,32 @@
This method actively encapsulates the video frame data with the class and passes it to the SDK. Call the method and set enable as before calling this method; otherwise, a failure returns after calling this method.
-
You can push the video frame either by calling this method or by calling . The difference is that the method supports video data in texture format.
+
This method actively encapsulates the video frame data with the class and passes it to the SDK. Call the method and set enable as before calling this method; otherwise, a failure returns after calling this method.
+
You can push the video frame either by calling this method or by calling . The difference is that the method supports video data in texture format.
Parametersframe
- Video frame to be pushed. See .
+ Video frame to be pushed. See .Returns
-
: Pushes the external raw video frame to the SDK successfully.
-
: Fails to push external raw video frame to the SDK.
+
: Pushes the external raw video frame to the SDK successfully.
+
: Fails to push external raw video frame to the SDK.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita
index 5855456247d..bd4f010f2dd 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_querycodeccapability.dita
@@ -1,12 +1,12 @@
- <ph keyref="queryCodecCapability"/>
+ <ph keyref="queryCodecCapability" />Queries the current device's supported video codec capabilities.
-
+
@@ -14,13 +14,13 @@
public abstract CodecCapInfo[] queryCodecCapability();
- - (NSArray <AgoraVideoCodecCapInfo *> *__nullable)queryCodecCapability;
+ - (NSArray <AgoraVideoCodecCapInfo *> *__nullable)queryCodecCapability;virtual int queryCodecCapability(CodecCapInfo* codecInfo, int& size) = 0;
abstract queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number };public abstract int QueryCodecCapability(ref CodecCapInfo[] codecInfo, ref int size);abstract queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number };
- Future<List<CodecCapInfo>> queryCodecCapability(int size);
Input and output parameter. An array representing the video codec capabilities of the device. See .
+
Input and output parameter. An array representing the video codec capabilities of the device. See .
-
Input value: One defined by the user when executing this method, representing the video codec capability to be queried.
-
Output value: The after the method is executed, representing the actual video codec capabilities supported by the device.
+
Input value: One defined by the user when executing this method, representing the video codec capability to be queried.
+
Output value: The after the method is executed, representing the actual video codec capabilities supported by the device.
size
- Input and output parameter, represent the size of the array.
-
Input value: Size of the defined by the user when executing the method.
-
Output value: Size of the output after this method is executed.
+ Input and output parameter, represent the size of the array.
+
Input value: Size of the defined by the user when executing the method.
+
Output value: Size of the output after this method is executed.
- The size of .
+ The size of .
Returns
If the call is successful, an object containing the following attributes is returned:
-
codecInfo: The array, indicating the video codec capabillity of the device.
-
size: The size of the array.
+
codecInfo: The array, indicating the video codec capabillity of the device.
+
size: The size of the array.
If the call timeouts, please modify the call logic and do not invoke the method in the main thread.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
One array indicating the video encoding capability of the device, if the method call succeeds.
+
One array indicating the video encoding capability of the device, if the method call succeeds.
If the call timeouts, please modify the call logic and do not invoke the method in the main thread.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita b/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita
index a5c5c9bdd05..7afadbb1bfd 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_queryscreencapturecapability.dita
@@ -1,12 +1,12 @@
- <ph keyref="queryScreenCaptureCapability"/>
+ <ph keyref="queryScreenCaptureCapability" />Queries the highest frame rate supported by the device during screen sharing.
-
+
@@ -18,10 +18,10 @@
#if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
virtual int queryScreenCaptureCapability() = 0;
#endif
-
+ public abstract int QueryScreenCaptureCapability();abstract queryScreenCaptureCapability(): number;
- Future<int> queryScreenCaptureCapability();
+ Future<int> queryScreenCaptureCapability();Details
@@ -31,7 +31,7 @@
v4.2.0
-
+
Applicable scenarios
@@ -39,15 +39,15 @@
To ensure optimal screen sharing performance, particularly in enabling high frame rates like 60 fps, Agora recommends you to query the device's maximum supported frame rate using this method beforehand. This way, if the device cannot support such a high frame rate, you can adjust the screen sharing stream accordingly to avoid any negative impact on the sharing quality. If the device does not support high frame rate, you can reduce the frame rate of the screen sharing stream appropriately when sharing the screen to ensure that the sharing effect meets your expectation.
- <ph keyref="return-section-title"/>
-
The highest frame rate supported by the device, if the method is called successfully. See .
-
If the call fails, returns .
+ <ph keyref="return-section-title" />
+
The highest frame rate supported by the device, if the method is called successfully. See .
+
If the call fails, returns .
-
The highest frame rate supported by the device, if the method is called successfully. See .
+
The highest frame rate supported by the device, if the method is called successfully. See .
0: The device supports the frame rate of up to 15 fps.
1: The device supports the frame rate of up to 30 fps.
2: The device supports the frame rate of up to 60 fps.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita
index 1d02bd7d0e5..af70206c7a2 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudioencodedframeobserver.dita
@@ -30,7 +30,7 @@
void registerAudioEncodedFrameObserver(
{required AudioEncodedFrameObserverConfig config,
required AudioEncodedFrameObserver observer});
-
+ Details
@@ -57,12 +57,12 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
One object.
+
One object.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita
index 2fd9148d87d..feb57cf4a9a 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_registeraudiospectrumobserver.dita
@@ -25,7 +25,7 @@
observer: IAudioSpectrumObserver
): number;void registerAudioSpectrumObserver(AudioSpectrumObserver observer);
-
+ Details
@@ -44,13 +44,13 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
One object.
+
One object.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita
index 88a5a7f38cd..bf1f58fb587 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_registermediametadataobserver.dita
@@ -28,7 +28,7 @@
): number;
void registerMediaMetadataObserver(
{required MetadataObserver observer, required MetadataType type});
-
+ Details
@@ -51,12 +51,12 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita
index 377d7e71c80..1d5ff941292 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_removehandler.dita
@@ -24,7 +24,7 @@
eventHandler: IRtcEngineEventHandler
): boolean;
void unregisterEventHandler(RtcEngineEventHandler eventHandler);
-
+ Details
@@ -40,11 +40,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
: Success.
-
: Failure. See for details and resolution suggestions.
+
: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita
index db84b53b771..a2233e2ec6f 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_sendmetadata.dita
@@ -21,7 +21,7 @@
abstract sendMetaData(metadata: Metadata, sourceType: VideoSourceType): number;Future<void> sendMetaData(
{required Metadata metadata, required VideoSourceType sourceType});
-
+ Details
@@ -33,20 +33,20 @@
metadata
- Media metadata See .
+ Media metadata See .sourceTypesource_type
- The type of the video source. See .
+ The type of the video source. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita
index 3f63744d977..cd1b84e9283 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setadvancedaudiooptions.dita
@@ -19,8 +19,8 @@
abstract setAdvancedAudioOptions(options: AdvancedAudioOptions): number;public abstract int SetAdvancedAudioOptions(AdvancedAudioOptions options);abstract setAdvancedAudioOptions(options: AdvancedAudioOptions): number;
- Future<void> setAdvancedAudioOptions(AdvancedAudioOptions options);
-
+ Future<void> setAdvancedAudioOptions(AdvancedAudioOptions options);
+ Details
@@ -35,11 +35,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita
index 87cbe321767..759d8d78c9f 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setaudiomixingdualmonomode.dita
@@ -20,7 +20,7 @@
public abstract int SetAudioMixingDualMonoMode(AUDIO_MIXING_DUAL_MONO_MODE mode);abstract setAudioMixingDualMonoMode(mode: AudioMixingDualMonoMode): number;Future<void> setAudioMixingDualMonoMode(AudioMixingDualMonoMode mode);
-
+ Details
@@ -39,11 +39,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita
index 1179f56b951..e1a37166d64 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setchannelprofile.dita
@@ -20,7 +20,7 @@
public abstract int SetChannelProfile(CHANNEL_PROFILE_TYPE profile);abstract setChannelProfile(profile: ChannelProfileType): number;Future<void> setChannelProfile(ChannelProfileType profile);
-
+ Details
@@ -45,13 +45,13 @@
(2): Gaming.
Deprecated:
-
Use instead.
+
Use instead.
(3): Interaction. The scenario is optimized for latency. Use this profile if the use case requires frequent interactions between users.
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
You can call this method either before or after joining the channel to set the user role as audience or host.
-
+
If you call this method to switch the user role after joining the channel, the SDK triggers the following callbacks:
The local client: .
The remote client: or ().
@@ -62,4 +62,4 @@
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita
index dbe107f97b5..5cfe8167aea 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole2.dita
@@ -27,7 +27,7 @@
): number;
Future<void> setClientRole(
{required ClientRoleType role, ClientRoleOptions? options});
-
+ Details
@@ -39,7 +39,7 @@
Triggers on the local client.
Triggers or on the remote client.
-
The difference between this method and is that this method can set the user level in addition to the user role.
+
The difference between this method and is that this method can set the user level in addition to the user role.
The user role (role) determines the permissions that the SDK grants to a user, such as permission to send local streams, receive remote streams, and push streams to a CDN address.
The user level (level) determines the level of services that a user can enjoy within the permissions of the user's role. For example, an audience member can choose to receive remote streams with low latency or ultra-low latency. User level affects the pricing of services.
@@ -61,11 +61,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-1: A general error occurs (no specified reason).
-2: The parameter is invalid.
-5: The request is rejected.
@@ -73,4 +73,4 @@
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita
index d3b3bba5c8d..62325ecc626 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcolorenhanceoptions.dita
@@ -30,11 +30,11 @@
options: ColorEnhanceOptions,
type?: MediaSourceType
): number;
- Future<void> setColorEnhanceOptions(
+ Future<void> setColorEnhanceOptions(
{required bool enabled,
required ColorEnhanceOptions options,
MediaSourceType type = MediaSourceType.primaryCameraSource});
-
+ Details
@@ -66,16 +66,16 @@
The color enhancement options. See .
-
-
+
+
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita
index cf4a2f77dce..4084e253a7f 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita
@@ -1,12 +1,12 @@
- <ph keyref="setDualStreamMode"/>
+ <ph keyref="setDualStreamMode" />Sets the dual-stream mode on the sender side.
-
+
@@ -16,11 +16,11 @@
public abstract int setDualStreamMode(Constants.SimulcastStreamMode mode);- (int)setDualStreamMode:(AgoraSimulcastStreamMode)mode;virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode) = 0;
-
+ public abstract int SetDualStreamMode(SIMULCAST_STREAM_MODE mode);
-
-
-
+
+
+ Details
@@ -29,12 +29,12 @@
v4.0.1
-
The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling . After receiving the application, the sending end automatically switches to the low-quality video stream mode.
-
If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).
-
If you want to restore the default behavior after making changes, you can call this method again with mode set to .
- The difference and connection between this method and is as follows:
-
When calling this method and setting mode to , it has the same effect as ().
-
When calling this method and setting mode to , it has the same effect as ().
+
The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling . After receiving the application, the sending end automatically switches to the low-quality video stream mode.
+
If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).
+
If you want to restore the default behavior after making changes, you can call this method again with mode set to .
+ The difference and connection between this method and is as follows:
+
When calling this method and setting mode to , it has the same effect as ().
+
When calling this method and setting mode to , it has the same effect as ().
Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
@@ -43,15 +43,15 @@
mode
- The mode in which the video stream is sent. See .
+ The mode in which the video stream is sent. See .Returns
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita
index 62e3821a2cd..d7d24b05232 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setdualstreammode2.dita
@@ -1,12 +1,12 @@
- <ph keyref="setDualStreamMode2"/>
+ <ph keyref="setDualStreamMode2" />Sets dual-stream mode configuration on the sender, and sets the low-quality video stream.
-
+
@@ -28,9 +28,9 @@
mode: SimulcastStreamMode,
streamConfig?: SimulcastStreamConfig
): number;
- Future<void> setDualStreamMode(
+ Future<void> setDualStreamMode(
{required SimulcastStreamMode mode, SimulcastStreamConfig? streamConfig});
-
+ Details
@@ -40,11 +40,11 @@
v4.0.1
-
-
The difference between this method and is that this method can also configure the low-quality video stream, and the SDK sends the stream according to the configuration in streamConfig.
- The difference and connection between this method and is as follows:
-
When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
-
When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
+
+
The difference between this method and is that this method can also configure the low-quality video stream, and the SDK sends the stream according to the configuration in streamConfig.
+ The difference and connection between this method and is as follows:
+
When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
+
When calling this method and setting mode to , it has the same effect as calling and setting enabled to .
Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
@@ -53,22 +53,22 @@
mode
- The mode in which the video stream is sent. See .
+ The mode in which the video stream is sent. See .streamConfig
-
The configuration of the low-quality video stream. See .
- When setting mode to , setting streamConfig will not take effect.
+
The configuration of the low-quality video stream. See .
+ When setting mode to , setting streamConfig will not take effect.
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita
index a420b8b61c8..835be9dd6a2 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setexternalaudiosourcevolume.dita
@@ -1,26 +1,26 @@
- <ph keyref="setExternalAudioSourceVolume"/>
+ <ph keyref="setExternalAudioSourceVolume" />Sets the volume of the external audio frame in the specified position.
-
+
-
-
-
-
+
+
+
+ public abstract int SetExternalAudioSourceVolume(int sourcePos, int volume);
-
-
-
+
+
+ Details
@@ -31,7 +31,7 @@
sourcePos
- The push position of the external audio frame. See .
+ The push position of the external audio frame. See .The push position of the external audio frame.
0: The position before local playback. If you need to play the external audio frame on the local client, set this position.
1: The position after audio capture and before audio pre-processing. If you need the audio module of the SDK to process the external audio frame, set this position.
@@ -47,7 +47,7 @@
Returns
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita
index 1d7816d5df6..56ad4f71422 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setheadphoneeqpreset.dita
@@ -1,12 +1,12 @@
- <ph keyref="setHeadphoneEQPreset"/>
+ <ph keyref="setHeadphoneEQPreset" />Sets the preset headphone equalization effect.
-
+
@@ -19,8 +19,8 @@
abstract setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): number;public abstract int SetHeadphoneEQPreset(HEADPHONE_EQUALIZER_PRESET preset);abstract setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): number;
- Future<void> setHeadphoneEQPreset(HeadphoneEqualizerPreset preset);
-
+ Future<void> setHeadphoneEQPreset(HeadphoneEqualizerPreset preset);
+ Details
@@ -37,12 +37,12 @@
preset
- The preset headphone equalization effect. See .
+ The preset headphone equalization effect. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
< 0: Failure.
@@ -50,4 +50,4 @@
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita
index bea0c1062b7..e16af742e02 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlivetranscoding.dita
@@ -20,7 +20,7 @@
public abstract int SetLiveTranscoding(LiveTranscoding transcoding);abstract setLiveTranscoding(transcoding: LiveTranscoding): number;Future<void> setLiveTranscoding(LiveTranscoding transcoding);
-
+ Details
@@ -49,11 +49,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita
index e42bbe4b26d..6ca21e715ec 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalaccesspoint.dita
@@ -20,7 +20,7 @@
public abstract int SetLocalAccessPoint(LocalAccessPointConfiguration config);abstract setLocalAccessPoint(config: LocalAccessPointConfiguration): number;Future<void> setLocalAccessPoint(LocalAccessPointConfiguration config);
-
+ Details
@@ -39,11 +39,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita
index 43c5e906b59..354436e12c4 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalpublishfallbackoption.dita
@@ -20,7 +20,7 @@
public abstract int SetLocalPublishFallbackOption(STREAM_FALLBACK_OPTIONS option);Future<void> setLocalPublishFallbackOption(StreamFallbackOptions option);
-
+ Details
@@ -43,11 +43,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita
index 382f44434f0..52a09fa51d5 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode.dita
@@ -27,7 +27,7 @@
mirrorMode?: VideoMirrorModeType
): number;Future<void> setLocalRenderMode2(RenderModeType renderMode);
-
+ Details
@@ -58,11 +58,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita
index 0359b740d7e..362e5a34877 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita
@@ -30,7 +30,7 @@
{required RenderModeType renderMode,
VideoMirrorModeType mirrorMode =
VideoMirrorModeType.videoMirrorModeAuto});
-
+ Details
@@ -69,11 +69,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita
index 436c98bb8a0..340b1fe564e 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideomirrormode.dita
@@ -20,7 +20,7 @@
public abstract int SetLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode);abstract setLocalVideoMirrorMode(mirrorMode: VideoMirrorModeType): number;Future<void> setLocalVideoMirrorMode(VideoMirrorModeType mirrorMode);
-
+ Details
@@ -49,11 +49,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita
index 63491110164..94341a13808 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlowlightenhanceoptions.dita
@@ -30,11 +30,11 @@
options: LowlightEnhanceOptions,
type?: MediaSourceType
): number;
- Future<void> setLowlightEnhanceOptions(
+ Future<void> setLowlightEnhanceOptions(
{required bool enabled,
required LowlightEnhanceOptions options,
MediaSourceType type = MediaSourceType.primaryCameraSource});
-
+ Details
@@ -67,15 +67,15 @@
type
- The type of the video source. See .
+ The type of the video source. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita
index 8f447d3fe1a..c83aecfc281 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserspatialaudioparams.dita
@@ -28,7 +28,7 @@
): number;Future<void> setRemoteUserSpatialAudioParams(
{required int uid, required SpatialAudioParams params});
-
+ Details
@@ -48,11 +48,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita
index d79ce4737f5..240ffaf0035 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setscreencapturecontenthint.dita
@@ -21,7 +21,7 @@
public abstract int SetScreenCaptureContentHint(VIDEO_CONTENT_HINT contentHint);abstract setScreenCaptureContentHint(contentHint: VideoContentHint): number;Future<void> setScreenCaptureContentHint(VideoContentHint contentHint);
-
+ Details
@@ -37,8 +37,8 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
< 0: Failure.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita
index 7f976c8b44e..abf5f1e479a 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setuplocalvideo.dita
@@ -20,7 +20,7 @@
public abstract int SetupLocalVideo(VideoCanvas canvas);abstract setupLocalVideo(canvas: VideoCanvas): number;Future<void> setupLocalVideo(VideoCanvas canvas);
-
+
Details
@@ -28,7 +28,7 @@
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 view parameter as .
-
If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
+
If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
You can call this method either before or after joining a channel.
To update the rendering or mirror mode of the local video view during a call, use the method.
@@ -38,15 +38,15 @@
canvaslocal
- The local video view and settings. See .
+ The local video view and settings. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita
index 34b3ebe145b..88595963864 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setupremotevideo.dita
@@ -1,12 +1,12 @@
- <ph keyref="setupRemoteVideo"/>
+ <ph keyref="setupRemoteVideo" />Initializes the video view of a remote user.
-
+
@@ -20,19 +20,19 @@
public abstract int SetupRemoteVideo(VideoCanvas canvas);abstract setupRemoteVideo(canvas: VideoCanvas): number;Future<void> setupRemoteVideo(VideoCanvas canvas);
-
+ Details
This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view.
-
You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the callback.
+
You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the callback.
To unbind the remote user from the view, set the view parameter to NULL.
Once the remote user leaves the channel, the SDK unbinds the remote user.
-
If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
-
To update the rendering or mirror mode of the remote video view during a call, use the method.
-
If you use the Agora recording function, the recording client joins the channel as a placeholder client, triggering the callback. Do not bind the placeholder client to the app view because the placeholder client does not send any video streams. If your app does not recognize the placeholder client, bind the remote user to the view when the SDK triggers the callback.
+
If you need to implement native window rendering, use this method; if you only need to render video images in your Unity project, use the methods in the class instead.
+
To update the rendering or mirror mode of the remote video view during a call, use the method.
+
If you use the Agora recording function, the recording client joins the channel as a placeholder client, triggering the callback. Do not bind the placeholder client to the app view because the placeholder client does not send any video streams. If your app does not recognize the placeholder client, bind the remote user to the view when the SDK triggers the callback.
Parameters
@@ -41,16 +41,16 @@
canvasremote
-
The remote video view and settings. See .
+
The remote video view and settings. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita
index f4cdca367d3..7c58a552b8a 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideodenoiseroptions.dita
@@ -1,12 +1,12 @@
- <ph keyref="setVideoDenoiserOptions"/>
+ <ph keyref="setVideoDenoiserOptions" /> Sets video noise reduction.
-
+
@@ -30,11 +30,11 @@
options: VideoDenoiserOptions,
type?: MediaSourceType
): number;
- Future<void> setVideoDenoiserOptions(
+ Future<void> setVideoDenoiserOptions(
{required bool enabled,
required VideoDenoiserOptions options,
MediaSourceType type = MediaSourceType.primaryCameraSource});
-
+ Details
@@ -42,11 +42,11 @@
You can call this method to enable the video noise reduction feature and set the options of the video noise reduction effect.
-
Call this method after calling .
+
Call this method after calling .
Video noise reduction has certain requirements for equipment performance. If your device overheats after you enable video noise reduction, Agora recommends modifying the video noise reduction options to a less performance-consuming level or disabling video noise reduction entirely.
-
Both this method and can turn on video noise reduction function:
+
Both this method and can turn on video noise reduction function:
When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
-
When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
+
When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using .
This method relies on the image enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
@@ -57,25 +57,25 @@
enabledenableWhether to enable video noise reduction:
-
: Enable video noise reduction.
-
: (Default) Disable video noise reduction.
+
: Enable video noise reduction.
+
: (Default) Disable video noise reduction.
options
- The video noise reduction options. See .
+ The video noise reduction options. See .
-
-
+
+
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita
index c44e8ee5653..5b3f3047fd6 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoencoderconfiguration.dita
@@ -1,12 +1,12 @@
- <ph keyref="setVideoEncoderConfiguration"/>
+ <ph keyref="setVideoEncoderConfiguration" />Sets the video encoder configuration.
-
+
@@ -24,32 +24,32 @@
config: VideoEncoderConfiguration
): number;
Future<void> setVideoEncoderConfiguration(VideoEncoderConfiguration config);
-
+ Details
Sets the encoder configuration for the local video.
-
You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
-
Both this method and the method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, which causes the mirroring settings to fail.
+
You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
+
Both this method and the method support setting the mirroring effect. Agora recommends that you only choose one method to set it up. Using both methods at the same time causes the mirroring effect to overlap, which causes the mirroring settings to fail.
- You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
- Call this method before joining a channel. Agora recommends calling this method before to reduce the time to render the first video frame.
+ You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
+ Call this method before joining a channel. Agora recommends calling this method before to reduce the time to render the first video frame.Parametersconfig
- Video profile. See .
+ Video profile. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita
index bd6091ec096..a3eadbc0327 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_setvideoprofile.dita
@@ -1,12 +1,12 @@
- <ph keyref="setVideoProfile"/>
+ <ph keyref="setVideoProfile" />Sets the video encoder configuration.
-
+
@@ -17,21 +17,21 @@
- (int)setVideoProfile:(AgoraVideoProfile)profile
swapWidthAndHeight:(BOOL)swapWidthAndHeightvirtual int setVideoProfile(VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight) = 0;
-
+ public abstract int SetVideoProfile(VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight = false);
-
-
-
+
+
+ Details
Deprecated:
-
This method is deprecated. Use instead.
+
This method is deprecated. Use instead.
-
This method sets the video encoder configuration. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
+
This method sets the video encoder configuration. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before to reduce the time to render the first video frame.
Parameters
@@ -39,7 +39,7 @@
profile
-
Video profile. See .
+
Video profile. See .
@@ -47,8 +47,8 @@
The SDK outputs video with a fixed width and height according to the video profile (profile) you selected. This parameter sets whether to swap width and height of the video:
-
: Swap the width and height.
-
: (Default) Do not swap the width and height.
+
: Swap the width and height.
+
: (Default) Do not swap the width and height.
@@ -56,7 +56,7 @@
Returns
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita
index 3fe55ac3479..64405795936 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording3.dita
@@ -20,7 +20,7 @@
public abstract int StartAudioRecording(AudioRecordingConfiguration config);abstract startAudioRecording(config: AudioRecordingConfiguration): number;Future<void> startAudioRecording(AudioRecordingConfiguration config);
-
+ Details
@@ -39,11 +39,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
You can call this method to start capturing video from one or more cameras by specifying sourceType.
- On the iOS platform, if you want to enable multi-camera capture, you need to call and set enabled to before calling this method.
+ On the iOS platform, if you want to enable multi-camera capture, you need to call and set enabled to before calling this method.Parameters
@@ -48,7 +48,7 @@
sourceType
-
The type of the video source. See .
+
The type of the video source. See .
On the mobile platforms, you can capture video from up to 2 cameras, provided the device has dual cameras or supports an external camera.
On the desktop platforms, you can capture video from up to 4 cameras.
@@ -57,18 +57,18 @@
config
-
The configuration of the video capture. See .
- On the iOS platform, this parameter has no practical function. Use the config parameter in instead to set the video capture configuration.
+
The configuration of the video capture. See .
+ On the iOS platform, this parameter has no practical function. Use the config parameter in instead to set the video capture configuration.
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita
index 7e0f909d14e..f554f21fafc 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_startchannelmediarelay.dita
@@ -1,12 +1,12 @@
- <ph keyref="startChannelMediaRelay"/>
+ <ph keyref="startChannelMediaRelay" />Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels.
-
+
@@ -26,7 +26,7 @@
): number;
Future<void> startChannelMediaRelay(
ChannelMediaRelayConfiguration configuration);
-
+ Details
@@ -36,16 +36,16 @@
This method is deprecated. Use instead.
-
After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.
-
If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
-
If the callback returns (3), an exception occurs during the media stream relay.
+
After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.
+
If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
+
If the callback returns (3), an exception occurs during the media stream relay.
Call this method after joining the channel.
This method takes effect only when you are a host in a live streaming channel.
-
After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
-
The relaying media streams across channels function needs to be enabled by contacting .
+
After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
+
The relaying media streams across channels function needs to be enabled by contacting .
Agora does not support string user accounts in this API.
@@ -55,12 +55,12 @@
channelMediaRelayConfigurationconfigconfiguration
- The configuration of the media stream relay. See .
+ The configuration of the media stream relay. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
< 0: Failure.
@@ -71,4 +71,4 @@
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita
index ac0eff4bd5b..5e4840e581b 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_startdirectcdnstreaming.dita
@@ -28,11 +28,11 @@
publishUrl: string,
options: DirectCdnStreamingMediaOptions
): number;
- Future<void> startDirectCdnStreaming(
+ Future<void> startDirectCdnStreaming(
{required DirectCdnStreamingEventHandler eventHandler,
required String publishUrl,
required DirectCdnStreamingMediaOptions options});
-
+ Details
Aogra does not support pushing media streams to one URL repeatedly.
@@ -46,7 +46,7 @@
publishCameraTrack is set as (the default value)
publishMicrophoneTrack is set as (the default value)
-
As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call to push audio streams. As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call or to push audio streams.Agora only supports pushing one audio and video streams or one audio streams to CDN.
+
As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call to push audio streams. As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in as and call or to push audio streams.Agora only supports pushing one audio and video streams or one audio streams to CDN.
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita
index c2a8a6417fb..610717b10b2 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita
@@ -1,12 +1,12 @@
- <ph keyref="startEchoTest3"/>
+ <ph keyref="startEchoTest3" />Starts an audio device loopback test.
-
+
@@ -19,8 +19,8 @@
abstract startEchoTest(config: EchoTestConfiguration): number;public abstract int StartEchoTest(EchoTestConfiguration config);abstract startEchoTest(config: EchoTestConfiguration): number;
- Future<void> startEchoTest(EchoTestConfiguration config);
-
+ Future<void> startEchoTest(EchoTestConfiguration config);
+ Details
@@ -28,7 +28,7 @@
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. When calling in a channel, make sure that no audio or video stream is being published.
-
After calling this method, call to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
+
After calling this method, call to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
In live streaming scenarios, this method only applies to hosts.
@@ -37,14 +37,14 @@
config
- The configuration of the audio and video call loop test. See .
+ The configuration of the audio and video call loop test. See .Returns
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita
index ec1ae30871c..4681e3714ae 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_startorupdatechannelmediarelay.dita
@@ -1,12 +1,12 @@
- <ph keyref="startOrUpdateChannelMediaRelay"/>
+ <ph keyref="startOrUpdateChannelMediaRelay" />Starts relaying media streams across channels or updates channels for media relay.
-
+
@@ -24,9 +24,9 @@
abstract startOrUpdateChannelMediaRelay(
configuration: ChannelMediaRelayConfiguration
): number;
- Future<void> startOrUpdateChannelMediaRelay(
+ Future<void> startOrUpdateChannelMediaRelay(
ChannelMediaRelayConfiguration configuration);
-
+ Details
@@ -36,15 +36,15 @@
v4.2.0
The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels.
-
After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:
-
If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
-
If the callback returns (3), an exception occurs during the media stream relay.
+
After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:
+
If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
+
If the callback returns (3), an exception occurs during the media stream relay.
Call this method after joining the channel.
This method takes effect only when you are a host in a live streaming channel.
-
The relaying media streams across channels function needs to be enabled by contacting .
+
The relaying media streams across channels function needs to be enabled by contacting .
Agora does not support string user accounts in this API.
@@ -54,12 +54,12 @@
channelMediaRelayConfigurationconfigconfiguration
- The configuration of the media stream relay. See .
+ The configuration of the media stream relay. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
In music education, physical education and other scenarios, teachers usually need to use a metronome so that students can practice with the correct beat. The meter is composed of a downbeat and upbeats. The first beat of each measure is called a downbeat, and the rest are called upbeats.
In this method, you need to set the file path of the upbeat and downbeat, the number of beats per measure, the beat speed, and whether to send the sound of the metronome to remote users.
-
After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.
+
After successfully calling this method, the SDK triggers the callback locally to report the status of the virtual metronome.
This method is for Android and iOS only.
-
After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in . For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
-
By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in as .
+
After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in . For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
+
By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in as .
Parameterssound1
- The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
+ The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.sound2
- The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
+ The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example, . For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.config
- The metronome configuration. See .
+ The metronome configuration. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
There are two ways to start screen sharing, you can choose one according to your needs:
-
Call this method before joining a channel, then call to join channel and set publishScreenCaptureVideo to to start screen sharing.
-
Call this method after joining a channel, then call and set publishScreenCaptureVideo to to start screen sharing.
+
Call this method before joining a channel, then call to join channel and set publishScreenCaptureVideo to to start screen sharing.
+
Call this method after joining a channel, then call and set publishScreenCaptureVideo to to start screen sharing.
-
When the state of the screen sharing extension process changes, the SDK triggers the callback accordingly. When the type of sourceType is , the state parameter indicates the state of the screen sharing.
+
When the state of the screen sharing extension process changes, the SDK triggers the callback accordingly. When the type of sourceType is , the state parameter indicates the state of the screen sharing.
This method applies to Android and iOS only.
On the iOS platform, screen sharing is only available on iOS 12.0 and later.
-
The billing for the screen sharing stream is based on the dimensions in . When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. For billing details, see .
+
The billing for the screen sharing stream is based on the dimensions in . When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. For billing details, see .
If you are using the custom audio source instead of the SDK to capture audio, Agora recommends you add the keep-alive processing logic to your application to avoid screen sharing stopping when the application goes to the background.
This feature requires high-performance device, and Agora recommends that you use it on iPhone X and later models.
This method relies on the iOS screen sharing dynamic library AgoraReplayKitExtension.xcframework. If the dynamic library is deleted, screen sharing cannot be enabled normally.
On the Android platform, make sure the user has granted the app screen capture permission.
-
Make sure that the Android API level is not earlier than 21, otherwise, the SDK reports error codes (16) and (2).
-
To capture system audio during screen sharing, ensure that the Android API level is not earlier than 29 as well; otherwise, the SDK reports the error code (3).
+
Make sure that the Android API level is not earlier than 21, otherwise, the SDK reports error codes (16) and (2).
+
To capture system audio during screen sharing, ensure that the Android API level is not earlier than 29 as well; otherwise, the SDK reports the error code (3).
On Android 9 and later, to avoid the application being killed by the system after going to the background, Agora recommends you add the foreground service android.permission.FOREGROUND_SERVICE to the /app/Manifests/AndroidManifest.xml file.
Due to performance limitations, screen sharing is not supported on Android TV.
Due to system limitations, if you are using Huawei phones, do not adjust the video encoding resolution of the screen sharing stream during the screen sharing, or you could experience crashes.
Due to system limitations, some Xiaomi devices do not support capturing system audio during screen sharing.
-
To avoid system audio capture failure when screen sharing, Agora recommends that you set the audio application scenario to by using the method before joining the channel.
+
To avoid system audio capture failure when screen sharing, Agora recommends that you set the audio application scenario to by using the method before joining the channel.
Parameters
@@ -56,12 +56,12 @@
parametersscreenCaptureParameterscaptureParams
- The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See .
+ The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See .
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
< 0: Failure.
@@ -69,4 +69,4 @@
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita
index b3acaac3c5f..4351ddd9106 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture2.dita
@@ -22,11 +22,11 @@
config: ScreenCaptureConfiguration
): number;public abstract int StartScreenCapture(VIDEO_SOURCE_TYPE sourceType, ScreenCaptureConfiguration config);
-
- Future<void> startScreenCaptureBySourceType(
+
+ Future<void> startScreenCaptureBySourceType(
{required VideoSourceType sourceType,
required ScreenCaptureConfiguration config});
-
+ Details
@@ -36,15 +36,15 @@
v4.2.0
-
This method, as well as and , all have the capability to start screen capture, with the following differences:
-This method, as well as , , and , all have the capability to start screen capture, with the following differences:
-
only applies to Android and iOS, whereas this method only applies to Windows and iOS.
-
and only support capturing video from a single screen or window. By calling this method and specifying the sourceType parameter, you can capture multiple video streams used for local video mixing or multi-channel publishing.
+
This method, as well as and , all have the capability to start screen capture, with the following differences:
+This method, as well as , , and , all have the capability to start screen capture, with the following differences:
+
only applies to Android and iOS, whereas this method only applies to Windows and iOS.
+
and only support capturing video from a single screen or window. By calling this method and specifying the sourceType parameter, you can capture multiple video streams used for local video mixing or multi-channel publishing.
This method applies to the macOS and Windows only.
-
If you call this method to start screen capture, Agora recommends that you call to stop the capture and avoid using .
+
If you call this method to start screen capture, Agora recommends that you call to stop the capture and avoid using .
Parameters
@@ -52,10 +52,10 @@
sourceType
-
The type of the video source. See .
+
The type of the video source. See .
Windows supports up to four screen capture video streams.
-
macOS supports only one screen capture video stream. You can only set this parameter to (2).
+
macOS supports only one screen capture video stream. You can only set this parameter to (2).
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita
index ac1b202e9b8..51eb23c221a 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebydisplayid.dita
@@ -36,7 +36,7 @@
{required int displayId,
required Rectangle regionRect,
required ScreenCaptureParameters captureParams});
-
+ Details
@@ -71,8 +71,8 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
< 0: Failure.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita
index 4f419c0f36a..968cf91cf25 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel2.dita
@@ -1,33 +1,33 @@
- <ph keyref="switchChannel2"/>
+ <ph keyref="switchChannel2" />Switches to a different channel, and configures whether to automatically subscribe to audio or video streams in the target channel.
-
+
This method allows the audience of an interactive live streaming channel to switch to a different channel.
-
After the user successfully switches to another channel, the and callbacks are triggered to indicate that the user has left the original channel and joined a new one.
+
After the user successfully switches to another channel, the and callbacks are triggered to indicate that the user has left the original channel and joined a new one.
Once the user switches to another channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.
@@ -37,10 +37,10 @@
token
The token generated at your server.
-
In scenarios with low security requirements, token is optional and can be set as .
+
In scenarios with low security requirements, token is optional and can be set as .
In scenarios with high security requirements, set the value to the token generated from your server. If you enable the App Certificate, you must use a token to join the channel.
- Ensure that the App ID, channel name, and user name used for creating the token are the same ones as those used by the method for initializing the RTC engine.
+ Ensure that the App ID, channel name, and user name used for creating the token are the same ones as those used by the method for initializing the RTC engine.
@@ -52,20 +52,20 @@
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita
index 9079b6d47d2..341e28b20fd 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencapture.dita
@@ -21,13 +21,13 @@
public abstract int UpdateScreenCapture(ScreenCaptureParameters2 captureParams);abstract updateScreenCapture(captureParams: ScreenCaptureParameters2): number;Future<void> updateScreenCapture(ScreenCaptureParameters2 captureParams);
-
+ Details
If the system audio is not captured when screen sharing is enabled, and then you want to update the parameter configuration and publish the system audio, you can refer to the following steps:
-
Call this method, and set captureAudio to .
-
Call , and set publishScreenCaptureAudio to to publish the audio captured by the screen.
+
Call this method, and set captureAudio to .
+
Call , and set publishScreenCaptureAudio to to publish the audio captured by the screen.
@@ -46,13 +46,13 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
< 0: Failure.
-
+
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita
index b43a79f1ce3..9a817e0cbbb 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureparameters.dita
@@ -27,7 +27,7 @@
): number;
Future<void> updateScreenCaptureParameters(
ScreenCaptureParameters captureParams);
-
+ Details
@@ -46,8 +46,8 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
< 0: Failure.
diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita
index af8ccc10121..896e8791aca 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion.dita
@@ -20,7 +20,7 @@
public abstract int UpdateScreenCaptureRegion(Rectangle regionRect);abstract updateScreenCaptureRegion(regionRect: Rectangle): number;Future<void> updateScreenCaptureRegion(Rectangle regionRect);
-
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ Parameters
@@ -28,15 +28,15 @@
rectregionRect
- The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window.
+ The relative location of the region to the screen or window. If you do not set this parameter, the SDK shares the whole screen. See . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window.
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita
index 1926b7219ae..2cf86168db9 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengineex_createdatastreamex2.dita
@@ -30,7 +30,7 @@
): number;
Future<int> createDataStreamEx(
{required DataStreamConfig config, required RtcConnection connection});
-
+ Details
@@ -58,7 +58,7 @@
0: The data stream is successfully created.
ID of the created data stream, if the method call succeeds.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita
index 18f12794ebf..b033808fc8a 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengineex_joinchannelex.dita
@@ -1,12 +1,12 @@
- <ph keyref="joinChannelEx"/>
+ <ph keyref="joinChannelEx" />Joins a channel with the connection ID.
-
+
@@ -38,7 +38,7 @@
{required String token,
required RtcConnection connection,
required ChannelMediaOptions options});
-
+ Details
@@ -47,34 +47,34 @@
If you are already in a channel, you cannot rejoin it with the same user ID.
If you want to join the same channel from different devices, ensure that the user IDs are different for all devices.
-
Ensure that the app ID you use to generate the token is the same as the app ID used when creating the instance.
-
In a multi-camera capture scenario, you need to call the method after calling this method to set the sourceType to , to ensure that the second camera captures normally.
+
Ensure that the app ID you use to generate the token is the same as the app ID used when creating the instance.
+
In a multi-camera capture scenario, you need to call the method after calling this method to set the sourceType to , to ensure that the second camera captures normally.
Parameters
-
-
+
+ connection
- The connection information. See .
+ The connection information. See .
-
-
+
+ eventHandlerdelegate
- The callback class of .See .
+ The callback class of .See .
-
-
+
+
-
+
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita
index 97da798c55e..be30a0d5d6f 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengineex_muteallremoteaudiostreamsex.dita
@@ -36,7 +36,7 @@
Call this method after joining a channel.
-
If you do not want to subscribe the audio streams of remote users before joining a channel, you can set autoSubscribeAudio as when calling .
+
If you do not want to subscribe the audio streams of remote users before joining a channel, you can set autoSubscribeAudio as when calling .
See recommended settings in Set the Subscribing State.
The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to . If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).
- The difference and connection between this method and is as follows:
-
When calling this method and setting mode to , it has the same effect as ().
-
When calling this method and setting mode to , it has the same effect as ().
+
The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to . If you want to modify this behavior, you can call this method and modify the mode to (never send low-quality video streams) or (always send low-quality video streams).
+ The difference and connection between this method and is as follows:
+
When calling this method and setting mode to , it has the same effect as ().
+
When calling this method and setting mode to , it has the same effect as ().
Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
@@ -57,23 +57,23 @@
mode
- The mode in which the video stream is sent. See .
+ The mode in which the video stream is sent. See .
-
-
+
+
-
-
+
+
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita
index 2dc8b8161d6..5975b307f28 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setupremotevideoex.dita
@@ -28,7 +28,7 @@
): number;
Future<void> setupRemoteVideoEx(
{required VideoCanvas canvas, required RtcConnection connection});
-
+ Details
@@ -56,11 +56,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita
index 1ddbbe434ba..01d4f31d67b 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setvideoencoderconfigurationex.dita
@@ -30,7 +30,7 @@
Future<void> setVideoEncoderConfigurationEx(
{required VideoEncoderConfiguration config,
required RtcConnection connection});
-
+ Details
@@ -50,11 +50,11 @@
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita
index b9d4e5e12c1..74af9bcb24a 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startchannelmediarelayex.dita
@@ -1,12 +1,12 @@
- <ph keyref="startChannelMediaRelayEx"/>
+ <ph keyref="startChannelMediaRelayEx" />Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels.
-
+
@@ -26,10 +26,10 @@
configuration: ChannelMediaRelayConfiguration,
connection: RtcConnection
): number;
- Future<void> startChannelMediaRelayEx(
+ Future<void> startChannelMediaRelayEx(
{required ChannelMediaRelayConfiguration configuration,
required RtcConnection connection});
-
+ Details
@@ -39,16 +39,16 @@
This method is deprecated. Use instead.
-
After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.
-
If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
-
If the callback returns (3), an exception occurs during the media stream relay.
+
After a successful method call, the SDK triggers the and callbacks, and these callbacks return the state and events of the media stream relay.
+
If the callback returns (2) and (0), and the callback returns (4), it means that the SDK starts relaying media streams between the source channel and the target channel.
+
If the callback returns (3), an exception occurs during the media stream relay.
Call this method after joining the channel.
This method takes effect only when you are a host in a live streaming channel.
-
After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
-
The relaying media streams across channels function needs to be enabled by contacting .
+
After a successful method call, if you want to call this method again, ensure that you call the method to quit the current relay.
+
The relaying media streams across channels function needs to be enabled by contacting .
Agora does not support string user accounts in this API.
@@ -58,16 +58,16 @@
channelMediaRelayConfigurationconfigconfiguration
- The configuration of the media stream relay. See .
+ The configuration of the media stream relay. See .
-
-
+
+
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
< 0: Failure.
@@ -78,4 +78,4 @@
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita
index c48db5d76e8..20723ed2831 100644
--- a/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita
+++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startorupdatechannelmediarelayex.dita
@@ -1,12 +1,12 @@
- <ph keyref="startOrUpdateChannelMediaRelayEx"/>
+ <ph keyref="startOrUpdateChannelMediaRelayEx" />Starts relaying media streams across channels or updates channels for media relay.
-
+
@@ -26,10 +26,10 @@
configuration: ChannelMediaRelayConfiguration,
connection: RtcConnection
): number;
- Future<void> startOrUpdateChannelMediaRelayEx(
+ Future<void> startOrUpdateChannelMediaRelayEx(
{required ChannelMediaRelayConfiguration configuration,
required RtcConnection connection});
-
+ Details
@@ -39,15 +39,15 @@
v4.2.0
The first successful call to this method starts relaying media streams from the source channel to the destination channels. To relay the media stream to other channels, or exit one of the current media relays, you can call this method again to update the destination channels. This feature supports relaying media streams to a maximum of six destination channels.
-
After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:
-
If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
-
If the callback returns (3), an exception occurs during the media stream relay.
+
After a successful method call, the SDK triggers the callback, and this callback returns the state of the media stream relay. Common states are as follows:
+
If the callback returns (2) and (0), it means that the SDK starts relaying media streams from the source channel to the destination channel.
+
If the callback returns (3), an exception occurs during the media stream relay.
Call this method after joining the channel.
This method takes effect only when you are a host in a live streaming channel.
-
The relaying media streams across channels function needs to be enabled by contacting .
+
The relaying media streams across channels function needs to be enabled by contacting .
Agora does not support string user accounts in this API.
@@ -57,16 +57,16 @@
channelMediaRelayConfigurationconfigconfiguration
- The configuration of the media stream relay. See .
+ The configuration of the media stream relay. See .
-
-
+
+
- <ph keyref="return-section-title"/>
-
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
+ <ph keyref="return-section-title" />
+
When the method call succeeds, there is no return value; when fails, the exception is thrown; and you need to catch the exception and handle it accordingly. See for details and resolution suggestions.
0: Success.
< 0: Failure.
@@ -77,4 +77,4 @@
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita
index 276bd773c9d..3f0d78bcbd5 100644
--- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita
+++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_getcapability.dita
@@ -26,9 +26,9 @@
deviceIdUTF8: string,
deviceCapabilityNumber: number
): VideoFormat;
- Future<VideoFormat> getCapability(
+ Future<VideoFormat> getCapability(
{required String deviceIdUTF8, required int deviceCapabilityNumber});
-
+ Details
@@ -55,7 +55,7 @@
Returns
0: Success.
-
< 0: Failure. See for details and resolution suggestions.
+
< 0: Failure. See for details and resolution suggestions.
The specific information of the specified video format, including width (px), height (px), and frame rate (fps). See .
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita
index 5e938362dc7..48f3597553f 100644
--- a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita
+++ b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita
@@ -1,9 +1,8 @@
- <ph keyref="LocalAccessPointConfiguration"/>
- The configurations of the Local Access Point.
+ <ph keyref="LocalAccessPointConfiguration" />
+ The configurations of the Local Access Point.
@@ -60,8 +59,8 @@
return logUploadServer;
}
};
- public ArrayList<String> ipList = null;
- public ArrayList<String> domainList = null;
+ public ArrayList<String> ipList = null;
+ public ArrayList<String> domainList = null;
public String verifyDomainName = null;
public int mode = Constants.LOCAL_RPOXY_CONNECTIVITY_FIRST;
public AdvancedConfigInfo advancedConfig = null;
@@ -147,13 +146,13 @@
this.advancedConfig});
@JsonKey(name: 'ipList')
- final List<String>? ipList;
+ final List<String>? ipList;
@JsonKey(name: 'ipListSize')
final int? ipListSize;
@JsonKey(name: 'domainList')
- final List<String>? domainList;
+ final List<String>? domainList;
@JsonKey(name: 'domainListSize')
final int? domainListSize;
@@ -167,15 +166,15 @@
@JsonKey(name: 'advancedConfig')
final AdvancedConfigInfo? advancedConfig;
- factory LocalAccessPointConfiguration.fromJson(Map<String, dynamic> json) =>
+ factory LocalAccessPointConfiguration.fromJson(Map<String, dynamic> json) =>
_$LocalAccessPointConfigurationFromJson(json);
- Map<String, dynamic> toJson() => _$LocalAccessPointConfigurationToJson(this);
+ Map<String, dynamic> toJson() => _$LocalAccessPointConfigurationToJson(this);
}
(0): The SDK firstly tries to connect to the specified Agora private media server; if the connection attempt fails, it will connect to the Agora SD-RTN™ instead.
-
(1) The SDK only tries to connect to the specified Agora private media server.
+
(0): The SDK firstly tries to connect to the specified Agora private media server; if the connection attempt fails, it will connect to the Agora SD-RTN™ instead.
+
(1) The SDK only tries to connect to the specified Agora private media server.
advancedConfig
- The advanced options for the Local Access Point. See .
+ The advanced options for the Local Access Point. See .
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_advanceoptions.dita b/en-US/dita/RTC-NG/API/class_advanceoptions.dita
index 9bdc1a2e617..0dc3b8188c3 100644
--- a/en-US/dita/RTC-NG/API/class_advanceoptions.dita
+++ b/en-US/dita/RTC-NG/API/class_advanceoptions.dita
@@ -1,7 +1,7 @@
- <ph keyref="AdvanceOptions"/>
+ <ph keyref="AdvanceOptions" />Advanced options for video encoding.
@@ -75,12 +75,12 @@
@JsonKey(name: 'compressionPreference')
final CompressionPreference? compressionPreference;
- factory AdvanceOptions.fromJson(Map<String, dynamic> json) =>
+ factory AdvanceOptions.fromJson(Map<String, dynamic> json) =>
_$AdvanceOptionsFromJson(json);
- Map<String, dynamic> toJson() => _$AdvanceOptionsToJson(this);
+ Map<String, dynamic> toJson() => _$AdvanceOptionsToJson(this);
}
-
+
@@ -89,19 +89,19 @@
v4.1.0
-
+
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />encodingPreference
- Video encoder preference. See .
+ Video encoder preference. See .compressionPreference
- Compression preference for video encoding. See .
+ Compression preference for video encoding. See .
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_audioparams.dita b/en-US/dita/RTC-NG/API/class_audioparams.dita
index 9293da4048f..8e884f6f6d3 100644
--- a/en-US/dita/RTC-NG/API/class_audioparams.dita
+++ b/en-US/dita/RTC-NG/API/class_audioparams.dita
@@ -1,7 +1,7 @@
- <ph keyref="AudioParams"/>
+ <ph keyref="AudioParams" />Audio data format.
@@ -98,33 +98,33 @@
@JsonKey(name: 'samples_per_call')
final int? samplesPerCall;
- factory AudioParams.fromJson(Map<String, dynamic> json) =>
+ factory AudioParams.fromJson(Map<String, dynamic> json) =>
_$AudioParamsFromJson(json);
- Map<String, dynamic> toJson() => _$AudioParamsToJson(this);
+ Map<String, dynamic> toJson() => _$AudioParamsToJson(this);
}
-
+
-
You can pass the object in the following APIs to set the audio data format for the corresponding callback:
-
: Sets the audio data format for the callback.
-
: Sets the audio data format for the callback.
-
: Sets the audio data format for the callback.
-
: Sets the audio data format for the callback.
+
You can pass the object in the following APIs to set the audio data format for the corresponding callback:
+
: Sets the audio data format for the callback.
+
: Sets the audio data format for the callback.
+
: Sets the audio data format for the callback.
+
: Sets the audio data format for the callback.
-
The SDK sets the audio data format in the following callbacks according to .
-
-
-
+
The SDK sets the audio data format in the following callbacks according to .
+
+
+
-
The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in , and triggers the , , , and callbacks according to the sampling interval.
+
The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in , and triggers the , , , and callbacks according to the sampling interval.
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />sampleRate
@@ -147,10 +147,10 @@
mode
- The use mode of the audio data. See .
+ The use mode of the audio data. See .The use mode of the audio data, which can be set as either of the following values:
-
(0): Read-only mode, where users only read the original data from without any modification. For example, when users acquire the data with the Agora SDK, then start the media push.
-
(2): Read and write mode, where users read the data from , modify it, and then play it. Users read the data returned by the SDK, modify it, and then play it. For example, when users have their own audio-effect processing module and perform some voice pre-processing, such as a voice change.
+
(0): Read-only mode, where users only read the original data from without any modification. For example, when users acquire the data with the Agora SDK, then start the media push.
+
(2): Read and write mode, where users read the data from , modify it, and then play it. Users read the data returned by the SDK, modify it, and then play it. For example, when users have their own audio-effect processing module and perform some voice pre-processing, such as a voice change.
@@ -160,4 +160,4 @@
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita b/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita
index 039b4d298c6..b694d999d95 100644
--- a/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita
+++ b/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita
@@ -164,12 +164,12 @@
@JsonKey(name: 'recordingChannel')
final int? recordingChannel;
- factory AudioRecordingConfiguration.fromJson(Map<String, dynamic> json) =>
+ factory AudioRecordingConfiguration.fromJson(Map<String, dynamic> json) =>
_$AudioRecordingConfigurationFromJson(json);
- Map<String, dynamic> toJson() => _$AudioRecordingConfigurationToJson(this);
+ Map<String, dynamic> toJson() => _$AudioRecordingConfigurationToJson(this);
}
-
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />
diff --git a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita
index 12b2e5c04f2..c0f274a22e8 100644
--- a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita
+++ b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita
@@ -1,7 +1,7 @@
- <ph keyref="CameraCapturerConfiguration"/>
+ <ph keyref="CameraCapturerConfiguration" /> The camera capturer preference.
@@ -199,40 +199,40 @@
@JsonKey(name: 'followEncodeDimensionRatio')
final bool? followEncodeDimensionRatio;
- factory CameraCapturerConfiguration.fromJson(Map<String, dynamic> json) =>
+ factory CameraCapturerConfiguration.fromJson(Map<String, dynamic> json) =>
_$CameraCapturerConfigurationFromJson(json);
- Map<String, dynamic> toJson() => _$CameraCapturerConfigurationToJson(this);
+ Map<String, dynamic> toJson() => _$CameraCapturerConfigurationToJson(this);
}
-
+
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <title> <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />
cameraDirection
- This parameter applies to Android and iOS only.The camera direction. See .
+ This parameter applies to Android and iOS only.The camera direction. See .formatcaptureFormat
- The format of the video frame. See .
+ The format of the video frame. See .deviceIdThis method applies to Windows only.
- This method applies to macOS only.The ID of the camera. The maximum length is .
+ This method applies to macOS only.The ID of the camera. The maximum length is .followEncodeDimensionRatio
- Whether to follow the video aspect ratio set in :
-
: (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in and .
-
: Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
+ Whether to follow the video aspect ratio set in :
+
: (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in and .
+
: Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita
index b01a70c5966..4e662aba898 100644
--- a/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita
+++ b/en-US/dita/RTC-NG/API/class_channelmediaoptions.dita
@@ -1,7 +1,7 @@
- <ph keyref="ChannelMediaOptions"/>
+ <ph keyref="ChannelMediaOptions" /> The channel media options.
@@ -80,8 +80,8 @@
struct ChannelMediaOptions {
Optional<bool> publishCameraTrack;
Optional<bool> publishSecondaryCameraTrack;
- Optional<bool> publishThirdCameraTrack;
- Optional<bool> publishFourthCameraTrack;
+ Optional<bool> publishThirdCameraTrack;
+ Optional<bool> publishFourthCameraTrack;
Optional<bool> publishMicrophoneTrack;
#if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
@@ -90,8 +90,8 @@
#else
Optional<bool> publishScreenTrack;
Optional<bool> publishSecondaryScreenTrack;
- Optional<bool> publishThirdScreenTrack;
- Optional<bool> publishFourthScreenTrack;
+ Optional<bool> publishThirdScreenTrack;
+ Optional<bool> publishFourthScreenTrack;
#endif
Optional<bool> publishCustomAudioTrack;
@@ -223,37 +223,37 @@
}public class ChannelMediaOptions : OptionalJsonParse
{
- public Optional<bool> publishCameraTrack = new Optional<bool>();
- public Optional<bool> publishSecondaryCameraTrack = new Optional<bool>();
- public Optional<bool> publishThirdCameraTrack = new Optional<bool>();
- public Optional<bool> publishFourthCameraTrack = new Optional<bool>();
- public Optional<bool> publishMicrophoneTrack = new Optional<bool>();
- public Optional<bool> publishScreenCaptureVideo = new Optional<bool>();
- public Optional<bool> publishScreenCaptureAudio = new Optional<bool>();
- public Optional<bool> publishScreenTrack = new Optional<bool>();
- public Optional<bool> publishSecondaryScreenTrack = new Optional<bool>();
- public Optional<bool> publishThirdScreenTrack = new Optional<bool>();
- public Optional<bool> publishFourthScreenTrack = new Optional<bool>();
- public Optional<bool> publishCustomAudioTrack = new Optional<bool>();
- public Optional<int> publishCustomAudioTrackId = new Optional<int>();
- public Optional<bool> publishCustomVideoTrack = new Optional<bool>();
- public Optional<bool> publishEncodedVideoTrack = new Optional<bool>();
- public Optional<bool> publishMediaPlayerAudioTrack = new Optional<bool>();
- public Optional<bool> publishMediaPlayerVideoTrack = new Optional<bool>();
- public Optional<bool> publishTranscodedVideoTrack = new Optional<bool>();
- public Optional<bool> autoSubscribeAudio = new Optional<bool>();
- public Optional<bool> autoSubscribeVideo = new Optional<bool>();
- public Optional<bool> enableAudioRecordingOrPlayout = new Optional<bool>();
- public Optional<int> publishMediaPlayerId = new Optional<int>();
- public Optional<CLIENT_ROLE_TYPE> clientRoleType = new Optional<CLIENT_ROLE_TYPE>();
- public Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel = new Optional<AUDIENCE_LATENCY_LEVEL_TYPE>();
- public Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType = new Optional<VIDEO_STREAM_TYPE>();
- public Optional<CHANNEL_PROFILE_TYPE> channelProfile = new Optional<CHANNEL_PROFILE_TYPE>();
- public Optional<string> token = new Optional<string>();
- public Optional<bool> publishRhythmPlayerTrack = new Optional<bool>();
- public Optional<bool> isInteractiveAudience = new Optional<bool>();
- public Optional<video_track_id_t> customVideoTrackId = new Optional<video_track_id_t>();
- public Optional<bool> isAudioFilterable = new Optional<bool>();
+ public Optional<bool> publishCameraTrack = new Optional<bool>();
+ public Optional<bool> publishSecondaryCameraTrack = new Optional<bool>();
+ public Optional<bool> publishThirdCameraTrack = new Optional<bool>();
+ public Optional<bool> publishFourthCameraTrack = new Optional<bool>();
+ public Optional<bool> publishMicrophoneTrack = new Optional<bool>();
+ public Optional<bool> publishScreenCaptureVideo = new Optional<bool>();
+ public Optional<bool> publishScreenCaptureAudio = new Optional<bool>();
+ public Optional<bool> publishScreenTrack = new Optional<bool>();
+ public Optional<bool> publishSecondaryScreenTrack = new Optional<bool>();
+ public Optional<bool> publishThirdScreenTrack = new Optional<bool>();
+ public Optional<bool> publishFourthScreenTrack = new Optional<bool>();
+ public Optional<bool> publishCustomAudioTrack = new Optional<bool>();
+ public Optional<int> publishCustomAudioTrackId = new Optional<int>();
+ public Optional<bool> publishCustomVideoTrack = new Optional<bool>();
+ public Optional<bool> publishEncodedVideoTrack = new Optional<bool>();
+ public Optional<bool> publishMediaPlayerAudioTrack = new Optional<bool>();
+ public Optional<bool> publishMediaPlayerVideoTrack = new Optional<bool>();
+ public Optional<bool> publishTranscodedVideoTrack = new Optional<bool>();
+ public Optional<bool> autoSubscribeAudio = new Optional<bool>();
+ public Optional<bool> autoSubscribeVideo = new Optional<bool>();
+ public Optional<bool> enableAudioRecordingOrPlayout = new Optional<bool>();
+ public Optional<int> publishMediaPlayerId = new Optional<int>();
+ public Optional<CLIENT_ROLE_TYPE> clientRoleType = new Optional<CLIENT_ROLE_TYPE>();
+ public Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel = new Optional<AUDIENCE_LATENCY_LEVEL_TYPE>();
+ public Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType = new Optional<VIDEO_STREAM_TYPE>();
+ public Optional<CHANNEL_PROFILE_TYPE> channelProfile = new Optional<CHANNEL_PROFILE_TYPE>();
+ public Optional<string> token = new Optional<string>();
+ public Optional<bool> publishRhythmPlayerTrack = new Optional<bool>();
+ public Optional<bool> isInteractiveAudience = new Optional<bool>();
+ public Optional<video_track_id_t> customVideoTrackId = new Optional<video_track_id_t>();
+ public Optional<bool> isAudioFilterable = new Optional<bool>();
}export class ChannelMediaOptions {
@@ -462,68 +462,68 @@ class ChannelMediaOptions {
@JsonKey(name: 'isAudioFilterable')
final bool? isAudioFilterable;
- factory ChannelMediaOptions.fromJson(Map<String, dynamic> json) =>
+ factory ChannelMediaOptions.fromJson(Map<String, dynamic> json) =>
_$ChannelMediaOptionsFromJson(json);
- Map<String, dynamic> toJson() => _$ChannelMediaOptionsToJson(this);
+ Map<String, dynamic> toJson() => _$ChannelMediaOptionsToJson(this);
}
-
+
- Agora supports publishing multiple audio streams and one video stream at the same time and in the same . For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as at the same time, but only one of publishCameraTrack, publishScreenCaptureVideopublishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as .Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
+ Agora supports publishing multiple audio streams and one video stream at the same time and in the same . For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as at the same time, but only one of publishCameraTrack, publishScreenCaptureVideopublishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as .Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />publishCameraTrackWhether to publish the video captured by the camera:
-
: Publish the video captured by the camera.
-
: Do not publish the video captured by the camera.
+
: Publish the video captured by the camera.
+
: Do not publish the video captured by the camera.
publishSecondaryCameraTrackWhether to publish the video captured by the second camera:
-
: Publish the video captured by the second camera.
-
: Do not publish the video captured by the second camera.
+
: Publish the video captured by the second camera.
+
: Do not publish the video captured by the second camera.
publishMicrophoneTrackWhether to publish the audio captured by the microphone:
-
: Publish the audio captured by the microphone.
-
: Do not publish the audio captured by the microphone.
+
: Publish the audio captured by the microphone.
+
: Do not publish the audio captured by the microphone.
As of v4.0.0, the parameter name is changed from publishAudioTrack to publishMicrophoneTrack.
As of v6.0.0, the parameter name is changed from publishAudioTrack to publishMicrophoneTrack.
-
If you set this parameter as , SDK turns off microphone capturing.
-
If you want to publish the audio streams captured by your microphone, ensure enableAudioRecordingOrPlayout is set as .
+
If you set this parameter as , SDK turns off microphone capturing.
+
If you want to publish the audio streams captured by your microphone, ensure enableAudioRecordingOrPlayout is set as .
publishThirdCameraTrackWhether to publish the video captured by the third camera:
-
: Publish the video captured by the third camera.
-
: Do not publish the video captured by the third camera.
+
: Publish the video captured by the third camera.
+
: Do not publish the video captured by the third camera.
This method is for Windows and macOS only.
publishFourthCameraTrackWhether to publish the video captured by the fourth camera:
-
: Publish the video captured by the fourth camera.
-
: Do not publish the video captured by the fourth camera.
+
: Publish the video captured by the fourth camera.
+
: Do not publish the video captured by the fourth camera.
This method is for Windows and macOS only.
publishScreenTrack
Whether to publish the video captured from the screen:
-
: Publish the video captured from the screen.
-
: Do not publish the video captured from the screen.
+
: Publish the video captured from the screen.
+
: Do not publish the video captured from the screen.
This method is for Windows and macOS only.
@@ -532,8 +532,8 @@ class ChannelMediaOptions {
publishScreenCaptureVideo
Whether to publish the video captured from the screen:
-
: Publish the video captured from the screen.
-
: Do not publish the video captured from the screen.
+
: Publish the video captured from the screen.
+
: Do not publish the video captured from the screen.
This parameter applies to Android and iOS only.As of v4.0.0, the parameter name is changed from publishScreenTrack to publishScreenCaptureVideo.
@@ -542,8 +542,8 @@ class ChannelMediaOptions {
publishScreenCaptureAudio
Whether to publish the audio captured from the screen:
-
: Publish the audio captured from the screen.
-
: Publish the audio captured from the screen.
+
: Publish the audio captured from the screen.
+
: Publish the audio captured from the screen.
This parameter applies to Android and iOS only.
@@ -551,16 +551,16 @@ class ChannelMediaOptions {
publishSecondaryScreenTrackWhether to publish the video captured from the second screen:
-
: Publish the video captured from the second screen.
-
: Do not publish the video captured from the second screen.
+
: Publish the video captured from the second screen.
+
: Do not publish the video captured from the second screen.
publishThirdScreenTrackWhether to publish the video captured from the third screen:
-
: Publish the captured video from the third screen.
-
: Do not publish the video captured from the third screen.
+
: Publish the captured video from the third screen.
+
: Do not publish the video captured from the third screen.
This method is for Windows and macOS only.
@@ -569,8 +569,8 @@ class ChannelMediaOptions {
publishFourthScreenTrackWhether to publish the video captured from the fourth screen:
-
: Publish the captured video from the fourth screen.
-
: Do not publish the video captured from the fourth screen.
+
: Publish the captured video from the fourth screen.
+
: Do not publish the video captured from the fourth screen.
This method is for Windows and macOS only.
@@ -579,8 +579,8 @@ class ChannelMediaOptions {
publishTranscodedVideoTrackWhether to publish the local transcoded video:
-
: Publish the local transcoded video.
-
: Do not publish the local transcoded video.
+
: Publish the local transcoded video.
+
: Do not publish the local transcoded video.
As of v4.2.0, the parameter name is corrected from publishTrancodedVideoTrack to publishTranscodedVideoTrack.
@@ -588,64 +588,64 @@ class ChannelMediaOptions {
publishCustomAudioTrackWhether to publish the audio captured from a custom source:
-
: Publish the audio captured from the custom source.
-
: Do not publish the captured audio from a custom source.
+
: Publish the audio captured from the custom source.
+
: Do not publish the captured audio from a custom source.
publishCustomAudioTrackId
- The ID of the custom audio source to publish. The default value is 0.
If you have set sourceNumber in to a value greater than 1, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track, starting from 0.
+ The ID of the custom audio source to publish. The default value is 0.
If you have set sourceNumber in to a value greater than 1, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track, starting from 0.
publishCustomVideoTrackWhether to publish the video captured from a custom source:
-
: Publish the video captured from the custom source.
-
: Do not publish the captured video from a custom source.
+
: Publish the video captured from the custom source.
+
: Do not publish the captured video from a custom source.
publishEncodedVideoTrackWhether to publish the encoded video:
-
: Publish the encoded video.
-
: Do not publish the encoded video.
+
: Publish the encoded video.
+
: Do not publish the encoded video.
publishMediaPlayerAudioTrackWhether to publish the audio from the media player:
-
: Publish the audio from the media player.
-
: Do not publish the audio from the media player.
+
: Publish the audio from the media player.
+
: Do not publish the audio from the media player.
publishMediaPlayerVideoTrackWhether to publish the video from the media player:
-
: Publish the video from the media player.
-
: Do not publish the video from the media player.
+
: Publish the video from the media player.
+
: Do not publish the video from the media player.
autoSubscribeAudioWhether to automatically subscribe to all remote audio streams when the user joins a channel:
-
: Subscribe to all remote audio streams.
-
: Do not automatically subscribe to any remote audio streams.
+
: Subscribe to all remote audio streams.
+
: Do not automatically subscribe to any remote audio streams.
autoSubscribeVideoWhether to automatically subscribe to all remote video streams when the user joins the channel:
-
: Subscribe to all remote video streams.
-
: Do not automatically subscribe to any remote video streams.
+
: Subscribe to all remote video streams.
+
: Do not automatically subscribe to any remote video streams.
enableAudioRecordingOrPlayoutWhether to enable audio capturing or playback:
-
: Enable audio capturing or playback.
-
: Do not enable audio capturing or playback.
+
: Enable audio capturing or playback.
+
: Do not enable audio capturing or playback.
- If you need to publish the audio streams captured by your microphone, ensure this parameter is set as .
+ If you need to publish the audio streams captured by your microphone, ensure this parameter is set as .publishMediaPlayerId
@@ -653,23 +653,23 @@ class ChannelMediaOptions {
clientRoleType
-
+ clientRoleType
- The user role. See .
+ The user role. See .
-
-
+
+ defaultVideoStreamType
-
+ channelProfile
-
+ audioDelayMs
@@ -681,58 +681,58 @@ class ChannelMediaOptions {
publishCustomAudioTrackAecWhether to publish audio frames processed by an external echo cancellation module.
-
: Publish audio frames processed by the external echo cancellation module.
-
: Do not publish to publish audio frames processed by the external echo cancellation module.
+
: Publish audio frames processed by the external echo cancellation module.
+
: Do not publish to publish audio frames processed by the external echo cancellation module.
token
-
(Optional) The token generated on your server for authentication. See .
+
(Optional) The token generated on your server for authentication. See .
-
This parameter takes effect only when calling or .
-
Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the method for initializing the RTC engine, and those used by the and methods for joining the channel.
+
This parameter takes effect only when calling or .
+
Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the method for initializing the RTC engine, and those used by the and methods for joining the channel.
startPreviewWhether to automatically start the preview when joining a channel:
-
: Do not automatically start the preview. Ensure that you have called the method to set the local video property; otherwise, the preview is not enabled.
-
: Do not automatically start the preview.
+
: Do not automatically start the preview. Ensure that you have called the method to set the local video property; otherwise, the preview is not enabled.
+
: Do not automatically start the preview.
publishRhythmPlayerTrackWhether to publish the sound of a metronome to remote users:
-
: Publish processed audio frames. Both the local user and remote users can hear the metronome.
-
: Do not publish the sound of the metronome. Only the local user can hear the metronome.
+
: Publish processed audio frames. Both the local user and remote users can hear the metronome.
+
: Do not publish the sound of the metronome. Only the local user can hear the metronome.
isInteractiveAudienceWhether to enable interactive mode:
-
: Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency.
-
:Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.
+
: Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency.
+
:Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.
-
This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the method to join the other host's channel as an audience member, and set isInteractiveAudience to .
-
This parameter takes effect only when the user role is .
+
This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the method to join the other host's channel as an audience member, and set isInteractiveAudience to .
+
This parameter takes effect only when the user role is .
customVideoTrackId
- The video track ID returned by calling the method. The default value is 0.
+ The video track ID returned by calling the method. The default value is 0.isAudioFilterableWhether the audio stream being published is filtered according to the volume algorithm:
-
: The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect.
-
: The audio stream is not filtered.
+
: The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect.
+
: The audio stream is not filtered.
- If you need to enable this function, contact .
+ If you need to enable this function, contact .
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita
index 32d206bfbf4..0cec8673f65 100644
--- a/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita
+++ b/en-US/dita/RTC-NG/API/class_channelmediarelayconfiguration.dita
@@ -1,17 +1,17 @@
- <ph keyref="ChannelMediaRelayConfiguration"/>
+ <ph keyref="ChannelMediaRelayConfiguration" /> Configuration of cross channel media relay.
public class ChannelMediaRelayConfiguration {
private ChannelMediaInfo srcInfo = null;
- private Map<String, ChannelMediaInfo> destInfos = null;
+ private Map<String, ChannelMediaInfo> destInfos = null;
public ChannelMediaRelayConfiguration() {
- destInfos = new HashMap<String, ChannelMediaInfo>();
+ destInfos = new HashMap<String, ChannelMediaInfo>();
srcInfo = new ChannelMediaInfo(null, null, 0);
}
@@ -31,7 +31,7 @@
return srcInfo;
}
- public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() {
+ public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() {
return destInfos;
}
}
@@ -104,44 +104,44 @@
_$ChannelMediaRelayConfigurationFromJson(json);
Map<String, dynamic> toJson() => _$ChannelMediaRelayConfigurationToJson(this);
}
-
+ MethodsetSrcChannelInfo
- Sets the information of the source channel. See .
+ Sets the information of the source channel. See .setDestChannelInfo
- Sets the information of the target channel. See .
+ Sets the information of the target channel. See .removeDestChannelInfo
- Deletes the information of target channel. See .
+ Deletes the information of target channel. See .getSrcChannelMediaInfo
- Gets the information of the source channel. See .
+ Gets the information of the source channel. See .getDestChannelMediaInfos
- Gets the information of the target channel. See .
+ Gets the information of the target channel. See .
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> srcInfosourceInfo
-
The information of the source channel. See . It contains the following members:
-
channelName: The name of the source channel. The default value is , which means the SDK applies the name of the current channel.
+
The information of the source channel. See . It contains the following members:
+
channelName: The name of the source channel. The default value is , which means the SDK applies the name of the current channel.
token: The token for joining the source channel. This token is generated with the channelName and uid you set in srcInfo.
-
If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
+
If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
If you have enabled the App Certificate, you must use the token generated with the channelName and uid, and the uid must be set as 0.
uid: The unique user ID to identify the relay stream in the source channel. Agora recommends leaving the default value of 0 unchanged.
@@ -152,10 +152,10 @@
destInfosdestinationInfos
-
The information of the target channel . It contains the following members:
+
The information of the target channel . It contains the following members:
channelName: The name of the target channel.
token: The token for joining the target channel. It is generated with the channelName and uid you set in destInfos.
-
If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
+
If you have not enabled the App Certificate, set this parameter as the default value , which means the SDK applies the App ID.
If you have enabled the App Certificate, you must use the token generated with the channelName and uid.
If the token of any target channel expires, the whole media relay stops; hence Agora recommends that you specify the same expiration time for the tokens of all the target channels.
uid: The unique user ID to identify the relay stream in the target channel. The value ranges from 0 to (2 32-1). To avoid user ID conflicts, this user ID must be different from any other user ID in the target channel. The default value is 0, which means the SDK generates a random user ID.
@@ -164,16 +164,16 @@
destCount
- The number of target channels. The default value is 0, and the value range is from 0 to 6. Ensure that the value of this parameter corresponds to the number of structs you define in destInfo.
+ The number of target channels. The default value is 0, and the value range is from 0 to 6. Ensure that the value of this parameter corresponds to the number of structs you define in destInfo.setDestinationInfo
- Sets the information of the target channel. See .
+ Sets the information of the target channel. See .removeDestinationInfoForChannelName
- Deletes the information of target channel. See .
+ Deletes the information of target channel. See .
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_cloudspatialaudioconfig.dita b/en-US/dita/RTC-NG/API/class_cloudspatialaudioconfig.dita
index 67f4c7c5698..597d5fb3138 100644
--- a/en-US/dita/RTC-NG/API/class_cloudspatialaudioconfig.dita
+++ b/en-US/dita/RTC-NG/API/class_cloudspatialaudioconfig.dita
@@ -68,7 +68,7 @@
deployRegion?: number;
}
There are no corresponding names available
-
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />
diff --git a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita
index 0db7da8ee6a..e23d6c97366 100644
--- a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita
+++ b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita
@@ -1,7 +1,7 @@
- <ph keyref="CodecCapInfo"/>
+ <ph keyref="CodecCapInfo" />The codec capability of the device.
@@ -70,10 +70,10 @@ class CodecCapInfo {
@JsonKey(name: 'codecLevels')
final CodecCapLevels? codecLevels;
- factory CodecCapInfo.fromJson(Map<String, dynamic> json) =>
+ factory CodecCapInfo.fromJson(Map<String, dynamic> json) =>
_$CodecCapInfoFromJson(json);
- Map<String, dynamic> toJson() => _$CodecCapInfoToJson(this);
+ Map<String, dynamic> toJson() => _$CodecCapInfoToJson(this);
}
@@ -83,14 +83,14 @@ class CodecCapInfo {
v4.2.0
-
+
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />codecType
- The video codec types. See .
+ The video codec types. See .
The video codec types:
1: VP8.
@@ -100,7 +100,7 @@ class CodecCapInfo {
codecCapMask
- The bit mask of the codec type. See .
+ The bit mask of the codec type. See .
The bit mask of the codec type:
(0): The device does not support encoding or decoding.
@@ -113,8 +113,8 @@ class CodecCapInfo {
codecLevels
- The level of the codec capability. See .
+ The level of the codec capability. See .
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_codeccaplevels.dita b/en-US/dita/RTC-NG/API/class_codeccaplevels.dita
index 02291a389e8..b120ee0a9bf 100644
--- a/en-US/dita/RTC-NG/API/class_codeccaplevels.dita
+++ b/en-US/dita/RTC-NG/API/class_codeccaplevels.dita
@@ -1,7 +1,7 @@
- <ph keyref="CodecCapLevels"/>
+ <ph keyref="CodecCapLevels" />The level of the codec capability.
@@ -60,10 +60,10 @@ class CodecCapLevels {
@JsonKey(name: 'swDecodingLevel')
final VideoCodecCapabilityLevel? swDecodingLevel;
- factory CodecCapLevels.fromJson(Map<String, dynamic> json) =>
+ factory CodecCapLevels.fromJson(Map<String, dynamic> json) =>
_$CodecCapLevelsFromJson(json);
- Map<String, dynamic> toJson() => _$CodecCapLevelsToJson(this);
+ Map<String, dynamic> toJson() => _$CodecCapLevelsToJson(this);
}
@@ -73,19 +73,19 @@ class CodecCapLevels {
v4.2.2
-
+
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />hwDecodingLevel
- Hardware decoding capability level, which represents the device's ability to perform hardware decoding on videos of different quality. See .
+ Hardware decoding capability level, which represents the device's ability to perform hardware decoding on videos of different quality. See .swDecodingLevel
- Software decoding capability level, which represents the device's ability to perform software decoding on videos of different quality. See .
+ Software decoding capability level, which represents the device's ability to perform software decoding on videos of different quality. See .
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita
index a5b8be949a4..970de4ab592 100644
--- a/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita
+++ b/en-US/dita/RTC-NG/API/class_contentinspectconfig.dita
@@ -1,7 +1,7 @@
- <ph keyref="ContentInspectConfig"/>
+ <ph keyref="ContentInspectConfig" />Configuration of video screenshot and upload.
@@ -95,16 +95,16 @@ class ContentInspectConfig {
const ContentInspectConfig(
{this.extraInfo, this.serverConfig, this.modules, this.moduleCount});
- @JsonKey(name: 'extraInfo')
+ @JsonKey(name: 'extraInfo')
final String? extraInfo;
- @JsonKey(name: 'serverConfig')
+ @JsonKey(name: 'serverConfig')
final String? serverConfig;
- @JsonKey(name: 'modules')
+ @JsonKey(name: 'modules')
final List<ContentInspectModule>? modules;
- @JsonKey(name: 'moduleCount')
+ @JsonKey(name: 'moduleCount')
final int? moduleCount;
factory ContentInspectConfig.fromJson(Map<String, dynamic> json) =>
@@ -112,7 +112,7 @@ class ContentInspectConfig {
Map<String, dynamic> toJson() => _$ContentInspectConfigToJson(this);
}
-
+ Parameters
@@ -143,20 +143,20 @@ class ContentInspectConfig {
serverConfig
- (Optional) Server configuration related to uploading video screenshots via extensions from Agora Extensions Marketplace. This parameter only takes effect when type in is set to . If you want to use it, contact .
+ (Optional) Server configuration related to uploading video screenshots via extensions from Agora Extensions Marketplace. This parameter only takes effect when type in is set to . If you want to use it, contact .modules
-
Functional module. See .
-
A maximum of 32 instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].
+
Functional module. See .
+
A maximum of 32 instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].
A function module can only be configured with one instance at most. Currently only the video screenshot and upload function is supported.moduleCount
- The number of functional modules, that is,the number of configured instances, must be the same as the number of instances configured in modules. The maximum number is 32.
+ The number of functional modules, that is,the number of configured instances, must be the same as the number of instances configured in modules. The maximum number is 32.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita
index da868a40228..35ceab71c3d 100644
--- a/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita
+++ b/en-US/dita/RTC-NG/API/class_contentinspectmodule.dita
@@ -1,8 +1,8 @@
- <ph keyref="ContentInspectModule"/>
- A structure used to configure the frequency of video screenshot and upload.
+ <ph keyref="ContentInspectModule" />
+ A structure used to configure the frequency of video screenshot and upload.
+
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />type
- Types of functional module. See .
+ Types of functional module. See .
Types of functional modules:
(0): (Default) This module has no actual function. Do not set to this value.
@@ -84,4 +84,4 @@
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_directcdnstreamingmediaoptions.dita b/en-US/dita/RTC-NG/API/class_directcdnstreamingmediaoptions.dita
index a80171c9179..fbc5da17bd7 100644
--- a/en-US/dita/RTC-NG/API/class_directcdnstreamingmediaoptions.dita
+++ b/en-US/dita/RTC-NG/API/class_directcdnstreamingmediaoptions.dita
@@ -1,7 +1,7 @@
- <ph keyref="DirectCdnStreamingMediaOptions"/>
+ <ph keyref="DirectCdnStreamingMediaOptions" />The media setting options for the host.
@@ -101,49 +101,49 @@
@JsonKey(name: 'customVideoTrackId')
final int? customVideoTrackId;
- factory DirectCdnStreamingMediaOptions.fromJson(Map<String, dynamic> json) =>
+ factory DirectCdnStreamingMediaOptions.fromJson(Map<String, dynamic> json) =>
_$DirectCdnStreamingMediaOptionsFromJson(json);
- Map<String, dynamic> toJson() => _$DirectCdnStreamingMediaOptionsToJson(this);
+ Map<String, dynamic> toJson() => _$DirectCdnStreamingMediaOptionsToJson(this);
}
-
+
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />publishCameraTrackSets whether to publish the video captured by the camera:
-
: Publish the video captured by the camera.
-
: (Default) Do not publish the video captured by the camera.
+
: Publish the video captured by the camera.
+
: (Default) Do not publish the video captured by the camera.
publishMicrophoneTrackSets whether to publish the audio captured by the microphone:
-
: Publish the audio captured by the microphone.
-
: (Default) Do not publish the audio captured by the microphone.
+
: Publish the audio captured by the microphone.
+
: (Default) Do not publish the audio captured by the microphone.
publishCustomAudioTrackSets whether to publish the captured audio from a custom source:
-
: Publish the captured audio from a custom source.
-
: (Default) Do not publish the captured audio from the custom source.
+
: Publish the captured audio from a custom source.
+
: (Default) Do not publish the captured audio from the custom source.
publishMediaPlayerAudioTrackSets whether to publish the audio from the media player:
-
: Publish the audio from the media player.
-
: (Default) Do not publish the audio from the media player.
+
: Publish the audio from the media player.
+
: (Default) Do not publish the audio from the media player.
publishCustomVideoTrackSets whether to publish the captured video from a custom source:
-
: Publish the captured video from a custom source.
-
: (Default) Do not publish the captured video from the custom source.
+
: Publish the captured video from a custom source.
+
: (Default) Do not publish the captured video from the custom source.
@@ -152,8 +152,8 @@
customVideoTrackId
- The video track ID returned by calling the method. The default value is 0.
+ The video track ID returned by calling the method. The default value is 0.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_directcdnstreamingstats.dita b/en-US/dita/RTC-NG/API/class_directcdnstreamingstats.dita
index 2a41579dba4..92398399c9f 100644
--- a/en-US/dita/RTC-NG/API/class_directcdnstreamingstats.dita
+++ b/en-US/dita/RTC-NG/API/class_directcdnstreamingstats.dita
@@ -80,12 +80,12 @@
@JsonKey(name: 'audioBitrate')
final int? audioBitrate;
- factory DirectCdnStreamingStats.fromJson(Map<String, dynamic> json) =>
+ factory DirectCdnStreamingStats.fromJson(Map<String, dynamic> json) =>
_$DirectCdnStreamingStatsFromJson(json);
- Map<String, dynamic> toJson() => _$DirectCdnStreamingStatsToJson(this);
+ Map<String, dynamic> toJson() => _$DirectCdnStreamingStatsToJson(this);
}
-
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />
diff --git a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita
index 78da718d6ad..d453f97a3b4 100644
--- a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita
+++ b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita
@@ -299,12 +299,12 @@
@JsonKey(name: 'streamType')
final VideoStreamType? streamType;
- factory EncodedVideoFrameInfo.fromJson(Map<String, dynamic> json) =>
+ factory EncodedVideoFrameInfo.fromJson(Map<String, dynamic> json) =>
_$EncodedVideoFrameInfoFromJson(json);
- Map<String, dynamic> toJson() => _$EncodedVideoFrameInfoToJson(this);
+ Map<String, dynamic> toJson() => _$EncodedVideoFrameInfoToJson(this);
}
-
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />
@@ -313,9 +313,9 @@
codecTypeThe codec type of the local video stream. See . The default value is (2).
The codec type of the video:
-
(1): VP8.
-
(2): (Default) H.264.
-
(3): H.265.
+
(1): VP8.
+
(2): (Default) H.264.
+
(3): H.265.
@@ -382,4 +382,4 @@
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita
index 0a05a41985f..811b3e69def 100644
--- a/en-US/dita/RTC-NG/API/class_externalvideoframe.dita
+++ b/en-US/dita/RTC-NG/API/class_externalvideoframe.dita
@@ -177,58 +177,58 @@ class ExternalVideoFrame {
this.alphaBuffer,
this.textureSliceIndex});
- @JsonKey(name: 'type')
+ @JsonKey(name: 'type')
final VideoBufferType? type;
- @JsonKey(name: 'format')
+ @JsonKey(name: 'format')
final VideoPixelFormat? format;
- @JsonKey(name: 'buffer', ignore: true)
+ @JsonKey(name: 'buffer', ignore: true)
final Uint8List? buffer;
- @JsonKey(name: 'stride')
+ @JsonKey(name: 'stride')
final int? stride;
- @JsonKey(name: 'height')
+ @JsonKey(name: 'height')
final int? height;
- @JsonKey(name: 'cropLeft')
+ @JsonKey(name: 'cropLeft')
final int? cropLeft;
- @JsonKey(name: 'cropTop')
+ @JsonKey(name: 'cropTop')
final int? cropTop;
- @JsonKey(name: 'cropRight')
+ @JsonKey(name: 'cropRight')
final int? cropRight;
- @JsonKey(name: 'cropBottom')
+ @JsonKey(name: 'cropBottom')
final int? cropBottom;
- @JsonKey(name: 'rotation')
+ @JsonKey(name: 'rotation')
final int? rotation;
- @JsonKey(name: 'timestamp')
+ @JsonKey(name: 'timestamp')
final int? timestamp;
- @JsonKey(name: 'eglType')
+ @JsonKey(name: 'eglType')
final EglContextType? eglType;
- @JsonKey(name: 'textureId')
+ @JsonKey(name: 'textureId')
final int? textureId;
- @JsonKey(name: 'matrix')
+ @JsonKey(name: 'matrix')
final List<double>? matrix;
- @JsonKey(name: 'metadata_buffer', ignore: true)
+ @JsonKey(name: 'metadata_buffer', ignore: true)
final Uint8List? metadataBuffer;
- @JsonKey(name: 'metadata_size')
+ @JsonKey(name: 'metadata_size')
final int? metadataSize;
- @JsonKey(name: 'alphaBuffer', ignore: true)
+ @JsonKey(name: 'alphaBuffer', ignore: true)
final Uint8List? alphaBuffer;
- @JsonKey(name: 'texture_slice_index')
+ @JsonKey(name: 'texture_slice_index')
final int? textureSliceIndex;
factory ExternalVideoFrame.fromJson(Map<String, dynamic> json) =>
@@ -236,7 +236,7 @@ class ExternalVideoFrame {
Map<String, dynamic> toJson() => _$ExternalVideoFrameToJson(this);
}
-
+
@@ -414,4 +414,4 @@ class ExternalVideoFrame {
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita b/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita
index 31ad3643074..452d88bb0fc 100644
--- a/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita
+++ b/en-US/dita/RTC-NG/API/class_injectstreamconfig.dita
@@ -143,7 +143,7 @@
_$InjectStreamConfigFromJson(json);
Map<String, dynamic> toJson() => _$InjectStreamConfigToJson(this);
}
-
+
diff --git a/en-US/dita/RTC-NG/API/class_livetranscoding.dita b/en-US/dita/RTC-NG/API/class_livetranscoding.dita
index ef85237744a..55d9152e9b5 100644
--- a/en-US/dita/RTC-NG/API/class_livetranscoding.dita
+++ b/en-US/dita/RTC-NG/API/class_livetranscoding.dita
@@ -1,7 +1,7 @@
- <ph keyref="LiveTranscoding"/>
+ <ph keyref="LiveTranscoding" /> Transcoding configurations for Media Push.
@@ -513,7 +513,7 @@
final int? userCount;
@JsonKey(name: 'transcodingUsers')
- final List<TranscodingUser>? transcodingUsers;
+ final List<TranscodingUser>? transcodingUsers;
@JsonKey(name: 'transcodingExtraInfo')
final String? transcodingExtraInfo;
@@ -522,13 +522,13 @@
final String? metadata;
@JsonKey(name: 'watermark')
- final List<RtcImage>? watermark;
+ final List<RtcImage>? watermark;
@JsonKey(name: 'watermarkCount')
final int? watermarkCount;
@JsonKey(name: 'backgroundImage')
- final List<RtcImage>? backgroundImage;
+ final List<RtcImage>? backgroundImage;
@JsonKey(name: 'backgroundImageCount')
final int? backgroundImageCount;
@@ -546,20 +546,20 @@
final AudioCodecProfileType? audioCodecProfile;
@JsonKey(name: 'advancedFeatures')
- final List<LiveStreamAdvancedFeature>? advancedFeatures;
+ final List<LiveStreamAdvancedFeature>? advancedFeatures;
@JsonKey(name: 'advancedFeatureCount')
final int? advancedFeatureCount;
- factory LiveTranscoding.fromJson(Map<String, dynamic> json) =>
+ factory LiveTranscoding.fromJson(Map<String, dynamic> json) =>
_$LiveTranscodingFromJson(json);
- Map<String, dynamic> toJson() => _$LiveTranscodingToJson(this);
+ Map<String, dynamic> toJson() => _$LiveTranscodingToJson(this);
}
-
+
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />width
@@ -595,7 +595,7 @@
videoBitrate
Bitrate of the output video stream for Media Push in Kbps. The default value is 400 Kbps.
-
Set this member according to the table. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range.
+
Set this member according to the table. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range.
@@ -615,8 +615,8 @@
Latency mode:
-
: Low latency with unassured quality.
-
: (Default) High latency with assured quality.
+
: Low latency with unassured quality.
+
: (Default) High latency with assured quality.
@@ -626,17 +626,17 @@
videoCodecProfile
-
Video codec profile type for Media Push. Set it as 66, 77, or 100 (default). See for details.
+
Video codec profile type for Media Push. Set it as 66, 77, or 100 (default). See for details.
If you set this parameter to any other value, Agora adjusts it to the default value.videoCodecType
- Video codec profile types for Media Push. See .
+ Video codec profile types for Media Push. See .transcodingUsers
-
Manages the user layout configuration in the Media Push. Agora supports a maximum of 17 transcoding users in a Media Push channel. See .
+
Manages the user layout configuration in the Media Push. Agora supports a maximum of 17 transcoding users in a Media Push channel. See .
@@ -663,7 +663,7 @@
Deprecated
-
Obsolete and not recommended for use. Use instead.
+
Obsolete and not recommended for use. Use instead.
@@ -677,7 +677,7 @@
Deprecated
-
Obsolete and not recommended for use. Use instead.
+
Obsolete and not recommended for use. Use instead.
The number of users in the Media Push. The value range is [0,17].
@@ -698,25 +698,25 @@
watermark
-
The watermark on the live video. The image format needs to be PNG. See .
+
The watermark on the live video. The image format needs to be PNG. See .
You can add one watermark, or add multiple watermarks using an array. This parameter is used with watermarkCount.
backgroundImage
-
The number of background images on the live video. The image format needs to be PNG. See .
+
The number of background images on the live video. The image format needs to be PNG. See .
You can add a background image or use an array to add multiple background images. This parameter is used with backgroundImageCount.
backgroundImageArray
- An array of background images on the live video. See . You can use backgroundImageArray to add one or more background images. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10.
+ An array of background images on the live video. See . You can use backgroundImageArray to add one or more background images. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10.audioSampleRate
-
The audio sampling rate (Hz) of the output media stream. See .
+
The audio sampling rate (Hz) of the output media stream. See .
@@ -739,11 +739,11 @@
audioCodecProfile
- Audio codec profile type for Media Push. See .
+ Audio codec profile type for Media Push. See .watermarkArray
- The array of watermarks on the live video. See . You can add one or more watermarks using watermarkArray. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10.
+ The array of watermarks on the live video. See . You can add one or more watermarks using watermarkArray. The image format needs to be PNG. The total number of watermarks and background images on a live video must be greater than or equal to 0 and less than or equal to 10.watermarkCount
@@ -755,7 +755,7 @@
advancedFeatures
- Advanced features of the Media Push with transcoding. See .
+ Advanced features of the Media Push with transcoding. See .advancedFeatureCount
@@ -767,27 +767,27 @@
addBackgroundImage
- Adds a background image. See .
+ Adds a background image. See .addUser
- Adds a user for video mixing during the CDN live streaming. See .
+ Adds a user for video mixing during the CDN live streaming. See .addWatermark
- Adds a watermark. See .
+ Adds a watermark. See .getAdvancedFeatures
- Gets the status of the advanced features of streaming with transcoding. See .
+ Gets the status of the advanced features of streaming with transcoding. See .getBackgroundColor
- Gets the background color in hex. See .
+ Gets the background color in hex. See .getBackgroundImageList
- Gets the list of background images. See .
+ Gets the list of background images. See .getBlue
@@ -798,7 +798,7 @@
Obsolete and not recommended for use.
-
Gets the background color's blue component. See .
+
Gets the background color's blue component. See .
@@ -810,7 +810,7 @@
Obsolete and not recommended for use.
-
Gets the background color's green component. See .
+
Gets the background color's green component. See .
@@ -822,44 +822,44 @@
Obsolete and not recommended for use.
-
Gets the background color's red component. See .
+
Gets the background color's red component. See .
getUserCount
- Gets the number of users transcoded in the CDN live streaming. See .
+ Gets the number of users transcoded in the CDN live streaming. See .getUsers
- Gets the user list in the CDN live streaming. See .
+ Gets the user list in the CDN live streaming. See .getWatermarkList
- Gets the watermark list. See .
+ Gets the watermark list. See .removeBackgroundImage
- Removes a background image from the background image list. See .
+ Removes a background image from the background image list. See .removeUser
- Removes a user from video mixing during the CDN live streaming. See .
+ Removes a user from video mixing during the CDN live streaming. See .removeWatermark
- Removes a watermark from the watermark list. See .
+ Removes a watermark from the watermark list. See .setAdvancedFeatures
- Sets whether to enable the advanced features of streaming with transcoding. See .
+ Sets whether to enable the advanced features of streaming with transcoding. See .setBackgroundColor [1/2]
- Sets the background color of the CDN live stream in the format of RGB hex. See .
+ Sets the background color of the CDN live stream in the format of RGB hex. See .setBackgroundColor [2/2]
- Sets the background color in RGB format. See .
+ Sets the background color in RGB format. See .setBlue
@@ -870,7 +870,7 @@
Obsolete and not recommended for use.
-
Sets the background color's blue component. See .
+
Sets the background color's blue component. See .
@@ -882,7 +882,7 @@
Obsolete and not recommended for use.
-
Sets the background color's green component. See .
+
Sets the background color's green component. See .
@@ -894,22 +894,22 @@
Obsolete and not recommended for use.
-
Sets the background color's red component. See .
+
Sets the background color's red component. See .
setUsers [1/2]
- Sets the users in batches in the CDN live streaming. See .
+ Sets the users in batches in the CDN live streaming. See .setUsers [2/2]
- Sets the users in batches in the CDN live streaming. See .
+ Sets the users in batches in the CDN live streaming. See .defaultTranscoding
- Applies the default transcoding settings, see .
+ Applies the default transcoding settings, see .
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita
index d94f8db1be2..1c28c605b5c 100644
--- a/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita
+++ b/en-US/dita/RTC-NG/API/class_localtranscoderconfiguration.dita
@@ -1,24 +1,24 @@
- <ph keyref="LocalTranscoderConfiguration"/>
+ <ph keyref="LocalTranscoderConfiguration" />The configuration of the video mixing on the local client.
public class LocalTranscoderConfiguration {
- public ArrayList<TranscodingVideoStream> transcodingVideoStreams;
+ public ArrayList<TranscodingVideoStream> transcodingVideoStreams;
public VideoEncoderConfiguration videoOutputConfiguration;
public LocalTranscoderConfiguration() {
- transcodingVideoStreams = new ArrayList<TranscodingVideoStream>();
+ transcodingVideoStreams = new ArrayList<TranscodingVideoStream>();
videoOutputConfiguration = new VideoEncoderConfiguration();
}
}__attribute__((visibility("default"))) @interface AgoraLocalTranscoderConfiguration: NSObject
-@property(copy, nonatomic) NSArray<AgoraTranscodingVideoStream *> *_Nullable videoInputStreams;
+@property(copy, nonatomic) NSArray<AgoraTranscodingVideoStream *> *_Nullable videoInputStreams;
@property (strong, nonatomic) AgoraVideoEncoderConfiguration *_Nonnull videoOutputConfiguration;
@@ -68,19 +68,19 @@ class LocalTranscoderConfiguration {
final int? streamCount;
@JsonKey(name: 'videoInputStreams')
- final List<TranscodingVideoStream>? videoInputStreams;
+ final List<TranscodingVideoStream>? videoInputStreams;
@JsonKey(name: 'videoOutputConfiguration')
final VideoEncoderConfiguration? videoOutputConfiguration;
- factory LocalTranscoderConfiguration.fromJson(Map<String, dynamic> json) =>
+ factory LocalTranscoderConfiguration.fromJson(Map<String, dynamic> json) =>
_$LocalTranscoderConfigurationFromJson(json);
- Map<String, dynamic> toJson() => _$LocalTranscoderConfigurationToJson(this);
+ Map<String, dynamic> toJson() => _$LocalTranscoderConfigurationToJson(this);
}
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />streamCount
@@ -89,12 +89,12 @@ class LocalTranscoderConfiguration {
videoInputStreamstranscodingVideoStreams
- The video streams for local video mixing. See .
+ The video streams for local video mixing. See .videoOutputConfiguration
- The encoding configuration of the mixed video stream after the local video mixing. See .
+ The encoding configuration of the mixed video stream after the local video mixing. See .
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_localvideostats.dita b/en-US/dita/RTC-NG/API/class_localvideostats.dita
index 109b362474a..8aa1b1f5ae7 100644
--- a/en-US/dita/RTC-NG/API/class_localvideostats.dita
+++ b/en-US/dita/RTC-NG/API/class_localvideostats.dita
@@ -1,7 +1,7 @@
- <ph keyref="LocalVideoStats"/>
+ <ph keyref="LocalVideoStats" />The statistics of the local video stream.
@@ -296,15 +296,15 @@
@JsonKey(name: 'hwEncoderAccelerating')
final int? hwEncoderAccelerating;
- factory LocalVideoStats.fromJson(Map<String, dynamic> json) =>
+ factory LocalVideoStats.fromJson(Map<String, dynamic> json) =>
_$LocalVideoStatsFromJson(json);
- Map<String, dynamic> toJson() => _$LocalVideoStatsToJson(this);
+ Map<String, dynamic> toJson() => _$LocalVideoStatsToJson(this);
}
-
+
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />uid
@@ -362,11 +362,11 @@
qualityAdaptIndication
- The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate). See .
+ The quality adaptation of the local video stream in the reported interval (based on the target frame rate and target bitrate). See .
-
(0): The local video quality stays the same.
-
(1): The local video quality improves because the network bandwidth increases.
-
(2): The local video quality deteriorates because the network bandwidth decreases.
+
(0): The local video quality stays the same.
+
(1): The local video quality improves because the network bandwidth increases.
+
(2): The local video quality deteriorates because the network bandwidth decreases.
@@ -390,11 +390,11 @@
codecType
- The codec type of the local video. See .
+ The codec type of the local video. See .
-
(1): VP8.
-
(2): (Default) H.264.
-
(3): H.265.
+
(1): VP8.
+
(2): (Default) H.264.
+
(3): H.265.
@@ -408,24 +408,24 @@
captureBrightnessLevel
- The brightness level of the video image captured by the local camera. See .
+ The brightness level of the video image captured by the local camera. See .captureBrightnessLevelThe brightness level of the video image captured by the local camera.
-
(-1): The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level from captureBrightnessLevel in the next callback.
-
(0): The brightness level of the video image is normal.
-
(1): The brightness level of the video image is too bright.
-
(2): The brightness level of the video image is too dark.
+
(-1): The SDK does not detect the brightness level of the video image. Wait a few seconds to get the brightness level from captureBrightnessLevel in the next callback.
+
(0): The brightness level of the video image is normal.
+
(1): The brightness level of the video image is too bright.
+
(2): The brightness level of the video image is too dark.
hwEncoderAccelerating
- The local video encoding acceleration type. See .
+ The local video encoding acceleration type. See .
0: Software encoding is applied without acceleration.
1: Hardware encoding is applied for acceleration.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita
index e76727e38a1..0fce85b477d 100644
--- a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita
+++ b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita
@@ -93,12 +93,12 @@
@JsonKey(name: 'recorderInfoUpdateInterval')
final int? recorderInfoUpdateInterval;
- factory MediaRecorderConfiguration.fromJson(Map<String, dynamic> json) =>
+ factory MediaRecorderConfiguration.fromJson(Map<String, dynamic> json) =>
_$MediaRecorderConfigurationFromJson(json);
- Map<String, dynamic> toJson() => _$MediaRecorderConfigurationToJson(this);
+ Map<String, dynamic> toJson() => _$MediaRecorderConfigurationToJson(this);
}
-
+
@@ -109,10 +109,10 @@
storagePathThe absolute path (including the filename extensions) of the recording file. For example:
Ensure that the directory for the log files exists and is writable.
@@ -123,7 +123,7 @@
streamType
- The recording content. See .
+ The recording content. See .The recording content:
: Only audio.
: Only video.
@@ -140,4 +140,4 @@
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_mediasource.dita b/en-US/dita/RTC-NG/API/class_mediasource.dita
index 5f87bc7a086..3d76952e6e7 100644
--- a/en-US/dita/RTC-NG/API/class_mediasource.dita
+++ b/en-US/dita/RTC-NG/API/class_mediasource.dita
@@ -1,7 +1,7 @@
- <ph keyref="MediaSource"/>
+ <ph keyref="MediaSource" />Information related to the media file to be played and the playback scenario configurations.
@@ -134,12 +134,12 @@
@JsonKey(name: 'isLiveSource')
final bool? isLiveSource;
- factory MediaSource.fromJson(Map<String, dynamic> json) =>
+ factory MediaSource.fromJson(Map<String, dynamic> json) =>
_$MediaSourceFromJson(json);
- Map<String, dynamic> toJson() => _$MediaSourceToJson(this);
+ Map<String, dynamic> toJson() => _$MediaSourceToJson(this);
}
-
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />
@@ -207,7 +207,7 @@
provider
-
The callback for custom media resource files. See .
+
The callback for custom media resource files. See .
If you open a custom media resource, pass in the value to provider. If you open a common media resource, pass in the value to url. Agora recommends that you do not pass in values to both url and provider in one call; otherwise, this call may fail.
@@ -216,19 +216,19 @@
playerOnReadCallback
-
Occurs when the SDK reads the media resource data. See .
+
Occurs when the SDK reads the media resource data. See .
-
+
playerOnSeekCallback
-
Occurs when the SDK seeks the media resource data. See .
+
Occurs when the SDK seeks the media resource data. See .
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita
index c6dede7d234..d46370f7af9 100644
--- a/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita
+++ b/en-US/dita/RTC-NG/API/class_remoteaudiostats.dita
@@ -260,10 +260,10 @@
@JsonKey(name: 'qualityChangedReason')
final int? qualityChangedReason;
- factory RemoteAudioStats.fromJson(Map<String, dynamic> json) =>
+ factory RemoteAudioStats.fromJson(Map<String, dynamic> json) =>
_$RemoteAudioStatsFromJson(json);
- Map<String, dynamic> toJson() => _$RemoteAudioStatsToJson(this);
+ Map<String, dynamic> toJson() => _$RemoteAudioStatsToJson(this);
}
diff --git a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita
index a7d2f86a57d..d8d2ccef7f4 100644
--- a/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita
+++ b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita
@@ -1,8 +1,8 @@
- <ph keyref="RtcEngineConfig"/>
- Configurations for the instance.
+ <ph keyref="RtcEngineConfig" />
+ Configurations for the instance.
+
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />eventHandlermEventHandler
- The event handler for . See .
+ The event handler for . See .appIdmAppId
- The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one instance. To change your App ID, call to destroy the current instance, and then create a new one.
+ The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one instance. To change your App ID, call to destroy the current instance, and then create a new one.context
@@ -256,33 +256,33 @@ class RtcEngineContext {
This method is applicable when you integrate the SDK manually but not when you integrate the SDK with Maven Central or JitPack.
-
Ensure the specified directory exists; otherwise, the initialization fails.
+
Ensure the specified directory exists; otherwise, the initialization fails.
channelProfilemChannelProfile
-
+ audioScenariomAudioScenario
-
+ areaCodemAreaCode
- The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. For details on supported regions, see . The area codes support bitwise operation.
+ The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. For details on supported regions, see . The area codes support bitwise operation.After specifying the region, the app integrated with the Agora SDK connects to the Agora servers within that region.logConfigmLogConfig
-
Sets the log file size. See .
+
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:
-
+
@@ -292,19 +292,19 @@ class RtcEngineContext {
mExtensionObservereventDelegate
- The instance.
+ The instance.mediaFilterExtensions
- The instance.
+ The instance.mDomainLimitdomainLimit
Whether to enable domain name restriction:
-
: Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator.
-
: (Default) Disables the domain name restriction. This value is suitable for most common scenarios.
+
: Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator.
+
: (Default) Disables the domain name restriction. This value is suitable for most common scenarios.
@@ -312,9 +312,9 @@ class RtcEngineContext {
mAutoRegisterAgoraExtensionsautoRegisterAgoraExtensions
-
Whether to automatically register the Agora extensions when initializing :
-
: (Default) Automatically register the Agora extensions when initializing .
-
: Do not register the Agora extensions when initializing . You need to call to register the Agora extensions.
+
Whether to automatically register the Agora extensions when initializing :
+
: (Default) Automatically register the Agora extensions when initializing .
+
: Do not register the Agora extensions when initializing . You need to call to register the Agora extensions.
@@ -324,9 +324,9 @@ class RtcEngineContext {
addExtension
- Adds the extension. See .
+ Adds the extension. See .
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_rtcstats.dita b/en-US/dita/RTC-NG/API/class_rtcstats.dita
index ea4289a97f5..b0e9063bba1 100644
--- a/en-US/dita/RTC-NG/API/class_rtcstats.dita
+++ b/en-US/dita/RTC-NG/API/class_rtcstats.dita
@@ -520,7 +520,7 @@
This property is disabled on devices running iOS 14 or later, and enabled on devices running versions earlier than iOS 14 by default.
To enable this property on devices running iOS 14 or later, .
- On Android, to get gatewayRtt, ensure that you add the android.permission.ACCESS_WIFI_STATE permission after </application> in the AndroidManifest.xml file in your project.
+ On Android, to get gatewayRtt, ensure that you add the android.permission.ACCESS_WIFI_STATE permission after </application> in the AndroidManifest.xml file in your project.memoryAppUsageRatio
diff --git a/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita b/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita
index 8d5a72b3fa8..0d43f31acc0 100644
--- a/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita
+++ b/en-US/dita/RTC-NG/API/class_screencaptureconfiguration.dita
@@ -101,7 +101,7 @@ __attribute__((visibility("default"))) @interface AgoraScreenCaptureConfiguratio
_$ScreenCaptureConfigurationFromJson(json);
Map<String, dynamic> toJson() => _$ScreenCaptureConfigurationToJson(this);
}
-
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />
diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita
index 8d41f2b02c2..303f196dce1 100644
--- a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita
+++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita
@@ -1,12 +1,12 @@
- <ph keyref="ScreenCaptureParameters"/>
+ <ph keyref="ScreenCaptureParameters" />Screen sharing configurations.
+
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
- The video profiles of the shared screen stream are only set by , independent of .
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />
+ The video profiles of the shared screen stream are only set by , independent of .dimensions
-
The video encoding resolution of the shared screen stream. See . The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.
+
The video encoding resolution of the shared screen stream. See . The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges.
If the screen dimensions are different from the value of this parameter, Agora applies the following strategies for encoding. Suppose dimensions is set to 1920 × 1080:
If the value of the screen dimensions is lower than that of dimensions, for example, 1000 × 1000 pixels, the SDK uses the screen dimensions, that is, 1000 × 1000 pixels, for encoding.
If the value of the screen dimensions is higher than that of dimensions, for example, 2000 × 1500, the SDK uses the maximum value under dimensions with the aspect ratio of the screen dimension (4:3) for encoding, that is, 1440 × 1080.
@@ -253,33 +253,33 @@
captureMouseCursor
Whether to capture the mouse in screen sharing:
-
: (Default) Capture the mouse.
-
: Do not capture the mouse.
+
: (Default) Capture the mouse.
+
: Do not capture the mouse.
- Due to macOS system restrictions, setting this parameter to is ineffective during screen sharing (it has no impact when sharing a window).
+ Due to macOS system restrictions, setting this parameter to is ineffective during screen sharing (it has no impact when sharing a window).
windowFocus
-
Whether to bring the window to the front when calling the method to share it:
-
: Bring the window to the front.
-
: (Default) Do not bring the window to the front.
+
Whether to bring the window to the front when calling the method to share it:
+
: Bring the window to the front.
+
: (Default) Do not bring the window to the front.
excludeWindowList
- The ID list of the windows to be blocked. When calling to start screen sharing, you can use this parameter to block a specified window. When calling to update screen sharing configurations, you can use this parameter to dynamically block a specified window.
+ The ID list of the windows to be blocked. When calling to start screen sharing, you can use this parameter to block a specified window. When calling to update screen sharing configurations, you can use this parameter to dynamically block a specified window.highLightedenableHighLight(For macOS and Windows only) Whether to place a border around the shared window or screen:
-
: Place a border.
-
: (Default) Do not place a border.
+
: Place a border.
+
: (Default) Do not place a border.
- When you share a part of a window or screen, the SDK places a border around the entire window or screen if you set this parameter to .
+ When you share a part of a window or screen, the SDK places a border around the entire window or screen if you set this parameter to .highLightColor
@@ -289,7 +289,7 @@
highLightWidth
- (For macOS and Windows only) The width (px) of the border. The default value is 5, and the value range is (0, 50].This parameter only takes effect when highLighted is set to .
+ (For macOS and Windows only) The width (px) of the border. The default value is 5, and the value range is (0, 50].This parameter only takes effect when highLighted is set to .excludeWindowCount
@@ -298,4 +298,4 @@
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita
index c13c18f9924..0527a680bb0 100644
--- a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita
+++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita
@@ -1,7 +1,7 @@
- <ph keyref="ScreenCaptureParameters2"/>
+ <ph keyref="ScreenCaptureParameters2" />Screen sharing configurations.
@@ -169,58 +169,58 @@
@JsonKey(name: 'videoParams')
final ScreenVideoParameters? videoParams;
- factory ScreenCaptureParameters2.fromJson(Map<String, dynamic> json) =>
+ factory ScreenCaptureParameters2.fromJson(Map<String, dynamic> json) =>
_$ScreenCaptureParameters2FromJson(json);
- Map<String, dynamic> toJson() => _$ScreenCaptureParameters2ToJson(this);
+ Map<String, dynamic> toJson() => _$ScreenCaptureParameters2ToJson(this);
}
-
+
-
+
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />captureAudioDetermines whether to capture system audio during screen sharing:
-
: Capture system audio.
-
: (Default) Do not capture system audio.
+
: Capture system audio.
+
: (Default) Do not capture system audio.
Due to system limitations, capturing system audio is only applicable to Android API level 29 and later (that is, Android 10 and later).
-
To improve the success rate of capturing system audio during screen sharing, ensure that you have called the method and set the audio scenario to .
+
To improve the success rate of capturing system audio during screen sharing, ensure that you have called the method and set the audio scenario to .
audioParams
- The audio configuration for the shared screen stream. See .This parameter only takes effect when captureAudio is .
+ The audio configuration for the shared screen stream. See .This parameter only takes effect when captureAudio is .captureVideoWhether to capture the screen when screen sharing:
-
: (Default) Capture the screen.
-
: Do not capture the screen.
+
: (Default) Capture the screen.
+
: Do not capture the screen.
Due to system limitations, the capture screen is only applicable to Android API level 21 and above, that is, Android 5 and above.videoParams
- The video configuration for the shared screen stream. See .This parameter only takes effect when captureVideo is .
+ The video configuration for the shared screen stream. See .This parameter only takes effect when captureVideo is .Subclass
-
- The video configuration for the shared screen stream. See .
+
+ The video configuration for the shared screen stream. See .
-
- The audio configuration for the shared screen stream. See .
+
+ The audio configuration for the shared screen stream. See .
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita
index 7e34c34419f..11b9db647ba 100644
--- a/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita
+++ b/en-US/dita/RTC-NG/API/class_screencapturesourceinfo.dita
@@ -1,12 +1,12 @@
- <ph keyref="ScreenCaptureSourceInfo"/>
- The information about the specified shareable window or screen. The information is returned in .
+ <ph keyref="ScreenCaptureSourceInfo" />
+ The information about the specified shareable window or screen. The information is returned in .
+
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />type
- The type of the shared target. See .
+ The type of the shared target. See .sourceId
@@ -148,11 +148,11 @@
thumbImage
- The image content of the thumbnail. See .
+ The image content of the thumbnail. See .iconImage
- The image content of the icon. See .
+ The image content of the icon. See .processPath
@@ -165,19 +165,19 @@
primaryMonitorDetermines whether the screen is the primary display:
-
: The screen is the primary display.
-
: The screen is not the primary display.
+
: The screen is the primary display.
+
: The screen is not the primary display.
position
- The position of a window relative to the entire screen space (including all shareable screens). See . See .
+ The position of a window relative to the entire screen space (including all shareable screens). See . See .minimizeWindow(For Windows only) Whether the window is minimized:
-
: The window is minimized.
-
: The window is not minimized.
+
: The window is minimized.
+
: The window is not minimized.
@@ -186,4 +186,4 @@
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita b/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita
index 3d0308e16a3..d6b9c671871 100644
--- a/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita
+++ b/en-US/dita/RTC-NG/API/class_transcodingvideostream.dita
@@ -1,7 +1,7 @@
- <ph keyref="TranscodingVideoStream"/>
+ <ph keyref="TranscodingVideoStream" />The video streams for local video mixing.
@@ -176,18 +176,18 @@ class TranscodingVideoStream {
@JsonKey(name: 'mirror')
final bool? mirror;
- factory TranscodingVideoStream.fromJson(Map<String, dynamic> json) =>
+ factory TranscodingVideoStream.fromJson(Map<String, dynamic> json) =>
_$TranscodingVideoStreamFromJson(json);
- Map<String, dynamic> toJson() => _$TranscodingVideoStreamToJson(this);
+ Map<String, dynamic> toJson() => _$TranscodingVideoStreamToJson(this);
}
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />sourceType
- The video source type for local video mixing. See .
+ The video source type for local video mixing. See .remoteUserUid
@@ -203,7 +203,7 @@ class TranscodingVideoStream {
mediaPlayerId
- (Optional) Media player ID. Use the parameter only when you set sourceType to .
+ (Optional) Media player ID. Use the parameter only when you set sourceType to .x
@@ -246,4 +246,4 @@ class TranscodingVideoStream {
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita
index e596c79a50d..83b1e96284f 100644
--- a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita
+++ b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita
@@ -53,7 +53,7 @@
_$UserAudioSpectrumInfoFromJson(json);
Map<String, dynamic> toJson() => _$UserAudioSpectrumInfoToJson(this);
}
-
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />
diff --git a/en-US/dita/RTC-NG/API/class_videocanvas.dita b/en-US/dita/RTC-NG/API/class_videocanvas.dita
index 802aaae693d..239a10a4f4c 100644
--- a/en-US/dita/RTC-NG/API/class_videocanvas.dita
+++ b/en-US/dita/RTC-NG/API/class_videocanvas.dita
@@ -1,7 +1,7 @@
- <ph keyref="VideoCanvas"/>
+ <ph keyref="VideoCanvas" />Attributes of the video canvas object.
@@ -173,16 +173,16 @@ class VideoCanvas {
@JsonKey(name: 'enableAlphaMask')
final bool? enableAlphaMask;
- factory VideoCanvas.fromJson(Map<String, dynamic> json) =>
+ factory VideoCanvas.fromJson(Map<String, dynamic> json) =>
_$VideoCanvasFromJson(json);
- Map<String, dynamic> toJson() => _$VideoCanvasToJson(this);
+ Map<String, dynamic> toJson() => _$VideoCanvasToJson(this);
}
-
+
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />view
@@ -193,16 +193,16 @@ class VideoCanvas {
renderMode
- The rendering mode of the video. See .
-
+ The rendering mode of the video. See .
+
mirrorMode
-
The mirror mode of the view. See .
+
The mirror mode of the view. See .
-
+
@@ -216,7 +216,7 @@ class VideoCanvas {
sourceType
- The type of the video source. See .
+ The type of the video source. See .sourceId
@@ -224,29 +224,29 @@ class VideoCanvas {
setupMode
- Setting mode of the view. See .
+ Setting mode of the view. See .Setting mode of the view.
-
(0): (Default) Replaces a view.
-
(1): Adds a view.
-
(2): Deletes a view.
+
(0): (Default) Replaces a view.
+
(1): Adds a view.
+
(2): Deletes a view.
mediaPlayerId
- The ID of the media player. You can get the Device ID by calling .
- This parameter is required when sourceType is .
+ The ID of the media player. You can get the Device ID by calling .
+ This parameter is required when sourceType is .rect
- (Optional) Display area for the video frame. See . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed.
+ (Optional) Display area for the video frame. See . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed.cropArea
- (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed.
+ (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed.cropArea
- (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed.
+ (Optional) Display area of the video frame, see . width and height represent the video pixel width and height of the area. The default value is null (width or height is 0), which means that the actual resolution of the video frame is displayed.backgroundColor
@@ -256,15 +256,15 @@ class VideoCanvas {
enableAlphaMask
(Optional) Whether the receiver enables alpha mask rendering:
-
: The receiver enables alpha mask rendering.
-
: (default) The receiver disables alpha mask rendering.
+
: The receiver enables alpha mask rendering.
+
: (default) The receiver disables alpha mask rendering.
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 picture-in-picture and watermarking.
-
This property applies to macOS only.
The receiver can render alpha channel information only when the sender enables alpha transmission.
To enable alpha transmission, .
+
This property applies to macOS only.
The receiver can render alpha channel information only when the sender enables alpha transmission.
The dimensions of the encoded video (px). See . This parameter measures the video encoding quality in the format of length × width. The default value is 960 × 540. You can set a custom value.
+
The dimensions of the encoded video (px). See . This parameter measures the video encoding quality in the format of length × width. The default value is 960 × 540. You can set a custom value.
Users can set the resolution by themselves, or directly select the desired resolution from the following list:
-
: The video resolution is 120 × 120.
-
: The video resolution is 160 × 120.
-
: The video resolution is 180 × 180.
-
: The video resolution is 240 × 180.
-
: The video resolution is 320 × 180.
-
: The video resolution is 240 × 240.
-
: The video resolution is 320 × 240.
-
: The video resolution is 424 × 240.
-
: The video resolution is 360 × 360.
-
: The video resolution is 480 × 360.
-
: The video resolution is 640 × 360.
-
: The video resolution is 480 × 480.
-
: The video resolution is 640 × 480.
-
: The video resolution is 840 × 480.
-
: The video resolution is 960 × 540.
-
: The video resolution is 960 × 720.
-
: The video resolution is 1280 × 720.
-
: The video resolution is 1920 × 1080.
-
: The video resolution is 2540 × 1440.
-
: The video resolution is 3840 × 2160.
+
: The video resolution is 120 × 120.
+
: The video resolution is 160 × 120.
+
: The video resolution is 180 × 180.
+
: The video resolution is 240 × 180.
+
: The video resolution is 320 × 180.
+
: The video resolution is 240 × 240.
+
: The video resolution is 320 × 240.
+
: The video resolution is 424 × 240.
+
: The video resolution is 360 × 360.
+
: The video resolution is 480 × 360.
+
: The video resolution is 640 × 360.
+
: The video resolution is 480 × 480.
+
: The video resolution is 640 × 480.
+
: The video resolution is 840 × 480.
+
: The video resolution is 960 × 540.
+
: The video resolution is 960 × 720.
+
: The video resolution is 1280 × 720.
+
: The video resolution is 1920 × 1080.
+
: The video resolution is 2540 × 1440.
+
: The video resolution is 3840 × 2160.
@@ -467,19 +465,19 @@
codecType
- The codec type of the local video stream. See .
+ The codec type of the local video stream. See .frameRate
- The frame rate (fps) of the encoding video frame. The default value is 15. See .
+ The frame rate (fps) of the encoding video frame. The default value is 15. See .bitrate
-
The encoding bitrate (Kbps) of the video. See .
+
The encoding bitrate (Kbps) of the video. See .
-
(0): (Recommended) Standard bitrate mode. In this mode, the bitrates of the live broadcasting profile is higher than that of the communication profile. See .
-
(-1): Adaptive bitrate mode. In this mode, the bitrates of the live broadcasting profile equals that of the communication profile. If this mode is selected, the video frame rate of live broadcasting scenarios may be lower than the set value.
+
(0): (Recommended) Standard bitrate mode. In this mode, the bitrates of the live broadcasting profile is higher than that of the communication profile. See .
+
(-1): Adaptive bitrate mode. In this mode, the bitrates of the live broadcasting profile equals that of the communication profile. If this mode is selected, the video frame rate of live broadcasting scenarios may be lower than the set value.
@@ -491,16 +489,16 @@
orientationMode
- The orientation mode of the encoded video. See .
+ The orientation mode of the encoded video. See .degradationPreference
- Video degradation preference under limited bandwidth. See .
+ Video degradation preference under limited bandwidth. See .mirrorMode
-
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. See .
The mirror mode specified in video encoder configurations only affect the view of remote users.
(0): The SDK determines whether to enable the mirror mode. The SDK disables mirror mode by default.
(1): Enables the mirror mode for remote users.
@@ -510,7 +508,7 @@
advanceOptions
- Advanced options for video encoding. See .
+ Advanced options for video encoding. See .
@@ -518,13 +516,13 @@
initWithSize
- Specifies the video resolution and initializes the object. See .
+ Specifies the video resolution and initializes the object. See .initWithWidth
- Specifies the video width and height, and initializes the object. See .
+ Specifies the video width and height, and initializes the object. See .
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_videoframe.dita b/en-US/dita/RTC-NG/API/class_videoframe.dita
index 6c92820296a..820f0dc0beb 100644
--- a/en-US/dita/RTC-NG/API/class_videoframe.dita
+++ b/en-US/dita/RTC-NG/API/class_videoframe.dita
@@ -1,7 +1,7 @@
- <ph keyref="VideoFrame"/>
+ <ph keyref="VideoFrame" />Configurations of the video frame.
@@ -476,28 +476,28 @@ class VideoFrame {
final int? textureId;
@JsonKey(name: 'matrix')
- final List<double>? matrix;
+ final List<double>? matrix;
@JsonKey(name: 'pixelBuffer', ignore: true)
final Uint8List? pixelBuffer;
- factory VideoFrame.fromJson(Map<String, dynamic> json) =>
+ factory VideoFrame.fromJson(Map<String, dynamic> json) =>
_$VideoFrameFromJson(json);
- Map<String, dynamic> toJson() => _$VideoFrameToJson(this);
+ Map<String, dynamic> toJson() => _$VideoFrameToJson(this);
}
-
+
Note that the buffer provides a pointer to a pointer. This interface cannot modify the pointer of the buffer, but it can modify the content of the buffer.
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />type
- The pixel format. See .
-
+ The pixel format. See .
+ width
@@ -602,7 +602,7 @@ class VideoFrame {
colorSpace
- The color space of a video frame. See .
+ The color space of a video frame. See .sourceType
@@ -620,9 +620,9 @@ class VideoFrame {
alphaBuffer
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.To use this parameter, contact .
+
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.To use this parameter, contact .
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita
index ed72701605a..3eb62b97334 100644
--- a/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita
+++ b/en-US/dita/RTC-NG/API/class_videosubscriptionoptions.dita
@@ -1,7 +1,7 @@
- <ph keyref="VideoSubscriptionOptions"/>
+ <ph keyref="VideoSubscriptionOptions" />Video subscription options.
@@ -48,8 +48,8 @@
@end
struct VideoSubscriptionOptions {
- Optional<VIDEO_STREAM_TYPE> type;
- Optional<bool> encodedFrameOnly;
+ Optional<VIDEO_STREAM_TYPE> type;
+ Optional<bool> encodedFrameOnly;
VideoSubscriptionOptions() {}
};
@@ -61,9 +61,9 @@
}
public class VideoSubscriptionOptions:OptionalJsonParse
{
- public Optional<VIDEO_STREAM_TYPE> type = new Optional<VIDEO_STREAM_TYPE>();
+ public Optional<VIDEO_STREAM_TYPE> type = new Optional<VIDEO_STREAM_TYPE>();
- public Optional<bool> encodedFrameOnly = new Optional<bool>();
+ public Optional<bool> encodedFrameOnly = new Optional<bool>();
}export class VideoSubscriptionOptions {
@@ -80,33 +80,33 @@
@JsonKey(name: 'encodedFrameOnly')
final bool? encodedFrameOnly;
- factory VideoSubscriptionOptions.fromJson(Map<String, dynamic> json) =>
+ factory VideoSubscriptionOptions.fromJson(Map<String, dynamic> json) =>
_$VideoSubscriptionOptionsFromJson(json);
- Map<String, dynamic> toJson() => _$VideoSubscriptionOptionsToJson(this);
+ Map<String, dynamic> toJson() => _$VideoSubscriptionOptionsToJson(this);
}
-
+
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />streamTypetype
- The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. See .
+ The video stream type that you want to subscribe to. The default value is , indicating that the high-quality video streams are subscribed. See .The video stream type that you want to subscribe to:
-
(0): (Default) High-quality video stream, that is, a high-resolution, high-bit-rate video stream.
-
(1): Low-quality stream, that is, a low-resolution, low-bitrate video stream.
+
(0): (Default) High-quality video stream, that is, a high-resolution, high-bit-rate video stream.
+
(1): Low-quality stream, that is, a low-resolution, low-bitrate video stream.
encodedFrameOnlyWhether to subscribe to encoded video frames only:
-
: Subscribe to the encoded video data (structured data) only; the SDK does not decode or render raw video data.
-
: (Default) Subscribe to both raw video data and encoded video data.
+
: Subscribe to the encoded video data (structured data) only; the SDK does not decode or render raw video data.
+
: (Default) Subscribe to both raw video data and encoded video data.
-
+
\ No newline at end of file
diff --git a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita
index 14f964b573c..51b194856e3 100644
--- a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita
+++ b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita
@@ -1,7 +1,7 @@
- <ph keyref="WatermarkOptions"/>
+ <ph keyref="WatermarkOptions" />Configurations of the watermark image.
@@ -121,13 +121,13 @@
_$WatermarkOptionsFromJson(json);
Map<String, dynamic> toJson() => _$WatermarkOptionsToJson(this);
}
-
+
-
+
- <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/>
+ <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" />visibleInPreview
@@ -135,8 +135,8 @@
positionInLandscapeMode
- The area to display the watermark image in landscape mode. See .
- When the adaptation mode of the watermark is , it is used to set the area of the watermark image in landscape mode. See .
+ The area to display the watermark image in landscape mode. See .
+ When the adaptation mode of the watermark is , it is used to set the area of the watermark image in landscape mode. See .The area to display the watermark image in landscape mode. This parameter contains the following members:
x: The horizontal position of the watermark relative to the upper left corner.
y: The vertical position of the watermark relative to the upper left corner.
@@ -146,8 +146,8 @@
positionInPortraitMode
- The area to display the watermark image in portrait mode. See .
- When the adaptation mode of the watermark is , it is used to set the area of the watermark image in portrait mode. See .
+ The area to display the watermark image in portrait mode. See .
+ When the adaptation mode of the watermark is , it is used to set the area of the watermark image in portrait mode. See .The area to display the watermark image in portrait mode. This parameter contains the following members:
x: The horizontal position of the watermark relative to the upper left corner.
y: The vertical position of the watermark relative to the upper left corner.
@@ -157,12 +157,12 @@
watermarkRatio
- When the watermark adaptation mode is , this parameter is used to set the watermark coordinates. See .
+ When the watermark adaptation mode is , this parameter is used to set the watermark coordinates. See .mode
- The adaptation mode of the watermark. See .
+ The adaptation mode of the watermark. See .
-
+
\ No newline at end of file