diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita index 321808ad597..cc6bb339b4d 100644 --- a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita +++ b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_getdestchannelmediainfos.dita @@ -1,32 +1,32 @@ - <ph keyref="getDestChannelMediaInfos" /> + <ph keyref="getDestChannelMediaInfos"/> Gets the information of the target channel. - +

- public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { + public Map<String, ChannelMediaInfo> getDestChannelMediaInfos() { return destInfos; } - - - - - - -

+ + + + + + +

Returns -

The information of the target channel. See .

+

The information of the target channel. See .

 - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_removedestchannelinfo.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_removedestchannelinfo.dita index 551dece91d3..a3a8907fe29 100644 --- a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_removedestchannelinfo.dita +++ b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_removedestchannelinfo.dita @@ -17,12 +17,12 @@ destInfos.remove(channelName); } - (BOOL)removeDestinationInfoForChannelName:(NSString *_Nonnull)channelName; - - - - - -

+ + + + + +

Parameters diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita index 1be99d03556..f77a6366e55 100644 --- a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita +++ b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setdestchannelinfo.dita @@ -18,12 +18,12 @@ } - (BOOL)setDestinationInfo:(AgoraChannelMediaRelayInfo *_Nonnull)destinationInfo forChannelName:(NSString *_Nonnull)channelName; - - - - - -

+ + + + + +

Parameters diff --git a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setsrcchannelinfo.dita b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setsrcchannelinfo.dita index d3441a624a2..f1a2fd3fd32 100644 --- a/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setsrcchannelinfo.dita +++ b/en-US/dita/RTC-NG/API/api_channelmediarelayconfiguration_setsrcchannelinfo.dita @@ -1,12 +1,12 @@ - <ph keyref="setSrcChannelInfo" /> + <ph keyref="setSrcChannelInfo"/> Sets the information of the source channel. - + @@ -16,13 +16,13 @@ public void setSrcChannelInfo(ChannelMediaInfo srcInfo) { this.srcInfo = srcInfo; } - - - - - - -

+ + + + + + +

Parameters @@ -30,10 +30,10 @@ srcInfo -

The information of the source channel . 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 . 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.
      • @@ -42,4 +42,4 @@
- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_createagorartcengine.dita b/en-US/dita/RTC-NG/API/api_createagorartcengine.dita index b2040e2e3d8..5ed8c0d3d73 100644 --- a/en-US/dita/RTC-NG/API/api_createagorartcengine.dita +++ b/en-US/dita/RTC-NG/API/api_createagorartcengine.dita @@ -1,20 +1,20 @@ - <ph keyref="createAgoraRtcEngine" /> - Creates one object. Creates one object. + <ph keyref="createAgoraRtcEngine"/> + Creates one object. Creates one object. - +

- - + + AGORA_API agora::rtc::IRtcEngine *AGORA_CALL createAgoraRtcEngine () export function createAgoraRtcEngine(): IRtcEngineEx { return instance; @@ -29,19 +29,19 @@ RtcEngine createAgoraRtcEngine() { return impl.RtcEngineImpl.create(); } -

+

Details -

Currently, the Agora RTC SDK v4.x supports creating only one object for each app.

-

Currently, the Agora RTC SDK v4.x supports creating only one object for each app.

-

Currently, the Agora RTC SDK v6.x supports creating only one object for each app.

+

Currently, the Agora RTC SDK v4.x supports creating only one object for each app.

+

Currently, the Agora RTC SDK v4.x supports creating only one object for each app.

+

Currently, the Agora RTC SDK v6.x supports creating only one object for each app.

Returns -

Pointer to the object.

-

One object.

-

One object.

+

Pointer to the object.

+

One object.

+

One object.

 - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_createagorartcengineex.dita b/en-US/dita/RTC-NG/API/api_createagorartcengineex.dita index e7b5e0bfb9f..97a463d640b 100644 --- a/en-US/dita/RTC-NG/API/api_createagorartcengineex.dita +++ b/en-US/dita/RTC-NG/API/api_createagorartcengineex.dita @@ -1,40 +1,40 @@ - <ph keyref="createAgoraRtcEngineEx" /> - Creates one object. + <ph keyref="createAgoraRtcEngineEx"/> + Creates one object. - +

- - - - + + + + public static IRtcEngineEx CreateAgoraRtcEngineEx() { return (IRtcEngineEx)(instance ?? (instance = new RtcEngine(IntPtr.Zero))); } - + RtcEngineEx createAgoraRtcEngineEx() { return impl.RtcEngineImpl.create(); } -

+

Details -

Currently, the Agora RTC v4.x SDK supports creating only one object for each app.

-

Currently, the Agora RTC v6.x SDK supports creating only one object for each app.

+

Currently, the Agora RTC v4.x SDK supports creating only one object for each app.

+

Currently, the Agora RTC v6.x SDK supports creating only one object for each app.

Returns -

One object.

+

One object.

 \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_getmediaplayercachemanager.dita b/en-US/dita/RTC-NG/API/api_getmediaplayercachemanager.dita index b7706c494ee..8d7eae441a7 100644 --- a/en-US/dita/RTC-NG/API/api_getmediaplayercachemanager.dita +++ b/en-US/dita/RTC-NG/API/api_getmediaplayercachemanager.dita @@ -24,7 +24,7 @@ return new IMediaPlayerCacheManagerImpl(); } MediaPlayerCacheManager getMediaPlayerCacheManager() -

+

Details @@ -37,4 +37,4 @@

The instance.

- \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_enumeraterecordingdevices.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_enumeraterecordingdevices.dita index 18334154942..d6124a1d2ac 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_enumeraterecordingdevices.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_enumeraterecordingdevices.dita @@ -20,7 +20,7 @@ abstract DeviceInfo[] EnumerateRecordingDevices(); abstract enumerateRecordingDevices(): AudioDeviceInfo[]; List<AudioDeviceInfo> enumerateRecordingDevices(); -

+

Details diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita index dfb04765049..859d04cd660 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_followsystemloopbackdevice.dita @@ -13,8 +13,8 @@

- - + + virtual int followSystemLoopbackDevice(bool enable) = 0; abstract followSystemLoopbackDevice(enable: boolean): number; public abstract int FollowSystemLoopbackDevice(bool enable); diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getloopbackdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getloopbackdevice.dita index 4435434481f..c6187d15f49 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getloopbackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getloopbackdevice.dita @@ -13,8 +13,8 @@

- - + + virtual int getLoopbackDevice(char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; abstract getLoopbackDevice(): string; public abstract int GetLoopbackDevice(ref string deviceId); diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita index d292c20dc70..f6e16bd18d9 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdefaultdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="getPlaybackDefaultDevice" /> + <ph keyref="getPlaybackDefaultDevice"/> Gets the default audio playback device. - +

- - - + + + abstract getPlaybackDefaultDevice(): AudioDeviceInfo; public abstract int GetPlaybackDefaultDevice(ref string deviceId, ref string deviceName); - - Future<AudioDeviceInfo> getPlaybackDefaultDevice(); -

+ + Future<AudioDeviceInfo> getPlaybackDefaultDevice(); +

Details @@ -40,11 +40,11 @@
Returns -

The details about the default audio playback device. See .

+

The details about the default audio playback 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_iaudiodevicemanager_getrecordingdefaultdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita index 5dda26e2174..bba32a04a95 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdefaultdevice.dita @@ -1,26 +1,26 @@ - <ph keyref="getRecordingDefaultDevice" /> + <ph keyref="getRecordingDefaultDevice"/> Gets the default audio capture device. - +

- - - + + + abstract getRecordingDefaultDevice(): AudioDeviceInfo; public abstract int GetRecordingDefaultDevice(ref string deviceId, ref string deviceName); - - Future<AudioDeviceInfo> getRecordingDefaultDevice(); -

+ + Future<AudioDeviceInfo> getRecordingDefaultDevice(); +

Details @@ -40,11 +40,11 @@
Returns -

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_iaudiodevicemanager_getrecordingdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevice.dita index 5400c9bc7c9..3e56516b00d 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getrecordingdevice.dita @@ -13,8 +13,8 @@

- - + + virtual int getRecordingDevice(char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; abstract getRecordingDevice(): string; public abstract int GetRecordingDevice(ref string deviceId); diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita index 92ec968f351..4b5cb13a1f5 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setloopbackdevice.dita @@ -13,8 +13,8 @@

- - + + virtual int setLoopbackDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; abstract setLoopbackDevice(deviceId: string): number; public abstract int SetLoopbackDevice(string deviceId); diff --git a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita index a96c9d528d9..637a78656bb 100644 --- a/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita +++ b/en-US/dita/RTC-NG/API/api_iaudiodevicemanager_setrecordingdevicevolume.dita @@ -13,8 +13,8 @@

- - + + virtual int setRecordingDeviceVolume(int volume) = 0; abstract setRecordingDeviceVolume(volume: number): number; public abstract int SetRecordingDeviceVolume(int volume); diff --git a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita index 322f0a1e688..9829d4581e8 100644 --- a/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita +++ b/en-US/dita/RTC-NG/API/api_ibasespatialaudioengine_setzones.dita @@ -14,7 +14,7 @@

public abstract int setZones(SpatialAudioZone[] zones); - - (int)setZones:(NSArray<AgoraSpatialAudioZone*> * _Nonnull)zones; + - (int)setZones:(NSArray<AgoraSpatialAudioZone*> * _Nonnull)zones; virtual int setZones(const SpatialAudioZone *zones, unsigned int zoneCount) = 0; abstract setZones(zones: SpatialAudioZone, zoneCount: number): number; public abstract int SetZones(SpatialAudioZone[] zones, uint zoneCount); 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 41be2d7b2b0..d39782b61b8 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 8b80ee04d57..c535e0b3930 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.
Parameters config - 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 ab6fb4932a0..c88449f8031 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 0e006691d30..f97153f4d5e 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. - +

- - - - addListener?<EventType extends keyof IMediaEngineEvent>( + + + + addListener?<EventType extends keyof IMediaEngineEvent>( eventType: EventType, listener: IMediaEngineEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaEngineEvent>( + + addListener?<EventType extends keyof IMediaEngineEvent>( eventType: EventType, listener: IMediaEngineEvent[EventType] ): void; - -

+ +

Details -

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.

Parameters eventType - 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 4b3d1d972c6..6c268bd0b21 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:

  1. Call this method to create a custom audio track and get the audio track ID.
    2. -
  2. In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
    3. -
  3. 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.
    4. +
  4. In of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to .
    5. +
  5. 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 2ea5558608d..6dc1f62db49 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; - - - - - -

    + + + + + +

    Parameters frame - 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 b654872595a..67b8b41e30f 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 956b45fb433..3089be0921a 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 @@ frameInfo videoEncodedFrameInfo - 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 012364cc717..817e0b960b9 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 ab908a7548a..6306b54e451 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 @@ -34,35 +34,35 @@ delegate audioFrameObserver -

    The observer instance. See . Set the value as to release the instance. Agora recommends calling this method after receiving to release the audio observer object.

    +

    The observer instance. See . Set the value as to release the instance. Agora recommends calling this method after receiving to release the audio observer object.

     mode - The audio data callback mode. See . + The audio data callback mode. See . position The 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 ada50c18b18..a7dbcb2910f 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:

      -
    1. Call to register the raw video frame observer before joining the channel.
      2. -
    2. Call to register the encoded video frame observer before joining the channel.
      3. -
    3. 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 .
      4. -
    4. 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 @@ receiver observer videoEncodedImageReceiver - 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 b504344084b..7336c0710fd 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 @@ -43,31 +43,31 @@ observer delegate videoFrameObserver - The observer instance. See . To release the instance, set the value as . + The observer instance. See . To release the instance, set the value as . 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_imediaengine_unregisteraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita index 211d08fa6e0..bb1a4be2904 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregisteraudioframeobserver.dita @@ -13,9 +13,9 @@

    - - - + + + abstract unregisterAudioFrameObserver(observer: IAudioFrameObserver): number; abstract unregisterAudioFrameObserver(observer: IAudioFrameObserver): number; diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita index 28d65a834bc..eec2c041884 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoencodedframeobserver.dita @@ -13,9 +13,9 @@

    - - - + + + abstract unregisterVideoEncodedFrameObserver( observer: IVideoEncodedFrameObserver ): number; diff --git a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita index 4b8bc590185..bcc3f3b6471 100644 --- a/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaengine_unregistervideoframeobserver.dita @@ -13,9 +13,9 @@

    - - - + + + abstract unregisterVideoFrameObserver(observer: IVideoFrameObserver): number; public abstract int UnRegisterVideoFrameObserver(); abstract unregisterVideoFrameObserver(observer: IVideoFrameObserver): number; 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 9ce3923ca0f..0c96f2ee242 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. - +

    - - - - addListener?<EventType extends keyof IMediaPlayerEvent>( + + + + addListener?<EventType extends keyof IMediaPlayerEvent>( eventType: EventType, listener: IMediaPlayerEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaPlayerEvent>( + + addListener?<EventType extends keyof IMediaPlayerEvent>( eventType: EventType, listener: IMediaPlayerEvent[EventType] ): void; -

    +

    Details -

    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.

    Parameters eventType - 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_getplayposition.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getplayposition.dita index b4116fdb446..b6a8ed0544d 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getplayposition.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_getplayposition.dita @@ -20,7 +20,7 @@ public abstract int GetPlayPosition(ref Int64 pos); abstract getPlayPosition(): number; Future<int> getPlayPosition(); -

    +

    <ph keyref="callback-section-title" /> diff --git a/en-US/dita/RTC-NG/API/api_imediaplayer_getplaysrc.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_getplaysrc.dita index 5828be5bc80..5f2dcbb98d0 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_getplaysrc.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_getplaysrc.dita @@ -1,12 +1,12 @@ - <ph keyref="getPlaySrc_IMediaPlayer" /> + <ph keyref="getPlaySrc_IMediaPlayer"/> Gets the path of the media resource being played. - + @@ -19,12 +19,12 @@ abstract getPlaySrc(): string; public abstract string GetPlaySrc(); abstract getPlaySrc(): string; - Future<String> getPlaySrc(); -

    + Future<String> getPlaySrc(); +

    Returns

    The path of the media resource being played.

    - \ 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 382bad72cf6..52b72c3ea03 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_registeraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver.dita index 26da8e2d3c5..00e3e46fbd9 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_registeraudioframeobserver.dita @@ -13,10 +13,10 @@

    - - + + virtual int registerAudioFrameObserver(media::IAudioPcmFrameSink* observer) = 0; - + public abstract int RegisterAudioFrameObserver(IAudioPcmFrameSink observer); 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 75da81cd9c3..265f22f4008 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 @@

    int registerVideoFrameObserver(IMediaPlayerVideoFrameObserver videoFrameObserver); - + virtual int registerVideoFrameObserver(media::base::IVideoFrameObserver* observer) = 0; abstract registerVideoFrameObserver( observer: IMediaPlayerVideoFrameObserver @@ -24,11 +24,11 @@ observer: IMediaPlayerVideoFrameObserver ): number; void registerVideoFrameObserver(MediaPlayerVideoFrameObserver observer); -

    +

    Details -

    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 @@ videoFrameObserver observer - 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_selectinternalsubtitle.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_selectinternalsubtitle.dita index 5cb40d731e4..614c6bb588d 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_selectinternalsubtitle.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_selectinternalsubtitle.dita @@ -18,7 +18,7 @@ - (int)selectInternalSubtitle:(int)index; virtual int selectInternalSubtitle(int index) = 0; - + public abstract int SelectInternalSubtitle(int playerId, int index); 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 ccfebbc3a14..4f26670ac9b 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 10edd81c0d5..d1d7c3bcf2b 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_imediaplayer_unregistervideoframeobserver.dita b/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita index bd3fbb0a092..c66d27ef186 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayer_unregistervideoframeobserver.dita @@ -13,8 +13,8 @@

    - - + + virtual int unregisterVideoFrameObserver(agora::media::base::IVideoFrameObserver* observer) = 0; abstract unregisterVideoFrameObserver( observer: IMediaPlayerVideoFrameObserver diff --git a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removecachebyuri.dita b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removecachebyuri.dita index 99c91139d9f..f5994487a8b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removecachebyuri.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removecachebyuri.dita @@ -1,12 +1,12 @@ - <ph keyref="removeCacheByUri" /> + <ph keyref="removeCacheByUri"/> Deletes a cached media file. - + @@ -19,13 +19,13 @@ abstract removeCacheByUri(uri: string): number; public abstract int RemoveCacheByUri(string uri) ; abstract removeCacheByUri(uri: string): number; - uture<void> removeCacheByUri(String uri); -

    + uture<void> removeCacheByUri(String uri); +

    Details -

    +

    Parameters @@ -37,4 +37,4 @@
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeoldcache.dita b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeoldcache.dita index b697ac2b5d4..02fd8f4d25d 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeoldcache.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_removeoldcache.dita @@ -1,12 +1,12 @@ - <ph keyref="removeOldCache" /> + <ph keyref="removeOldCache"/> Deletes a cached media file that is the least recently used. - + @@ -19,8 +19,8 @@ abstract removeOldCache(): number; public abstract int RemoveOldCache(); abstract removeOldCache(): number; - Future<void> removeOldCache(); -

    + Future<void> removeOldCache(); +

    Details @@ -30,4 +30,4 @@
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_setcachedir.dita b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_setcachedir.dita index 18a18dbaecd..3d1c1acf54f 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_setcachedir.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_setcachedir.dita @@ -1,12 +1,12 @@ - <ph keyref="setCacheDir" /> + <ph keyref="setCacheDir"/> Sets the storage path for the media files that you want to cache. - + @@ -19,13 +19,13 @@ abstract setCacheDir(path: string): number; public abstract int SetCacheDir(string path) ; abstract setCacheDir(path: string): number; - Future<void> setCacheDir(String path); -

    + Future<void> setCacheDir(String path); +

    Details -

    Make sure is initialized before you call this method.

    +

    Make sure is initialized before you call this method.
    Parameters @@ -38,4 +38,4 @@
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_setmaxcachefilecount.dita b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_setmaxcachefilecount.dita index c84449a2390..2ff506c745b 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_setmaxcachefilecount.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_setmaxcachefilecount.dita @@ -1,12 +1,12 @@ - <ph keyref="setMaxCacheFileCount" /> + <ph keyref="setMaxCacheFileCount"/> Sets the maximum number of media files that can be cached. - + @@ -19,8 +19,8 @@ abstract setMaxCacheFileCount(count: number): number; public abstract int SetMaxCacheFileCount(int count); abstract setMaxCacheFileCount(count: number): number; - Future<void> setMaxCacheFileCount(int count); -

    + Future<void> setMaxCacheFileCount(int count); +

    Parameters @@ -32,4 +32,4 @@
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_setmaxcachefilesize.dita b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_setmaxcachefilesize.dita index 36a7d1e903f..2472efa8ef6 100644 --- a/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_setmaxcachefilesize.dita +++ b/en-US/dita/RTC-NG/API/api_imediaplayercachemanager_setmaxcachefilesize.dita @@ -1,12 +1,12 @@ - <ph keyref="setMaxCacheFileSize" /> + <ph keyref="setMaxCacheFileSize"/> Sets the maximum size of the aggregate storage space for cached media files. - + @@ -19,8 +19,8 @@ abstract setMaxCacheFileSize(cacheSize: number): number; public abstract int SetMaxCacheFileSize(Int64 cacheSize); abstract setMaxCacheFileSize(cacheSize: number): number; - Future<void> setMaxCacheFileSize(int cacheSize); -

    + Future<void> setMaxCacheFileSize(int cacheSize); +

    Parameters @@ -32,4 +32,4 @@
    -     \ 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 344aa0cebdb..dc6238f2f49 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. - +

    - - - - addListener?<EventType extends keyof IMediaRecorderEvent>( + + + + addListener?<EventType extends keyof IMediaRecorderEvent>( eventType: EventType, listener: IMediaRecorderEvent[EventType] ): void; - - addListener?<EventType extends keyof IMediaRecorderEvent>( + + addListener?<EventType extends keyof IMediaRecorderEvent>( eventType: EventType, listener: IMediaRecorderEvent[EventType] ): void; -

    +

    Details -

    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.

    Parameters eventType - 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_release.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_release.dita index 34a1c3db88e..4d4fc3bf0f9 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_release.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_release.dita @@ -1,12 +1,12 @@ - <ph keyref="releaseRecorder" /> - Release the object. + <ph keyref="releaseRecorder"/> + Release the object. - + @@ -17,14 +17,14 @@ + (void)destroy; virtual void release() = 0; abstract release(): void; - + abstract release(): void; - Future<void> release(); -

    + Future<void> release(); +

    Details -

    This method releases the object and all resources used by the object. After calling this method, if you need to start recording again, you need to call again to get the object.

    +

    This method releases the object and all resources used by the object. After calling this method, if you need to start recording again, you need to call again to get the object.

    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita b/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita index 4f64c5d5753..675d4b37e2a 100644 --- a/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita +++ b/en-US/dita/RTC-NG/API/api_imediarecorder_setmediarecorderobserver.dita @@ -14,7 +14,7 @@

    public int setMediaRecorderObserver(IMediaRecorderCallback callback) - - (int)setMediaRecorderDelegate:(id<AgoraMediaRecorderDelegate> _Nullable)delegate; + - (int)setMediaRecorderDelegate:(id<AgoraMediaRecorderDelegate> _Nullable)delegate; virtual int setMediaRecorderObserver(media::IMediaRecorderObserver* callback) = 0; abstract setMediaRecorderObserver(callback: IMediaRecorderObserver): number; public abstract int SetMediaRecorderObserver(IMediaRecorderObserver callback); 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 e17f2cd5ec8..71e7e039395 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_addhandler.dita b/en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita index 1f012b33859..878a0fe6b29 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_addhandler.dita @@ -16,8 +16,8 @@ public void addHandler(IRtcEngineEventHandler handler) { mInstance.addHandler(handler); } - - + + abstract registerEventHandler(eventHandler: IRtcEngineEventHandler): boolean; public abstract int InitEventHandler(IRtcEngineEventHandler engineEventHandler); abstract registerEventHandler(eventHandler: IRtcEngineEventHandler): boolean; 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 a21fcc70f63..028041b353b 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. - +

    - - - - addListener?<EventType extends keyof IRtcEngineEvent>( + + + + addListener?<EventType extends keyof IRtcEngineEvent>( eventType: EventType, listener: IRtcEngineEvent[EventType] ): void; - - addListener?<EventType extends keyof IRtcEngineEvent>( + + addListener?<EventType extends keyof IRtcEngineEvent>( eventType: EventType, listener: IRtcEngineEvent[EventType] ): void; -

    +

    Details -

    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.

    Parameters eventType - 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 3dcfc29a661..1d99052821f 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.

    +
    Parameters 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.

    • 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_create.dita b/en-US/dita/RTC-NG/API/api_irtcengine_create.dita index bcc47d853eb..2497c8be2ef 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_create.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_create.dita @@ -18,12 +18,12 @@     + (instancetype _Nonnull)sharedEngineWithAppId:(NSString * _Nonnull)appId delegate:(id<AgoraRtcEngineDelegate> _Nullable)delegate; - - - - - -

    + + + + + +

    Details diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita index f3d044ea6c3..71a06989b32 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createcustomvideotrack.dita @@ -1,12 +1,12 @@ - <ph keyref="createCustomVideoTrack" /> + <ph keyref="createCustomVideoTrack"/> Creates a customized video track. - + @@ -20,14 +20,14 @@ public abstract video_track_id_t CreateCustomVideoTrack(); abstract createCustomVideoTrack(): number; Future<int> createCustomVideoTrack(); -

    +

    Details

    When you need to publish multiple custom captured videos in the channel, you can refer to the following steps:

    1. Call this method to create a video track and get the video track ID.
      2. -
    2. In each channel's , set the customVideoTrackId parameter to the ID of the video track you want to publish, and set publishCustomVideoTrack to .
      3. -
    3. If you call , and specify customVideoTrackId as the videoTrackId set in step 2, you can publish the corresponding custom video source in multiple channels.
      4. +
    4. In each channel's , set the customVideoTrackId parameter to the ID of the video track you want to publish, and set publishCustomVideoTrack to .
      5. +
    5. If you call , and specify customVideoTrackId as the videoTrackId set in step 2, you can publish the corresponding custom video source in multiple channels.

    @@ -37,4 +37,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_irtcengine_createdatastream.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream.dita index 10892294cb1..c763e575e00 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createdatastream.dita @@ -22,7 +22,7 @@ public abstract int CreateDataStream(ref int streamId, bool reliable, bool ordered); Future<int> createDataStream(DataStreamConfig config); -

    +

    Details @@ -30,7 +30,7 @@
    • Call this method after joining a channel.
      • -
    • Agora does not support setting reliable as and ordered as .
      • +
    • Agora does not support setting reliable as and ordered as .
    Parameters 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 a3ca1a6757b..d0e0c7ad951 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_createmediaplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita index 4cedbb18273..5886daefb12 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createmediaplayer.dita @@ -21,7 +21,7 @@ public abstract IMediaPlayer CreateMediaPlayer(); abstract createMediaPlayer(): IMediaPlayer; Future<MediaPlayer> createMediaPlayer(); -

    +

    Parameters @@ -40,4 +40,4 @@

    An instance, if the method call succeeds.

    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_createmediarecorder.dita b/en-US/dita/RTC-NG/API/api_irtcengine_createmediarecorder.dita index a8528290d03..82925728ecd 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_createmediarecorder.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_createmediarecorder.dita @@ -1,12 +1,12 @@ - <ph keyref="createMediaRecorder" /> + <ph keyref="createMediaRecorder"/> Creates a recording object for audio and video recording. - + @@ -15,11 +15,11 @@

    public abstract AgoraMediaRecorder createMediaRecorder(RecorderStreamInfo info); - (AgoraMediaRecorder * _Nullable)createMediaRecorder:(AgoraRecorderStreamInfo * _Nonnull)info NS_SWIFT_NAME(createMediaRecorder(withInfo:)); - virtual agora_refptr<IMediaRecorder> createMediaRecorder(const RecorderStreamInfo& info) = 0; + virtual agora_refptr<IMediaRecorder> createMediaRecorder(const RecorderStreamInfo& info) = 0; abstract createMediaRecorder(info: RecorderStreamInfo): IMediaRecorder; public abstract IMediaRecorder CreateMediaRecorder(RecorderStreamInfo info); abstract createMediaRecorder(info: RecorderStreamInfo): IMediaRecorder; - Future<MediaRecorder?> createMediaRecorder(RecorderStreamInfo info);

    + Future<MediaRecorder?> createMediaRecorder(RecorderStreamInfo info);

    Details @@ -30,23 +30,23 @@

    Before you start recording, you need to call this method to create a recording object. Agora SDKs support recording the audio and video streams of both local and remote users. You can call this method as needed to create muitiple recording objects and specify the streams that you want to record through the info parameter.

    -

    After successfully creating a recording object, you need to call to register a recording observer to listen for recording callbacks, and then call to start recording.

    +

    After successfully creating a recording object, you need to call to register a recording observer to listen for recording callbacks, and then call to start recording.

    Parameters info - The information about the media streams you want to record. See . + The information about the media streams you want to record. See .
    Returns
      -
    • The object, if the method call succeeds.
      • -
    • The instance, if the method call succeeds.
      • +
    • The object, if the method call succeeds.
      • +
    • The instance, if the method call succeeds.
    • An empty pointer, if the method call fails.
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_destroymediarecorder.dita b/en-US/dita/RTC-NG/API/api_irtcengine_destroymediarecorder.dita index f0bcf8a3d0d..89f04ca0996 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_destroymediarecorder.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_destroymediarecorder.dita @@ -1,12 +1,12 @@ - <ph keyref="destroyMediaRecorder" /> + <ph keyref="destroyMediaRecorder"/> Destroys a recording object for audio and video recording. - + @@ -15,11 +15,11 @@

    public abstract void destroyMediaRecorder(AgoraMediaRecorder mediaRecorder); - (int)destroyMediaRecorder:(AgoraMediaRecorder * _Nullable)mediaRecorder; - virtual int destroyMediaRecorder(agora_refptr<IMediaRecorder> mediaRecorder) = 0; + virtual int destroyMediaRecorder(agora_refptr<IMediaRecorder> mediaRecorder) = 0; abstract destroyMediaRecorder(mediaRecorder: IMediaRecorder): number; public abstract int DestroyMediaRecorder(IMediaRecorder mediaRecorder); abstract destroyMediaRecorder(mediaRecorder: IMediaRecorder): number; - Future<void> destroyMediaRecorder(MediaRecorder mediaRecorder);

    + Future<void> destroyMediaRecorder(MediaRecorder mediaRecorder);

    Details @@ -29,7 +29,7 @@
    v4.2.0
    -

    When you do not need to record any audio and video streams, you can call this method to destroy the recording object. Before you call this method, if you are recording a media stream, you need to call to stop recording.

    +

    When you do not need to record any audio and video streams, you can call this method to destroy the recording object. Before you call this method, if you are recording a media stream, you need to call to stop recording.

    Parameters @@ -41,4 +41,4 @@
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_disablelastmiletest.dita b/en-US/dita/RTC-NG/API/api_irtcengine_disablelastmiletest.dita index 0155b78d543..1b0cc842215 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_disablelastmiletest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_disablelastmiletest.dita @@ -13,10 +13,10 @@

    - - + + virtual int disableLastmileTest() = 0; - + public abstract int DisableLastmileTest(); 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 79876008572..f79c8b4f19b 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 57fd1fc4aba..5ff70d41a58 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 5057d9504c5..9c5a105c18c 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.

    • 0: Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita index 0735bdfa472..64e46bfb94d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring.dita @@ -15,8 +15,8 @@

        public abstract int enableInEarMonitoring(boolean enabled); - (int)enableInEarMonitoring:(BOOL)enabled; - - + + public abstract int EnableInEarMonitoring(bool enabled); diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita index c1ff454ccae..8384b00a036 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enableinearmonitoring2.dita @@ -1,12 +1,12 @@ - <ph keyref="enableInEarMonitoring2" /> + <ph keyref="enableInEarMonitoring2"/> Enables in-ear monitoring. - + @@ -25,10 +25,10 @@ enabled: boolean, includeAudioFilters: EarMonitoringFilterType ): number; - Future<void> enableInEarMonitoring( + Future<void> enableInEarMonitoring( {required bool enabled, required EarMonitoringFilterType includeAudioFilters}); -

        +

    Details @@ -44,28 +44,28 @@ enabled Enables 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_enablelastmiletest.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablelastmiletest.dita index 01e87dc9511..6d8da2aca61 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablelastmiletest.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablelastmiletest.dita @@ -13,10 +13,10 @@

    - - + + virtual int enableLastmileTest() = 0; - + public abstract int EnableLastmileTest(); diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_enablemainqueuedispatch.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablemainqueuedispatch.dita index 860d8b01d94..81537e94260 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablemainqueuedispatch.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablemainqueuedispatch.dita @@ -1,42 +1,42 @@ - <ph keyref="enableMainQueueDispatch" /> + <ph keyref="enableMainQueueDispatch"/> Enables or disables dispatching delegate methods to the main queue. - +

    - + - (int)enableMainQueueDispatch:(BOOL)enabled; - - removeAllListeners?<EventType extends keyof IMediaEngineEvent>( + + removeAllListeners?<EventType extends keyof IMediaEngineEvent>( eventType?: EventType ): void; - - - -

    + + + +

    -

    +

    Parameters - - + +
    Returns
    - \ 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 ceca8316592..e165e6bc38a 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. - +

    - + - (int)enableMultiCamera:(BOOL)enabled config:(AgoraCameraCapturerConfiguration* _Nullable)config NS_SWIFT_NAME(enableMultiCamera(_:config:)); #if defined(__APPLE__) && TARGET_OS_IOS virtual int enableMultiCamera(bool enabled, const CameraCapturerConfiguration& config) = 0; @@ -27,9 +27,9 @@ enabled: boolean, config: CameraCapturerConfiguration ): number; - Future<void> enableMultiCamera( + Future<void> enableMultiCamera( {required bool enabled, required CameraCapturerConfiguration config}); -

    +

    Details @@ -41,18 +41,18 @@

    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:

    1. Call this method to enable multi-channel camera capture.
      2. -
    2. Call to start the local video preview.
      3. -
    3. Call , and set sourceType to start video capture with the second camera.
      4. -
    4. Call , and set publishSecondaryCameraTrack to to publish the video stream captured by the second camera in the channel.
      5. +
    5. Call to start the local video preview.
      6. +
    6. Call , and set sourceType to start video capture with the second camera.
      7. +
    7. 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:

      -
    1. Call .
      2. -
    2. Call this method with enabled set to .
      3. +
    3. Call .
      4. +
    4. 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 @@ enabled Whether 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_enablevirtualbackground.dita b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita index 88f96236625..be2ad36ebed 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita @@ -1,12 +1,12 @@ - <ph keyref="enableVirtualBackground" /> + <ph keyref="enableVirtualBackground"/> Enables/Disables the virtual background. - + @@ -32,17 +32,17 @@ segproperty: SegmentationProperty, type?: MediaSourceType ): number; - Future<void> enableVirtualBackground( + Future<void> enableVirtualBackground( {required bool enabled, required VirtualBackgroundSource backgroundSource, required SegmentationProperty segproperty, MediaSourceType type = MediaSourceType.primaryCameraSource}); -

    +

    Details

    The virtual background feature enables the local user to replace their original background with a static image, dynamic video, blurred background, or portrait-background segmentation to achieve picture-in-picture effect. Once the virtual background feature is enabled, all users in the channel can see the custom background.

    -

    Call this method before calling or .

    +

    Call this method before calling or .

    • This feature requires high performance devices. Agora recommends that you implement it on devices equipped with the following chips:
        @@ -64,7 +64,7 @@
      • A high-definition camera device is used, and the environment is uniformly lit.
      • There are few objects in the captured video. Portraits are half-length and unobstructed. Ensure that the background is a solid color that is different from the color of the user's clothing.
      • -
    • This method relies on the virtual background dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
      • +
    • This method relies on the virtual background dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    Parameters @@ -73,38 +73,38 @@ enabled enable Whether to enable virtual background:
      -
    • : Enable virtual background.
      • -
    • : Disable virtual background.
      • +
    • : Enable virtual background.
      • +
    • : Disable virtual background.
     backgroundSource backData - The custom background. See . To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted. + The custom background. See . To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted. segproperty segData - Processing properties for background images. See . + Processing properties for background images. See . type - The type of the video source. See .In this method, this parameter supports only the following two settings:
      -
    • The default value is .
      • -
    • If you want to use the second camera to capture video, set this parameter to .
      • + The type of the video source. See .In this method, this parameter supports only the following two settings:
        +
      • The default value is .
        • +
      • If you want to use the second camera to capture video, set this parameter to .
    - <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.
        -
      • -1: The custom background image does not exist. Check the value of source in .
        • -
      • -2: The color format of the custom background image is invalid. Check the value of color in .
        • +
      • -1: The custom background image does not exist. Check the value of source in .
        • +
      • -2: The color format of the custom background image is invalid. Check the value of color in .
      • -3: The device does not support virtual background.
     - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita index 0d9f5624440..8699614f414 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getcameramaxzoomfactor.dita @@ -20,7 +20,7 @@ public abstract float GetCameraMaxZoomFactor(); abstract getCameraMaxZoomFactor(): number; Future<double> getCameraMaxZoomFactor(); -

    +

    Details diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita b/en-US/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita index 42f94e0d47a..a94e8c1c760 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_geterrordescription.dita @@ -20,7 +20,7 @@ public abstract string GetErrorDescription(int code); abstract getErrorDescription(code: number): string; Future<String> getErrorDescription(int code); -

    +

    Parameters 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 3803ae2b685..7af9752c219 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 @@ sourceType type - 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_getloopbackrecordingvolume.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getloopbackrecordingvolume.dita index 77531fe88e5..b36530f65d4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getloopbackrecordingvolume.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getloopbackrecordingvolume.dita @@ -20,7 +20,7 @@ Future<int> getLoopbackRecordingVolume(); -

    +

    Details diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getmediarecorder.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getmediarecorder.dita index 60c03a87dd8..530ede0cc8e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getmediarecorder.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getmediarecorder.dita @@ -1,12 +1,12 @@ - <ph keyref="getMediaRecorder" /> - Gets an object. Creates one instance. + <ph keyref="getMediaRecorder"/> + Gets an object. Creates one instance. - + @@ -15,12 +15,12 @@

    public static synchronized AgoraMediaRecorder getMediaRecorder(RtcEngine engine) + (instancetype _Nonnull)sharedMediaRecorderWithRtcEngine:(AgoraRtcEngineKit* _Nonnull)engine; - + abstract getMediaRecorder(): IMediaRecorder; public abstract IMediaRecorder GetMediaRecorder(); abstract getMediaRecorder(): IMediaRecorder; MediaRecorder getMediaRecorder(); -

    +

    Details @@ -30,12 +30,12 @@ engine - One object. + One object.
    Returns -

    One object.

    +

    One object.

    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita index 3c8e86a3901..5f29b8a96ad 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getnativehandle.dita @@ -15,7 +15,7 @@

    public abstract long getNativeHandle(); - (void* _Nullable)getNativeHandle; - + abstract getNativeHandle(): number; public abstract int GetNativeHandler(ref IntPtr nativeHandler); abstract getNativeHandle(): number; diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getnetworktype.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getnetworktype.dita index 9bea3a7b1a6..6de631a1455 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getnetworktype.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getnetworktype.dita @@ -1,12 +1,12 @@ - <ph keyref="getNetworkType" /> + <ph keyref="getNetworkType"/> Gets the type of the local network connection. - + @@ -19,8 +19,8 @@ abstract getNetworkType(): number; public abstract int GetNetworkType(); abstract getNetworkType(): number; - Future<int> getNetworkType(); -

    + Future<int> getNetworkType(); +

    Details @@ -49,4 +49,4 @@
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_getntpwalltimeinms.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getntpwalltimeinms.dita index c759dc9ed80..44716e8fdb9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getntpwalltimeinms.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getntpwalltimeinms.dita @@ -1,12 +1,12 @@ - <ph keyref="getNtpWallTimeInMs" /> + <ph keyref="getNtpWallTimeInMs"/> Gets the current NTP (Network Time Protocol) time. - + @@ -19,8 +19,8 @@ abstract getNtpWallTimeInMs(): number; public abstract UInt64 GetNtpWallTimeInMs(); abstract getNtpWallTimeInMs(): number; - Future<int> getNtpWallTimeInMs(); -

    + Future<int> getNtpWallTimeInMs(); +

    Details @@ -37,4 +37,4 @@

    The Unix timestamp (ms) of the current NTP time.

    -     \ 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 1657ff3ff0c..d7bc08736a9 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_getversion.dita b/en-US/dita/RTC-NG/API/api_irtcengine_getversion.dita index d744386bd69..5162ae3eaba 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_getversion.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_getversion.dita @@ -1,12 +1,12 @@ - <ph keyref="getVersion" /> + <ph keyref="getVersion"/> Gets the SDK version. - + @@ -20,7 +20,7 @@ public abstract string GetVersion(ref int build); abstract getVersion(): SDKBuildInfo; Future<SDKBuildInfo> getVersion(); -

    +

    Parameters @@ -33,7 +33,7 @@
    Returns

    The SDK version number. The format is a string.

    -

    One object.

    +

    One object.

    - \ 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 770768f8c6e..d962196b1d8 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.
    Parameters @@ -41,21 +41,21 @@ context config -

    Configurations for the instance. See .

    +

    Configurations for the instance. See .

     delegate - +
    - <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.

      -
    • 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_iscameraautoexposurefacemodesupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraautoexposurefacemodesupported.dita index d4286cc4b21..27329e89614 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraautoexposurefacemodesupported.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraautoexposurefacemodesupported.dita @@ -20,7 +20,7 @@ public abstract bool IsCameraAutoExposureFaceModeSupported(); abstract isCameraAutoExposureFaceModeSupported(): boolean; Future<bool> isCameraAutoExposureFaceModeSupported(); -

    +

    Details diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraautofocusfacemodesupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraautofocusfacemodesupported.dita index 0d98da8e095..0a35f7cfecb 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraautofocusfacemodesupported.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraautofocusfacemodesupported.dita @@ -20,7 +20,7 @@ public abstract bool IsCameraAutoFocusFaceModeSupported(); abstract isCameraAutoFocusFaceModeSupported(): boolean; Future<bool> isCameraAutoFocusFaceModeSupported(); -

    +

    Details diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposurepositionsupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposurepositionsupported.dita index 47e7b61634e..fc4100ac8c5 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposurepositionsupported.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposurepositionsupported.dita @@ -20,7 +20,7 @@ public abstract bool IsCameraExposurePositionSupported(); abstract isCameraExposurePositionSupported(): boolean; Future<bool> isCameraExposurePositionSupported(); -

    +

    Details diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita index 5273c07117c..d7109b7405c 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_iscameraexposuresupported.dita @@ -16,7 +16,7 @@ public abstract boolean isCameraExposureSupported(); - (BOOL)isCameraExposureSupported NS_SWIFT_NAME(isCameraExposureSupported()); virtual bool isCameraExposureSupported() = 0; - + public abstract bool IsCameraExposureSupported(); abstract isCameraExposureSupported(): boolean; Future<bool> isCameraExposureSupported(); diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_iscamerafacedetectsupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscamerafacedetectsupported.dita index 0ff46401c85..11f4102eeed 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscamerafacedetectsupported.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_iscamerafacedetectsupported.dita @@ -20,7 +20,7 @@ public abstract bool IsCameraFaceDetectSupported(); abstract isCameraFaceDetectSupported(): boolean; Future<bool> isCameraFaceDetectSupported(); -

    +

    diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_iscamerafocussupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscamerafocussupported.dita index f9e7709a3f6..6e82e73af88 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscamerafocussupported.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_iscamerafocussupported.dita @@ -20,7 +20,7 @@ public abstract bool IsCameraFocusSupported(); abstract isCameraFocusSupported(): boolean; Future<bool> isCameraFocusSupported(); -

    +

    Details diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_iscameratorchsupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscameratorchsupported.dita index 5d05bace16e..69943d667a0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscameratorchsupported.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_iscameratorchsupported.dita @@ -20,7 +20,7 @@ public abstract bool IsCameraTorchSupported(); abstract isCameraTorchSupported(): boolean; Future<bool> isCameraTorchSupported(); -

    +

    Details diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita b/en-US/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita index 2ac5b56f177..b451a915c3a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita @@ -20,7 +20,7 @@ public abstract bool IsCameraZoomSupported(); abstract isCameraZoomSupported(): boolean; Future<bool> isCameraZoomSupported(); -

    +

    Details diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita index 47afa5a557f..a8e14158f75 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_joinchannel.dita @@ -40,7 +40,7 @@ required String channelId, required String info, required int uid}); -

    +

    Details 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 be33f384296..99abe864cf4 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 @@
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
    • -
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    • +
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

    •  @@ -91,8 +91,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.
        @@ -106,4 +106,4 @@
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita b/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita index 963ce80bc46..81899fdeaf2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_loadextensionprovider.dita @@ -13,8 +13,8 @@

    - - + + virtual int loadExtensionProvider(const char* path, bool unload_after_use = false) = 0; abstract loadExtensionProvider( path: string, diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_playeffect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_playeffect.dita index 6f92de38bbf..95807658d11 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_playeffect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_playeffect.dita @@ -1,12 +1,12 @@ - <ph keyref="playEffect1" /> + <ph keyref="playEffect1"/> Plays the specified local or online audio effect file. - + @@ -26,48 +26,48 @@ pan:(double)pan gain:(NSInteger)gain; - - - - - -

    + + + + + +

    Details - -

    + +

    Parameters - - + + filePath -

    +

    - - + + - - + + - - + + - - + +

    -
    +
    - \ No newline at end of file + 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 1b04fbb0ef9..a140c6d0daf 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.

         @@ -65,17 +65,17 @@
      • All uppercase English letters: A to Z.
      • All numeric characters: 0 to 9.
      • Space
        • -
      • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
        • +
      • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

      - - + +
    - <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.
        @@ -84,4 +84,4 @@
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita index bf2cc99097e..c665b15c8d0 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_pushaudioframe2.dita @@ -21,12 +21,12 @@ channels:(NSInteger)channels trackId:(NSInteger)trackId timestamp:(NSTimeInterval)timestamp NS_SWIFT_NAME(pushExternalAudioFrameRawData(_:samples:sampleRate:channels:trackId:timestamp:)); - - - - - -

    + + + + + +

    Details 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 cb13450015b..3aff9269f23 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 532e8c7ddcc..8b9d50bb20c 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 @@

    public abstract boolean pushExternalVideoFrame(VideoFrame frame); - - - - - - -

    + + + + + + +

    Details -

    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.

    Parameters frame - 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 bd4f010f2dd..5855456247d 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);

    + Future<List<CodecCapInfo>> queryCodecCapability(int size);

    Details @@ -30,7 +30,7 @@
    v4.2.0
    -

    +

    Parameters @@ -38,37 +38,37 @@ codecInfo -

    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 7afadbb1bfd..a5c5c9bdd05 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 af70206c7a2..1d02bd7d0e5 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 feb57cf4a9a..2fd9148d87d 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_registerextension.dita b/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita index 30c1efbaead..c400e38efef 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_registerextension.dita @@ -13,8 +13,8 @@

    - - + + virtual int registerExtension(const char* provider, const char* extension, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0; abstract registerExtension( 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 70e5b021968..ae14605bec9 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_release.dita b/en-US/dita/RTC-NG/API/api_irtcengine_release.dita index f56aacaeeb6..8e5b55c30e7 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_release.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_release.dita @@ -1,12 +1,12 @@ - <ph keyref="release" /> - Releases the instance. + <ph keyref="release"/> + Releases the instance. - + @@ -26,17 +26,17 @@ abstract release(sync?: boolean): void; public abstract void Dispose(bool sync = false); abstract release(sync?: boolean): void; - Future<void> release({bool sync = false}); -

    + Future<void> release({bool sync = false}); +

    Details

    This method releases all resources used by the Agora SDK. Use this method for apps in which users occasionally make voice or video calls. When users do not make calls, you can free up resources for other operations.

    -

    After a successful method call, you can no longer use any method or callback in the SDK anymore. If you want to use the real-time communication functions again, you must call and to create a new instance.

    -

    After a successful method call, you can no longer use any method or callback in the SDK anymore. If you want to use the real-time communication functions again, you must call to create a new instance.

    +

    After a successful method call, you can no longer use any method or callback in the SDK anymore. If you want to use the real-time communication functions again, you must call and to create a new instance.

    +

    After a successful method call, you can no longer use any method or callback in the SDK anymore. If you want to use the real-time communication functions again, you must call to create a new instance.

      -
    • This method can be called synchronously. You need to wait for the resource of to be released before performing other operations (for example, create a new object). Therefore, Agora recommends calling this method in the child thread to avoid blocking the main thread.
      • -
    • Besides, Agora does not recommend you calling in any callback of the SDK. Otherwise, the SDK cannot release the resources until the callbacks return results, which may result in a deadlock.
    +
  • This method can be called synchronously. You need to wait for the resource of to be released before performing other operations (for example, create a new object). Therefore, Agora recommends calling this method in the child thread to avoid blocking the main thread.
    • +
  • Besides, Agora does not recommend you calling in any callback of the SDK. Otherwise, the SDK cannot release the resources until the callbacks return results, which may result in a deadlock.
    • Parameters @@ -45,10 +45,10 @@

    Whether the method is called synchronously:

      -
    • : Synchronous call.
      • -
    • : Asynchronous call. Currently this method only supports synchronous calls. Do not set this parameter to this value.
      • +
    • : Synchronous call.
      • +
    • : Asynchronous call. Currently this method only supports synchronous calls. Do not set this parameter to this value.
    -     \ 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 1d5ff941292..377d7e71c80 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 a2233e2ec6f..db84b53b771 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 . sourceType source_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 cd1b84e9283..3f63744d977 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 759d8d78c9f..87cbe321767 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_setcameraexposurefactor.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita index ab4472cf181..c3b51588482 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setcameraexposurefactor.dita @@ -17,7 +17,7 @@ - (CGFloat)setCameraExposureFactor:(CGFloat)exposureFactor NS_SWIFT_NAME(setCameraExposureFactor(_:)); virtual int setCameraExposureFactor(float factor) = 0; - + public abstract int SetCameraExposureFactor(float factor); abstract setCameraExposureFactor(factor: number): number; Future<void> setCameraExposureFactor(double factor); 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 e1a37166d64..1179f56b951 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.
    Deprecated:
    -
    Use instead.
    +
    Use instead.

    • @@ -59,8 +59,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(ERR_OK): Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita index d10f2b5fc1a..46af17733e2 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setclientrole.dita @@ -30,7 +30,7 @@
        Details

        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 5cfe8167aea..dbe107f97b5 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 80c45acc675..f2d5491b62f 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 @@ -48,7 +48,7 @@
  • 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 .
    • -
  • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • +
  • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • Parameters @@ -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 4084e253a7f..cf4a2f77dce 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 d7d24b05232..62e3821a2cd 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 835be9dd6a2..a420b8b61c8 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 56ad4f71422..1d7816d5df6 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 e16af742e02..bea0c1062b7 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 6ca21e715ec..e42bbe4b26d 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 354436e12c4..43c5e906b59 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 52a09fa51d5..382f44434f0 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 362e5a34877..0359b740d7e 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 340b1fe564e..436c98bb8a0 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_setlocalvoicechanger.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicechanger.dita index 00daa75ddc8..58f26c57227 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicechanger.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicechanger.dita @@ -16,7 +16,7 @@ public abstract int setLocalVoiceChanger(int voiceChanger); - (int) setLocalVoiceChanger:(AgoraAudioVoiceChanger)voiceChanger; virtual int setLocalVoiceChanger(VOICE_CHANGER_PRESET voiceChanger) = 0; - + public abstract int SetLocalVoiceChanger(VOICE_CHANGER_PRESET voiceChanger); diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverbpreset.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverbpreset.dita index ed0435ddadc..c019c376611 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverbpreset.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setlocalvoicereverbpreset.dita @@ -16,7 +16,7 @@ public abstract int setLocalVoiceReverbPreset(int reverbPreset); - (int) setLocalVoiceReverbPreset:(AgoraAudioReverbPreset)reverbPreset; virtual int setLocalVoiceReverbPreset(AUDIO_REVERB_PRESET reverbPreset) = 0; - + public abstract int SetLocalVoiceReverbPreset(AUDIO_REVERB_PRESET reverbPreset); 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 194df414a2a..eb5b49f5ce6 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 @@ -48,7 +48,7 @@
  • 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 .
    • -
  • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • +
  • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    • Parameters @@ -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_setremoterendermode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode.dita index 26220da8607..5c3f31e6177 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoterendermode.dita @@ -17,7 +17,7 @@ - (int)setRemoteRenderMode:(NSUInteger)uid mode:(AgoraVideoRenderMode) mode; virtual int setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode) = 0; - + public abstract int SetRemoteRenderMode(uint userId, RENDER_MODE_TYPE renderMode); diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserpriority.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserpriority.dita index 64321086e98..a227c2cf22d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserpriority.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setremoteuserpriority.dita @@ -14,9 +14,9 @@

    public abstract int setRemoteUserPriority(int uid, int userPriority); - + virtual int setRemoteUserPriority(uid_t uid, PRIORITY_TYPE userPriority) = 0; - + public abstract int SetRemoteUserPriority(uint uid, PRIORITY_TYPE userPriority);

    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 c83aecfc281..8f447d3fe1a 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_setrouteincommunicationmode.dita b/en-US/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita index c54dcf18edd..337b8b5022f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_setrouteincommunicationmode.dita @@ -14,9 +14,9 @@

    public abstract int setRouteInCommunicationMode(int route); - + virtual int setRouteInCommunicationMode(int route) = 0; - + public abstract int SetRouteInCommunicationMode(int route); abstract setRouteInCommunicationMode(route: number): number; Future<void> setRouteInCommunicationMode(int route);

    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 240ffaf0035..d79ce4737f5 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 abf5f1e479a..7f976c8b44e 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 @@ canvas local - 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 88595963864..34b3ebe145b 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 @@ canvas remote -

    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 9b16e756311..e2bd1d4e345 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,13 +42,13 @@

    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 video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
        • +
      • This method relies on the video enhancement dynamic library . If the dynamic library is deleted, the function cannot be enabled normally.
    Parameters @@ -57,25 +57,25 @@ enabled enable Whether 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 5b3f3047fd6..c44e8ee5653 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.
    Parameters config - 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 76e8d6f33d0..f059f059f6f 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)swapWidthAndHeight virtual 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_startaudiorecording.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita index 6852d4dbe39..be91f7d030a 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording.dita @@ -17,7 +17,7 @@ - (int)startAudioRecording:(NSString * _Nonnull)filePath quality:(AgoraAudioRecordingQuality)quality; virtual int startAudioRecording(const char* filePath, AUDIO_RECORDING_QUALITY_TYPE quality) = 0; - + public abstract int StartAudioRecording(string filePath, AUDIO_RECORDING_QUALITY_TYPE quality); diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording2.dita index d82d33d29bc..5221c92d6c9 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startaudiorecording2.dita @@ -13,8 +13,8 @@

    - - + + virtual int startAudioRecording(const char* filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality) = 0; 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 64405795936..3fe55ac3479 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.
     \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita index fac5545f581..a12efd298c8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startcameracapture.dita @@ -1,12 +1,12 @@ - <ph keyref="startCameraCapture" /> + <ph keyref="startCameraCapture"/> Starts camera capture. - + @@ -26,10 +26,10 @@ sourceType: VideoSourceType, config: CameraCapturerConfiguration ): number;     - Future<void> startCameraCapture( + Future<void> startCameraCapture( {required VideoSourceType sourceType, required CameraCapturerConfiguration config}); -

    +

    Details @@ -40,7 +40,7 @@

    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 f554f21fafc..7e0f909d14e 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 @@ channelMediaRelayConfiguration config configuration - 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 5e4840e581b..ac0eff4bd5b 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.

    Parameters @@ -65,11 +65,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_startechotest3.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startechotest3.dita index 610717b10b2..c2a8a6417fb 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 4681e3714ae..ec1ae30871c 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 @@ channelMediaRelayConfiguration config configuration - 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.
        @@ -70,4 +70,4 @@
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita index 49d2ca96f57..df2d1a9093f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startrhythmplayer.dita @@ -1,12 +1,12 @@ - <ph keyref="startRhythmPlayer" /> + <ph keyref="startRhythmPlayer"/> Enables the virtual metronome. - + @@ -28,42 +28,42 @@ sound2: string, config: AgoraRhythmPlayerConfig ): number;     - Future<void> startRhythmPlayer( + Future<void> startRhythmPlayer( {required String sound1, required String sound2, required AgoraRhythmPlayerConfig config}); -

    +

    Details

    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 .
    Parameters sound1 - 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.

    • 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_startrtmpstreamwithouttranscoding.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithouttranscoding.dita index 4b914ac1f32..e62522c4162 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithouttranscoding.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startrtmpstreamwithouttranscoding.dita @@ -1,12 +1,12 @@ - <ph keyref="startRtmpStreamWithoutTranscoding" /> + <ph keyref="startRtmpStreamWithoutTranscoding"/> Starts pushing media streams to a CDN without transcoding. - + @@ -20,22 +20,22 @@ public abstract int StartRtmpStreamWithoutTranscoding(string url); abstract startRtmpStreamWithoutTranscoding(url: string): number; Future<void> startRtmpStreamWithoutTranscoding(String url); -

    +

    Details

    Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

    You can call this method to push an audio or video stream to the specified CDN address. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times.

    -

    After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

    -
    +

    After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

    +
    Parameters - - + +
    -
    +
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita index 5b78fd8562a..acace31050f 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapture.dita @@ -1,12 +1,12 @@ - <ph keyref="startScreenCapture" /> + <ph keyref="startScreenCapture"/> Starts screen capture. - + @@ -22,32 +22,32 @@ abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number; public abstract int StartScreenCapture(ScreenCaptureParameters2 captureParams); abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number; - Future<void> startScreenCapture(ScreenCaptureParameters2 captureParams); -

    + Future<void> startScreenCapture(ScreenCaptureParameters2 captureParams); +

    Details

    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 @@ parameters screenCaptureParameters captureParams - 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 4351ddd9106..b3acaac3c5f 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).
    •      @@ -64,13 +64,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.
    -     \ 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 d3bdeac6302..0908210de2b 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.

    • 0: Success.
    • < 0: Failure.
        diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita index 9b06c582e4b..d846756b42d 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebyscreenrect.dita @@ -34,7 +34,7 @@ {required Rectangle screenRect, required Rectangle regionRect, required ScreenCaptureParameters captureParams}); -

        +

    Details @@ -65,8 +65,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_startscreencapturebywindowid.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita index 6c74606aa3e..58f2d07be9e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startscreencapturebywindowid.dita @@ -35,7 +35,7 @@ {required int windowId, required Rectangle regionRect, required ScreenCaptureParameters captureParams}); -

      +

    Details @@ -196,8 +196,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_startsecondarycustomaudiotrack.dita b/en-US/dita/RTC-NG/API/api_irtcengine_startsecondarycustomaudiotrack.dita index a597cc796f1..9aeb3710ac8 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_startsecondarycustomaudiotrack.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_startsecondarycustomaudiotrack.dita @@ -20,7 +20,7 @@ There are no corresponding names available -

      +

    Details diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita b/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita index fbf72ab0f91..b46888d7699 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita @@ -1,28 +1,28 @@ - <ph keyref="stateChanged" /> + <ph keyref="stateChanged"/> Occurs when the device state changes. - +

    - + - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine device:(NSString* _Nonnull)deviceId type:(AgoraMediaDeviceType)deviceType stateChanged:(NSInteger)state; - - - - - -

    + + + + + +

    Details
    @@ -31,7 +31,7 @@ engine - One object. + One object. deviceId @@ -40,7 +40,7 @@ deviceType -

    +

    @@ -55,4 +55,4 @@

    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel.dita b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel.dita index 3dd97c4638e..57968b41f0e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_switchchannel.dita @@ -16,11 +16,11 @@ public abstract int switchChannel(String token, String channelName); -(int)switchChannel:(NSString* _Nonnull)token channelName:(NSString* _Nonnull)channelName; virtual int switchChannel(const char* token, const char* channel) = 0; - - - - -

    + + + + +

    Details 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 968cf91cf25..4f419c0f36a 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. - +

    - - + + virtual int switchChannel(const char* token, const char* channelId, const ChannelMediaOptions& options) = 0; - + public abstract int SwitchChannel(string token, string channelId, ChannelMediaOptions options); - - -

    + + +

    Details

    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 @@
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • Space
    • -
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    • +
  • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

    •  options - The channel media options. See . + The channel media options. See .
    Returns
    • 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. This is probably because the user is not an audience member.
          • @@ -75,4 +75,4 @@
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita index 74bc073bab3..25c56c42613 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioencodedframeobserver.dita @@ -1,21 +1,21 @@ - <ph keyref="unregisterAudioEncodedFrameObserver" /> + <ph keyref="unregisterAudioEncodedFrameObserver"/> Unregisters the encoded audio frame observer. - +

    - - - + + + abstract unregisterAudioEncodedFrameObserver( observer: IAudioEncodedFrameObserver ): number; @@ -26,7 +26,7 @@ ): number; void unregisterAudioEncodedFrameObserver(AudioEncodedFrameObserver observer); -

    +

    Parameters @@ -38,12 +38,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_unregisteraudioframeobserver.dita b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita index 5561b357549..d7588032f0e 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_unregisteraudioframeobserver.dita @@ -13,10 +13,10 @@

    - - - - + + + + public abstract int UnRegisterAudioFrameObserver(); 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 341e28b20fd..9079b6d47d2 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:

      -
    1. Call this method, and set captureAudio to .
      2. -
    2. Call , and set publishScreenCaptureAudio to to publish the audio captured by the screen.
      3. +
    3. Call this method, and set captureAudio to .
      4. +
    4. 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 9a817e0cbbb..b43a79f1ce3 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 896e8791aca..af8ccc10121 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); -

        +

    Details @@ -47,8 +47,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_updatescreencaptureregion2.dita b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita index 244f2c06b6b..f7aaf5269f4 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengine_updatescreencaptureregion2.dita @@ -1,26 +1,26 @@ - <ph keyref="updateScreenCaptureRegion2" /> + <ph keyref="updateScreenCaptureRegion2"/> Updates the screen capturing region. - +

      - + - (int)updateScreenCaptureRegion:(CGRect)rect; virtual int updateScreenCaptureRegion(const Rect* rect) = 0; abstract updateScreenCaptureRegion(regionRect: Rectangle): number; public abstract int UpdateScreenCaptureRegion(Rectangle regionRect); - + Future<void> updateScreenCaptureRegion(Rectangle regionRect); -

      +

      Parameters @@ -28,15 +28,15 @@ rect regionRect - 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 2cf86168db9..1926b7219ae 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 b033808fc8a..18f12794ebf 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 . - - + + eventHandler delegate - 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_setdualstreammodeex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita index 7b0fb1c0049..f9a531c43a6 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setdualstreammodeex.dita @@ -1,12 +1,12 @@ - <ph keyref="setDualStreamModeEx" /> + <ph keyref="setDualStreamModeEx"/> Sets the dual-stream mode on the sender side. - + @@ -32,11 +32,11 @@ streamConfig: SimulcastStreamConfig, connection: RtcConnection ): number; - Future<void> setDualStreamModeEx( + Future<void> setDualStreamModeEx( {required SimulcastStreamMode mode, required SimulcastStreamConfig streamConfig, required RtcConnection connection}); -

    +

    Details @@ -46,10 +46,10 @@
    v4.0.1
    -

    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_setremotevideosubscriptionoptionsex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideosubscriptionoptionsex.dita index 3d5bb5054bb..1a0e7c10578 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideosubscriptionoptionsex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_setremotevideosubscriptionoptionsex.dita @@ -1,12 +1,12 @@ - <ph keyref="setRemoteVideoSubscriptionOptionsEx" /> + <ph keyref="setRemoteVideoSubscriptionOptionsEx"/> Options for subscribing to remote video streams. - + @@ -30,11 +30,11 @@ options: VideoSubscriptionOptions, connection: RtcConnection ): number; - Future<void> setRemoteVideoSubscriptionOptionsEx( + Future<void> setRemoteVideoSubscriptionOptionsEx( {required int uid, required VideoSubscriptionOptions options, required RtcConnection connection}); -

    +

    Details @@ -44,18 +44,18 @@ Parameters - - + + - - + + - - + +
    -
    +
    - \ 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 5975b307f28..2dc8b8161d6 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 01d4f31d67b..1ddbbe434ba 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 74af9bcb24a..b9d4e5e12c1 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 @@ channelMediaRelayConfiguration config configuration - 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 20723ed2831..c48db5d76e8 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 @@ channelMediaRelayConfiguration config configuration - 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_irtcengineex_startrtmpstreamwithouttranscodingex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_startrtmpstreamwithouttranscodingex.dita index 8240315eff3..bb54114d476 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_startrtmpstreamwithouttranscodingex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_startrtmpstreamwithouttranscodingex.dita @@ -1,12 +1,12 @@ - <ph keyref="startRtmpStreamWithoutTranscodingEx" /> + <ph keyref="startRtmpStreamWithoutTranscodingEx"/> Starts pushing media streams to a CDN without transcoding. - + @@ -26,7 +26,7 @@ url: string, connection: RtcConnection ): number;     - Future<void> startRtmpStreamWithoutTranscodingEx( + Future<void> startRtmpStreamWithoutTranscodingEx( {required String url, required RtcConnection connection});

    @@ -39,20 +39,20 @@

    Agora recommends that you use the server-side Media Push function. For details, see Use RESTful API.

    You can call this method to push an audio or video stream to the specified CDN address. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times.

    -

    After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

    -
    +

    After you call this method, the SDK triggers the callback on the local client to report the state of the streaming.

    +
    Parameters - - + + - - + +
    -
    +
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediaoptionsex.dita b/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediaoptionsex.dita index cabc1a65c75..42ed7b21165 100644 --- a/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediaoptionsex.dita +++ b/en-US/dita/RTC-NG/API/api_irtcengineex_updatechannelmediaoptionsex.dita @@ -30,7 +30,7 @@ Future<void> updateChannelMediaOptionsEx( {required ChannelMediaOptions options, required RtcConnection connection}); -

    +

    Parameters diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_enumeratevideodevices.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_enumeratevideodevices.dita index 31b7c7554a1..d3669d3f6db 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_enumeratevideodevices.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_enumeratevideodevices.dita @@ -20,7 +20,7 @@ public abstract DeviceInfo[] EnumerateVideoDevices(); abstract enumerateVideoDevices(): VideoDeviceInfo[]; List<VideoDeviceInfo> enumerateVideoDevices(); -

    +

    Details 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 3f0d78bcbd5..276bd773c9d 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/api_ivideodevicemanager_release.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_release.dita index 4ba4251a31c..955db733ea5 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_release.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_release.dita @@ -1,30 +1,30 @@ - <ph keyref="release_IVideoDeviceManager" /> - Releases all the resources occupied by the object. + <ph keyref="release_IVideoDeviceManager"/> + Releases all the resources occupied by the object. - +

    - - + + virtual void release() = 0; abstract release(): void; - + abstract release(): void; - Future<void> release(); -

    + Future<void> release(); +

    Details This method is for Windows and macOS only.
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita index 3999b1526fb..29df4a3a75e 100644 --- a/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita +++ b/en-US/dita/RTC-NG/API/api_ivideodevicemanager_setdevice.dita @@ -13,8 +13,8 @@

    - - + + virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; abstract setDevice(deviceIdUTF8: string): number; public abstract int SetDevice(string deviceIdUTF8); diff --git a/en-US/dita/RTC-NG/API/api_monitordevicechange.dita b/en-US/dita/RTC-NG/API/api_monitordevicechange.dita index f5f63b4d6da..ce445441e44 100644 --- a/en-US/dita/RTC-NG/API/api_monitordevicechange.dita +++ b/en-US/dita/RTC-NG/API/api_monitordevicechange.dita @@ -16,11 +16,11 @@ - (void)monitorDeviceChange:(BOOL)enabled; virtual int enableLoopbackRecording(bool enabled) = 0; - - - - -

    + + + + +

    Details diff --git a/en-US/dita/RTC-NG/API/api_rtcengineext_getassetabsolutepath.dita b/en-US/dita/RTC-NG/API/api_rtcengineext_getassetabsolutepath.dita index 6b7d3ca4622..962c5eac68b 100644 --- a/en-US/dita/RTC-NG/API/api_rtcengineext_getassetabsolutepath.dita +++ b/en-US/dita/RTC-NG/API/api_rtcengineext_getassetabsolutepath.dita @@ -19,14 +19,14 @@ Future<String?> getAssetAbsolutePath(String assetPath) -

    +

    Parameters assetPath - The flutter -> assets field configured in the pubspec.yaml file. + The flutter -> assets field configured in the pubspec.yaml file.
    diff --git a/en-US/dita/RTC-NG/API/callback_iaudioencodedframeobserver_onrecordaudioencodedframe.dita b/en-US/dita/RTC-NG/API/callback_iaudioencodedframeobserver_onrecordaudioencodedframe.dita index 7847d083b6d..9f5a700a2b7 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioencodedframeobserver_onrecordaudioencodedframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioencodedframeobserver_onrecordaudioencodedframe.dita @@ -18,7 +18,7 @@ - (void)onRecordEncodedAudioFrame:(NSData* _Nonnull)frameData info:(AgoraEncodedAudioFrameInfo* _Nonnull) info; - virtual void onRecordAudioEncodedFrame(const uint8_t* frameBuffer, int length, const EncodedAudioFrameInfo& audioEncodedFrameInfo) = 0; + virtual void onRecordAudioEncodedFrame(const uint8_t* frameBuffer, int length, const EncodedAudioFrameInfo& audioEncodedFrameInfo) = 0; onRecordAudioEncodedFrame?( frameBuffer: Uint8Array, length: number, diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita index 01c273e37e2..53c54d0cebe 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserver_onplaybackaudioframebeforemixing.dita @@ -17,7 +17,7 @@ int samplesPerChannel, int bytesPerSample, int channels, int samplesPerSec, ByteBuffer buffer, long renderTimeMs, int avsync_type); - (BOOL)onPlaybackAudioFrameBeforeMixing:(AgoraAudioFrame* _Nonnull)frame channelId:(NSString * _Nonnull)channelId uid:(NSUInteger)uid NS_SWIFT_NAME(onPlaybackAudioFrame(beforeMixing:channelId:uid:)); - virtual bool onPlaybackAudioFrameBeforeMixing(const char* channelId, rtc::uid_t uid, AudioFrame& audioFrame) = 0; + virtual bool onPlaybackAudioFrameBeforeMixing(const char* channelId, rtc::uid_t uid, AudioFrame& audioFrame) = 0; onPlaybackAudioFrameBeforeMixing?( channelId: string, uid: number, diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getmixedaudioparams.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getmixedaudioparams.dita index 3c7d92f8a32..43175e8755d 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getmixedaudioparams.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getmixedaudioparams.dita @@ -15,7 +15,7 @@

    public abstract AudioParams getMixedAudioParams(); - (AgoraAudioParams* _Nonnull)getMixedAudioParams NS_SWIFT_NAME(getMixedAudioParams()); - virtual AudioParams getMixedAudioParams() = 0; + virtual AudioParams getMixedAudioParams() = 0; public virtual AudioParams GetMixedAudioParams() { diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getobservedaudioframeposition.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getobservedaudioframeposition.dita index 0d86f209899..ed344d9568e 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getobservedaudioframeposition.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getobservedaudioframeposition.dita @@ -15,7 +15,7 @@

    - (AgoraAudioFramePosition)getObservedAudioFramePosition NS_SWIFT_NAME(getObservedAudioFramePosition()); - (AgoraAudioFramePosition)getObservedAudioFramePosition NS_SWIFT_NAME(getObservedAudioFramePosition()); - virtual int getObservedAudioFramePosition() = 0; + virtual int getObservedAudioFramePosition() = 0; public virtual int GetObservedAudioFramePosition() diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getplaybackaudioparams.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getplaybackaudioparams.dita index c40e44a4502..511bfa17c92 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getplaybackaudioparams.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getplaybackaudioparams.dita @@ -15,7 +15,7 @@

    public abstract AudioParams getMixedAudioParams(); - (AgoraAudioParams* _Nonnull)getPlaybackAudioParams NS_SWIFT_NAME(getPlaybackAudioParams()); - virtual AudioParams getPlaybackAudioParams() = 0; + virtual AudioParams getPlaybackAudioParams() = 0; public virtual AudioParams GetPlaybackAudioParams() { diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getrecordaudioparams.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getrecordaudioparams.dita index fc4a4771749..00efa2d44b9 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getrecordaudioparams.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_getrecordaudioparams.dita @@ -15,7 +15,7 @@

    public abstract AudioParams getRecordAudioParams(); - (AgoraAudioParams* _Nonnull)getRecordAudioParams NS_SWIFT_NAME(getRecordAudioParams()); - virtual AudioParams getRecordAudioParams() = 0; + virtual AudioParams getRecordAudioParams() = 0; public virtual AudioParams GetRecordAudioParams() { diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onearmonitoringaudioframe.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onearmonitoringaudioframe.dita index bef8a6554c9..c14320c25b7 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onearmonitoringaudioframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onearmonitoringaudioframe.dita @@ -19,7 +19,7 @@ - (BOOL)onEarMonitoringAudioFrame:(AgoraAudioFrame* _Nonnull)frame; - virtual bool onEarMonitoringAudioFrame(AudioFrame& audioFrame) = 0; + virtual bool onEarMonitoringAudioFrame(AudioFrame& audioFrame) = 0; onEarMonitoringAudioFrame?(audioFrame: AudioFrame): boolean; public virtual bool OnEarMonitoringAudioFrame(AudioFrame audioFrame) { diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onmixedaudioframe.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onmixedaudioframe.dita index 224b49792a2..3d0c8d99b0d 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onmixedaudioframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onmixedaudioframe.dita @@ -17,7 +17,7 @@ int channels, int samplesPerSec, ByteBuffer buffer, long renderTimeMs, int avsync_type); - (BOOL)onMixedAudioFrame:(AgoraAudioFrame* _Nonnull)frame channelId:(NSString * _Nonnull)channelId NS_SWIFT_NAME(onMixedAudioFrame(_:channelId:)); - virtual bool onMixedAudioFrame(const char* channelId, AudioFrame& audioFrame) = 0; + virtual bool onMixedAudioFrame(const char* channelId, AudioFrame& audioFrame) = 0; onMixedAudioFrame?(channelId: string, audioFrame: AudioFrame): boolean; public virtual bool OnMixedAudioFrame(string channelId, AudioFrame audio_frame) { diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onplaybackaudioframe.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onplaybackaudioframe.dita index 8dba7000518..1822935bce9 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onplaybackaudioframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onplaybackaudioframe.dita @@ -17,7 +17,7 @@ int channels, int samplesPerSec, ByteBuffer buffer, long renderTimeMs, int avsync_type); - (BOOL)onPlaybackAudioFrame:(AgoraAudioFrame* _Nonnull)frame; - virtual bool onPlaybackAudioFrame(const char* channelId, AudioFrame& audioFrame) = 0; + virtual bool onPlaybackAudioFrame(const char* channelId, AudioFrame& audioFrame) = 0; onPlaybackAudioFrame?(channelId: string, audioFrame: AudioFrame): boolean; public virtual bool OnPlaybackAudioFrame(string channelId, AudioFrame audio_frame) { diff --git a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onrecordaudioframe.dita b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onrecordaudioframe.dita index a2627b7bb19..413d335d554 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onrecordaudioframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudioframeobserverbase_onrecordaudioframe.dita @@ -17,7 +17,7 @@ int bytesPerSample, int channels, int samplesPerSec, ByteBuffer buffer, long renderTimeMs, int avsync_type); - (BOOL)onRecordAudioFrame:(AgoraAudioFrame* _Nonnull)frame channelId:(NSString * _Nonnull)channelId NS_SWIFT_NAME(onRecordAudioFrame(_:channelId:)); - virtual bool onRecordAudioFrame(const char* channelId, AudioFrame& audioFrame) = 0; + virtual bool onRecordAudioFrame(const char* channelId, AudioFrame& audioFrame) = 0; onRecordAudioFrame?(channelId: string, audioFrame: AudioFrame): boolean; public virtual bool OnRecordAudioFrame(string channelId, AudioFrame audioFrame) { diff --git a/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita b/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita index 4e808a7ab0e..fd2d9ace775 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudiopcmframesink_onframe.dita @@ -16,7 +16,7 @@ AudioFrame onFrame(AudioFrame frame); - (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit didReceiveAudioFrame:(AgoraAudioFrame* _Nonnull)audioFrame NS_SWIFT_NAME(AgoraRtcMediaPlayer(_:didReceiveAudioFrame:)); - virtual void onFrame(agora::media::base::AudioPcmFrame* frame) = 0; + virtual void onFrame(agora::media::base::AudioPcmFrame* frame) = 0; onFrame?(frame: AudioPcmFrame): void; public virtual bool OnFrame(AudioPcmFrame frame) { diff --git a/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita b/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita index 4943cd6dfcf..128b30fcac5 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onlocalaudiospectrum.dita @@ -16,7 +16,7 @@ boolean onLocalAudioSpectrum(AudioSpectrumInfo data); - (BOOL)onLocalAudioSpectrum:(NSArray<NSNumber *> * _Nullable)audioSpectrumData; - virtual bool onLocalAudioSpectrum(const AudioSpectrumData& data) = 0; + virtual bool onLocalAudioSpectrum(const AudioSpectrumData& data) = 0; onLocalAudioSpectrum?(data: AudioSpectrumData): boolean; public virtual bool OnLocalAudioSpectrum(AudioSpectrumData data) { diff --git a/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onremoteaudiospectrum.dita b/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onremoteaudiospectrum.dita index ade3b15f578..151a1f93798 100644 --- a/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onremoteaudiospectrum.dita +++ b/en-US/dita/RTC-NG/API/callback_iaudiospectrumobserver_onremoteaudiospectrum.dita @@ -17,7 +17,7 @@ - (BOOL)onRemoteAudioSpectrum:(NSArray<AgoraAudioSpectrumInfo *> * _Nullable)AudioSpectrumInfo; - virtual bool onRemoteAudioSpectrum(const UserAudioSpectrumInfo * spectrums, unsigned int spectrumNumber) = 0; + virtual bool onRemoteAudioSpectrum(const UserAudioSpectrumInfo * spectrums, unsigned int spectrumNumber) = 0; onRemoteAudioSpectrum?( spectrums: UserAudioSpectrumInfo[], spectrumNumber: number diff --git a/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstatechanged.dita b/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstatechanged.dita index d5c7f93ae23..5389dd5e79a 100644 --- a/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstatechanged.dita @@ -18,7 +18,7 @@ - (void)onDirectCdnStreamingStateChanged:(AgoraDirectCdnStreamingState)state error:(AgoraDirectCdnStreamingError)error message:(NSString *_Nullable)message; - virtual void onDirectCdnStreamingStateChanged(DIRECT_CDN_STREAMING_STATE state, DIRECT_CDN_STREAMING_ERROR error, const char* message) { + virtual void onDirectCdnStreamingStateChanged(DIRECT_CDN_STREAMING_STATE state, DIRECT_CDN_STREAMING_ERROR error, const char* message) { (void)state; (void)error; (void)message; diff --git a/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstats.dita b/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstats.dita index ad2d83e4d15..351670bf640 100644 --- a/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstats.dita +++ b/en-US/dita/RTC-NG/API/callback_idirectcdnstreamingeventhandler_ondirectcdnstreamingstats.dita @@ -15,7 +15,7 @@

    void onDirectCdnStreamingStats(DirectCdnStreamingStats stats); - (void)onDirectCdnStreamingStats:(AgoraDirectCdnStreamStats *_Nonnull)stats; - virtual void onDirectCdnStreamingStats(const DirectCdnStreamStats& stats) { + virtual void onDirectCdnStreamingStats(const DirectCdnStreamStats& stats) { (void)stats; }; onDirectCdnStreamingStats?(stats: DirectCdnStreamingStats): void; diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayeraudioframeobserver_onframe.dita b/en-US/dita/RTC-NG/API/callback_imediaplayeraudioframeobserver_onframe.dita index f89f48e0f9f..8ec05f54ab7 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayeraudioframeobserver_onframe.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayeraudioframeobserver_onframe.dita @@ -15,7 +15,7 @@

    - + onFrame?(frame: AudioPcmFrame): void; public virtual bool OnFrame(AudioPcmFrame frame) { diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onreaddata.dita b/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onreaddata.dita index 52da69a5023..4818b9aff1d 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onreaddata.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onreaddata.dita @@ -17,7 +17,7 @@ typedef int(^AgoraRtcMediaPlayerCustomSourceOnReadCallback)(id<AgoraRtcMediaPlayerProtocol> _Nonnull playerKit, unsigned char * _Nullable buffer, int bufferSize); - virtual int onReadData(unsigned char *buffer, int bufferSize) = 0; + virtual int onReadData(unsigned char *buffer, int bufferSize) = 0; public virtual int OnReadData(IntPtr bufferPtr, int bufferSize) diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onseek.dita b/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onseek.dita index 01d21289c88..1545fd04918 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onseek.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayercustomdataprovider_onseek.dita @@ -17,7 +17,7 @@ typedef long long(^AgoraRtcMediaPlayerCustomSourceOnSeekCallback)(id<AgoraRtcMediaPlayerProtocol> _Nonnull playerKit, long long offset, int whence); - virtual int64_t onSeek(int64_t offset, int whence) = 0; + virtual int64_t onSeek(int64_t offset, int whence) = 0; public virtual Int64 OnSeek(Int64 offset, int whence) diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onmetadata.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onmetadata.dita index b55d2fb993a..3ee33ce65fc 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onmetadata.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onmetadata.dita @@ -18,7 +18,7 @@ - (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit didReceiveData:(NSString *_Nullable)data length:(NSInteger)length; - virtual void onMetaData(const void* data, int length) = 0; + virtual void onMetaData(const void* data, int length) = 0; onMetaData?(data: Uint8Array, length: number): void; public virtual void OnMetaData(byte[] data, int length) { } onMetaData?(data: Uint8Array, length: number): void; diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita index 52079db70f0..437add5cfa1 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayerevent.dita @@ -20,7 +20,7 @@ elapsedTime:(NSInteger)elapsedTime message:(NSString *_Nullable)message; - virtual void onPlayerEvent(media::base::MEDIA_PLAYER_EVENT eventCode, int64_t elapsedTime, const char* message) = 0; + virtual void onPlayerEvent(media::base::MEDIA_PLAYER_EVENT eventCode, int64_t elapsedTime, const char* message) = 0; onPlayerEvent?( eventCode: MediaPlayerEvent, diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersourcestatechanged.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersourcestatechanged.dita index 25dc32864a1..6846bf91dee 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersourcestatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onplayersourcestatechanged.dita @@ -18,7 +18,7 @@ - (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit didChangedToState:(AgoraMediaPlayerState)state error:(AgoraMediaPlayerError)error NS_SWIFT_NAME(AgoraRtcMediaPlayer(_:didChangedTo:error:)); - virtual void onPlayerSourceStateChanged(media::base::MEDIA_PLAYER_STATE state, + virtual void onPlayerSourceStateChanged(media::base::MEDIA_PLAYER_STATE state, media::base::MEDIA_PLAYER_ERROR ec) = 0; onPlayerSourceStateChanged?( state: MediaPlayerState, diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita index 79c3e78f25d..b60e9edd78a 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpositionchanged.dita @@ -17,7 +17,7 @@ - (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit didChangedToPosition:(NSInteger)position NS_SWIFT_NAME(AgoraRtcMediaPlayer(_:didChangedTo:)); - virtual void onPositionChanged(int64_t position) = 0; + virtual void onPositionChanged(int64_t position) = 0; onPositionChanged?(positionMs: number): void; public virtual void OnPositionChanged(Int64 position_ms) { } onPositionChanged?(positionMs: number): void; diff --git a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita index e5d0215a647..8bf9fb6f907 100644 --- a/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita +++ b/en-US/dita/RTC-NG/API/callback_imediaplayersourceobserver_onpreloadevent.dita @@ -18,7 +18,7 @@ - (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit didPreloadEvent:(AgoraMediaPlayerPreloadEvent)event; - virtual void onPreloadEvent(const char* src, media::base::PLAYER_PRELOAD_EVENT event) = 0; + virtual void onPreloadEvent(const char* src, media::base::PLAYER_PRELOAD_EVENT event) = 0; onPreloadEvent?(src: string, event: PlayerPreloadEvent): void; public virtual void OnPreloadEvent(string src, PLAYER_PRELOAD_EVENT @event) { } diff --git a/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderinfoupdated.dita b/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderinfoupdated.dita index 59c1f12d8af..c3727a362bb 100644 --- a/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderinfoupdated.dita +++ b/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderinfoupdated.dita @@ -15,7 +15,7 @@

    void onRecorderInfoUpdated(String channelId, int uid, RecorderInfo info); - (void)mediaRecorder:(AgoraMediaRecorder* _Nonnull)recorder informationDidUpdated:(NSString * _Nonnull)channelId uid:(NSUInteger)uid info:(AgoraMediaRecorderInfo* _Nonnull)info; - virtual void onRecorderInfoUpdated(const char* channelId, rtc::uid_t uid, const RecorderInfo& info) = 0; + virtual void onRecorderInfoUpdated(const char* channelId, rtc::uid_t uid, const RecorderInfo& info) = 0; onRecorderInfoUpdated?( channelId: string, uid: number, diff --git a/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita b/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita index ed9bfe084fa..0773413c197 100644 --- a/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_imediarecorderobserver_onrecorderstatechanged.dita @@ -15,7 +15,7 @@

    void onRecorderStateChanged(String channelId, int uid, int state, int error); - (void)mediaRecorder:(AgoraMediaRecorder* _Nonnull)recorder stateDidChanged:(NSString * _Nonnull)channelId uid:(NSUInteger)uid state:(AgoraMediaRecorderState)state error:(AgoraMediaRecorderErrorCode)error; - virtual void onRecorderStateChanged(const char* channelId, rtc::uid_t uid, RecorderState state, RecorderErrorCode error) = 0; + virtual void onRecorderStateChanged(const char* channelId, rtc::uid_t uid, RecorderState state, RecorderErrorCode error) = 0; onRecorderStateChanged?( channelId: string, uid: number, diff --git a/en-US/dita/RTC-NG/API/callback_imetadataobserver_onmetadatareceived.dita b/en-US/dita/RTC-NG/API/callback_imetadataobserver_onmetadatareceived.dita index 3aacf96bde6..24047d7942e 100644 --- a/en-US/dita/RTC-NG/API/callback_imetadataobserver_onmetadatareceived.dita +++ b/en-US/dita/RTC-NG/API/callback_imetadataobserver_onmetadatareceived.dita @@ -16,7 +16,7 @@ public abstract void onMetadataReceived(byte[] buffer, int uid, long timeStampMs); - (void)receiveMetadata:(NSData * _Nonnull)data fromUser:(NSInteger)uid atTimestamp:(NSTimeInterval)timestamp; - virtual void onMetadataReceived(const Metadata &metadata) = 0; + virtual void onMetadataReceived(const Metadata &metadata) = 0; onMetadataReceived?(metadata: Metadata): void; public virtual void OnMetadataReceived(Metadata metadata) { diff --git a/en-US/dita/RTC-NG/API/callback_imetadataobserver_onreadytosendmetadata.dita b/en-US/dita/RTC-NG/API/callback_imetadataobserver_onreadytosendmetadata.dita index 44f8988aa08..6fa8567fc1b 100644 --- a/en-US/dita/RTC-NG/API/callback_imetadataobserver_onreadytosendmetadata.dita +++ b/en-US/dita/RTC-NG/API/callback_imetadataobserver_onreadytosendmetadata.dita @@ -16,7 +16,7 @@ public abstract byte[] onReadyToSendMetadata(long timeStampMs, int sourceType); - (NSData * _Nullable)readyToSendMetadataAtTimestamp:(NSTimeInterval)timestamp sourceType:(AgoraVideoSourceType)sourceType; - virtual bool onReadyToSendMetadata(Metadata &metadata, VIDEO_SOURCE_TYPE source_type) = 0; + virtual bool onReadyToSendMetadata(Metadata &metadata, VIDEO_SOURCE_TYPE source_type) = 0; public virtual bool OnReadyToSendMetadata(ref Metadata metadata, VIDEO_SOURCE_TYPE source_type) { diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onactivespeaker.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onactivespeaker.dita index 872175ae4c6..695d30ebbac 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onactivespeaker.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onactivespeaker.dita @@ -15,7 +15,7 @@

    public void onActiveSpeaker(int uid) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine activeSpeaker:(NSUInteger)speakerUid; - virtual void onActiveSpeaker(uid_t userId) { (void)userId; } + virtual void onActiveSpeaker(uid_t userId) { (void)userId; } onActiveSpeaker?(connection: RtcConnection, uid: number): void; public virtual void OnActiveSpeaker(RtcConnection connection, uint uid) { } onActiveSpeaker?(connection: RtcConnection, uid: number): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onapicallexecuted.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onapicallexecuted.dita index d478a7b00c7..52864c59c21 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onapicallexecuted.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onapicallexecuted.dita @@ -18,7 +18,7 @@ didApiCallExecute:(NSInteger)error api:(NSString * _Nonnull)api result:(NSString * _Nonnull)result; - virtual void onApiCallExecuted(int err, + virtual void onApiCallExecuted(int err, const char* api, const char* result) { (void)err; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicestatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicestatechanged.dita index 4a225e8bbed..8601474d353 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicestatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicestatechanged.dita @@ -15,7 +15,7 @@

    - virtual void onAudioDeviceStateChanged(const char* deviceId, + virtual void onAudioDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) { (void)deviceId; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicevolumechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicevolumechanged.dita index 28444bc5abd..7429452d0c7 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicevolumechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiodevicevolumechanged.dita @@ -15,7 +15,7 @@

    - virtual void onAudioDeviceVolumeChanged(MEDIA_DEVICE_TYPE deviceType, int volume, bool muted) { + virtual void onAudioDeviceVolumeChanged(MEDIA_DEVICE_TYPE deviceType, int volume, bool muted) { (void)deviceType; (void)volume; (void)muted; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingpositionchanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingpositionchanged.dita index ce0109968fc..9c09b13306b 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingpositionchanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingpositionchanged.dita @@ -15,7 +15,7 @@

    public void onAudioMixingPositionChanged(long position) {} - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine audioMixingPositionChanged:(NSInteger)position NS_SWIFT_NAME(rtcEngine(_:audioMixingPositionChanged:)); - virtual void onAudioMixingPositionChanged(int64_t position) {} + virtual void onAudioMixingPositionChanged(int64_t position) {} onAudioMixingPositionChanged?(position: number): void; public virtual void OnAudioMixingPositionChanged(long position) { } onAudioMixingPositionChanged?(position: number): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita index f5a12029c86..901b659e352 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiomixingstatechanged.dita @@ -16,7 +16,7 @@ public void onAudioMixingStateChanged(int state, int reasonCode); - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine audioMixingStateChanged:(AgoraAudioMixingStateType)state reasonCode:(AgoraAudioMixingReasonCode)reasonCode; - virtual void onAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_REASON_TYPE reason) { + virtual void onAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_REASON_TYPE reason) { (void)state; (void)reason; onAudioMixingStateChanged?( diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita index b6a64a3d96c..52b92d850c0 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiopublishstatechanged.dita @@ -20,7 +20,7 @@ oldState:(AgoraStreamPublishState)oldState newState:(AgoraStreamPublishState)newState elapseSinceLastState:(int)elapseSinceLastState; - virtual void onAudioPublishStateChanged(const char* channel, + virtual void onAudioPublishStateChanged(const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioquality.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioquality.dita index 7964dca2de5..b91f6ec27a4 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioquality.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioquality.dita @@ -15,7 +15,7 @@

    public void onAudioQuality(int uid, int quality, short delay, short lost) {} - (void)audioQualityBlock:(void (^_Nullable)(NSUInteger uid, AgoraNetworkQuality quality, NSUInteger delay, NSUInteger lost))audioQualityBlock - virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) { + virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) { (void)uid; (void)quality; (void)delay; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioroutingchanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioroutingchanged.dita index 65a9d06420e..73b91035f7f 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioroutingchanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudioroutingchanged.dita @@ -15,7 +15,7 @@

    public void onAudioRouteChanged(int routing) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didAudioRouteChanged:(AgoraAudioOutputRouting)routing; - virtual void onAudioRoutingChanged(int routing) { (void)routing; } + virtual void onAudioRoutingChanged(int routing) { (void)routing; } onAudioRoutingChanged?(routing: number): void; public virtual void OnAudioRoutingChanged(int routing) {} diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita index 7aaedac6d32..355232bf19d 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiosubscribestatechanged.dita @@ -21,7 +21,7 @@ oldState:(AgoraStreamSubscribeState)oldState newState:(AgoraStreamSubscribeState)newState elapseSinceLastState:(int)elapseSinceLastState; - virtual void onAudioSubscribeStateChanged(const char* channel, + virtual void onAudioSubscribeStateChanged(const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiovolumeindication.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiovolumeindication.dita index 26a0cedda89..0e62461e548 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiovolumeindication.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onaudiovolumeindication.dita @@ -17,7 +17,7 @@ - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine reportAudioVolumeIndicationOfSpeakers:(NSArray<AgoraRtcAudioVolumeInfo *> * _Nonnull)speakers totalVolume:(NSInteger)totalVolume; - virtual void onAudioVolumeIndication(const AudioVolumeInfo* speakers, + virtual void onAudioVolumeIndication(const AudioVolumeInfo* speakers, unsigned int speakerNumber, int totalVolume) { (void)speakers; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita index 33b53dc608f..0add9be84a0 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncameraexposureareachanged.dita @@ -15,7 +15,7 @@

    public void onCameraExposureAreaChanged(Rect rect) {} - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine cameraExposureDidChangedToRect:(CGRect)rect; - virtual void onCameraExposureAreaChanged(int x, int y, int width, int height) { + virtual void onCameraExposureAreaChanged(int x, int y, int width, int height) { (void)x; (void)y; (void)width; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita index f61c9323c96..c0cef9ddb68 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncamerafocusareachanged.dita @@ -15,7 +15,7 @@

    public void onCameraFocusAreaChanged(Rect rect) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine cameraFocusDidChangedToRect:(CGRect)rect; - virtual void onCameraFocusAreaChanged(int x, int y, int width, int height) { + virtual void onCameraFocusAreaChanged(int x, int y, int width, int height) { (void)x; (void)y; (void)width; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelayevent.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelayevent.dita index c4973cb74da..88958193b83 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelayevent.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelayevent.dita @@ -16,7 +16,7 @@ public void onChannelMediaRelayEvent(int code) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didReceiveChannelMediaRelayEvent:(AgoraChannelMediaRelayEvent)event; - virtual void onChannelMediaRelayEvent(int code) { + virtual void onChannelMediaRelayEvent(int code) { (void)code; } onChannelMediaRelayEvent?(code: ChannelMediaRelayEvent): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita index e27cc185ed1..4abc6405993 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onchannelmediarelaystatechanged.dita @@ -17,7 +17,7 @@ - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine channelMediaRelayStateDidChange:(AgoraChannelMediaRelayState)state error:(AgoraChannelMediaRelayError)error; - virtual void onChannelMediaRelayStateChanged(CHANNEL_MEDIA_RELAY_STATE state,CHANNEL_MEDIA_RELAY_ERROR code) { + virtual void onChannelMediaRelayStateChanged(CHANNEL_MEDIA_RELAY_STATE state,CHANNEL_MEDIA_RELAY_ERROR code) { } onChannelMediaRelayStateChanged?( state: ChannelMediaRelayState, diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita index 0427bba625c..bd005dab010 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechanged.dita @@ -11,7 +11,7 @@ - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didClientRoleChanged:(AgoraClientRole)oldRole newRole:(AgoraClientRole)newRole newRoleOptions:(AgoraClientRoleOptions * _Nullable)newRoleOptions NS_SWIFT_NAME(rtcEngine(_:didClientRoleChanged:newRole:newRoleOptions:)); - virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions& newRoleOptions) { + virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions& newRoleOptions) { (void)oldRole; (void)newRole; (void)newRoleOptions; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita index 6ed744c8753..eaeb1bd2ce9 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onclientrolechangefailed.dita @@ -15,7 +15,7 @@

    public void onClientRoleChangeFailed(int reason, int currentRole) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didClientRoleChangeFailed:(AgoraClientRoleChangeFailedReason)reason currentRole:(AgoraClientRole)currentRole; - virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole) { + virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole) { (void)reason; (void)currentRole; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionbanned.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionbanned.dita index c8930125ec0..5f3efbb6085 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionbanned.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionbanned.dita @@ -15,7 +15,7 @@

    public void onConnectionBanned() {} - (void)rtcEngineConnectionDidBanned:(AgoraRtcEngineKit * _Nonnull)engine; - virtual void onConnectionBanned() + virtual void onConnectionBanned() onConnectionBanned?(connection: RtcConnection): void; public virtual void OnConnectionBanned(RtcConnection connection) {} onConnectionBanned?(connection: RtcConnection): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectioninterrupted.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectioninterrupted.dita index 021c02dbdf9..b0b17a2b68c 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectioninterrupted.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectioninterrupted.dita @@ -15,7 +15,7 @@

    public void onConnectionInterrupted() {} - (void)rtcEngineConnectionDidInterrupted:(AgoraRtcEngineKit * _Nonnull)engine; - virtual void onConnectionInterrupted() {} + virtual void onConnectionInterrupted() {} onConnectionInterrupted?(connection: RtcConnection): void; public virtual void OnConnectionInterrupted(RtcConnection connection) {} onConnectionInterrupted?(connection: RtcConnection): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionlost.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionlost.dita index 95c2d0fbc69..2ed371285e7 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionlost.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionlost.dita @@ -15,7 +15,7 @@

    public void onConnectionLost() {} - (void)rtcEngineConnectionDidLost:(AgoraRtcEngineKit * _Nonnull)engine; - virtual void onConnectionLost() + virtual void onConnectionLost() onConnectionLost?(connection: RtcConnection): void; public virtual void OnConnectionLost(RtcConnection connection) {} onConnectionLost?(connection: RtcConnection): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita index 5ec58de3755..9f56dfe9b32 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onconnectionstatechanged.dita @@ -17,7 +17,7 @@ - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine connectionStateChanged:(AgoraConnectionState)state reason:(AgoraConnectionChangedReason)reason; - virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) { + virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) { (void)state; (void)reason; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncontentinspectresult.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncontentinspectresult.dita index 376ee662939..9f8f6247217 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncontentinspectresult.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_oncontentinspectresult.dita @@ -17,7 +17,7 @@ - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine contentInspectResult:(AgoraContentInspectResult)result; - virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result) { (void)result; } + virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result) { (void)result; } onContentInspectResult?(result: ContentInspectResult): void; public virtual void OnContentInspectResult(CONTENT_INSPECT_RESULT result) onContentInspectResult?(result: ContentInspectResult): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita index 6d3bf12aa07..6b2ec755a68 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onencryptionerror.dita @@ -16,7 +16,7 @@ public void onEncryptionError(int errorType) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didOccurEncryptionError:(AgoraEncryptionErrorType)errorType; - virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType) { + virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType) { (void)errorType; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita index 934682d3331..138b0a5f1a3 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onerror.dita @@ -17,7 +17,7 @@ - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didOccurError:(AgoraErrorCode)errorCode; - virtual void onError(int err, const char* msg) { + virtual void onError(int err, const char* msg) { (void)err; (void)msg; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionevent.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionevent.dita index 45923a30c18..81bac1494ab 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionevent.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionevent.dita @@ -20,7 +20,7 @@ value:(NSString * __nullable)value; @end - virtual void onExtensionEvent(const char* provider, const char* extension, const char* key, const char* value) { + virtual void onExtensionEvent(const char* provider, const char* extension, const char* key, const char* value) { (void)provider; (void)extension; (void)key; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionstarted.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionstarted.dita index bab6ad0ca77..774e00c3b49 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionstarted.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onextensionstarted.dita @@ -17,7 +17,7 @@ - (void)onExtensionStarted:(NSString * __nullable)provider extension:(NSString * __nullable)extension; - virtual void onExtensionStarted(const char* provider, const char* extension) { + virtual void onExtensionStarted(const char* provider, const char* extension) { (void)provider; (void)extension; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita index d25429e1225..b80e8035fe7 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfacepositionchanged.dita @@ -16,7 +16,7 @@ public void onFacePositionChanged( int imageWidth, int imageHeight, AgoraFacePositionInfo[] faceRectArr) {} - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine facePositionDidChangeWidth:(int)width previewHeight:(int)height faces:(NSArray<AgoraFacePositionInfo*>* _Nullable)faces NS_SWIFT_NAME(rtcEngine(_:facePositionDidChangeWidth:previewHeight:faces:)); - virtual void onFacePositionChanged(int imageWidth, int imageHeight, + virtual void onFacePositionChanged(int imageWidth, int imageHeight, const Rectangle* vecRectangle, const int* vecDistance, int numFaces) { (void) imageWidth; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalaudioframepublished.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalaudioframepublished.dita index 3b5cf97b344..942eb841d38 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalaudioframepublished.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalaudioframepublished.dita @@ -15,7 +15,7 @@

    public void onFirstLocalAudioFramePublished(int elapsed) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstLocalAudioFramePublished:(NSInteger)elapsed; - virtual void onFirstLocalAudioFramePublished(int elapsed) { + virtual void onFirstLocalAudioFramePublished(int elapsed) { (void)elapsed; } onFirstLocalAudioFramePublished?( diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita index 9ae8c8bc896..7ef3bddc10d 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframe.dita @@ -21,7 +21,7 @@ elapsed:(NSInteger)elapsed sourceType:(AgoraVideoSourceType)sourceType; - virtual void onFirstLocalVideoFrame(VIDEO_SOURCE_TYPE source, int width, int height, int elapsed) { + virtual void onFirstLocalVideoFrame(VIDEO_SOURCE_TYPE source, int width, int height, int elapsed) { (void)source; (void)width; (void)height; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframepublished.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframepublished.dita index 93da417f32c..22123687ca7 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframepublished.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstlocalvideoframepublished.dita @@ -19,7 +19,7 @@ firstLocalVideoFramePublishedWithElapsed:(NSInteger)elapsed sourceType:(AgoraVideoSourceType)sourceType; - virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed) { + virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed) { (void)source; (void)elapsed; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremoteaudiodecoded.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremoteaudiodecoded.dita index 601bbc9acf0..b17054c9763 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremoteaudiodecoded.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremoteaudiodecoded.dita @@ -18,7 +18,7 @@ - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine firstRemoteAudioFrameDecodedOfUid:(NSUInteger)uid elapsed:(NSInteger)elapsed; - virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) { + virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) { (void)uid; (void)elapsed; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremoteaudioframe.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremoteaudioframe.dita index b2d9f1588f4..790bcf73ba7 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremoteaudioframe.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremoteaudioframe.dita @@ -18,7 +18,7 @@ - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine firstRemoteAudioFrameOfUid:(NSUInteger)uid elapsed:(NSInteger)elapsed NS_SWIFT_NAME(rtcEngine(_:firstRemoteAudioFrameOfUid:elapsed:)); - virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) AGORA_DEPRECATED_ATTRIBUTE { + virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) AGORA_DEPRECATED_ATTRIBUTE { (void)uid; (void)elapsed; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideodecoded.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideodecoded.dita index 1dbcde8771f..3e8af94c28d 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideodecoded.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideodecoded.dita @@ -16,7 +16,7 @@ public void onFirstRemoteVideoDecoded(int uid, int width, int height, int elapsed) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstRemoteVideoDecodedOfUid:(NSUInteger)uid size:(CGSize)size elapsed:(NSInteger)elapsed; - virtual void onFirstRemoteVideoDecoded(uid_t uid, + virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) { diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita index e5f206babb2..fa844882514 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita @@ -16,7 +16,7 @@ public void onFirstRemoteVideoFrame(int uid, int width, int height, int elapsed) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine firstRemoteVideoFrameOfUid:(NSUInteger)uid size:(CGSize)size elapsed:(NSInteger)elapsed; - virtual void onFirstRemoteVideoFrame(uid_t userId, int width, int height, int elapsed) { + virtual void onFirstRemoteVideoFrame(uid_t userId, int width, int height, int elapsed) { (void)userId; (void)width; (void)height; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita index 573d24fec8d..d500adf45a5 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onjoinchannelsuccess.dita @@ -16,7 +16,7 @@ public void onJoinChannelSuccess(String channel, int uid, int elapsed) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didJoinChannel:(NSString * _Nonnull)channel withUid:(NSUInteger)uid elapsed:(NSInteger) elapsed; - virtual void onJoinChannelSuccess(const char* channel, + virtual void onJoinChannelSuccess(const char* channel, uid_t uid, int elapsed) { (void)channel; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita index e88c918b759..43175fccb3b 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlastmilequality.dita @@ -15,7 +15,7 @@

    public void onLastmileQuality(int quality) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine lastmileQuality:(AgoraNetworkQuality)quality; - virtual void onLastmileQuality(int quality) { + virtual void onLastmileQuality(int quality) { (void)quality; } onLastmileQuality?(quality: QualityType): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita index 2e16b972394..8c76c470a54 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onleavechannel.dita @@ -16,7 +16,7 @@ public void onLeaveChannel(RtcStats stats) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didLeaveChannelWithStats:(AgoraChannelStats * _Nonnull)stats; - virtual void onLeaveChannel(const RtcStats& stats) { + virtual void onLeaveChannel(const RtcStats& stats) { (void)stats; } onLeaveChannel?(connection: RtcConnection, stats: RtcStats): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita index 4a45e129e81..618d2df92fa 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostatechanged.dita @@ -17,7 +17,7 @@ public void onLocalAudioStateChanged(int state, int error) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine localAudioStateChanged:(AgoraAudioLocalState)state error:(AgoraAudioLocalError)error; - virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error) { + virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error) { (void)state; (void)error; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostats.dita index b9ce15c7ab4..c3308ca360a 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalaudiostats.dita @@ -16,7 +16,7 @@ public void onLocalAudioStats(LocalAudioStats stats) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine localAudioStats:(AgoraRtcLocalAudioStats * _Nonnull)stats; - virtual void onLocalAudioStats(const LocalAudioStats& stats) { + virtual void onLocalAudioStats(const LocalAudioStats& stats) { (void)stats; } onLocalAudioStats?(connection: RtcConnection, stats: LocalAudioStats): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita index 59d3c140a40..3d101d2f71c 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostatechanged.dita @@ -22,7 +22,7 @@ error:(AgoraLocalVideoStreamError)error sourceType:(AgoraVideoSourceType)sourceType; - virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR error) { + virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR error) { (void)source; (void)state; (void)error; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostats.dita index 425e6d47bad..1e43f65c9dc 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideostats.dita @@ -19,7 +19,7 @@ localVideoStats:(AgoraRtcLocalVideoStats * _Nonnull)stats sourceType:(AgoraVideoSourceType)sourceType; - virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats& stats) { + virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats& stats) { (void)source; (void)stats; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita index b43003e87d5..e6d0e009900 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onlocalvideotranscodererror.dita @@ -17,7 +17,7 @@ LocalTranscoderConfiguration.TranscodingVideoStream stream, int error) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didLocalVideoTranscoderErrorWithStream:(AgoraTranscodingVideoStream * _Nonnull )stream errorCode:(AgoraVideoTranscoderError)errorCode NS_SWIFT_NAME(rtcEngine(_:didLocalVideoTranscoderErrorWithStream:errorCode:)); - virtual void onLocalVideoTranscoderError(const TranscodingVideoStream& stream, VIDEO_TRANSCODER_ERROR error){ + virtual void onLocalVideoTranscoderError(const TranscodingVideoStream& stream, VIDEO_TRANSCODER_ERROR error){ (void)stream; (void)error; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita index 27f7ff28e3b..b16d0596261 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworkquality.dita @@ -18,7 +18,7 @@ networkQuality:(NSUInteger)uid txQuality:(AgoraNetworkQuality)txQuality rxQuality:(AgoraNetworkQuality)rxQuality; - virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality) { + virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality) { (void)uid; (void)txQuality; (void)rxQuality; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworktypechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworktypechanged.dita index 77f57f45e8f..66ae0470320 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworktypechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onnetworktypechanged.dita @@ -15,7 +15,7 @@

    public void onNetworkTypeChanged(int type) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine networkTypeChanged:(AgoraNetworkType)type; - virtual void onNetworkTypeChanged(NETWORK_TYPE type) { + virtual void onNetworkTypeChanged(NETWORK_TYPE type) { (void)type; } onNetworkTypeChanged?(connection: RtcConnection, type: NetworkType): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita index 2e20b88e329..5b456631a09 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onpermissionerror.dita @@ -15,7 +15,7 @@

    public void onPermissionError(int permission) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine permissionError:(AgoraPermissionType)type; - virtual void onPermissionError(PERMISSION_TYPE permissionType) { + virtual void onPermissionError(PERMISSION_TYPE permissionType) { (void)permissionType; } onPermissionError?(permissionType: PermissionType): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita index fe7d799511b..b0665ff29a6 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onproxyconnected.dita @@ -16,7 +16,7 @@ public void onProxyConnected( String channel, int uid, int proxyType, String localProxyIp, int elapsed) {} - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine didProxyConnected:(NSString* _Nonnull)channel withUid:(NSUInteger)uid proxyType:(AgoraProxyType)proxyType localProxyIp:(NSString* _Nonnull)localProxyIp elapsed:(NSInteger)elapsed NS_SWIFT_NAME(rtcEngine(_:didProxyConnected:withUid:proxyType:localProxyIp:elapsed:)); - virtual void onProxyConnected(const char* channel, uid_t uid, PROXY_TYPE proxyType, const char* localProxyIp, int elapsed) { + virtual void onProxyConnected(const char* channel, uid_t uid, PROXY_TYPE proxyType, const char* localProxyIp, int elapsed) { (void)channel; (void)uid; (void)proxyType; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita index 4e67cb5d06e..5b794ee85df 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrejoinchannelsuccess.dita @@ -16,7 +16,7 @@ public void onRejoinChannelSuccess(String channel, int uid, int elapsed) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didRejoinChannel:(NSString * _Nonnull)channel withUid:(NSUInteger)uid elapsed:(NSInteger) elapsed; - virtual void onRejoinChannelSuccess(const char* channel, uid_t uid, int elapsed) { + virtual void onRejoinChannelSuccess(const char* channel, uid_t uid, int elapsed) { (void)channel; (void)uid; (void)elapsed; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita index 15664166f08..2f79b21c0f7 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostatechanged.dita @@ -16,7 +16,7 @@ public void onRemoteAudioStateChanged(int uid, int state, int reason, int elapsed) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine remoteAudioStateChangedOfUid:(NSUInteger)uid state:(AgoraAudioRemoteState)state reason:(AgoraAudioRemoteReason)reason elapsed:(NSInteger)elapsed; - virtual void onRemoteAudioStateChanged(uid_t uid, + virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) { diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostats.dita index ee85ed09753..cde395a1dbc 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiostats.dita @@ -16,7 +16,7 @@ public void onRemoteAudioStats(RemoteAudioStats stats) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine remoteAudioStats:(AgoraRtcRemoteAudioStats * _Nonnull)stats; - virtual void onRemoteAudioStats(const RemoteAudioStats& stats) { + virtual void onRemoteAudioStats(const RemoteAudioStats& stats) { (void)stats; } onRemoteAudioStats?(connection: RtcConnection, stats: RemoteAudioStats): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiotransportstats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiotransportstats.dita index 9d7ef0ea635..0d206bda813 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiotransportstats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremoteaudiotransportstats.dita @@ -19,7 +19,7 @@ delay:(NSUInteger)delay lost:(NSUInteger)lost rxKBitRate:(NSUInteger)rxKBitRate; - virtual void onRemoteAudioTransportStats(uid_t uid, + virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) { diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita index c6abb27bcef..81e0ad76344 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostatechanged.dita @@ -16,7 +16,7 @@ public void onRemoteVideoStateChanged(int uid, int state, int reason, int elapsed) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine remoteVideoStateChangedOfUid:(NSUInteger)uid state:(AgoraVideoRemoteState)state reason:(AgoraVideoRemoteReason)reason elapsed:(NSInteger)elapsed; - virtual void onRemoteVideoStateChanged(uid_t uid, + virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) { diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostats.dita index 4f4333a8f30..a83b6465851 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideostats.dita @@ -16,7 +16,7 @@ public void onRemoteVideoStats(RemoteVideoStats stats) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine remoteVideoStats:(AgoraRtcRemoteVideoStats * _Nonnull)stats; - virtual void onRemoteVideoStats(const RemoteVideoStats& stats) { + virtual void onRemoteVideoStats(const RemoteVideoStats& stats) { (void)stats; } onRemoteVideoStats?(connection: RtcConnection, stats: RemoteVideoStats): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideotransportstats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideotransportstats.dita index e6c8a8af98a..02b32c2c270 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideotransportstats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onremotevideotransportstats.dita @@ -19,7 +19,7 @@ delay:(NSUInteger)delay lost:(NSUInteger)lost rxKBitRate:(NSUInteger)rxKBitRate; - virtual void onRemoteVideoTransportStats(uid_t uid, + virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) { diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrequesttoken.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrequesttoken.dita index aedaf448a41..d838837a629 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrequesttoken.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrequesttoken.dita @@ -15,7 +15,7 @@

    public void onRequestToken() {} - (void)rtcEngineRequestToken:(AgoraRtcEngineKit * _Nonnull)engine; - virtual void onRequestToken() + virtual void onRequestToken() onRequestToken?(connection: RtcConnection): void; public virtual void OnRequestToken(RtcConnection connection) {} onRequestToken?(connection: RtcConnection): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrhythmplayerstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrhythmplayerstatechanged.dita index dce601b17e0..fd3829c8a5a 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrhythmplayerstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrhythmplayerstatechanged.dita @@ -16,7 +16,7 @@ public void onRhythmPlayerStateChanged(int state, int errorCode) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didRhythmPlayerStateChanged:(AgoraRhythmPlayerState)state errorCode:(AgoraRhythmPlayerError)errorCode NS_SWIFT_NAME(rtcEngine(_:didRhythmPlayerStateChanged:errorCode:)); - virtual void onRhythmPlayerStateChanged(RHYTHM_PLAYER_STATE_TYPE state, RHYTHM_PLAYER_ERROR_TYPE errorCode) { + virtual void onRhythmPlayerStateChanged(RHYTHM_PLAYER_STATE_TYPE state, RHYTHM_PLAYER_ERROR_TYPE errorCode) { (void)state; (void)errorCode; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtcstats.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtcstats.dita index 789bb6fa173..8fc5b623f77 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtcstats.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtcstats.dita @@ -16,7 +16,7 @@ public void onRtcStats(RtcStats stats) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine reportRtcStats:(AgoraChannelStats * _Nonnull)stats; - virtual void onRtcStats(const RtcStats& stats) { + virtual void onRtcStats(const RtcStats& stats) { (void)stats; } onRtcStats?(connection: RtcConnection, stats: RtcStats): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita index ca176be64c3..89be875c4b3 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingevent.dita @@ -15,7 +15,7 @@

    public void onRtmpStreamingEvent(String url, int event) {} - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine rtmpStreamingEventWithUrl:(NSString* _Nonnull)url eventCode:(AgoraRtmpStreamingEvent)eventCode; - virtual void onRtmpStreamingEvent(const char* url, RTMP_STREAMING_EVENT eventCode) { + virtual void onRtmpStreamingEvent(const char* url, RTMP_STREAMING_EVENT eventCode) { (void)url; (void)eventCode; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita index 63f7c745eda..392d670e7ab 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onrtmpstreamingstatechanged.dita @@ -15,7 +15,7 @@

    public void onRtmpStreamingStateChanged(String url, int state, int errCode) {} - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine rtmpStreamingChangedToState:(NSString* _Nonnull)url state:(AgoraRtmpStreamingState)state errCode:(AgoraRtmpStreamingErrorCode)errCode; - virtual void onRtmpStreamingStateChanged(const char* url, RTMP_STREAM_PUBLISH_STATE state, + virtual void onRtmpStreamingStateChanged(const char* url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR_TYPE errCode) { (void)url; (void)state; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onsnapshottaken.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onsnapshottaken.dita index c0a838e4383..f595c8fdc9f 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onsnapshottaken.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onsnapshottaken.dita @@ -15,7 +15,7 @@

    public void onSnapshotTaken(int uid, String filePath, int width, int height, int errCode) {} - (void)rtcEngine:(AgoraRtcEngineKit* _Nonnull)engine snapshotTaken:(NSUInteger)uid filePath:(NSString* _Nonnull)filePath width:(NSInteger)width height:(NSInteger)height errCode:(NSInteger)errCode; - virtual void onSnapshotTaken(uid_t uid, const char* filePath, int width, int height, int errCode) { + virtual void onSnapshotTaken(uid_t uid, const char* filePath, int width, int height, int errCode) { (void)uid; (void)filePath; (void)width; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita index d744babac84..9f5125f39b4 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessage.dita @@ -18,7 +18,7 @@ receiveStreamMessageFromUid:(NSUInteger)uid streamId:(NSInteger)streamId data:(NSData * _Nonnull)data; - virtual void onStreamMessage(uid_t userId, int streamId, const char* data, size_t length, uint64_t sentTs) { + virtual void onStreamMessage(uid_t userId, int streamId, const char* data, size_t length, uint64_t sentTs) { (void)userId; (void)streamId; (void)data; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessageerror.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessageerror.dita index a19b9450dd9..7a644837a9a 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessageerror.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreammessageerror.dita @@ -20,7 +20,7 @@ error:(NSInteger)error missed:(NSInteger)missed cached:(NSInteger)cached; - virtual void onStreamMessageError(uid_t userId, int streamId, int code, int missed, int cached) { + virtual void onStreamMessageError(uid_t userId, int streamId, int code, int missed, int cached) { (void)userId; (void)streamId; (void)code; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreampublished.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreampublished.dita index 05d3876b829..aad668c5387 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreampublished.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onstreampublished.dita @@ -17,7 +17,7 @@ - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine streamPublishedWithUrl:(NSString * _Nonnull)url errorCode:(AgoraErrorCode)errorCode; - virtual void onStreamPublished(const char *url, int error) { + virtual void onStreamPublished(const char *url, int error) { (void)url; (void)error; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_ontokenprivilegewillexpire.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_ontokenprivilegewillexpire.dita index 556ba7bf585..766ef22756f 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_ontokenprivilegewillexpire.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_ontokenprivilegewillexpire.dita @@ -16,7 +16,7 @@ public void onTokenPrivilegeWillExpire(String token) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine tokenPrivilegeWillExpire:(NSString *_Nonnull)token; - virtual void onTokenPrivilegeWillExpire(const char* token) { + virtual void onTokenPrivilegeWillExpire(const char* token) { (void)token; } onTokenPrivilegeWillExpire?(connection: RtcConnection, token: string): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuplinknetworkinfoupdated.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuplinknetworkinfoupdated.dita index 7f04aeab4ba..f5474d2bf08 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuplinknetworkinfoupdated.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuplinknetworkinfoupdated.dita @@ -16,7 +16,7 @@ public void onUplinkNetworkInfoUpdated(UplinkNetworkInfo info) {} - (void)rtcEngine:(AgoraRtcEngineKit *_Nonnull)engine uplinkNetworkInfoUpdate:(AgoraUplinkNetworkInfo *_Nonnull)networkInfo; - virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo& info) { + virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo& info) { (void)info; } onUplinkNetworkInfoUpdated?(info: UplinkNetworkInfo): void; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablelocalvideo.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablelocalvideo.dita index a54bb7524bc..7825cbd0205 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablelocalvideo.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablelocalvideo.dita @@ -17,7 +17,7 @@ - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didLocalVideoEnabled:(BOOL)enabled byUid:(NSUInteger)uid - virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) { + virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) { (void)uid; (void)enabled; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita index 7bab9eb5b50..65c889ac544 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserenablevideo.dita @@ -17,7 +17,7 @@ - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didVideoEnabled:(BOOL)enabled byUid:(NSUInteger)uid - virtual void onUserEnableVideo(uid_t uid, bool enabled) { + virtual void onUserEnableVideo(uid_t uid, bool enabled) { (void)uid; (void)enabled; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserinfoupdated.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserinfoupdated.dita index f7e0e759599..e40899a6e17 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserinfoupdated.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserinfoupdated.dita @@ -15,7 +15,7 @@

    public void onUserInfoUpdated(int uid, UserInfo userInfo) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didUserInfoUpdatedWithUserId:(NSUInteger)uid userInfo:(AgoraUserInfo* _Nonnull)userInfo; - virtual void onUserInfoUpdated(uid_t uid, const UserInfo& info) { + virtual void onUserInfoUpdated(uid_t uid, const UserInfo& info) { (void)uid; (void)info; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita index 394bd25300b..3111f873550 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita @@ -9,7 +9,7 @@ public void onUserJoined(int uid, int elapsed) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didJoinedOfUid:(NSUInteger)uid elapsed:(NSInteger)elapsed; - virtual void onUserJoined(uid_t uid, int elapsed) { + virtual void onUserJoined(uid_t uid, int elapsed) { (void)uid; (void)elapsed; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermuteaudio.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermuteaudio.dita index 0a1d6ba7f0c..4e52bef2419 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermuteaudio.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermuteaudio.dita @@ -15,7 +15,7 @@

    public void onUserMuteAudio(int uid, boolean muted) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didAudioMuted:(BOOL)muted byUid:(NSUInteger)uid; - virtual void onUserMuteAudio(uid_t uid, bool muted) { + virtual void onUserMuteAudio(uid_t uid, bool muted) { (void)uid; (void)muted; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita index 472c8918f5a..f625fcab4e1 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onusermutevideo.dita @@ -15,7 +15,7 @@

    public void onUserMuteVideo(int uid, boolean muted) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didVideoMuted:(BOOL)muted byUid:(NSUInteger)uid - virtual void onUserMuteVideo(uid_t uid, bool muted) { + virtual void onUserMuteVideo(uid_t uid, bool muted) { (void)uid; (void)muted; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita index ef5d105f7a9..f9c1d675462 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuseroffline.dita @@ -17,7 +17,7 @@ - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didOfflineOfUid:(NSUInteger)uid reason:(AgoraUserOfflineReason)reason; - virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason) { + virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason) { (void)uid; (void)reason; } diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideodevicestatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideodevicestatechanged.dita index 2003a6a9c98..55efdc96f88 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideodevicestatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideodevicestatechanged.dita @@ -15,7 +15,7 @@

    - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine device:(NSString * _Nonnull)deviceId type:(AgoraMediaDeviceType)deviceType stateChanged:(NSInteger)state NS_SWIFT_NAME(rtcEngine(_:device:type:stateChanged:)); - virtual void onVideoDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) { + virtual void onVideoDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) { (void)deviceId; (void)deviceType; (void)deviceState; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideopublishstatechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideopublishstatechanged.dita index b3e8848e421..3b59aafa1e7 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideopublishstatechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideopublishstatechanged.dita @@ -22,7 +22,7 @@ newState:(AgoraStreamPublishState)newState elapseSinceLastState:(int)elapseSinceLastState; - virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { + virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { (void)source; (void)channel; (void)oldState; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideorenderingtracingresult.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideorenderingtracingresult.dita index 848ecba2773..42096443be3 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideorenderingtracingresult.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideorenderingtracingresult.dita @@ -16,7 +16,7 @@ public void onVideoRenderingTracingResult(int uid, Constants.MEDIA_RENDER_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine videoRenderingTracingResultOfUid:(NSUInteger)uid currentEvent:(AgoraMediaRenderTraceEvent)currentEvent tracingInfo:(AgoraVideoRenderingTracingInfo * _Nonnull)tracingInfo NS_SWIFT_NAME(rtcEngine(_:videoRenderingTracingResultOfUid:currentEvent:tracingInfo:)); - virtual void onVideoRenderingTracingResult(uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo) { + virtual void onVideoRenderingTracingResult(uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo) { (void)uid; (void)currentEvent; (void)tracingInfo; diff --git a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosizechanged.dita b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosizechanged.dita index 9a64a30cc60..3696a8def1a 100644 --- a/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosizechanged.dita +++ b/en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onvideosizechanged.dita @@ -16,7 +16,7 @@ public void onVideoSizeChanged( Constants.VideoSourceType source, int uid, int width, int height, int rotation) {} - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine videoSizeChangedOfSourceType:(AgoraVideoSourceType)sourceType uid:(NSString * _Nonnull)uid size:(CGSize)size rotation:(NSInteger)rotation NS_SWIFT_NAME(rtcEngine(_:videoSizeChangedOf:uid:size:rotation:)); - virtual void onVideoSizeChanged(VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation) { + virtual void onVideoSizeChanged(VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation) { (void)uid; (void)width; (void)height; diff --git a/en-US/dita/RTC-NG/API/callback_ivideoencodedframeobserver_onencodedvideoframereceived.dita b/en-US/dita/RTC-NG/API/callback_ivideoencodedframeobserver_onencodedvideoframereceived.dita index 8e8c7d6e371..caa080d5dfb 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoencodedframeobserver_onencodedvideoframereceived.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoencodedframeobserver_onencodedvideoframereceived.dita @@ -15,7 +15,7 @@

    boolean onEncodedVideoFrameReceived(ByteBuffer buffer, EncodedVideoFrameInfo info); - (BOOL)onEncodedVideoFrameReceived:(NSData * _Nonnull )videoData length:(size_t)length info:(AgoraEncodedVideoFrameInfo * _Nonnull)videoFrameInfo NS_SWIFT_NAME(onEncodedVideoFrameReceived(_:length:info:)); - virtual bool onEncodedVideoFrameReceived(rtc::uid_t uid, const uint8_t* imageBuffer, size_t length, + virtual bool onEncodedVideoFrameReceived(rtc::uid_t uid, const uint8_t* imageBuffer, size_t length, const rtc::EncodedVideoFrameInfo& videoEncodedFrameInfo) = 0; onEncodedVideoFrameReceived?( uid: number, diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getmirrorapplied.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getmirrorapplied.dita index 8fa8045a6a6..413746f0346 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getmirrorapplied.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getmirrorapplied.dita @@ -15,7 +15,7 @@

    boolean getMirrorApplied(); - (BOOL)getMirrorApplied; - virtual bool getMirrorApplied() { return false; } + virtual bool getMirrorApplied() { return false; } diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getobservedframeposition.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getobservedframeposition.dita index 2eee26eda55..3a52b60c5f6 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getobservedframeposition.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getobservedframeposition.dita @@ -15,7 +15,7 @@

    int getObservedFramePosition(); - (unsigned int)getObservedFramePosition; - virtual uint32_t getObservedFramePosition() { + virtual uint32_t getObservedFramePosition() { return base::POSITION_POST_CAPTURER | base::POSITION_PRE_RENDERER; } diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getrotationapplied.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getrotationapplied.dita index a7c51a85454..2a16059ab12 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getrotationapplied.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getrotationapplied.dita @@ -15,7 +15,7 @@

    boolean getRotationApplied(); - (BOOL)getRotationApplied; - virtual bool getRotationApplied() { return false; } + virtual bool getRotationApplied() { return false; } diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita index a73c149badc..b8078a714d4 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_getvideoformatpreference.dita @@ -17,7 +17,7 @@ - (AgoraVideoFormat)getVideoFormatPreference; - virtual VIDEO_PIXEL_FORMAT getVideoFormatPreference() { return VIDEO_PIXEL_DEFAULT; } + virtual VIDEO_PIXEL_FORMAT getVideoFormatPreference() { return VIDEO_PIXEL_DEFAULT; } public virtual VIDEO_OBSERVER_FRAME_TYPE GetVideoFormatPreference() { @@ -32,7 +32,7 @@ If you want the video captured by the sender to be the original format, set the original video data format to in the return value. The original video pixel format varies based on different platforms. For the actual video pixel format, see .

    Returns -

    Sets the video format. See .

    +

    Sets the video format. See .

    According to different observation locations and collection scenarios, the actual video pixel format corresponding to this enumeration value is different. Agora recommends that you do not use this value. Some common situations are listed below.

    diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_oncapturevideoframe.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_oncapturevideoframe.dita index 73763bbc2f1..6b72409377d 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_oncapturevideoframe.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_oncapturevideoframe.dita @@ -15,7 +15,7 @@

    boolean onCaptureVideoFrame(int sourceType, VideoFrame videoFrame); - (BOOL)onCaptureVideoFrame:(AgoraOutputVideoFrame * _Nonnull)videoFrame sourceType:(AgoraVideoSourceType)sourceType; - virtual bool onCaptureVideoFrame(agora::rtc::VIDEO_SOURCE_TYPE sourceType, VideoFrame& videoFrame) = 0; + virtual bool onCaptureVideoFrame(agora::rtc::VIDEO_SOURCE_TYPE sourceType, VideoFrame& videoFrame) = 0; onCaptureVideoFrame?( sourceType: VideoSourceType, videoFrame: VideoFrame diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onframe.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onframe.dita index aa4eef52a77..d45749ea8d1 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onframe.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onframe.dita @@ -16,7 +16,7 @@ void onFrame(VideoFrame frame); - (void)AgoraRtcMediaPlayer:(id<AgoraRtcMediaPlayerProtocol> _Nonnull)playerKit didReceiveVideoFrame:(CVPixelBufferRef _Nonnull)pixelBuffer; - virtual void onFrame(const VideoFrame* frame) = 0; + virtual void onFrame(const VideoFrame* frame) = 0; public virtual bool OnFrame(VideoFrame audioFrame, VideoFrameBufferConfig config) { diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onmediaplayervideoframe.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onmediaplayervideoframe.dita index 90bd94f3042..5deedd2a85b 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onmediaplayervideoframe.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onmediaplayervideoframe.dita @@ -15,7 +15,7 @@

    boolean onMediaPlayerVideoFrame(VideoFrame videoFrame, int mediaPlayerId); - (BOOL)onMediaPlayerVideoFrame:(AgoraOutputVideoFrame * _Nonnull)videoFrame mediaPlayerId:(NSInteger)mediaPlayerId; - virtual bool onMediaPlayerVideoFrame(VideoFrame& videoFrame, int mediaPlayerId) = 0; + virtual bool onMediaPlayerVideoFrame(VideoFrame& videoFrame, int mediaPlayerId) = 0; onMediaPlayerVideoFrame?( videoFrame: VideoFrame, mediaPlayerId: number diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onpreencodescreenvideoframe.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onpreencodescreenvideoframe.dita index 0d7b3c15dbf..61fd2c319c1 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onpreencodescreenvideoframe.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onpreencodescreenvideoframe.dita @@ -15,7 +15,7 @@

    boolean onPreEncodeScreenVideoFrame(VideoFrame videoFrame); - (BOOL)onPreEncodeScreenVideoFrame:(AgoraOutputVideoFrame * _Nonnull)videoFrame; - virtual bool onPreEncodeScreenVideoFrame(VideoFrame& videoFrame) = 0; + virtual bool onPreEncodeScreenVideoFrame(VideoFrame& videoFrame) = 0; onPreEncodeScreenVideoFrame?(videoFrame: VideoFrame): boolean; diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onpreencodevideoframe.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onpreencodevideoframe.dita index d0fce7bade3..a43676acdf4 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onpreencodevideoframe.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onpreencodevideoframe.dita @@ -15,7 +15,7 @@

    boolean onPreEncodeVideoFrame(int sourceType, VideoFrame videoFrame); - (BOOL)onPreEncodeVideoFrame:(AgoraOutputVideoFrame * _Nonnull)videoFrame sourceType:(AgoraVideoSourceType)sourceType; - virtual bool onPreEncodeVideoFrame(agora::rtc::VIDEO_SOURCE_TYPE sourceType, VideoFrame& videoFrame) = 0; + virtual bool onPreEncodeVideoFrame(agora::rtc::VIDEO_SOURCE_TYPE sourceType, VideoFrame& videoFrame) = 0; onPreEncodeVideoFrame?(videoFrame: VideoFrame): boolean; public virtual bool OnPreEncodeVideoFrame(VIDEO_SOURCE_TYPE sourceType, VideoFrame videoFrame) onPreEncodeVideoFrame?(videoFrame: VideoFrame): boolean; diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onrendervideoframe.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onrendervideoframe.dita index 98f8bd08141..2b734874238 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onrendervideoframe.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onrendervideoframe.dita @@ -17,7 +17,7 @@ - (BOOL)onRenderVideoFrame:(AgoraOutputVideoFrame * _Nonnull)videoFrame uid:(NSUInteger)uid channelId:(NSString * _Nonnull)channelId; - virtual bool onRenderVideoFrame(const char* channelId, rtc::uid_t remoteUid, VideoFrame& videoFrame) = 0; + virtual bool onRenderVideoFrame(const char* channelId, rtc::uid_t remoteUid, VideoFrame& videoFrame) = 0; onRenderVideoFrame?( channelId: string, remoteUid: number, diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onscreencapturevideoframe.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onscreencapturevideoframe.dita index cba144aa4ea..27f79cbf649 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onscreencapturevideoframe.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onscreencapturevideoframe.dita @@ -15,7 +15,7 @@

    boolean onScreenCaptureVideoFrame(VideoFrame videoFrame); - (BOOL)onScreenCaptureVideoFrame:(AgoraOutputVideoFrame * _Nonnull)videoFrame; - virtual bool onScreenCaptureVideoFrame(VideoFrame& videoFrame) = 0; + virtual bool onScreenCaptureVideoFrame(VideoFrame& videoFrame) = 0; onScreenCaptureVideoFrame?(videoFrame: VideoFrame): boolean; onScreenCaptureVideoFrame?(videoFrame: VideoFrame): boolean; diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onsecondarypreencodecameravideoframe.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onsecondarypreencodecameravideoframe.dita index 8526f6989dc..07ccb246edc 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onsecondarypreencodecameravideoframe.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onsecondarypreencodecameravideoframe.dita @@ -15,7 +15,7 @@

    - virtual bool onSecondaryPreEncodeCameraVideoFrame(VideoFrame& videoFrame) = 0; + virtual bool onSecondaryPreEncodeCameraVideoFrame(VideoFrame& videoFrame) = 0; onSecondaryPreEncodeCameraVideoFrame?(videoFrame: VideoFrame): boolean; onSecondaryPreEncodeCameraVideoFrame?(videoFrame: VideoFrame): boolean; diff --git a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onsecondarypreencodescreenvideoframe.dita b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onsecondarypreencodescreenvideoframe.dita index ad2949732d4..039bc6b2673 100644 --- a/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onsecondarypreencodescreenvideoframe.dita +++ b/en-US/dita/RTC-NG/API/callback_ivideoframeobserver_onsecondarypreencodescreenvideoframe.dita @@ -15,7 +15,7 @@

    - virtual bool onSecondaryPreEncodeScreenVideoFrame(VideoFrame& videoFrame) = 0; + virtual bool onSecondaryPreEncodeScreenVideoFrame(VideoFrame& videoFrame) = 0; onSecondaryPreEncodeScreenVideoFrame?(videoFrame: VideoFrame): boolean; onSecondaryPreEncodeScreenVideoFrame?(videoFrame: VideoFrame): boolean; diff --git a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita index 48f3597553f..5e938362dc7 100644 --- a/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_Localaccesspointconfiguration.dita @@ -1,8 +1,9 @@ - <ph keyref="LocalAccessPointConfiguration" /> - The configurations of the Local Access Point. + <ph keyref="LocalAccessPointConfiguration"/> + The configurations of the Local Access Point.

    @@ -59,8 +60,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; @@ -146,13 +147,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; @@ -166,15 +167,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); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> ipList @@ -199,17 +200,17 @@ mode -

    The connection mode. See .

    +

    The connection mode. See .

    Select one of the following connection modes:

      -
    • (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 0dc3b8188c3..9bdc1a2e617 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 8e884f6f6d3..9293da4048f 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.
        • Sample interval (sec) = samplePerCall/(sampleRate × channel).
        • Ensure that the sample interval ≥ 0.01 (s).
    - <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_audiopcmframe.dita b/en-US/dita/RTC-NG/API/class_audiopcmframe.dita index 2b5f283aa3f..24473786c4a 100644 --- a/en-US/dita/RTC-NG/API/class_audiopcmframe.dita +++ b/en-US/dita/RTC-NG/API/class_audiopcmframe.dita @@ -80,14 +80,14 @@ final BytesPerSample? bytesPerSample; @JsonKey(name: 'data_') - final List<int>? data; + final List<int>? data; - factory AudioPcmFrame.fromJson(Map<String, dynamic> json) => + factory AudioPcmFrame.fromJson(Map<String, dynamic> json) => _$AudioPcmFrameFromJson(json); - Map<String, dynamic> toJson() => _$AudioPcmFrameToJson(this); + Map<String, dynamic> toJson() => _$AudioPcmFrameToJson(this); } -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> diff --git a/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita b/en-US/dita/RTC-NG/API/class_audiorecordingconfiguration.dita index b694d999d95..039b4d298c6 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_audiotrackconfig.dita b/en-US/dita/RTC-NG/API/class_audiotrackconfig.dita index 9403c246cbb..2e980524f6e 100644 --- a/en-US/dita/RTC-NG/API/class_audiotrackconfig.dita +++ b/en-US/dita/RTC-NG/API/class_audiotrackconfig.dita @@ -53,12 +53,12 @@ class AudioTrackConfig { @JsonKey(name: 'enableLocalPlayback') final bool? enableLocalPlayback; - factory AudioTrackConfig.fromJson(Map<String, dynamic> json) => + factory AudioTrackConfig.fromJson(Map<String, dynamic> json) => _$AudioTrackConfigFromJson(json); - Map<String, dynamic> toJson() => _$AudioTrackConfigToJson(this); + Map<String, dynamic> toJson() => _$AudioTrackConfigToJson(this); } -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -66,8 +66,8 @@ class AudioTrackConfig { enableLocalPlayback Whether to enable the local audio-playback device:
      -
    • : (Default) Enable the local audio-playback device.
      • -
    • : Do not enable the local audio-playback device.
      • +
    • : (Default) Enable the local audio-playback device.
      • +
    • : Do not enable the local audio-playback device.
         diff --git a/en-US/dita/RTC-NG/API/class_audiovolumeinfo.dita b/en-US/dita/RTC-NG/API/class_audiovolumeinfo.dita index 0a33d4f694b..f611cf6b051 100644 --- a/en-US/dita/RTC-NG/API/class_audiovolumeinfo.dita +++ b/en-US/dita/RTC-NG/API/class_audiovolumeinfo.dita @@ -84,7 +84,7 @@ _$AudioVolumeInfoFromJson(json); Map<String, dynamic> toJson() => _$AudioVolumeInfoToJson(this); } -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -100,7 +100,7 @@ volume - The volume of the user. The value ranges between 0 (the lowest volume) and 255 (the highest volume). If the local user enables audio capturing and calls and set it as to mute, the value of volume indicates the volume of locally captured audio signal. If the user calls , the value of volume indicates the volume after audio mixing. + The volume of the user. The value ranges between 0 (the lowest volume) and 255 (the highest volume). If the local user enables audio capturing and calls and set it as to mute, the value of volume indicates the volume of locally captured audio signal. If the user calls , the value of volume indicates the volume after audio mixing. vad diff --git a/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita b/en-US/dita/RTC-NG/API/class_cameracapturerconfiguration.dita index e6bf23088b4..7ade3f6bc97 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 . format captureFormat - The format of the video frame. See . + The format of the video frame. See . deviceId This 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 95fe49b0845..fa0acf721d0 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"/> publishCameraTrack Whether 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.
         publishSecondaryCameraTrack Whether 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.
         publishMicrophoneTrack Whether 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 .
         publishThirdCameraTrack Whether 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.

         publishFourthCameraTrack Whether 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 { publishSecondaryScreenTrack Whether 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.
         publishThirdScreenTrack Whether 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 { publishFourthScreenTrack Whether 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 { publishTranscodedVideoTrack Whether 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 { publishCustomAudioTrack Whether 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.

         publishCustomVideoTrack Whether 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.
         publishEncodedVideoTrack Whether 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.
         publishMediaPlayerAudioTrack Whether 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.
         publishMediaPlayerVideoTrack Whether 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.
         autoSubscribeAudio Whether 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.
         autoSubscribeVideo Whether 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.
         enableAudioRecordingOrPlayout Whether 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,8 +681,8 @@ class ChannelMediaOptions { publishCustomAudioTrackAec Whether 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.
         @@ -691,48 +691,48 @@ class ChannelMediaOptions {

    (Optional) The token generated on your server for authentication. See Authenticate Your Users with Token.

      -
    • 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.
         startPreview Whether 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.
         publishRhythmPlayerTrack Whether 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.
         isInteractiveAudience Whether 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. isAudioFilterable Whether 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 0cec8673f65..32d206bfbf4 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); } -

    +

    Method setSrcChannelInfo - 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"/> srcInfo sourceInfo -

    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 @@ destInfos destinationInfos -

        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_climaxsegment.dita b/en-US/dita/RTC-NG/API/class_climaxsegment.dita index 93a8da6689e..3f12248bd5b 100644 --- a/en-US/dita/RTC-NG/API/class_climaxsegment.dita +++ b/en-US/dita/RTC-NG/API/class_climaxsegment.dita @@ -1,7 +1,7 @@ - <ph keyref="ClimaxSegment" /> + <ph keyref="ClimaxSegment"/> The climax parts of the music.
    @@ -57,12 +57,12 @@ @JsonKey(name: 'endTimeMs') final int? endTimeMs; - factory ClimaxSegment.fromJson(Map<String, dynamic> json) => + factory ClimaxSegment.fromJson(Map<String, dynamic> json) => _$ClimaxSegmentFromJson(json); - Map<String, dynamic> toJson() => _$ClimaxSegmentToJson(this); + Map<String, dynamic> toJson() => _$ClimaxSegmentToJson(this); } -

    +

    @@ -73,7 +73,7 @@
    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> startTimeMs @@ -85,4 +85,4 @@
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_codeccapinfo.dita b/en-US/dita/RTC-NG/API/class_codeccapinfo.dita index e23d6c97366..0db7da8ee6a 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 b120ee0a9bf..02291a389e8 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 970de4ab592..a5b8be949a4 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 8a60baa53b3..d960e0a4cec 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.

    @@ -56,25 +56,25 @@ final ContentInspectType? type; @JsonKey(name: 'interval') final int? interval; - factory ContentInspectModule.fromJson(Map<String, dynamic> json) => + factory ContentInspectModule.fromJson(Map<String, dynamic> json) => _$ContentInspectModuleFromJson(json); - Map<String, dynamic> toJson() => _$ContentInspectModuleToJson(this); + Map<String, dynamic> toJson() => _$ContentInspectModuleToJson(this); } -

    +

    - <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.
      • -
    • (1): Video content moderation. SDK takes screenshots, inspects video content of the video stream in the channel, and uploads the screenshots and moderation results.
      • -
    • (2): Video screenshot and upload via Agora self-developed extension. SDK takes screenshots of the video stream in the channel and uploads them.
      • -
    • (3): Video screenshot and upload via extensions from Agora Extensions Marketplace. SDK uses video moderation extensions from Agora Extensions Marketplace to take screenshots of the video stream in the channel and uploads them.
      • +
    • (0): (Default) This module has no actual function. Do not set to this value.
      • +
    • (1): Video content moderation. SDK takes screenshots, inspects video content of the video stream in the channel, and uploads the screenshots and moderation results.
      • +
    • (2): Video screenshot and upload via Agora self-developed extension. SDK takes screenshots of the video stream in the channel and uploads them.
      • +
    • (3): Video screenshot and upload via extensions from Agora Extensions Marketplace. SDK uses video moderation extensions from Agora Extensions Marketplace to take screenshots of the video stream in the channel and uploads them.

         @@ -84,4 +84,4 @@
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_deviceinfo.dita b/en-US/dita/RTC-NG/API/class_deviceinfo.dita index 311310e6fd5..023df7f2f0f 100644 --- a/en-US/dita/RTC-NG/API/class_deviceinfo.dita +++ b/en-US/dita/RTC-NG/API/class_deviceinfo.dita @@ -41,7 +41,7 @@ _$DeviceInfoFromJson(json); Map<String, dynamic> toJson() => _$DeviceInfoToJson(this); } -

    +

    This class is for Android only.
    @@ -57,4 +57,4 @@
    - \ 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 92398399c9f..2a41579dba4 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_echotestconfiguration.dita b/en-US/dita/RTC-NG/API/class_echotestconfiguration.dita index 04a8e183ffc..649ea486452 100644 --- a/en-US/dita/RTC-NG/API/class_echotestconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_echotestconfiguration.dita @@ -129,19 +129,19 @@ class EchoTestConfiguration { @JsonKey(name: 'intervalInSeconds') final int? intervalInSeconds; - factory EchoTestConfiguration.fromJson(Map<String, dynamic> json) => + factory EchoTestConfiguration.fromJson(Map<String, dynamic> json) => _$EchoTestConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$EchoTestConfigurationToJson(this); + Map<String, dynamic> toJson() => _$EchoTestConfigurationToJson(this); } -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> view - The view used to render the local user's video. This parameter is only applicable to scenarios testing video devices, that is, when enableVideo is . + The view used to render the local user's video. This parameter is only applicable to scenarios testing video devices, that is, when enableVideo is . enableAudio @@ -159,7 +159,7 @@ class EchoTestConfiguration { token - The token used to secure the audio and video call loop test. If you do not enable App Certificate in Agora Console, you do not need to pass a value in this parameter; if you have enabled App Certificate in Agora Console, you must pass a token in this parameter; the uid used when you generate the token must be 0xFFFFFFFF, and the channel name used must be the channel name that identifies each audio and video call loop tested. For server-side token generation, see . + The token used to secure the audio and video call loop test. If you do not enable App Certificate in Agora Console, you do not need to pass a value in this parameter; if you have enabled App Certificate in Agora Console, you must pass a token in this parameter; the uid used when you generate the token must be 0xFFFFFFFF, and the channel name used must be the channel name that identifies each audio and video call loop tested. For server-side token generation, see . channelId @@ -171,4 +171,4 @@ class EchoTestConfiguration {
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita b/en-US/dita/RTC-NG/API/class_encodedvideoframeinfo.dita index 5604f09a505..ea4f912a7bb 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 @@ codecType The 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 811b3e69def..0a05a41985f 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_iaudiopcmframesink.dita b/en-US/dita/RTC-NG/API/class_iaudiopcmframesink.dita index 2f66ad243e8..42762d671d0 100644 --- a/en-US/dita/RTC-NG/API/class_iaudiopcmframesink.dita +++ b/en-US/dita/RTC-NG/API/class_iaudiopcmframesink.dita @@ -1,12 +1,12 @@ - <ph keyref="IAudioPcmFrameSink" /> + <ph keyref="IAudioPcmFrameSink"/> This class is used to get raw PCM audio. This protocol is used to get raw audio data.
    -

    You can inherit this class and implement the callback to get raw PCM audio.

    -

    You can get raw audio data through the callback under this protocol.

    +

    You can inherit this class and implement the callback to get raw PCM audio.

    +

    You can get raw audio data through the callback under this protocol.

     -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_imagetrackoptions.dita b/en-US/dita/RTC-NG/API/class_imagetrackoptions.dita index 87f7dfb1917..e5c57cbc0dc 100644 --- a/en-US/dita/RTC-NG/API/class_imagetrackoptions.dita +++ b/en-US/dita/RTC-NG/API/class_imagetrackoptions.dita @@ -58,12 +58,12 @@ @JsonKey(name: 'fps') final int? fps; - factory ImageTrackOptions.fromJson(Map<String, dynamic> json) => + factory ImageTrackOptions.fromJson(Map<String, dynamic> json) => _$ImageTrackOptionsFromJson(json); - Map<String, dynamic> toJson() => _$ImageTrackOptionsToJson(this); + Map<String, dynamic> toJson() => _$ImageTrackOptionsToJson(this); }     -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -79,4 +79,4 @@
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_imediarecorder.dita b/en-US/dita/RTC-NG/API/class_imediarecorder.dita index d469a16dba9..fc67c6e525a 100644 --- a/en-US/dita/RTC-NG/API/class_imediarecorder.dita +++ b/en-US/dita/RTC-NG/API/class_imediarecorder.dita @@ -1,6 +1,6 @@ - <ph keyref="IMediaRecorder" /> + <ph keyref="IMediaRecorder"/> This class provides APIs for local and remote recording. - \ 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 452d88bb0fc..31ad3643074 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_ivideodevicemanager.dita b/en-US/dita/RTC-NG/API/class_ivideodevicemanager.dita index f8f97c6193d..e77daf3927b 100644 --- a/en-US/dita/RTC-NG/API/class_ivideodevicemanager.dita +++ b/en-US/dita/RTC-NG/API/class_ivideodevicemanager.dita @@ -5,7 +5,7 @@ Video device management methods.
    -

    provides methods related to video device testing. You can call the method to get the interface.

    +

    provides methods related to video device testing. You can call the method to get the interface.

     \ No newline at end of file diff --git a/en-US/dita/RTC-NG/API/class_livetranscoding.dita b/en-US/dita/RTC-NG/API/class_livetranscoding.dita index 003438e6b86..0a6ae1719d9 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 @@ -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 1c28c605b5c..d94f8db1be2 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 { videoInputStreams transcodingVideoStreams - 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 8aa1b1f5ae7..109b362474a 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 . captureBrightnessLevel The 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_lowlightenhanceoptions.dita b/en-US/dita/RTC-NG/API/class_lowlightenhanceoptions.dita index 52f1a0b726c..dc300dc7ab1 100644 --- a/en-US/dita/RTC-NG/API/class_lowlightenhanceoptions.dita +++ b/en-US/dita/RTC-NG/API/class_lowlightenhanceoptions.dita @@ -86,12 +86,12 @@ @JsonKey(name: 'level') final LowLightEnhanceLevel? level; - factory LowlightEnhanceOptions.fromJson(Map<String, dynamic> json) => + factory LowlightEnhanceOptions.fromJson(Map<String, dynamic> json) => _$LowlightEnhanceOptionsFromJson(json); - Map<String, dynamic> toJson() => _$LowlightEnhanceOptionsToJson(this); + Map<String, dynamic> toJson() => _$LowlightEnhanceOptionsToJson(this); }     -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -99,18 +99,18 @@ <parml> <plentry> <pt>level</pt> - <pd><ph>The low-light enhancement level. </ph><ph props="apple cpp unreal bp rn unity electron flutter cs">See <xref keyref="LOW_LIGHT_ENHANCE_LEVEL" />.</ph><ul props="android"> - <li><ph keyref="LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY" />(0): (Default) Promotes video quality during low-light enhancement. It processes the brightness, details, and noise of the video image. The performance consumption is moderate, the processing speed is moderate, and the overall video quality is optimal.</li> - <li><ph keyref="LOW_LIGHT_ENHANCE_LEVEL_FAST" />(1): Promotes performance during low-light enhancement. It processes the brightness and details of the video image. The processing speed is faster.</li> + <pd><ph>The low-light enhancement level. </ph><ph props="apple cpp unreal bp rn unity electron flutter cs">See <xref keyref="LOW_LIGHT_ENHANCE_LEVEL"/>.</ph><ul props="android"> + <li><ph keyref="LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY"/>(0): (Default) Promotes video quality during low-light enhancement. It processes the brightness, details, and noise of the video image. The performance consumption is moderate, the processing speed is moderate, and the overall video quality is optimal.</li> + <li><ph keyref="LOW_LIGHT_ENHANCE_LEVEL_FAST"/>(1): Promotes performance during low-light enhancement. It processes the brightness and details of the video image. The processing speed is faster.</li> </ul> </pd> </plentry> <plentry> <pt>mode</pt> - <pd><ph>The low-light enhancement mode. </ph><ph props="apple cpp unreal bp rn unity electron flutter cs">See <xref keyref="LOW_LIGHT_ENHANCE_MODE" />.</ph><ul props="android"> - <li><ph keyref="LOW_LIGHT_ENHANCE_AUTO" />(0): (Default) Automatic mode. The SDK automatically enables or disables the low-light enhancement feature according to the ambient light to compensate for the lighting level or prevent overexposure, as necessary.</li> - <li><ph keyref="LOW_LIGHT_ENHANCE_MANUAL" />(1): Manual mode. Users need to enable or disable the low-light enhancement feature manually.</li> + <pd><ph>The low-light enhancement mode. </ph><ph props="apple cpp unreal bp rn unity electron flutter cs">See <xref keyref="LOW_LIGHT_ENHANCE_MODE"/>.</ph><ul props="android"> + <li><ph keyref="LOW_LIGHT_ENHANCE_AUTO"/>(0): (Default) Automatic mode. The SDK automatically enables or disables the low-light enhancement feature according to the ambient light to compensate for the lighting level or prevent overexposure, as necessary.</li> + <li><ph keyref="LOW_LIGHT_ENHANCE_MANUAL"/>(1): Manual mode. Users need to enable or disable the low-light enhancement feature manually.</li> </ul> </pd> </plentry> </parml> </section> </refbody> -</reference> \ No newline at end of file +</reference> diff --git a/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita b/en-US/dita/RTC-NG/API/class_mediarecorderconfiguration.dita index 0fce85b477d..e76727e38a1 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); }</codeblock> - <codeblock props="reserve" outputclass="language-cpp" /></p> + <codeblock props="reserve" outputclass="language-cpp"></codeblock></p> </section> <section id="detailed_desc"> <p /> @@ -109,10 +109,10 @@ <plentry> <pt>storagePath</pt> <pd>The absolute path (including the filename extensions) of the recording file. For example:<ul> - <li props="cpp unreal bp unity electron flutter cs">Windows: <codeph>C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4</codeph></li> + <li props="cpp unreal bp unity electron flutter cs">Windows: <codeph>C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4</codeph></li> <li props="ios cpp unreal bp unity rn flutter">iOS: <codeph>/App Sandbox/Library/Caches/example.mp4</codeph></li> <li props="mac cpp unreal bp unity electron flutter">macOS: <codeph>～/Library/Logs/example.mp4</codeph></li> - <li props="android cpp unreal bp unity rn flutter">Android:<codeph> /storage/emulated/0/Android/data/<package name>/files/agorasdk.mp4</codeph></li> + <li props="android cpp unreal bp unity rn flutter">Android:<codeph> /storage/emulated/0/Android/data/<package name>/files/agorasdk.mp4</codeph></li> </ul> <note type="attention">Ensure that the directory for the log files exists and is writable.</note></pd> </plentry> @@ -123,7 +123,7 @@ </plentry> <plentry> <pt>streamType</pt> - <pd props="ios mac cpp unreal bp rn unity electron flutter cs">The recording content. See <xref keyref="MediaRecorderStreamType" />.</pd> + <pd props="ios mac cpp unreal bp rn unity electron flutter cs">The recording content. See <xref keyref="MediaRecorderStreamType"/>.</pd> <pd props="android">The recording content:<ul> <li><apiname keyref="STREAM_TYPE_AUDIO" />: Only audio.</li> <li><apiname keyref="STREAM_TYPE_VIDEO" />: Only video.</li> @@ -140,4 +140,4 @@ </plentry> </parml> </section> </refbody> -</reference> \ No newline at end of file +</reference> diff --git a/en-US/dita/RTC-NG/API/class_mediasource.dita b/en-US/dita/RTC-NG/API/class_mediasource.dita index 3d76952e6e7..5f87bc7a086 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 @@ <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> <reference id="class_mediasource"> - <title><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_recorderstreaminfo.dita b/en-US/dita/RTC-NG/API/class_recorderstreaminfo.dita index bde8680c352..19635f17aa5 100644 --- a/en-US/dita/RTC-NG/API/class_recorderstreaminfo.dita +++ b/en-US/dita/RTC-NG/API/class_recorderstreaminfo.dita @@ -1,7 +1,7 @@ - <ph keyref="RecorderStreamInfo" /> + <ph keyref="RecorderStreamInfo"/> The information about the media streams to be recorded.
    @@ -45,10 +45,10 @@ class RecorderStreamInfo { @JsonKey(name: 'uid') final int? uid; - factory RecorderStreamInfo.fromJson(Map<String, dynamic> json) => + factory RecorderStreamInfo.fromJson(Map<String, dynamic> json) => _$RecorderStreamInfoFromJson(json); - Map<String, dynamic> toJson() => _$RecorderStreamInfoToJson(this); + Map<String, dynamic> toJson() => _$RecorderStreamInfoToJson(this); }

    @@ -60,7 +60,7 @@ class RecorderStreamInfo {
    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> channelId @@ -72,4 +72,4 @@ class RecorderStreamInfo {
    -     \ 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 3ca7938fabc..17ed4c6ac0c 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_remotevoicepositioninfo.dita b/en-US/dita/RTC-NG/API/class_remotevoicepositioninfo.dita index 2ed4f4f02a3..daabd8cff40 100644 --- a/en-US/dita/RTC-NG/API/class_remotevoicepositioninfo.dita +++ b/en-US/dita/RTC-NG/API/class_remotevoicepositioninfo.dita @@ -48,7 +48,7 @@ forward?: 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_rtcengineconfig.dita b/en-US/dita/RTC-NG/API/class_rtcengineconfig.dita index d8d2ccef7f4..a7d2f86a57d 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.

    @@ -214,25 +214,25 @@ class RtcEngineContext { @JsonKey(name: 'autoRegisterAgoraExtensions') final bool? autoRegisterAgoraExtensions; - factory RtcEngineContext.fromJson(Map<String, dynamic> json) => + factory RtcEngineContext.fromJson(Map<String, dynamic> json) => _$RtcEngineContextFromJson(json); - Map<String, dynamic> toJson() => _$RtcEngineContextToJson(this); + Map<String, dynamic> toJson() => _$RtcEngineContextToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> eventHandler mEventHandler - The event handler for . See . + The event handler for . See . appId mAppId - 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.
         channelProfile mChannelProfile - + audioScenario mAudioScenario - + areaCode mAreaCode - 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. logConfig mLogConfig -

    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 { mExtensionObserver eventDelegate - The instance. + The instance. mediaFilterExtensions - The instance. + The instance. mDomainLimit domainLimit

    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 { mAutoRegisterAgoraExtensions autoRegisterAgoraExtensions -

    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_rtcimage.dita b/en-US/dita/RTC-NG/API/class_rtcimage.dita index f27fde96f48..85287ed7d03 100644 --- a/en-US/dita/RTC-NG/API/class_rtcimage.dita +++ b/en-US/dita/RTC-NG/API/class_rtcimage.dita @@ -142,7 +142,7 @@ _$RtcImageFromJson(json); Map<String, dynamic> toJson() => _$RtcImageToJson(this); } -

    +

    This class sets the properties of the watermark and background images in the live video.

    diff --git a/en-US/dita/RTC-NG/API/class_rtcstats.dita b/en-US/dita/RTC-NG/API/class_rtcstats.dita index b0e9063bba1..ea4289a97f5 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 e4a4b6abafd..8d5a72b3fa8 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" /> @@ -129,7 +129,7 @@ __attribute__((visibility("default"))) @interface AgoraScreenCaptureConfiguratio params parameters - (For Windows and macOS only) The screen capture configuration. See . + (For Windows and macOS only) The screen capture configuration. See . regionRect diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita index 5c8da8a8a3c..8d41f2b02c2 100644 --- a/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita +++ b/en-US/dita/RTC-NG/API/class_screencaptureparameters.dita @@ -19,7 +19,7 @@ @property(assign, nonatomic) NSUInteger highLightWidth; @end - struct ScreenCaptureParameters { + struct ScreenCaptureParameters { VideoDimensions dimensions; int frameRate; int bitrate; @@ -234,7 +234,7 @@ 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.
      • diff --git a/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita b/en-US/dita/RTC-NG/API/class_screencaptureparameters2.dita index 0527a680bb0..c13c18f9924 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"/> captureAudio Determines 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 . captureVideo Whether 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 104c985b093..61a3fa58f41 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 .

    - + __attribute__((visibility("default"))) @interface AgoraScreenCaptureSourceInfo : NSObject @property(assign, nonatomic) AgoraScreenCaptureSourceType type; @property(assign, nonatomic) CGWindowID sourceId; @@ -76,7 +76,7 @@ public Rectangle position; public view_t sourceDisplayId; }; - + class ScreenCaptureSourceInfo { const ScreenCaptureSourceInfo( {this.type, @@ -124,19 +124,19 @@ @JsonKey(name: 'sourceDisplayId') final int? sourceDisplayId; - factory ScreenCaptureSourceInfo.fromJson(Map<String, dynamic> json) => + factory ScreenCaptureSourceInfo.fromJson(Map<String, dynamic> json) => _$ScreenCaptureSourceInfoFromJson(json); - Map<String, dynamic> toJson() => _$ScreenCaptureSourceInfoToJson(this); + Map<String, dynamic> toJson() => _$ScreenCaptureSourceInfoToJson(this); } -

    +

    - <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 @@ primaryMonitor Determines 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_sdkbuildinfo.dita b/en-US/dita/RTC-NG/API/class_sdkbuildinfo.dita index 342defe070b..429aeaeccb8 100644 --- a/en-US/dita/RTC-NG/API/class_sdkbuildinfo.dita +++ b/en-US/dita/RTC-NG/API/class_sdkbuildinfo.dita @@ -29,7 +29,7 @@ _$SDKBuildInfoFromJson(json); Map<String, dynamic> toJson() => _$SDKBuildInfoToJson(this); }     -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -45,4 +45,4 @@
    - \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_spatialaudioparams.dita b/en-US/dita/RTC-NG/API/class_spatialaudioparams.dita index 47265894687..af9e5de3da1 100644 --- a/en-US/dita/RTC-NG/API/class_spatialaudioparams.dita +++ b/en-US/dita/RTC-NG/API/class_spatialaudioparams.dita @@ -1,7 +1,7 @@ - <ph keyref="SpatialAudioParams" /> + <ph keyref="SpatialAudioParams"/> The spatial audio parameters.
    @@ -59,14 +59,14 @@ @property(assign, nonatomic) BOOL enable_doppler; @end struct SpatialAudioParams { - Optional<double> speaker_azimuth; - Optional<double> speaker_elevation; - Optional<double> speaker_distance; - Optional<int> speaker_orientation; - Optional<bool> enable_blur; - Optional<bool> enable_air_absorb; - Optional<double> speaker_attenuation; - Optional<bool> enable_doppler; + Optional<double> speaker_azimuth; + Optional<double> speaker_elevation; + Optional<double> speaker_distance; + Optional<int> speaker_orientation; + Optional<bool> enable_blur; + Optional<bool> enable_air_absorb; + Optional<double> speaker_attenuation; + Optional<bool> enable_doppler; }; export class SpatialAudioParams { @@ -94,8 +94,8 @@ public Optional<int> speaker_orientation = new Optional<int>(); public Optional<bool> enable_blur = new Optional<bool>(); public Optional<bool> enable_air_absorb = new Optional<bool>(); - public Optional<double> speaker_attenuation = new Optional<double>(); - public Optional<bool> enable_doppler = new Optional<bool>(); + public Optional<double> speaker_attenuation = new Optional<double>(); + public Optional<bool> enable_doppler = new Optional<bool>(); } export class SpatialAudioParams { @@ -150,15 +150,15 @@ @JsonKey(name: 'enable_doppler') final bool? enableDoppler; - factory SpatialAudioParams.fromJson(Map<String, dynamic> json) => + factory SpatialAudioParams.fromJson(Map<String, dynamic> json) => _$SpatialAudioParamsFromJson(json); - Map<String, dynamic> toJson() => _$SpatialAudioParamsToJson(this); + Map<String, dynamic> toJson() => _$SpatialAudioParamsToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> speaker_azimuth @@ -192,15 +192,15 @@ enable_blur Whether to enable audio blurring:
      -
    • : Enable audio blurring.
      • -
    • : (Default) Disable audio blurring.
      • +
    • : Enable audio blurring.
      • +
    • : (Default) Disable audio blurring.
         enable_air_absorb Whether to enable air absorption, that is, to simulate the sound attenuation effect of sound transmitting in the air; under a certain transmission distance, the attenuation speed of high-frequency sound is fast, and the attenuation speed of low-frequency sound is slow.
      -
    • : (Default) Enable air absorption. Make sure that the value of speaker_attenuation is not 0; otherwise, this setting does not take effect.
      • -
    • : Disable air absorption.
      • +
    • : (Default) Enable air absorption. Make sure that the value of speaker_attenuation is not 0; otherwise, this setting does not take effect.
      • +
    • : Disable air absorption.
         @@ -215,15 +215,15 @@ enable_doppler Whether to enable the Doppler effect: When there is a relative displacement between the sound source and the receiver of the sound source, the tone heard by the receiver changes.
      -
    • : Enable the Doppler effect.
      • -
    • : (Default) Disable the Doppler effect.
      • +
    • : Enable the Doppler effect.
      • +
    • : (Default) Disable the Doppler effect.
    • This parameter is suitable for scenarios where the sound source is moving at high speed (for example, racing games). It is not recommended for common audio and video interactive scenarios (for example, voice chat, cohosting, or online KTV).
      • -
    • When this parameter is enabled, Agora recommends that you set a regular period (such as 30 ms), and then call the , , and methods to continuously update the relative distance between the sound source and the receiver. The following factors can cause the Doppler effect to be unpredictable or the sound to be jittery: the period of updating the distance is too long, the updating period is irregular, or the distance information is lost due to network packet loss or delay.
      • +
    • When this parameter is enabled, Agora recommends that you set a regular period (such as 30 ms), and then call the , , and methods to continuously update the relative distance between the sound source and the receiver. The following factors can cause the Doppler effect to be unpredictable or the sound to be jittery: the period of updating the distance is too long, the updating period is irregular, or the distance information is lost due to network packet loss or delay.
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_spatialaudiozone.dita b/en-US/dita/RTC-NG/API/class_spatialaudiozone.dita index d6075f326df..516f3e923b1 100644 --- a/en-US/dita/RTC-NG/API/class_spatialaudiozone.dita +++ b/en-US/dita/RTC-NG/API/class_spatialaudiozone.dita @@ -1,7 +1,7 @@ - <ph keyref="SpatialAudioZone" /> + <ph keyref="SpatialAudioZone"/> Sound insulation area settings.
    @@ -137,16 +137,16 @@ final int? zoneSetId; @JsonKey(name: 'position') - final List<double>? position; + final List<double>? position; @JsonKey(name: 'forward') - final List<double>? forward; + final List<double>? forward; @JsonKey(name: 'right') - final List<double>? right; + final List<double>? right; @JsonKey(name: 'up') - final List<double>? up; + final List<double>? up; @JsonKey(name: 'forwardLength') final double? forwardLength; @@ -160,12 +160,12 @@ @JsonKey(name: 'audioAttenuation') final double? audioAttenuation; - factory SpatialAudioZone.fromJson(Map<String, dynamic> json) => + factory SpatialAudioZone.fromJson(Map<String, dynamic> json) => _$SpatialAudioZoneFromJson(json); - Map<String, dynamic> toJson() => _$SpatialAudioZoneToJson(this); + Map<String, dynamic> toJson() => _$SpatialAudioZoneToJson(this); } -

    +

    @@ -174,10 +174,10 @@
    v4.0.1
    -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> zoneSetId @@ -222,4 +222,4 @@
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_transcodinguser.dita b/en-US/dita/RTC-NG/API/class_transcodinguser.dita index 462f32785cc..1afe07e0b0b 100644 --- a/en-US/dita/RTC-NG/API/class_transcodinguser.dita +++ b/en-US/dita/RTC-NG/API/class_transcodinguser.dita @@ -137,7 +137,7 @@ _$TranscodingUserFromJson(json); Map<String, dynamic> toJson() => _$TranscodingUserToJson(this); }     -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> @@ -211,4 +211,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 d6b9c671871..3d0308e16a3 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_uplinknetworkinfo.dita b/en-US/dita/RTC-NG/API/class_uplinknetworkinfo.dita index 86b64b8ac9f..532ae8517a6 100644 --- a/en-US/dita/RTC-NG/API/class_uplinknetworkinfo.dita +++ b/en-US/dita/RTC-NG/API/class_uplinknetworkinfo.dita @@ -51,7 +51,7 @@ _$UplinkNetworkInfoFromJson(json); Map<String, dynamic> toJson() => _$UplinkNetworkInfoToJson(this); }     -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> diff --git a/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita b/en-US/dita/RTC-NG/API/class_useraudiospectruminfo.dita index c8ab6719214..bc8bdf05db7 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_userinfo.dita b/en-US/dita/RTC-NG/API/class_userinfo.dita index 2878ca46a80..239b931a205 100644 --- a/en-US/dita/RTC-NG/API/class_userinfo.dita +++ b/en-US/dita/RTC-NG/API/class_userinfo.dita @@ -57,7 +57,7 @@ _$UserInfoFromJson(json); Map<String, dynamic> toJson() => _$UserInfoToJson(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 239a10a4f4c..802aaae693d 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.
      • To enable alpha transmission, .
             Reserved.
    -     \ No newline at end of file + diff --git a/en-US/dita/RTC-NG/API/class_videodenoiseroptions.dita b/en-US/dita/RTC-NG/API/class_videodenoiseroptions.dita index d870472caea..0c7e0f17168 100644 --- a/en-US/dita/RTC-NG/API/class_videodenoiseroptions.dita +++ b/en-US/dita/RTC-NG/API/class_videodenoiseroptions.dita @@ -86,12 +86,12 @@ @JsonKey(name: 'level') final VideoDenoiserLevel? level; - factory VideoDenoiserOptions.fromJson(Map&lt;String, dynamic> json) => + factory VideoDenoiserOptions.fromJson(Map&lt;String, dynamic> json) => _$VideoDenoiserOptionsFromJson(json); - Map<String, dynamic> toJson() => _$VideoDenoiserOptionsToJson(this); + Map<String, dynamic> toJson() => _$VideoDenoiserOptionsToJson(this); } -

    +

    <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> diff --git a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita index 1c603fff584..20e7596616b 100644 --- a/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita +++ b/en-US/dita/RTC-NG/API/class_videoencoderconfiguration.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoEncoderConfiguration" /> + <ph keyref="VideoEncoderConfiguration"/> Video encoder configurations.
    @@ -420,41 +420,43 @@ @JsonKey(name: 'advanceOptions') final AdvanceOptions? advanceOptions; - factory VideoEncoderConfiguration.fromJson(Map<String, dynamic> json) => + factory VideoEncoderConfiguration.fromJson(Map<String, dynamic> json) => _$VideoEncoderConfigurationFromJson(json); - Map<String, dynamic> toJson() => _$VideoEncoderConfigurationToJson(this); + Map<String, dynamic> toJson() => _$VideoEncoderConfigurationToJson(this); } -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text + conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" + /> dimensions -

    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.
      @@ -465,19 +467,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 .

        -
        • -
        • +
        • +
      @@ -489,16 +491,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.
        • @@ -508,7 +510,7 @@ advanceOptions - Advanced options for video encoding. See . + Advanced options for video encoding. See .
    @@ -516,13 +518,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 820f0dc0beb..6c92820296a 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_videorenderingtracinginfo.dita b/en-US/dita/RTC-NG/API/class_videorenderingtracinginfo.dita index 683d9ef3d5c..765705cc319 100644 --- a/en-US/dita/RTC-NG/API/class_videorenderingtracinginfo.dita +++ b/en-US/dita/RTC-NG/API/class_videorenderingtracinginfo.dita @@ -1,7 +1,7 @@ - <ph keyref="VideoRenderingTracingInfo" /> + <ph keyref="VideoRenderingTracingInfo"/> Indicators during video frame rendering progress.
    @@ -93,10 +93,10 @@ class VideoRenderingTracingInfo { @JsonKey(name: 'remoteJoined2PacketReceived') final int? remoteJoined2PacketReceived; - factory VideoRenderingTracingInfo.fromJson(Map<String, dynamic> json) => + factory VideoRenderingTracingInfo.fromJson(Map<String, dynamic> json) => _$VideoRenderingTracingInfoFromJson(json); - Map<String, dynamic> toJson() => _$VideoRenderingTracingInfoToJson(this); + Map<String, dynamic> toJson() => _$VideoRenderingTracingInfoToJson(this); }

    @@ -106,33 +106,33 @@ class VideoRenderingTracingInfo {
    v4.1.1
    -

    +

    - <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property" /> + <text conref="../conref/conref_api_metadata.dita#conref_api_metadata/property"/> elapsedTime - The time interval from calling the method to SDK triggering the callback. The unit is milliseconds. Agora recommends you call before joining a channel. + The time interval from calling the method to SDK triggering the callback. The unit is milliseconds. Agora recommends you call before joining a channel. start2JoinChannel - The time interval from calling to calling . The unit is milliseconds. A negative number means to call after calling . + The time interval from calling to calling . The unit is milliseconds. A negative number means to call after calling . join2JoinSuccess - Time interval from calling to successfully joining the channel. The unit is milliseconds. + Time interval from calling to successfully joining the channel. The unit is milliseconds. joinSuccess2RemoteJoined
      -
    • If the local user calls before successfully joining the channel, this value is the time interval from the local user successfully joining the channel to the remote user joining the channel. The unit is milliseconds.
      • -
    • If the local user calls after successfully joining the channel, the value is the time interval from calling to when the remote user joins the channel. The unit is milliseconds.
      • +
    • If the local user calls before successfully joining the channel, this value is the time interval from the local user successfully joining the channel to the remote user joining the channel. The unit is milliseconds.
      • +
    • If the local user calls after successfully joining the channel, the value is the time interval from calling to when the remote user joins the channel. The unit is milliseconds.
      -
    • If the local user calls after the remote user joins the channel, the value is 0 and meaningless.
      • +
    • If the local user calls after the remote user joins the channel, the value is 0 and meaningless.
    • In order to reduce the time of rendering the first frame for remote users, Agora recommends that the local user joins the channel when the remote user is in the channel to reduce this value.
         @@ -141,12 +141,12 @@ class VideoRenderingTracingInfo { remoteJoined2SetView
      -
    • If the local user calls before the remote user joins the channel, this value is the time interval from when the remote user joins the channel to when the local user sets the remote view. The unit is milliseconds.
      • -
    • If the local user calls after the remote user joins the channel, this value is the time interval from calling to setting the remote view. The unit is milliseconds.
      • +
    • If the local user calls before the remote user joins the channel, this value is the time interval from when the remote user joins the channel to when the local user sets the remote view. The unit is milliseconds.
      • +
    • If the local user calls after the remote user joins the channel, this value is the time interval from calling to setting the remote view. The unit is milliseconds.
      -
    • If the local user calls after setting the remote view, the value is 0 and has no effect.
      • +
    • If the local user calls after setting the remote view, the value is 0 and has no effect.
    • In order to reduce the time of rendering the first frame for remote users, Agora recommends that the local user sets the remote view before the remote user joins the channel, or sets the remote view immediately after the remote user joins the channel to reduce this value.
         @@ -154,12 +154,12 @@ class VideoRenderingTracingInfo { remoteJoined2UnmuteVideo
      -
    • If the local user calls before the remote user joins the channel, this value is the time interval from the remote user joining the channel to subscribing to the remote video stream. The unit is milliseconds.
      • -
    • If the local user calls after the remote user joins the channel, this value is the time interval from calling to subscribing to the remote video stream. The unit is milliseconds.
      • +
    • If the local user calls before the remote user joins the channel, this value is the time interval from the remote user joining the channel to subscribing to the remote video stream. The unit is milliseconds.
      • +
    • If the local user calls after the remote user joins the channel, this value is the time interval from calling to subscribing to the remote video stream. The unit is milliseconds.
      -
    • If the local user calls after subscribing to the remote video stream, the value is 0 and has no effect.
      • +
    • If the local user calls after subscribing to the remote video stream, the value is 0 and has no effect.
    • In order to reduce the time of rendering the first frame for remote users, Agora recommends that after the remote user joins the channel, the local user immediately subscribes to the remote video stream to reduce this value.
         @@ -168,15 +168,15 @@ class VideoRenderingTracingInfo { remoteJoined2PacketReceived
      -
    • If the local user calls before the remote user joins the channel, this value is the time interval from when the remote user joins the channel to when the local user receives the remote video stream. The unit is milliseconds.
      • -
    • If the local user calls after the remote user joins the channel, this value is the time interval from calling to receiving the remote video stream. The unit is milliseconds.
      • +
    • If the local user calls before the remote user joins the channel, this value is the time interval from when the remote user joins the channel to when the local user receives the remote video stream. The unit is milliseconds.
      • +
    • If the local user calls after the remote user joins the channel, this value is the time interval from calling to receiving the remote video stream. The unit is milliseconds.
      -
    • If the local user calls after receiving the remote video stream, the value is 0 and has no effect.
      • +
    • If the local user calls after receiving the remote video stream, the value is 0 and has no effect.
    • In order to reduce the time of rendering the first frame for remote users, Agora recommends that the remote user publishes video streams immediately after joining the channel, and the local user immediately subscribes to remote video streams to reduce this value.
    -     \ 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 3eb62b97334..ed72701605a 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"/> streamType type - 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.
         encodedFrameOnly Whether 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_videosurfaceyuv.dita b/en-US/dita/RTC-NG/API/class_videosurfaceyuv.dita index 10eaf7868ed..6545d2d4ad0 100644 --- a/en-US/dita/RTC-NG/API/class_videosurfaceyuv.dita +++ b/en-US/dita/RTC-NG/API/class_videosurfaceyuv.dita @@ -1,6 +1,6 @@ - <ph keyref="VideoSurfaceYUV" /> - Porivdes APIs for rendering videos. This class inherits all APIs from the class, but enables you to render video images with high resolutions (such as 4K) faster and at higher frame rates. As of v4.2.0, Agora Unity SDK does not support rendering different video sources with both and at the same time. Specifically, after successfully creating , if the first view is rendered with , then only can be used for rendering throughout the entire lifecycle of . - \ No newline at end of file + <ph keyref="VideoSurfaceYUV"/> + Porivdes APIs for rendering videos. This class inherits all APIs from the class, but enables you to render video images with high resolutions (such as 4K) faster and at higher frame rates. As of v4.2.0, Agora Unity SDK does not support rendering different video sources with both and at the same time. Specifically, after successfully creating , if the first view is rendered with , then only can be used for rendering throughout the entire lifecycle of . + diff --git a/en-US/dita/RTC-NG/API/class_watermarkoptions.dita b/en-US/dita/RTC-NG/API/class_watermarkoptions.dita index 51b194856e3..14f964b573c 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 + diff --git a/en-US/dita/RTC-NG/API/enum_featuretype.dita b/en-US/dita/RTC-NG/API/enum_featuretype.dita index f5524aa1426..f9d371f9994 100644 --- a/en-US/dita/RTC-NG/API/enum_featuretype.dita +++ b/en-US/dita/RTC-NG/API/enum_featuretype.dita @@ -21,7 +21,7 @@ - 2: Image enchancement. + 2: Image enhancement.
    diff --git a/en-US/dita/RTC-NG/API/rtc_api_data_type.dita b/en-US/dita/RTC-NG/API/rtc_api_data_type.dita index 1c8bd2197d2..ae44dcc6ac2 100644 --- a/en-US/dita/RTC-NG/API/rtc_api_data_type.dita +++ b/en-US/dita/RTC-NG/API/rtc_api_data_type.dita @@ -1820,6 +1820,7 @@
    • +