Integration overview

Step 1: Request audio and video permissions

Verify that your app has microphone and camera permissions, and prompt the user to grant them if needed. A reference implementation is available in PermissionUtils.java.

PermissionX.init(this)
.permissions(PermissionUtils.getPermissions())
.request((allGranted, grantedList, deniedList) -> {
});

Step 2: Create and initialize the engine

Create and initialize the ARTCAICallEngine:

String userId = "123";  // We recommend using the user ID from your app's login.
ARTCAICallEngineImpl engine = new ARTCAICallEngineImpl(this, userId);

 // If the agent is a digital human (AvatarAgent), configure its view container.
if (aiAgentType == AvatarAgent) {
    ViewGroup avatarlayer;
    engine.setAgentView(
        avatarlayer,
        new ViewGroup.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT,
                                   ViewGroup.LayoutParams.MATCH_PARENT)
    );
}
// If the agent provides visual understanding (VisionAgent), configure the local video preview container.
else if (aiAgentType == VisionAgent) {
    ViewGroup previewLayer;
    engine.setLocalView(previewLayer,
        new FrameLayout.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT,
                                     ViewGroup.LayoutParams.MATCH_PARENT)
    );
} else if(aiAgentType == VideoAgent) {
    ARTCAICallEngine.ARTCAICallVideoCanvas remoteCanvas = new ARTCAICallEngine.ARTCAICallVideoCanvas();
            remoteCanvas.zOrderOnTop = false;
            remoteCanvas.zOrderMediaOverlay = false;
    ViewGroup avatarlayer;
    engine.setAgentView(
        avatarlayer,
        new ViewGroup.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT,
                                   ViewGroup.LayoutParams.MATCH_PARENT), remoteCanvas
    );

    ViewGroup previewLayer;
    engine.setLocalView(previewLayer,
        new FrameLayout.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT,
                                     ViewGroup.LayoutParams.MATCH_PARENT)
    );

}

Step 3: Implement callbacks

Implement engine callbacks to handle call events. For details on the callback interface, see the API reference.

protected ARTCAICallEngine.IARTCAICallEngineCallback mCallEngineCallback = new ARTCAICallEngine.IARTCAICallEngineCallback() {
    @Override
    public void onErrorOccurs(ARTCAICallEngine.AICallErrorCode errorCode) {
        // An error occurred. End the call.
        engine.handup();
    }

    @Override
    public void onCallBegin() {
        // The call starts (the user has joined the session).
    }

    @Override
    public void onCallEnd() {
        // The call ends (the user has left the session).
    }

    @Override
    public void onAICallEngineRobotStateChanged(ARTCAICallEngine.ARTCAICallRobotState oldRobotState, ARTCAICallEngine.ARTCAICallRobotState newRobotState) {
        // The agent's state changes.
    }

    @Override
    public void onUserSpeaking(boolean isSpeaking) {
        // A user is speaking.
    }

    @Override
    public void onUserAsrSubtitleNotify(String text, boolean isSentenceEnd, int sentenceId, VoicePrintStatusCode voicePrintStatusCode) {
    
    }

    @Override
    public void onAIAgentSubtitleNotify(String text, boolean end, int userAsrSentenceId) {
        // Received subtitles for the agent's response.
    }

    @Override
    public void onNetworkStatusChanged(String uid, ARTCAICallEngine.ARTCAICallNetworkQuality quality) {
        // The network status changes.
    }

    @Override
    public void onVoiceVolumeChanged(String uid, int volume) {
        // A user's voice volume changes.
    }

    @Override
    public void onVoiceIdChanged(String voiceId) {
        // The voice for the current call changes.
    }

    @Override
    public void onVoiceInterrupted(boolean enable) {
        // The voice interruption setting for the current call changes.
    }

    @Override
    public void onAgentVideoAvailable(boolean available) {
        // The agent's video is available (publishing).
    }

    @Override
    public void onAgentAudioAvailable(boolean available) {
        // The agent's audio is available (publishing).
    }

    @Override
    public void onAgentAvatarFirstFrameDrawn() {
        // The first video frame of the digital human is rendered.
    }

    @Override
    public void onUserOnLine(String uid) {
        // A remote user comes online.
    }

};

engine.setEngineCallback(mCallEngineCallback);

Step 4: Create and initialize ARTCAICallConfig

For details, see the ARTCAICallConfig reference.

ARTCAICallEngine.ARTCAICallConfig artcaiCallConfig = new ARTCAICallEngine.ARTCAICallConfig();
artcaiCallConfig.agentId = "XXX";            // Required. The agent ID.
artcaiCallConfig.region = "cn-shanghai";     // Required. The agent region.
artcaiCallConfig.agentType = VoiceAgent;     // Specify the agent type: voice-only, digital human, visual understanding, or video call.
engine.init(artcaiCallConfig);

Step 5: Start a call with the agent

Call call() to start a call with the agent. To obtain an authentication token, see Generate an ARTC authentication token. After the call starts, add in-call features such as subtitles and agent interruption. Implement features.

engine.call(token);

// After the call is connected, the following callback is triggered.
public void onCallBegin() {
        // The call starts (the user has joined the session).
}

Step 6: Implement in-call features

Add features such as subtitles and agent interruption during the call. Implement features.

Step 7: End the call

Call handup() to end the call.

engine.handup();