feat: add RtcEngineContext instead of RtcEngineConfig

example/src/examples/advanced/CreateStreamData.tsx

@@ -11,15 +11,12 @@ import {
 } from 'react-native';
 
 import RtcEngine, {
-  AudienceLatencyLevelType,
   ChannelProfile,
   ClientRole,
   DataStreamConfig,
-  RtcEngineConfig,
+  RtcEngineContext,
   RtcLocalView,
   RtcRemoteView,
-  VideoFrameRate,
-  VideoOutputOrientationMode,
   VideoRenderMode,
 } from 'react-native-agora';
 
@@ -66,8 +63,8 @@ export default class LiveStreaming extends Component<{}, State, any> {
         PermissionsAndroid.PERMISSIONS.CAMERA,
       ]);
     }
-    this._engine = await RtcEngine.createWithConfig(
-      new RtcEngineConfig(config.appId)
+    this._engine = await RtcEngine.createWithContext(
+      new RtcEngineContext(config.appId)
     );
     this._addListeners();
 
@@ -76,7 +73,7 @@ export default class LiveStreaming extends Component<{}, State, any> {
 
     // make myself a broadcaster
     await this._engine.setChannelProfile(ChannelProfile.LiveBroadcasting);
-    await this._updateClientRole(ClientRole.Broadcaster);
+    await this._engine.setClientRole(ClientRole.Broadcaster);
 
     // Set audio route to speaker
     await this._engine.setDefaultAudioRoutetoSpeakerphone(true);
@@ -139,27 +136,6 @@ export default class LiveStreaming extends Component<{}, State, any> {
     );
   };
 
-  _updateClientRole = async (role: ClientRole) => {
-    let option;
-    if (role === ClientRole.Broadcaster) {
-      await this._engine?.setVideoEncoderConfiguration({
-        dimensions: {
-          width: 640,
-          height: 360,
-        },
-        frameRate: VideoFrameRate.Fps30,
-        orientationMode: VideoOutputOrientationMode.Adaptative,
-      });
-      // enable camera/mic, this will bring up permission dialog for first time
-      await this._engine?.enableLocalAudio(true);
-      await this._engine?.enableLocalVideo(true);
-    } else {
-      // You have to provide client role options if set to audience
-      option = { audienceLatencyLevel: AudienceLatencyLevelType.LowLatency };
-    }
-    await this._engine?.setClientRole(role, option);
-  };
-
   render() {
     const { isJoin } = this.state;
     return (

example/src/examples/advanced/LiveStreaming.tsx

@@ -12,7 +12,7 @@ import RtcEngine, {
   AudienceLatencyLevelType,
   ChannelProfile,
   ClientRole,
-  RtcEngineConfig,
+  RtcEngineContext,
   RtcLocalView,
   RtcRemoteView,
   VideoFrameRate,
@@ -67,8 +67,8 @@ export default class LiveStreaming extends Component<{}, State, any> {
         PermissionsAndroid.PERMISSIONS.CAMERA,
       ]);
     }
-    this._engine = await RtcEngine.createWithConfig(
-      new RtcEngineConfig(config.appId)
+    this._engine = await RtcEngine.createWithContext(
+      new RtcEngineContext(config.appId)
     );
     this._addListeners();
 

example/src/examples/advanced/MediaChannelRelay.tsx

@@ -10,17 +10,14 @@ import {
 } from 'react-native';
 
 import RtcEngine, {
-  AudienceLatencyLevelType,
   ChannelMediaRelayError,
   ChannelMediaRelayEvent,
   ChannelMediaRelayState,
   ChannelProfile,
   ClientRole,
-  RtcEngineConfig,
+  RtcEngineContext,
   RtcLocalView,
   RtcRemoteView,
-  VideoFrameRate,
-  VideoOutputOrientationMode,
   VideoRenderMode,
 } from 'react-native-agora';
 
@@ -79,8 +76,8 @@ export default class MediaChannelRelay extends Component<{}, State, any> {
         PermissionsAndroid.PERMISSIONS.CAMERA,
       ]);
     }
-    this._engine = await RtcEngine.createWithConfig(
-      new RtcEngineConfig(config.appId)
+    this._engine = await RtcEngine.createWithContext(
+      new RtcEngineContext(config.appId)
     );
     this._addListeners();
 
@@ -89,7 +86,7 @@ export default class MediaChannelRelay extends Component<{}, State, any> {
 
     // make myself a broadcaster
     await this._engine.setChannelProfile(ChannelProfile.LiveBroadcasting);
-    await this._updateClientRole(ClientRole.Broadcaster);
+    await this._engine.setClientRole(ClientRole.Broadcaster);
 
     // Set audio route to speaker
     await this._engine.setDefaultAudioRoutetoSpeakerphone(true);
@@ -162,27 +159,6 @@ export default class MediaChannelRelay extends Component<{}, State, any> {
     );
   };
 
-  _updateClientRole = async (role: ClientRole) => {
-    let option;
-    if (role === ClientRole.Broadcaster) {
-      await this._engine?.setVideoEncoderConfiguration({
-        dimensions: {
-          width: 640,
-          height: 360,
-        },
-        frameRate: VideoFrameRate.Fps30,
-        orientationMode: VideoOutputOrientationMode.Adaptative,
-      });
-      // enable camera/mic, this will bring up permission dialog for first time
-      await this._engine?.enableLocalAudio(true);
-      await this._engine?.enableLocalVideo(true);
-    } else {
-      // You have to provide client role options if set to audience
-      option = { audienceLatencyLevel: AudienceLatencyLevelType.LowLatency };
-    }
-    await this._engine?.setClientRole(role, option);
-  };
-
   render() {
     const { isJoin } = this.state;
     return (

example/src/examples/advanced/MultiChannel.tsx

@@ -13,7 +13,7 @@ import RtcEngine, {
   ChannelProfile,
   ClientRole,
   RtcChannel,
-  RtcEngineConfig,
+  RtcEngineContext,
   RtcLocalView,
   RtcRemoteView,
   VideoRemoteState,
@@ -57,8 +57,8 @@ export default class MultiChannel extends Component<{}, State, any> {
   }
 
   _initEngine = async () => {
-    this._engine = await RtcEngine.createWithConfig(
-      new RtcEngineConfig(config.appId)
+    this._engine = await RtcEngine.createWithContext(
+      new RtcEngineContext(config.appId)
     );
 
     await this._engine.enableVideo();

example/src/examples/advanced/VoiceChange.tsx

@@ -18,7 +18,7 @@ import RtcEngine, {
   AudioScenario,
   ChannelProfile,
   ClientRole,
-  RtcEngineConfig,
+  RtcEngineContext,
   VoiceBeautifierPreset,
 } from 'react-native-agora';
 import VoiceChangeConfig, {
@@ -83,8 +83,8 @@ export default class VoiceChange extends Component<{}, State, any> {
         PermissionsAndroid.PERMISSIONS.CAMERA,
       ]);
     }
-    this._engine = await RtcEngine.createWithConfig(
-      new RtcEngineConfig(config.appId)
+    this._engine = await RtcEngine.createWithContext(
+      new RtcEngineContext(config.appId)
     );
 
     this._addListeners();

example/src/examples/basic/JoinChannelAudio.tsx

@@ -10,7 +10,7 @@ import {
 import RtcEngine, {
   ChannelProfile,
   ClientRole,
-  RtcEngineConfig,
+  RtcEngineContext,
 } from 'react-native-agora';
 import RNFS from 'react-native-fs';
 import Item from '../component/Item';
@@ -48,8 +48,8 @@ export default class JoinChannelAudio extends Component<{}, State, any> {
   }
 
   _initEngine = async () => {
-    this._engine = await RtcEngine.createWithConfig(
-      new RtcEngineConfig(config.appId)
+    this._engine = await RtcEngine.createWithContext(
+      new RtcEngineContext(config.appId)
     );
     this._addListeners();
 

example/src/examples/basic/JoinChannelVideo.tsx

@@ -13,7 +13,7 @@ import {
 import RtcEngine, {
   ChannelProfile,
   ClientRole,
-  RtcEngineConfig,
+  RtcEngineContext,
   RtcLocalView,
   RtcRemoteView,
 } from 'react-native-agora';
@@ -51,8 +51,8 @@ export default class JoinChannelAudio extends Component<{}, State, any> {
   }
 
   _initEngine = async () => {
-    this._engine = await RtcEngine.createWithConfig(
-      new RtcEngineConfig(config.appId)
+    this._engine = await RtcEngine.createWithContext(
+      new RtcEngineContext(config.appId)
     );
     this._addListeners();
 

example/src/examples/basic/StringUid.tsx

@@ -4,7 +4,7 @@ import { Button, StyleSheet, TextInput, View } from 'react-native';
 import RtcEngine, {
   ChannelProfile,
   ClientRole,
-  RtcEngineConfig,
+  RtcEngineContext,
 } from 'react-native-agora';
 
 const config = require('../../../agora.config.json');
@@ -36,8 +36,8 @@ export default class StringUid extends Component<{}, State, any> {
   }
 
   _initEngine = async () => {
-    this._engine = await RtcEngine.createWithConfig(
-      new RtcEngineConfig(config.appId)
+    this._engine = await RtcEngine.createWithContext(
+      new RtcEngineContext(config.appId)
     );
     this._addListeners();
 

src/common/Classes.ts

@@ -1611,7 +1611,7 @@ export class DataStreamConfig {
  *
  * @since v3.3.1
  */
-export class RtcEngineConfig {
+export class RtcEngineContext {
   /**
    * The App ID issued to you by Agora. See [How to get the App ID](https://docs.agora.io/en/Agora%20Platform/token#get-an-app-id).
    * Only users in apps with the same App ID can join the same channel and communicate with each other. Use an App ID to create only
@@ -1649,6 +1649,15 @@ export class RtcEngineConfig {
   }
 }
 
+/**
+ * @deprecated
+ *
+ * Configurations for the [`RtcEngine`]{@link RtcEngine}.
+ *
+ * @since v3.3.1
+ */
+export class RtcEngineConfig extends RtcEngineContext {}
+
 /**
  * Recording configuration, which is set in [`startAudioRecordingWithConfig`]{@link startAudioRecordingWithConfig}.
  */

src/common/RtcEngine.native.ts

@@ -14,6 +14,7 @@ import {
   LiveTranscoding,
   RhythmPlayerConfig,
   RtcEngineConfig,
+  RtcEngineContext,
   UserInfo,
   VideoEncoderConfiguration,
   WatermarkOptions,
@@ -148,7 +149,7 @@ export default class RtcEngine implements RtcEngineInterface {
    *    - 101(InvalidAppId): The app ID is invalid. Check if it is in the correct format.
    */
   static async create(appId: string): Promise<RtcEngine> {
-    return RtcEngine.createWithConfig(new RtcEngineConfig(appId));
+    return RtcEngine.createWithContext(new RtcEngineContext(appId));
   }
 
   /**
@@ -181,8 +182,8 @@ export default class RtcEngine implements RtcEngineInterface {
     appId: string,
     areaCode: AreaCode
   ): Promise<RtcEngine> {
-    return RtcEngine.createWithConfig(
-      new RtcEngineConfig(appId, { areaCode: [areaCode] })
+    return RtcEngine.createWithContext(
+      new RtcEngineContext(appId, { areaCode: [areaCode] })
     );
   }
 
@@ -203,9 +204,46 @@ export default class RtcEngine implements RtcEngineInterface {
    * - The error code, if the method call fails.
    *   - 101(InvalidAppId): The app ID is invalid. Check if it is in the correct format.
    */
-  static async createWithConfig(config: RtcEngineConfig) {
+  static async createWithConfig(config: RtcEngineConfig): Promise<RtcEngine> {
+    return this.createWithContext(config);
+  }
+
+  /**
+   * Creates an [`RtcEngine`]{@link RtcEngine} instance.
+   *
+   * @since v3.3.1.
+   *
+   * Unless otherwise specified, all the methods provided by the [`RtcEngine`]{@link RtcEngine} class are executed asynchronously. Agora recommends calling these methods in the same thread.
+   *
+   * @note
+   * - You must create an [`RtcEngine`]{@link RtcEngine} instance before calling any other method.
+   * - The Agora RTC Native SDK supports creating only one [`RtcEngine`]{@link RtcEngine} instance for an app for now.
+   *
+   * @param context Configurations for the [`RtcEngine`]{@link RtcEngine} instance. For details, see [`RtcEngineContext`]{@link RtcEngineContext}.
+   * @return
+   * - The [`RtcEngine`]{@link RtcEngine} instance, if the method call succeeds.
+   * - The error code, if the method call fails.
+   *   - 101(InvalidAppId): The app ID is invalid. Check if it is in the correct format.
+   */
+  static async createWithContext(
+    context: RtcEngineContext
+  ): Promise<RtcEngine> {
     if (engine) return engine;
-    await RtcEngine._callMethod('create', { config, appType: 8 });
+    let areaCode: number | undefined;
+    if (context.areaCode) {
+      let code = 0;
+      context.areaCode.forEach((value) => {
+        code |= value;
+      });
+      areaCode = code;
+    }
+    await RtcEngine._callMethod('create', {
+      config: {
+        ...context,
+        areaCode: areaCode,
+      },
+      appType: 8,
+    });
     engine = new RtcEngine();
     return engine;
   }
@@ -2931,7 +2969,6 @@ export default class RtcEngine implements RtcEngineInterface {
    *
    * @param config The configurations for the data stream.
    *
-   *
    * @return
    * - Returns the stream ID if you successfully create the data stream.
    * - < 0: Fails to create the data stream.