Talking avatar

Introduction

ZEGOCLOUD's Virtual Avatar now supports the Talking Avatar feature, it supports real-time driving of the virtual avatar's facial movements and corresponding audio playback of text-to-speech by inputting text.

Prerequisites

Before accessing the Text-Driven feature, please ensure that:

• Integrate the ZegoAvatar SDK into your project. For more information, see Integrate the SDK.
• Create a basic virtual avatar by referring to Create a virtual avatar.

• We have contacted ZEGO business personnel to enable text drive related permissions.

Implementation

1 Get module source code

After downloading Avatar SDK, find and copy the apiservice folder according to SDK's root directory /helper/apiservice and paste it to your app code to get the source code of talking avatar.

2 (Optional) Import dependencies

In the source code, ZegoTextAPI uses the AFNetworking network library and YYKit components, while you are allowed to import or modify the network implementation as needed based on the actual situation.

To import dependencies without modifying the network library or components, run the following:

pod 'AFNetworking', '~> 4.0'
pod 'YYKit'

3 Authentication

Before using the ZegoTextAPI, go to ZEGOCLOUD Admin Console to get your project's AppID and AppSign.

#import "ZegoTextLicenseCustomer.h"

[ZegoTextLicenseCustomer setZegoTextAppID:0];
[ZegoTextLicenseCustomer setZegoTextAppSign:@""];

4 Method calls

After building a basic avatar:

1. Initialize the ZegoTextAPI object and pass it in the Character object (can get from CharacterHelper).

// Initialize ZegoTextAPI,
ZegoTextAPI *textAPI = [[ZegoTextAPI alloc] initWithCharacter:self.helper.getCharacter];

//Set proxy
textAPI.delegate = self;

2. Call the playTextExpression method, type your text, and the avatar will make the corresponding expressions and say what you type.

// Type the text that needs to be converted into emotions
[textAPI playTextExpression:@"The text to be played"];

3. To stop driving the avatar to talk via text, call the stopTextExpression method.

//Stop the talking avatar.
[textAPI stopTextExpression];

5 Callbacks

After setting the proxy, ZegoTextAPI will call back the corresponding method.

// Callback when the talking avatar function starts.
- (void)onStart;

// Callback when an error occurs. For the Error Codes, refer to [Common Error Codes- Text Driver Error Codes]( <a href="https://docs.zegocloud.com/article/14596</a> )
- (void)onError:(ZegoTextAPIErrorCode)errorCode message:(NSString *_Nullable)message;

// Callback when the talking avatar function ends.
- (void)onEnd;

For related error codes, refer to Error codes- Talking Avatar.