Integrate Android SDK using license mode

1. Modes

To use the multimodal interaction development kit with the license billing model, you must integrate the License SDK. For integration instructions, see Section 4.

2. Prerequisites

• To use license mode, you must first create an application in the Model Studio console and purchase a license.

• The SDK generates a unique device identifier and persists it on the device to prevent duplicate registrations. Call DeviceUUIDUtil.getAndroid(context) to retrieve this identifier. You must either use the deviceName generated by the SDK or ensure the one you provide is unique.

• To specify a custom storage path for device registration information, call DeviceUUIDUtil.getAndroidId(context, "your_absolute_storage_path"). The client is responsible for ensuring it has the necessary read and write permissions for the custom path.

3. API

DeviceAuthClient.getInstance().initialize(new InitParams(APP_ID, APP_SECRET, mDeviceName), new InitCallBack() {
   @Override
   public void success() {
       Log.d(TAG, "initialize success");
   } 
   @Override
   public void fail(ResultError resultError) {
       Log.e(TAG, "initialize fail: " + resultError.getMessage());
   }
});

DeviceRegisterInfo deviceRegisterInfo = new DeviceRegisterInfo();
deviceRegisterInfo.setAppId(APP_ID);
deviceRegisterInfo.setDeviceName(mDeviceName);
deviceRegisterInfo.setPayMode(PAY_MODE);
deviceRegisterInfo.setReqNonce(RandomUtil.generateRandomHexString(26));
deviceRegisterInfo.setRequestTime(String.valueOf(System.currentTimeMillis()));
Result<String> result = DeviceAuthClient.getInstance().genRegisterReq(deviceRegisterInfo);
if (result.isSuccess()) {
    Log.d(TAG, "genRegisterReq: " + result.getData());
}

DeviceRegisterRsp params = new DeviceRegisterRsp();
params.setAppId(APP_ID);
params.setDeviceName(mDeviceName);
params.setReqNonce("YOUR REQUEST NONCE");
params.setRspNonce("YOUR RESPONSE NONCE");
params.setResponseTime("YOUR RESPONSE TIME");
params.setSignature("YOUR RESPONSE SIGNATURE");
Result<String> result = DeviceAuthClient.getInstance().writeDeviceInfo(params);
if (result.isSuccess()) {
    Log.d(TAG, "writeDeviceInfo success");
} else {
    Log.e(TAG, "writeDeviceInfo error: " + result.getMessage());
}

{
    "success": true,
    "data": "84uoRCyy6AG/SH7LrHjJW0D7lsBp/H4RReS7gJY5L0oC517xJWAmwtmghLjYkW/Qj4ZvK6vrM7QC5yxtMl3TQLHdAGSsqQLb0bP6zKOiDzoNFwqs61+GMQ7guTPjbE9Fqaf7"
}

GenGetTokenParams params = new GenGetTokenParams();
params.setNonce(RandomUtil.generateRandomHexString(26));
params.setAppId("YOUR APP_ID");
params.setDeviceName(mDeviceName);
params.setPayMode(PayMode.LICENSE.getPayMode());
params.setTokenType("MMI");
params.setRequestTime(String.valueOf(System.currentTimeMillis()));
Result<String> result = DeviceAuthClient.getInstance().genGetTokenReq(params);
if (result.isSuccess()) {
    Log.d(TAG, "getTokenSign: " + result.getData());
}

AnalyzeTokenSignRsp tokenSignRsp = new AnalyzeTokenSignRsp();
tokenSignRsp.setAppId(APP_ID);
tokenSignRsp.setDeviceName(mDeviceName);
tokenSignRsp.setReqNonce("YOUR REQUEST NONCE");
tokenSignRsp.setRspNonce("YOUR RESPONSE NONCE");
tokenSignRsp.setResponseTime("YOUR RESPONSE TIME");
tokenSignRsp.setSignature("YOUR RESPONSE SIGNATURE");
Result<String> result = DeviceAuthClient.getInstance().getToken(tokenSignRsp);
if (result.isSuccess()) {
    Log.d(TAG, "analyzeTokenSign: " + result.getData());
}

boolean deviceIsRegistered = DeviceAuthClient.getInstance().deviceIsRegistered();

DeviceRegisterParams params = new DeviceRegisterParams();
params.setNonce(RandomUtil.generateRandomHexString(26));
params.setAppId("YOUR_APP_ID");
params.setWorkspaceId("YOUR_WORKSPACE_ID");
params.setDeviceName(mDeviceName);
params.setRequestTime(String.valueOf(System.currentTimeMillis()));
params.setPayMode(PayMode.LICENSE.getPayMode());
DeviceAuthClient.getInstance().deviceRegister(params, new DeviceRegisterCallBack() {
 @Override
 public void success() {
     Log.d(TAG, "deviceRegister success");
 }
 @Override
 public void fail(ResultError error) {
     Log.e(TAG, error.getMessage());
 }
});

GenGetTokenParams params = new GenGetTokenParams();
params.setNonce(RandomUtil.generateRandomHexString(26));
params.setAppId("YOUR_APP_ID");
params.setDeviceName(mDeviceName);
params.setRequestTime(String.valueOf(System.currentTimeMillis()));
params.setPayMode(PayMode.LICENSE.getPayMode());
params.setTokenType("MMI");
DeviceAuthClient.getInstance().getToken(params, new GetTokenCallBack() {
    @Override
    public void success(String tokenInfo) {
        Log.d(TAG, "getToken success: " + tokenInfo);
    }
    @Override
    public void fail(ResultError error) {
        Log.e(TAG, error.getMessage());
    }
});

/// Get the license signature
String taskId = UUID.randomUUID().toString().replace("-", "");
LicenseSignatureParams params = new LicenseSignatureParams(authParams.getAppid(), deviceName, taskId);
JSONObject licenseInfoSignature = DeviceAuthClient.getInstance().getLicenseSignature(params);
// Returns a JSON object containing the timestamp, license_info, and device_info.

boolean result = DeviceAuthClient.getInstance().deviceReset();
 if (!result) {
     showToast("Failed to reset the device.");
 } else {
     showToast("Device reset successful. You can now register it again.");
 }

4. Integrate dependency library

Reference the multimodal_dialog_tongyimetathings-1.0.5.aar file from the latest Android SDK.

5. Multimodal SDK integration

1. Before you start a session, initialize the tongyimetathings SDK and check if the device is registered. If not, register the device. For more information, see the sample integration project.

2. After device registration is complete, obtain a multimodal session token. For more information, see the APIs in sections 2.1 and 2.3. Set the apiKey to the dashToken returned by the getToken API. For more information, see the sample project.

multimodalParams.setApiKey(jsonObject.getString("dashToken"));

3. When you create a session, pass the license billing identifier. For example:

private MultiModalRequestParam buildRequestParams() {
    
MultiModalRequestParam.UpStream.ReplaceWord replaceWord = new MultiModalRequestParam.UpStream.ReplaceWord();
replaceWord.setTarget("one plus one");
replaceWord.setSource("1 plus 1");
replaceWord.setMatchMode("partial");
String deviceName = DeviceUUIDUtil.getAndroidId(this); // Note: This uses the default SDK path for storage. The commented-out line shows how to specify a custom path.
//String deviceName = DeviceUUIDUtil.getAndroidId(this,"your_custom_absolute_path")
taskId = UUID.randomUUID().toString().replace("-", "");
// Build the license billing identifier
LicenseSignatureParams params = new LicenseSignatureParams(authParams.getAppid(), deviceName, taskId);
JSONObject licenseInfoSignature = DeviceAuthClient.getInstance().getLicenseSignature(params);
Map<String, Object> map = new HashMap<>();
map.put("signature", licenseInfoSignature);
return MultiModalRequestParam.builder()
        .clientInfo(MultiModalRequestParam.ClientInfo.builder()
                .device(MultiModalRequestParam.ClientInfo.Device.builder()
                        .uuid(deviceName).build()) // Set this to your device UUID
                .userId("123")  // The userId must be unique for each user and is used to track conversation history. We recommend using the device UUID.
                .passThroughParams(map) // Pass the license billing identifier
                .build())
        .upStream(MultiModalRequestParam.UpStream.builder()
                .mode(authParams.getDialogMode().getValue())
                .type("AudioAndVideo")
                .asrPostProcessing(Collections.singletonList(replaceWord))
                .build())
        .downStream(MultiModalRequestParam.DownStream.builder()
                .voice(mVoiceType) // The voice specified here must match the voice model configured in the console. For example, longxiaochun_v2 corresponds to cosyvoice_v2.
                .sampleRate(48000)
                .intermediateText(textStreamFeedback ? "dialog" : "transcript")
                .build())
        .build();
}