:Quick Start ApsaraVideo Real-time Communication

Android

private void createEngine() {
    mAliRtcEngine = AliRtcEngine.getInstance(getApplicationContext());
    mAliRtcEngine.setRtcEngineEventListener(new AliRtcEngineEventListener() {

        /* Notification of SDK connection status to the server. Handle connection failures. */
        @Override
        public void onConnectionStatusChange(AliRtcEngine.AliRtcConnectionStatus aliRtcConnectionStatus, AliRtcEngine.AliRtcConnectionStatusChangeReason aliRtcConnectionStatusChangeReason) {
            super.onConnectionStatusChange(aliRtcConnectionStatus, aliRtcConnectionStatusChangeReason);
            if (aliRtcConnectionStatus == AliRtcEngine.AliRtcConnectionStatus.AliRtcConnectionStatusFailed) {
                /* TODO: Required. Prompt the customer with an error message. The SDK reports this only after internal recovery policies have failed and it can no longer be used. */
            } else {
                /* TODO: Optional. Add business logic, typically for data statistics or UI changes. */
            }
        }

        /* The SDK attempts to control on-premises device exceptions. */
        @Override
        public void OnLocalDeviceException(AliRtcEngine.AliRtcEngineLocalDeviceType aliRtcEngineLocalDeviceType, AliRtcEngine.AliRtcEngineLocalDeviceExceptionType aliRtcEngineLocalDeviceExceptionType, String s) {
            super.OnLocalDeviceException(aliRtcEngineLocalDeviceType, aliRtcEngineLocalDeviceExceptionType, s);
            /* TODO: Required. Prompt the customer with an error message. The SDK reports this only after internal recovery policies have failed and it can no longer be used. */
        }

        @Override
        public void onJoinChannelResult(int result, String channel, String userId, int elapsed) {
            super.onJoinChannelResult(result, channel, userId, elapsed);
            /* TODO: Optional. Add business logic, typically for data statistics or UI changes. */
            Log.i(TAG, "onJoinChannelResult result=" + result + ",channel=" + channel + ",userId=" + userId + ",elapsed=" + elapsed);
        }

        @Override
        public void onLeaveChannelResult(int result, AliRtcEngine.AliRtcStats stats) {
            super.onLeaveChannelResult(result, stats);
            Log.i(TAG, "onLeaveChannelResult result=" + result);
        }
    });
    mAliRtcEngine.setRtcEngineNotify(new AliRtcEngineNotify() {

        /* Callback when authentication is 30 seconds from expiring. Refresh authentication time. */
        @Override
        public void onAuthInfoWillExpire() {
            super.onAuthInfoWillExpire();
            /* TODO: Required. The service triggers re-obtaining authentication information for the current channel and user, then set refreshAuthInfo. */
        }

        /* The service might trigger kicking users, so handle this as well. */
        @Override
        public void onBye(int code) {
            super.onBye(code);
            /* TODO: Handle this based on your business scenario. */
        }

        @Override
        public void onRemoteUserOnLineNotify(String uid, int elapsed) {
            super.onRemoteUserOnLineNotify(uid, elapsed);
            Log.i(TAG, "onRemoteUserOnLineNotify uid=" + uid + ",elapsed=" + elapsed);
        }

        @Override
        public void onRemoteUserOffLineNotify(String uid, AliRtcEngine.AliRtcUserOfflineReason aliRtcUserOfflineReason) {
            super.onRemoteUserOffLineNotify(uid, aliRtcUserOfflineReason);
            Log.i(TAG, "onRemoteUserOnLineNotify uid=" + uid + ",aliRtcUserOfflineReason=" + aliRtcUserOfflineReason);
        }

        @Override
        public void onRemoteTrackAvailableNotify(String uid, AliRtcEngine.AliRtcAudioTrack aliRtcAudioTrack, AliRtcEngine.AliRtcVideoTrack aliRtcVideoTrack) {
            super.onRemoteTrackAvailableNotify(uid, aliRtcAudioTrack, aliRtcVideoTrack);
            Log.i(TAG, "onRemoteUserOnLineNotify uid=" + uid + ",aliRtcAudioTrack=" + aliRtcAudioTrack + ",aliRtcVideoTrack=" + aliRtcVideoTrack);
            mMainHandler.post(new Runnable() {
                @Override
                public void run() {
                    if (aliRtcVideoTrack == AliRtcEngine.AliRtcVideoTrack.AliRtcVideoTrackCamera
                            || aliRtcVideoTrack == AliRtcEngine.AliRtcVideoTrack.AliRtcVideoTrackBoth) {
                        AliRtcEngine.AliRtcVideoCanvas remote_canvas = new AliRtcEngine.AliRtcVideoCanvas();
                        SurfaceView remoteView = mAliRtcEngine.createRenderSurfaceView(mContext);
                        if (remoteView != null) {
                            remoteView.setZOrderOnTop(true);
                            remoteView.setZOrderMediaOverlay(true);
                        }
                        remote_canvas.view = remoteView;
                        mLocalSurfaceContainer.addView(remote_canvas.view, new FrameLayout.LayoutParams(
                                findViewById(R.id.local_surface_container).getWidth()/4,
                                findViewById(R.id.local_surface_container).getHeight()/4));
                        mAliRtcEngine.setRemoteViewConfig(remote_canvas,uid,AliRtcEngine.AliRtcVideoTrack.AliRtcVideoTrackCamera);
                    } else {
                        mAliRtcEngine.setRemoteViewConfig(null, uid, AliRtcEngine.AliRtcVideoTrack.AliRtcVideoTrackCamera);
                    }
                }
            });
        }
    });
}

iOS

- (AliRtcEngine *)engine{
    if (!_engine) {
        NSString *extras = @"";
        /* Construct the engine and pass the delegate. */
        _engine = [AliRtcEngine sharedInstance:self extras:extras];
    }
    return _engine;
}

#pragma mark - "Delegates of engine"
/* Callback when authentication is 30 seconds from expiring. Refresh authentication time. */
- (void)onAuthInfoWillExpire{
    /* TODO: Required. The service triggers re-obtaining authentication information for the current channel and user, then set refreshAuthInfo. */
}

/* Notification of SDK connection status to the server. Handle connection failures. */
- (void)onConnectionStatusChange:(AliRtcConnectionStatus)status reason:(AliRtcConnectionStatusChangeReason)reason {
    if (status == AliRtcConnectionStatusFailed) {
        /* TODO: Required. Prompt the customer with an error message. The SDK reports this only after internal recovery policies have failed and it can no longer be used. */
    } else {
        /* TODO: Optional. Add business logic, typically for data statistics or UI changes. */
    }
}

/* The SDK attempts to control on-premises device exceptions. */
- (void)onLocalDeviceException:(AliRtcLocalDeviceType)deviceType exceptionType:(AliRtcLocalDeviceExceptionType)exceptionType message:(NSString *_Nullable)msg {
    /* TODO: Required. Prompt the customer with an error message. The SDK reports this only after internal recovery policies have failed and it can no longer be used. */
}

/* The service might trigger kicking users, so handle this as well. */
/* The service might trigger kicking users, so handle this as well. */
- (void)onBye:(int)code {
    /* TODO: Handle this based on your business scenario. */
}

/* Remote stream ingest notification. When auto-subscribing, set the black screen time and first frame time concurrently. */
- (void)onRemoteTrackAvailableNotify:(NSString *_Nonnull)uid audioTrack:(AliRtcAudioTrack)audioTrack videoTrack:(AliRtcVideoTrack)videoTrack {
    /* TODO: Required. Set a video rendering window for the SDK. */
    dispatch_async(dispatch_get_main_queue(), ^{
        if (videoTrack & AliRtcVideoTrackCamera) {
            AliVideoCanvas *canvas = [[AliVideoCanvas alloc] init];
            canvas.view = self.remoteRenderView;
            canvas.renderMode = AliRtcRenderModeAuto;
            [self.engine setRemoteViewConfig:canvas uid:uid forTrack:AliRtcVideoTrackCamera];
        } else {
            /* Clear the remote user's rendering window here, but the remote user might leave the channel directly. */
            [self.engine setRemoteViewConfig:nil uid:uid forTrack:AliRtcVideoTrackCamera];
        }
    });
}

- (void)onRemoteUserOffLineNotify:(NSString *)uid offlineReason:(AliRtcUserOfflineReason)reason {
    dispatch_async(dispatch_get_main_queue(), ^{
        /* Clear the remote user's rendering window here as well. */
        [self.engine setRemoteViewConfig:nil uid:uid forTrack:AliRtcVideoTrackBoth];
    });
}

- (void)onJoinChannelResult:(int)result channel:(NSString *)channel userId:(NSString *)userId elapsed:(int)elapsed {
    /* TODO: Optional. Add business logic, typically for data statistics or UI changes. */
}

- (void)onLeaveChannelResult:(int)result stats:(AliRtcStats)stats {
    /* TODO: Optional. Add business logic, typically for data statistics or UI changes. */
}

Windows

class AliEngineEventListenerImpl : public AliEngineEventListener {
public:
    AliEngineEventListenerImpl(AliEngine* engine, HWND hWnd) {
        mAliRtcEngine = engine;
        mHWnd = hWnd;
    };
    virtual AliEngineEventListenerImpl() {};

    virtual void OnConnectionStatusChange(int status, int reason) override {
        if (status == AliEngineConnectionFailed) {
            /* TODO: Required. Prompt the customer with an error message. The SDK reports this only after internal recovery policies have failed and it can no longer be used. */
        } else {
            /* TODO: Optional. Add business logic, typically for data statistics or UI changes. */
        }
    };

    virtual void OnLocalDeviceException(AliEngineLocalDeviceType deviceType, AliEngineLocalDeviceExceptionType exceptionType, const char* msg) override {
        /* TODO: Required. Prompt the customer with an error message. The SDK reports this only after internal recovery policies have failed and it can no longer be used. */
    };

    virtual void OnJoinChannelResult(int result, const char *channel, const char *userId, int elapsed) override {
        /* TODO: Optional. Add business logic, typically for data statistics or UI changes. */
    };

    virtual void OnLeaveChannelResult(int result, AliEngineStats stats) override {
        
    };

    virtual void OnAuthInfoWillExpire() override {
        /* TODO: Required. The service triggers re-obtaining authentication information for the current channel and user, then set refreshAuthInfo. */
    };

    virtual void OnBye(int code) override {
        /* TODO: Handle this based on your business scenario. */
    };

    virtual void OnRemoteUserOnLineNotify(const char *uid, int elapsed) override {
        
    };

    virtual void OnRemoteUserOffLineNotify(const char *uid, AliEngineUserOfflineReason reason) override {
        
    };

    virtual void OnRemoteTrackAvailableNotify(const char *uid,
                                                  AliEngineAudioTrack audioTrack,
                                                  AliEngineVideoTrack videoTrack) {
        AliEngineVideoCanvas remote_canvas;
        if (videoTrack == AliEngineVideoTrackCamera
                            || videoTrack == AliEngineVideoTrackBoth) {
            RECT rect;
            ::GetWindowRect(mHWnd, &rect);
            remote_canvas.displayView = remoteView;
            remote_canvas.renderMode = AliEngineRenderModeAuto;
            mAliRtcEngine->SetRemoteViewConfig(remote_canvas,uid,AliEngineVideoTrackCamera);
        } else {
            mAliRtcEngine->SetRemoteViewConfig(remote_canvas, uid, AliEngineVideoTrackCamera);
        }
    }

private:
    AliEngine* mAliRtcEngine = nullptr;
    /* Windows window handle */
    HWND mHWnd;
};


private:
void createEngine() {
    mAliRtcEngine = AliRtcEngine.Create("");
    mLisenter = new AliEngineEventListenerImpl(mAliRtcEngine, mHWnd);
    mAliRtcEngine->SetEngineEventListener(mLisenter);
}

Harmony client

this.rtcSdk = AliRtcEngine.getInstance(NULL, getContext(this));
this.engineEventListener: AliRtcEngineEventListener = new AliRtcEngineEventListener();
this.engineEventListener
      .onRemoteUserOnline((uid: string, elapsed: boolean)=> {
        // Someone joined the channel
      })
      .onRemoteUserOffline((uid:string, reason: AliRtcUserOfflineReason)=> {
        // Someone left the channel
      })
      .onJoinChannel((result : number, channel : string, userId : string, elapsed : number)=> {
        // Triggered when joining the channel
      })
      .onLeaveChannel((result : number, stat : AliRtcStats)=> {
        // Triggered when leaving the channel
      })
      
      .onBye((code : AliRtcOnByeType)=> {
        // Callback when kicked out by the server or the channel is closed
      })
      .onOccurError((error : number, msg : string)=> {
        // Callback when an error occurs
      })
      
      .onConnectionStatusChange((status : number, reason : number)=> {
        // Callback when network connection changes
      })
    ;

  this.rtcSdk?.setRtcEngineEventListener(this.engineEventListener);

Android

    private void initEngineBeforeJoin() {
        /* Optional: Parameter settings before joining the channel */
        mAliRtcEngine.setChannelProfile(AliRtcEngine.AliRTCSdkChannelProfile.AliRTCSdkInteractiveLive);
        mAliRtcEngine.setClientRole(AliRtcEngine.AliRTCSdkClientRole.AliRTCSdkInteractive);
        /* Set audio properties */
        mAliRtcEngine.setAudioProfile(AliRtcEngine.AliRtcAudioProfile.AliRtcEngineStereoHighQualityMode, AliRtcEngine.AliRtcAudioScenario.AliRtcSceneMusicMode);

        /* Optional: Camera preview. Streams are ingested even if not set. */
        AliRtcEngine.AliRtcVideoCanvas canvas = new AliRtcEngine.AliRtcVideoCanvas();
        canvas.view = mAliRtcEngine.createRenderSurfaceView(mContext);
        mLocalSurfaceContainer.removeAllViews();
        if (canvas.view != null) {
            mLocalSurfaceContainer.addView(canvas.view, new FrameLayout.LayoutParams(FrameLayout.LayoutParams.MATCH_PARENT, FrameLayout.LayoutParams.MATCH_PARENT));
        }
        mAliRtcEngine.setLocalViewConfig(canvas, AliRtcEngine.AliRtcVideoTrack.AliRtcVideoTrackCamera);
    }

iOS

- (void)initBeforeJoin {
    /* Optional: Parameter settings before joining the channel */
    [self.engine setChannelProfile:AliRtcInteractivelive];
    [self.engine setClientRole:AliRtcClientRoleInteractive];
    /* Set audio properties */
    [self.engine setAudioProfile:AliRtcEngineStereoHighQualityMode audio_scene:AliRtcSceneMusicMode];
    /* Optional: Camera preview. Streams are ingested even if not set. */
    AliVideoCanvas *canvas = [[AliVideoCanvas alloc] init];
    canvas.view = self.previewView;
    canvas.renderMode = AliRtcRenderModeAuto;
    [self.engine setLocalViewConfig:canvas forTrack:AliRtcVideoTrackCamera];
    return;
}

Windows

private:
void initEngineBeforeJoin() {
    /* Optional: Parameter settings before joining the channel */
    mAliRtcEngine->SetChannelProfile(AliEngineInteractiveLive);
    mAliRtcEngine->SetClientRole(AliEngineClientRoleInteractive);
    /* Set audio properties */
    mAliRtcEngine->SetAudioProfile(AliEngineBasicQualityMode, AliEngineSceneMusicMode);

    /* Optional: Camera preview. Streams are ingested even if not set. */
    AliEngineVideoCanvas canvas;
    /* Windows window handle */
    canvas.view = mHWnd;
    mAliRtcEngine.setLocalViewConfig(canvas, AliEngineVideoTrackCamera);
}

HarmonyOS Client

initEngineBeforeJoin = (surfaceId: string) => {
 
  let encoderConfig : AliRtcVideoEncoderConfiguration = new AliRtcVideoEncoderConfiguration();
  encoderConfig.dimensions = new AliRtcVideoDimensions();
  encoderConfig.dimensions.width = 480
  encoderConfig.dimensions.height = 640
  encoderConfig.frameRate = AliRtcFrameRate.AliEngineFrameRateFps15
  this.rtcSdk?.setVideoEncoderConfiguration(encoderConfig)

  let profile : AliRtcChannelProfile = AliRtcChannelProfile.AliEngineInteractiveLive
  if (this.mainPageParams.interactive_mode == 0) {
    profile = AliRtcChannelProfile.AliEngineCommunication
  } else if (this.mainPageParams.interactive_mode == 2) {
    profile = AliRtcChannelProfile.AliEngineInteractiveWithLowLatencyLive
  }
  this.rtcSdk?.setChannelProfile(profile);
  this.rtcSdk?.setClientRole(this.mainPageParams.is_anchor ? AliRtcClientRole.AliEngineClientRoleInteractive : AliRtcClientRole.AliEngineClientRoleLive);


  this.localVideoCanvas.surfaceId = surfaceId;
  this.rtcSdk?.setLocalViewConfig(this.localVideoCanvas, this.componentController, AliRtcVideoTrack.AliEngineVideoTrackCamera);

}

Android

initEngineBeforeJoin();
mAliRtcEngine.joinChannel("Your authentication information", null, null, "testUserName");

iOS

[self initBeforeJoin];
/* The channelId and userId here depend entirely on the values issued by the server; the app does not perceive them. */
[self.engine joinChannel:@"Your authentication information" channelId:nil userId:nil name:@"testUserName" onResultWithUserId:nil];

Windows

initEngineBeforeJoin();
mAliRtcEngine->joinChannel("Your authentication information", null, null, "testUserName");

Harmony Client

this.initEngineBeforeJoin();
this.rtcSdk?.joinChannel("Your authentication information", null, null, "testUserName");

Android

/* TODO: Set the role based on your business. */
/* Set the interactive role (streamer role). */
mAliRtcEngine.setClientRole(AliRtcEngine.AliRTCSdkClientRole.AliRTCSdkInteractive);
/* Set the viewing role (viewer role). */
mAliRtcEngine.setClientRole(AliRtcEngine.AliRTCSdkClientRole.AliRTCSdkLive);

iOS

/* TODO: Set the role based on your business. */
/* Set the interactive role (streamer role). */
[self.engine setClientRole:AliRtcClientRoleInteractive];
/* Set the viewing role (viewer role). */
[self.engine setClientRole:AliRtcClientRolelive];

Windows

/* TODO: Set the role based on your business. */
/* Set the interactive role (streamer role). */
mAliRtcEngine->SetClientRole(AliEngineClientRoleInteractive);
/* Set the viewing role (viewer role). */
mAliRtcEngine->SetClientRole(AliEngineClientRoleLive);

HarmonyOS

/* TODO: Set the role based on your business. */
/* Set the interactive role (streamer role). */
this.rtcSdk?.setClientRole(AliRtcClientRole.AliEngineClientRoleInteractive);
/* Set the viewing role (viewer role). */
this.rtcSdk?.setClientRole(AliRtcClientRole.AliEngineClientRoleLive);

Android

mAliRtcEngine.leaveChannel();

iOS

[self.engine leaveChannel];

Windows

mAliRtcEngine->LeaveChannel();

Harmony Client

this.rtcSdk?.leaveChannel();

Android

mAliRtcEngine.destroy();
mAliRtcEngine = null;

iOS

[AliRtcEngine destroy];

Windows

mAliRtcEngine->Destroy();
mAliRtcEngine = nullptr;

HarmonyOS

AliRtcEngine.destroyInstance();
this.rtcSdk? = null;

Android

iOS

Windows