- Product Overview
- Purchase Guide
- Introduction of Avatar
- Server API Integration
- Avatar aPaas API Calling Methods
- Avatar Image Customization and Voice Clone API Documentation - v 0.2.1
- Video Generation Service API Documentation - v 4.9.9
- Overview
- Digital Human aPaaS API Calling Methods
- Audio Production API
- Video Production API - Basic Edition
- Audio and Video Production Progress Query API
- Video Production API - Advanced Version
- Customer Resource Query Anchor API
- Querying All Images of a Specific Anchor
- Querying the Supported Timbres for VirtualmanKey (to Be Deprecated)
- Querying the Supported Actions for VirtualmanKey
- Appendix
- API Integration FAQs
- Interactive Digital Human Service API Documentation - v 5.0.3
- Overview
- Digital Human aPaaS API Calling Methods
- Live Session Management
- Creating a New Live Stream Session
- Using the Personal Asset Image to Create a Stream
- Querying the Session Status
- Starting Session
- Closing Live Session
- Querying the Conversation List under the Digital Human Project
- Querying the Conversion List under the Personal Asset Image
- Querying the Session List under UIN
- Instruction-driven
- Other APIs
- Error Code Description
- Best Practices demo
- Personal Asset Management API Documentation - v 1.1.2
- Overview
- Digital Human aPaaS API Calling Methods
- Querying for Avatar List by Pagination API
- Querying Supported Timbres for Avatars (to be Deprecated)
- Querying Customer Service Asset Information
- Querying Timbre Lists by Pagination
- Querying Image Asset Information - Query Anchor
- Querying Image Asset Information - Querying all Avatars under the Anchor
- Querying the List Of Actions Supported by the Avatar
- Appendix 1 - Service Asset Type
- Appendix 2 - Emotional Style
- Appendix 3 - Digital Human Type
- API Integration FAQs
- Client SDK Integration
- TCADH Platform Operation Guide
- FAQs
- Product Overview
- Purchase Guide
- Introduction of Avatar
- Server API Integration
- Avatar aPaas API Calling Methods
- Avatar Image Customization and Voice Clone API Documentation - v 0.2.1
- Video Generation Service API Documentation - v 4.9.9
- Overview
- Digital Human aPaaS API Calling Methods
- Audio Production API
- Video Production API - Basic Edition
- Audio and Video Production Progress Query API
- Video Production API - Advanced Version
- Customer Resource Query Anchor API
- Querying All Images of a Specific Anchor
- Querying the Supported Timbres for VirtualmanKey (to Be Deprecated)
- Querying the Supported Actions for VirtualmanKey
- Appendix
- API Integration FAQs
- Interactive Digital Human Service API Documentation - v 5.0.3
- Overview
- Digital Human aPaaS API Calling Methods
- Live Session Management
- Creating a New Live Stream Session
- Using the Personal Asset Image to Create a Stream
- Querying the Session Status
- Starting Session
- Closing Live Session
- Querying the Conversation List under the Digital Human Project
- Querying the Conversion List under the Personal Asset Image
- Querying the Session List under UIN
- Instruction-driven
- Other APIs
- Error Code Description
- Best Practices demo
- Personal Asset Management API Documentation - v 1.1.2
- Overview
- Digital Human aPaaS API Calling Methods
- Querying for Avatar List by Pagination API
- Querying Supported Timbres for Avatars (to be Deprecated)
- Querying Customer Service Asset Information
- Querying Timbre Lists by Pagination
- Querying Image Asset Information - Query Anchor
- Querying Image Asset Information - Querying all Avatars under the Anchor
- Querying the List Of Actions Supported by the Avatar
- Appendix 1 - Service Asset Type
- Appendix 2 - Emotional Style
- Appendix 3 - Digital Human Type
- API Integration FAQs
- Client SDK Integration
- TCADH Platform Operation Guide
- FAQs
After you Create Long Connection Channel, you can use a websocket persistent connection to send audio to drive the digital human.
Request Parameters
Parameter name | Type | Required | Description |
ReqId | String | Yes | A unique identifier for a single drive. Each segment of audio is assigned a UUID value. |
SessionId | String | Yes | Unique identifier for the session. |
Command | String | Yes | SEND_AUDIO; send the audio. |
Data | Yes | Data Object |
Data
Name | Type | Required | Description |
Audio | string | Yes | The byte array of the original audio data, encoded into a string via Base64. Only supports: format-PCM, sampling rate-16kHz, sampling bit depth-16bits, audio track-mono. |
Seq | int | Yes | Audio packet sequence number, which must start from 1. |
IsFinal | bool | No | The default value is false. |
Note:
1. If the data is being sent in real-time from a microphone, it can be sent every 160 ms (5120B) without any waiting interval. If the data is being sent from an offline audio file, the packet size should be 160 ms (5120B) with a 120 ms interval between packets.
2. The size of the last packet should be based on the actual remaining data (must be less than 160 ms).
3. After all data packets have been sent, an empty data packet with IsFinal=true (with the Audio field left empty) must be sent to signal the end of the audio session and return the Digital Human to a silent state.
4. The real-time rate of sending audio must be between [0.75, 1]. A rate lower than 0.75 will trigger throttling, while a rate higher than 1 will cause video stuttering. For example, for a 160 ms audio packet size, the sending interval must not be less than 120 ms or more than 160 ms.
Request Sample
{"Header": {},"Payload": {"ReqId": "d7aa08da33dd4a662ad5be508c5b77cf","SessionId": "m123adfafvbadsafd","Command": "SEND_AUDIO","Data": {"Audio": "The value of the audio binary data encoded in Base64","Seq": 0,"IsFinal": false}}}
Yes
No
Was this page helpful?