fix conflict

Author: sbd021

Group-Video/OpenVideoCall-Android/app/src/main/java/io/agora/openvcall/AGApplication.java

@@ -58,14 +58,29 @@ private void createRtcEngine() {
 
         mEventHandler = new MyEngineEventHandler();
         try {
+            // Creates an RtcEngine instance
             mRtcEngine = RtcEngine.create(context, appId, mEventHandler);
         } catch (Exception e) {
             log.error(Log.getStackTraceString(e));
             throw new RuntimeException("NEED TO check rtc sdk init fatal error\n" + Log.getStackTraceString(e));
         }
 
+        /*
+          Sets the channel profile of the Agora RtcEngine.
+          The Agora RtcEngine differentiates channel profiles and applies different optimization
+          algorithms accordingly. For example, it prioritizes smoothness and low latency for a
+          video call, and prioritizes video quality for a video broadcast.
+         */
         mRtcEngine.setChannelProfile(Constants.CHANNEL_PROFILE_COMMUNICATION);
+        // Enables the video module.
         mRtcEngine.enableVideo();
+        /*
+          Enables the onAudioVolumeIndication callback at a set time interval to report on which
+          users are speaking and the speakers' volume.
+          Once this method is enabled, the SDK returns the volume indication in the
+          onAudioVolumeIndication callback at the set time interval, regardless of whether any user
+          is speaking in the channel.
+         */
         mRtcEngine.enableAudioVolumeIndication(200, 3, false);
 
         mConfig = new EngineConfig();

Group-Video/OpenVideoCall-Android/app/src/main/java/io/agora/openvcall/model/MyEngineEventHandler.java

@@ -259,6 +259,17 @@ protected final int getActionBarHeight() {
         return actionBarHeight;
     }
 
+    /**
+     *
+     * Starts/Stops the local video preview
+     *
+     * Before calling this method, you must:
+     * Call the enableVideo method to enable the video.
+     *
+     * @param start Whether to start/stop the local preview
+     * @param view The SurfaceView in which to render the preview
+     * @param uid User ID.
+     */
     protected void preview(boolean start, SurfaceView view, int uid) {
         if (start) {
             rtcEngine().setupLocalVideo(new VideoCanvas(view, VideoCanvas.RENDER_MODE_HIDDEN, uid));
@@ -268,6 +279,26 @@ protected void preview(boolean start, SurfaceView view, int uid) {
         }
     }
 
+    /**
+     * Allows a user to join a channel.
+     *
+     * Users in the same channel can talk to each other, and multiple users in the same channel can start a group chat. Users with different App IDs cannot call each other.
+     *
+     * You must call the leaveChannel method to exit the current call before joining another channel.
+     *
+     * A successful joinChannel method call triggers the following callbacks:
+     *
+     * The local client: onJoinChannelSuccess.
+     * The remote client: onUserJoined, if the user joining the channel is in the Communication profile, or is a BROADCASTER in the Live Broadcast profile.
+     *
+     * When the connection between the client and Agora's server is interrupted due to poor
+     * network conditions, the SDK tries reconnecting to the server. When the local client
+     * successfully rejoins the channel, the SDK triggers the onRejoinChannelSuccess callback
+     * on the local client.
+     *
+     * @param channel The unique channel name for the AgoraRTC session in the string format.
+     * @param uid User ID.
+     */
     public final void joinChannel(final String channel, int uid) {
         String accessToken = getApplicationContext().getString(R.string.agora_access_token);
         if (TextUtils.equals(accessToken, "") || TextUtils.equals(accessToken, "<#YOUR ACCESS TOKEN#>")) {
@@ -280,6 +311,23 @@ public final void joinChannel(final String channel, int uid) {
         log.debug("joinChannel " + channel + " " + uid);
     }
 
+    /**
+     * Allows a user to leave a channel.
+     *
+     * After joining a channel, the user must call the leaveChannel method to end the call before
+     * joining another channel. This method returns 0 if the user leaves the channel and releases
+     * all resources related to the call. This method call is asynchronous, and the user has not
+     * exited the channel when the method call returns. Once the user leaves the channel,
+     * the SDK triggers the onLeaveChannel callback.
+     *
+     * A successful leaveChannel method call triggers the following callbacks:
+     *
+     * The local client: onLeaveChannel.
+     * The remote client: onUserOffline, if the user leaving the channel is in the
+     * Communication channel, or is a BROADCASTER in the Live Broadcast profile.
+     *
+     * @param channel Channel Name
+     */
     public final void leaveChannel(String channel) {
         log.debug("leaveChannel " + channel);
         config().mChannel = null;
@@ -288,6 +336,9 @@ public final void leaveChannel(String channel) {
         config().reset();
     }
 
+    /**
+     * Enables image enhancement and sets the options.
+     */
     protected void enablePreProcessor() {
         if (Constant.BEAUTY_EFFECT_ENABLED) {
             rtcEngine().setBeautyEffectOptions(true, Constant.BEAUTY_OPTIONS);
@@ -300,6 +351,10 @@ public final void setBeautyEffectParameters(float lightness, float smoothness, f
         Constant.BEAUTY_OPTIONS.rednessLevel = redness;
     }
 
+
+    /**
+     * Disables image enhancement.
+     */
     protected void disablePreProcessor() {
         // do not support null when setBeautyEffectOptions to false
         rtcEngine().setBeautyEffectOptions(false, Constant.BEAUTY_OPTIONS);
@@ -312,6 +367,7 @@ protected void configEngine(VideoEncoderConfiguration.VideoDimensions videoDimen
         }
 
         log.debug("configEngine " + videoDimension + " " + fps + " " + encryptionMode);
+        // Set the Resolution, FPS. Bitrate and Orientation of the video
         rtcEngine().setVideoEncoderConfiguration(new VideoEncoderConfiguration(videoDimension,
                 fps,
                 VideoEncoderConfiguration.STANDARD_BITRATE,

Group-Video/OpenVideoCall-Android/app/src/main/java/io/agora/openvcall/ui/BaseActivity.java

@@ -378,11 +378,18 @@ private void doConfigEngine(String encryptionKey, String encryptionMode) {
 
     public void onSwitchCameraClicked(View view) {
         RtcEngine rtcEngine = rtcEngine();
+        // Switches between front and rear cameras.
         rtcEngine.switchCamera();
     }
 
     public void onSwitchSpeakerClicked(View view) {
         RtcEngine rtcEngine = rtcEngine();
+        /*
+          Enables/Disables the audio playback route to the speakerphone.
+          This method sets whether the audio is routed to the speakerphone or earpiece.
+          After calling this method, the SDK returns the onAudioRouteChanged callback
+          to indicate the changes.
+         */
         rtcEngine.setEnableSpeakerphone(mAudioRouting != Constants.AUDIO_ROUTE_SPEAKERPHONE);
     }
 
@@ -545,6 +552,13 @@ public void run() {
                     return;
                 }
 
+                /*
+                  Creates the video renderer view.
+                  CreateRendererView returns the SurfaceView type. The operation and layout of the
+                  view are managed by the app, and the Agora SDK renders the view provided by the
+                  app. The video display view must be created using this method instead of
+                  directly calling SurfaceView.
+                 */
                 SurfaceView surfaceV = RtcEngine.CreateRendererView(getApplicationContext());
                 mUidsList.put(uid, surfaceV);
 
@@ -553,6 +567,11 @@ public void run() {
                 surfaceV.setZOrderOnTop(true);
                 surfaceV.setZOrderMediaOverlay(true);
 
+                /*
+                  Initializes the video view of a remote user.
+                  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.
+                 */
                 rtcEngine().setupRemoteVideo(new VideoCanvas(surfaceV, VideoCanvas.RENDER_MODE_HIDDEN, uid));
 
                 if (useDefaultLayout) {

Group-Video/OpenVideoCall-Android/app/src/main/java/io/agora/openvcall/ui/CallActivity.java

@@ -11,6 +11,8 @@ import { RESOLUTION_ARR } from "@/utils/Settings";
 import Polyfill from "@/utils/Polyfill";
 import Validator from "@/utils/Validate";
 
+// Parses the query params from the url
+
 const getParameterByName = (name, url) => {
   if (!url) {
     url = window.location.href;
@@ -23,6 +25,8 @@ const getParameterByName = (name, url) => {
   return decodeURIComponent(results[2].replace(/\+/g, " "));
 };
 
+
+// Intializes the ui with necessary video profile options. (resolution, framerate, bitrate etc.)
 const uiInit = () => {
   document.querySelector(
     ".login-title"
@@ -73,6 +77,8 @@ const uiInit = () => {
   }
 };
 
+// Channel name validator
+
 const validate = channelName => {
   if (Validator.isNonEmpty(channelName)) {
     return "Cannot be empty!";
@@ -90,6 +96,8 @@ const validate = channelName => {
   return "";
 };
 
+
+
 const subscribeMouseEvent = () => {
   // Click Join and go to the meeting room
   $("#joinBtn").on("click", () => {
@@ -112,6 +120,7 @@ const subscribeMouseEvent = () => {
     $("#channel").addClass("is-success");
     validateIcon.append(`<i class="ag-icon icon-correct"></i>`);
 
+    // This config data is added to the cookies to be used in other pages.
     let postData = {
       baseMode: document.querySelector("#baseMode").dataset.value,
       transcode: $('input[name="transcode"]:checked').val(),