Duix

https://docs.duix.com/
Admin
Duix provides APIs and SDKs for developers to integrate its features, including conversation...
Tokens:61,182
Snippets:325
Trust Score:7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Duix iOS SDK Guide

Source: https://docs.duix.com/api-reference/h5/process

Guides for the iOS SDK, including download, installation, SDK reference, quick start, key interfaces, code examples, and common errors.

```APIDOC
iOS SDK:
  Download and Installation: https://docs.duix.com/api-reference/ios/download
  SDK Reference: https://docs.duix.com/api-reference/ios/sdkreference
  Quick Start: https://docs.duix.com/api-reference/ios/quickstart
  Key Interfaces: https://docs.duix.com/api-reference/ios/interface
  Code Example: https://docs.duix.com/api-reference/ios/example
  Common Errors: https://docs.duix.com/api-reference/ios/error
```

--------------------------------

### Duix API Introduction and Getting Started

Source: https://docs.duix.com/api-reference/api/createYourFirstConvsation

Provides an overview of the Duix API, including how to create an account, log in to the platform, and start generating conversations. It guides users through the initial setup process.

```APIDOC
API Documentation:
  Introduction: Overview of the Duix API.
  Create Your First Conversation: Guide to starting conversations.
    - Create an Account: Instructions to create a DUIX.COM account.
    - Login to the Platform: Steps to log in and access the workbench.
  Get Your API Keys: Information on obtaining API keys.
  Get Token: Details on how to get an authentication token.
  Open API: Information about the OpenAPI specification.
```

--------------------------------

### H5 SDK Quick Start

Source: https://docs.duix.com/api-reference/h5/events

Guide for quickly starting with the H5 SDK, including download and installation.

```APIDOC
Quick Start
https://docs.duix.com/api-reference/h5/quickstart
```

--------------------------------

### Duix iOS SDK Documentation

Source: https://docs.duix.com/api-reference/ios/download

Guides for the iOS SDK, including download, installation, reference, quick start, key interfaces, examples, and common errors.

```APIDOC
iOS SDK:
  Download and Installation: Instructions for downloading and installing the iOS SDK.
  SDK Reference: Detailed reference for the iOS SDK.
  Quick Start: A quick guide to get started with the iOS SDK.
  Key Interfaces: Explanation of key interfaces in the iOS SDK.
  Code Example: Example code for using the iOS SDK.
  Common Errors: List and solutions for common errors encountered with the iOS SDK.
```

--------------------------------

### Duix iOS SDK Guide

Source: https://docs.duix.com/api-reference/ios/example

Documentation for the Duix iOS SDK, including download, installation, SDK reference, quick start, key interfaces, code examples, and common errors.

```APIDOC
iOS SDK:
  Download and Installation: https://docs.duix.com/api-reference/ios/download
  SDK Reference: https://docs.duix.com/api-reference/ios/sdkreference
  Quick Start: https://docs.duix.com/api-reference/ios/quickstart
  Key Interfaces: https://docs.duix.com/api-reference/ios/interface
  Code Example: https://docs.duix.com/api-reference/ios/example
  Common Errors: https://docs.duix.com/api-reference/ios/error
```

--------------------------------

### iOS SDK Documentation

Source: https://docs.duix.com/api-reference/android/download

Guides for the Duix iOS SDK, including download, installation, quick start, key interfaces, code examples, and common errors.

```APIDOC
iOS SDK:
  Download and Installation: https://docs.duix.com/api-reference/ios/download
  SDK Reference: https://docs.duix.com/api-reference/ios/sdkreference
  Quick Start: https://docs.duix.com/api-reference/ios/quickstart
  Key Interfaces: https://docs.duix.com/api-reference/ios/interface
  Code Example: https://docs.duix.com/api-reference/ios/example
  Common Errors: https://docs.duix.com/api-reference/ios/error
```

--------------------------------

### Duix Android SDK Guide

Source: https://docs.duix.com/api-reference/h5/process

Guides for the Android SDK, including download, installation, dependency management, Proguard configuration, quick start, key interfaces, and precautions.

```APIDOC
Android SDK:
  Download and Installation: https://docs.duix.com/api-reference/android/download
  Add Dependencies: https://docs.duix.com/api-reference/android/dependent
  Proguard Configuration: https://docs.duix.com/api-reference/android/proguard
  Quick Start: https://docs.duix.com/api-reference/android/quickstart
  Key Interfaces: https://docs.duix.com/api-reference/android/interface
  Precautions: https://docs.duix.com/api-reference/android/be_careful
```

--------------------------------

### Duix H5 SDK Guide

Source: https://docs.duix.com/api-reference/h5/process

Guides for the H5 SDK, covering quick start, call process, methods, events, code examples, FAQs, and version history.

```APIDOC
H5 SDK:
  Quick Start: https://docs.duix.com/api-reference/h5/quickstart
  Call Process: https://docs.duix.com/api-reference/h5/process
  Methods: https://docs.duix.com/api-reference/h5/methods
  Events: https://docs.duix.com/api-reference/h5/events
  Code Examples: https://docs.duix.com/api-reference/h5/code
  Frequently Asked Questions: https://docs.duix.com/api-reference/h5/questions
  Version History: https://docs.duix.com/api-reference/h5/versions
```

--------------------------------

### Duix H5 SDK - Quick Start and Methods

Source: https://docs.duix.com/api-reference/ios/sdkreference

Documentation for the Duix H5 SDK, covering quick start guides, call processes, available methods, events, code examples, and FAQs.

```APIDOC
H5 SDK:
  Quick Start: https://docs.duix.com/api-reference/h5/quickstart
  Call Process: https://docs.duix.com/api-reference/h5/process
  Methods: https://docs.duix.com/api-reference/h5/methods
  Events: https://docs.duix.com/api-reference/h5/events
  Code Examples: https://docs.duix.com/api-reference/h5/code
  Frequently Asked Questions: https://docs.duix.com/api-reference/h5/questions
  Version History: https://docs.duix.com/api-reference/h5/versions
```

--------------------------------

### Duix iOS SDK Documentation

Source: https://docs.duix.com/api-reference/android/proguard

Guides for the iOS SDK, including download, installation, quick start, key interfaces, code examples, and common error handling.

```APIDOC
iOS SDK:
  - Download and Installation: https://docs.duix.com/api-reference/ios/download
  - SDK Reference: https://docs.duix.com/api-reference/ios/sdkreference
  - Quick Start: https://docs.duix.com/api-reference/ios/quickstart
  - Key Interfaces: https://docs.duix.com/api-reference/ios/interface
  - Code Example: https://docs.duix.com/api-reference/ios/example
  - Common Errors: https://docs.duix.com/api-reference/ios/error
```

--------------------------------

### Duix iOS SDK Guide

Source: https://docs.duix.com/api-reference/ios/error

Guides for integrating the Duix iOS SDK, including download, installation, quick start, key interfaces, code examples, and common errors.

```APIDOC
iOS SDK:
  Download and Installation: https://docs.duix.com/api-reference/ios/download
  SDK Reference: https://docs.duix.com/api-reference/ios/sdkreference
  Quick Start: https://docs.duix.com/api-reference/ios/quickstart
  Key Interfaces: https://docs.duix.com/api-reference/ios/interface
  Code Example: https://docs.duix.com/api-reference/ios/example
  Common Errors: https://docs.duix.com/api-reference/ios/error
```

--------------------------------

### DUIX iOS SDK Documentation

Source: https://docs.duix.com/api-reference/api/Introduction

Guides for the iOS SDK, including download, installation, SDK reference, quick start, key interfaces, code examples, and common errors.

```APIDOC
* [Download and Installation](https://docs.duix.com/api-reference/ios/download)
* [SDK Reference](https://docs.duix.com/api-reference/ios/sdkreference)
* [Quick Start](https://docs.duix.com/api-reference/ios/quickstart)
* [Key Interfaces](https://docs.duix.com/api-reference/ios/interface)
* [Code Example](https://docs.duix.com/api-reference/ios/example)
* [Common Errors](https://docs.duix.com/api-reference/ios/error)
```

--------------------------------

### iOS SDK Guide

Source: https://docs.duix.com/api-reference/h5/questions

Instructions for integrating the Duix iOS SDK, including download, installation, SDK reference, quick start, key interfaces, code examples, and common error handling.

```APIDOC
iOS SDK:
  Download and Installation: Steps to get and install the SDK.
  SDK Reference: Detailed reference for SDK components and methods.
  Quick Start: A rapid guide to begin using the SDK.
  Key Interfaces: Explanation of essential SDK interfaces.
  Code Example: Practical code snippets demonstrating SDK usage.
  Common Errors: Troubleshooting common issues encountered with the SDK.
```

--------------------------------

### iOS SDK Documentation

Source: https://docs.duix.com/api-reference/avatar/Overview

Guides for the Duix iOS SDK, including download, installation, reference, quick start, key interfaces, code examples, and common errors.

```APIDOC
iOS SDK:
  Download and Installation: https://docs.duix.com/api-reference/ios/download
  SDK Reference: https://docs.duix.com/api-reference/ios/sdkreference
  Quick Start: https://docs.duix.com/api-reference/ios/quickstart
  Key Interfaces: https://docs.duix.com/api-reference/ios/interface
  Code Example: https://docs.duix.com/api-reference/ios/example
  Common Errors: https://docs.duix.com/api-reference/ios/error
```

--------------------------------

### Duix iOS SDK

Source: https://docs.duix.com/api-reference/api/openAPI

Guides for the Duix iOS SDK, covering download and installation, SDK reference, quick start, key interfaces, code examples, and common errors.

```APIDOC
iOS SDK:
  Download and Installation
  SDK Reference
  Quick Start
  Key Interfaces
  Code Example
  Common Errors
```

--------------------------------

### H5 SDK Quick Start

Source: https://docs.duix.com/api-reference/h5/methods

A quick start guide to help developers begin using the Duix H5 SDK.

```APIDOC
H5 SDK Quick Start:
  Provides essential steps to get the H5 SDK up and running quickly in web applications.
```

--------------------------------

### H5 SDK Installation

Source: https://docs.duix.com/api-reference/h5/quickstart

Install the Duix H5 SDK using npm. This command adds the 'duix-guiji-light' package as a dependency to your project.

```bash
npm i duix-guiji-light -S
```

--------------------------------

### Duix Android SDK Guide

Source: https://docs.duix.com/api-reference/ios/example

Documentation for the Duix Android SDK, covering download, installation, dependency management, Proguard configuration, quick start, key interfaces, and precautions.

```APIDOC
Android SDK:
  Download and Installation: https://docs.duix.com/api-reference/android/download
  Add Dependencies: https://docs.duix.com/api-reference/android/dependent
  Proguard Configuration: https://docs.duix.com/api-reference/android/proguard
  Quick Start: https://docs.duix.com/api-reference/android/quickstart
  Key Interfaces: https://docs.duix.com/api-reference/android/interface
  Precautions: https://docs.duix.com/api-reference/android/be_careful
```

--------------------------------

### Duix H5 SDK Guide

Source: https://docs.duix.com/api-reference/ios/example

Documentation for the Duix H5 SDK, including quick start, call process, methods, events, code examples, FAQs, and version history.

```APIDOC
H5 SDK:
  Quick Start: https://docs.duix.com/api-reference/h5/quickstart
  Call Process: https://docs.duix.com/api-reference/h5/process
  Methods: https://docs.duix.com/api-reference/h5/methods
  Events: https://docs.duix.com/api-reference/h5/events
  Code Examples: https://docs.duix.com/api-reference/h5/code
  Frequently Asked Questions: https://docs.duix.com/api-reference/h5/questions
  Version History: https://docs.duix.com/api-reference/h5/versions
```

--------------------------------

### H5 SDK Quick Start Example

Source: https://docs.duix.com/api-reference/h5/quickstart

A basic example of how to initialize and start a Duix session using the H5 SDK. It includes event handling for successful initialization and starting the session with ASR enabled. It's recommended not to make the Duix instance reactive in frameworks like Vue or React.

```javascript
import DUIX from 'duix-guiji-light'
const duix = new DUIX()
duix.on('initialSuccess', () => {
  // start session
  duix.start({
    openAsr: true
  }).then(res => {
    console.info(res)
  })
})
// initialization
duix.init({
  sign: 'xxxx',
  containerLable: '.remote-container',
  conversationId: '',
})
```

--------------------------------

### iOS SDK Quick Start

Source: https://docs.duix.com/api-reference/h5/methods

A quick start guide to help developers begin using the Duix iOS SDK.

```APIDOC
iOS SDK Quick Start:
  Provides essential steps to get the iOS SDK up and running quickly.
```

--------------------------------

### DUIX API Introduction and Getting Started

Source: https://docs.duix.com/api-reference/api/Introduction

Provides an overview of the DUIX API, prerequisites, and a guide to creating your first DUIX session. It explains how to use the API programmatically and discusses session duration and plan options.

```APIDOC
# Introduction
Take a look at our Docs and API Reference to learn how to use DUIX!
## [Developer Portal The first interface that speaks our language. CVI is multimodal and understands and uses facial expressions, body language, and has natural conversational awareness including interrupts and turn-taking. ](https://duix.com/platform/cases) Contact Us The world’s fastest interface of its kind, with SLAs as fast as under 1s latency utterance-to-utterance.
# 
[](https://docs.duix.com/api-reference/api/Introduction#getting-started)
Getting started
Prerequisites and how to get help All plans, even free plans, have access to API (application programming interface), allowing you to use our technology and all its functions programmatically through code. APIs are the basic components that applications that use DUIX or any other service rely on. In this section, we’ll provide a fairly concise overview of how to create our first DUIX session using the API to make a request to the endpoint. It is worth noting that the website is only the front end of the API. Therefore, if you experience a session demo or call the API directly with code, there should be no difference in quality or output under the same settings. However, it is still non-deterministic, so the delivery of the generated output may vary. The session duration is required for the API call to connect to the session. Therefore, if you have 5 minutes of conversation duration in your account, and you create a session, you need to consume the corresponding conversation duration when using the API to call the session. For your convenience, you can go first.[Purchase plan](https://duix.com/pricing), or you can use the free quota to verify the process first. Given the breadth of APIs and the almost limitless possibilities, we’ll do a very quick overview and show some examples so you can get up and running quickly.
[Create Your First Conversation](https://docs.duix.com/api-reference/api/createYourFirstConvsation)
[github](https://github.com/GuijiAI/duix.ai)
[Powered by Mintlify](https://mintlify.com/preview-request?utm_campaign=poweredBy&utm_medium=referral&utm_source=ahuahua-a7e6ffbc)
```

--------------------------------

### Duix iOS SDK Documentation

Source: https://docs.duix.com/api-reference/android/interface

Guides for the Duix iOS SDK, covering download, installation, SDK reference, quick start, key interfaces, code examples, and common errors.

```APIDOC
iOS SDK:
  Download and Installation: https://docs.duix.com/api-reference/ios/download
  SDK Reference: https://docs.duix.com/api-reference/ios/sdkreference
  Quick Start: https://docs.duix.com/api-reference/ios/quickstart
  Key Interfaces: https://docs.duix.com/api-reference/ios/interface
  Code Example: https://docs.duix.com/api-reference/ios/example
  Common Errors: https://docs.duix.com/api-reference/ios/error
```

--------------------------------

### Duix Android SDK Guide

Source: https://docs.duix.com/api-reference/ios/error

Guides for integrating the Duix Android SDK, including download, installation, dependency management, Proguard configuration, quick start, key interfaces, and precautions.

```APIDOC
Android SDK:
  Download and Installation: https://docs.duix.com/api-reference/android/download
  Add Dependencies: https://docs.duix.com/api-reference/android/dependent
  Proguard Configuration: https://docs.duix.com/api-reference/android/proguard
  Quick Start: https://docs.duix.com/api-reference/android/quickstart
  Key Interfaces: https://docs.duix.com/api-reference/android/interface
  Precautions: https://docs.duix.com/api-reference/android/be_careful
```

--------------------------------

### Duix H5 SDK Guide

Source: https://docs.duix.com/api-reference/ios/error

Guides for integrating the Duix H5 SDK, including quick start, call process, methods, events, code examples, FAQs, and version history.

```APIDOC
H5 SDK:
  Quick Start: https://docs.duix.com/api-reference/h5/quickstart
  Call Process: https://docs.duix.com/api-reference/h5/process
  Methods: https://docs.duix.com/api-reference/h5/methods
  Events: https://docs.duix.com/api-reference/h5/events
  Code Examples: https://docs.duix.com/api-reference/h5/code
  Frequently Asked Questions: https://docs.duix.com/api-reference/h5/questions
  Version History: https://docs.duix.com/api-reference/h5/versions
```

--------------------------------

### H5 SDK Documentation

Source: https://docs.duix.com/api-reference/h5/versions

Guides for using the Duix H5 SDK, covering quick start, call processes, methods, events, code examples, FAQs, and version history.

```APIDOC
H5 SDK:
  Quick Start: A quick guide to get started with the H5 SDK.
  Call Process: Explanation of the call process for the H5 SDK.
  Methods: Documentation for available methods.
  Events: Information on supported events.
  Code Examples: Practical code examples for the H5 SDK.
  Frequently Asked Questions: Answers to common questions.
  Version History: A record of changes across different versions.
```

--------------------------------

### H5 SDK Documentation

Source: https://docs.duix.com/api-reference/android/download

Guides for the Duix H5 SDK, covering quick start, call process, methods, events, code examples, FAQs, and version history.

```APIDOC
H5 SDK:
  Quick Start: https://docs.duix.com/api-reference/h5/quickstart
  Call Process: https://docs.duix.com/api-reference/h5/process
  Methods: https://docs.duix.com/api-reference/h5/methods
  Events: https://docs.duix.com/api-reference/h5/events
  Code Examples: https://docs.duix.com/api-reference/h5/code
  Frequently Asked Questions: https://docs.duix.com/api-reference/h5/questions
  Version History: https://docs.duix.com/api-reference/h5/versions
```

--------------------------------

### DUIX Android SDK Documentation

Source: https://docs.duix.com/api-reference/api/Introduction

Guides for the Android SDK, covering download, installation, dependency management, Proguard configuration, quick start, key interfaces, and precautions.

```APIDOC
* [Download and Installation](https://docs.duix.com/api-reference/android/download)
* [Add Dependencies](https://docs.duix.com/api-reference/android/dependent)
* [Proguard Configuration](https://docs.duix.com/api-reference/android/proguard)
* [Quick Start](https://docs.duix.com/api-reference/android/quickstart)
* [Key Interfaces](https://docs.duix.com/api-reference/android/interface)
* [Precautions](https://docs.duix.com/api-reference/android/be_careful)
```

--------------------------------

### DUIX API Reference - iOS SDK

Source: https://docs.duix.com/api-reference/api/https/docs

Guides for the iOS SDK, including download, installation, SDK reference, quick start, key interfaces, code examples, and common errors.

```APIDOC
iOS SDK
* [Download and Installation](https://docs.duix.com/api-reference/ios/download)
* [SDK Reference](https://docs.duix.com/api-reference/ios/sdkreference)
* [Quick Start](https://docs.duix.com/api-reference/ios/quickstart)
* [Key Interfaces](https://docs.duix.com/api-reference/ios/interface)
* [Code Example](https://docs.duix.com/api-reference/ios/example)
* [Common Errors](https://docs.duix.com/api-reference/ios/error)
```

--------------------------------

### Android SDK Quick Start

Source: https://docs.duix.com/api-reference/h5/methods

A quick start guide to help developers begin using the Duix Android SDK.

```APIDOC
Android SDK Quick Start:
  Provides essential steps to get the Android SDK up and running quickly.
```

--------------------------------

### Duix API Reference Introduction

Source: https://docs.duix.com/api-reference/ios/download

Provides an introduction to the Duix API Reference, guiding users on how to get started with the API.

```APIDOC
API Reference:
  Introduction: Overview of the Duix API.
  Create Your First Conversation: Guide to creating your first conversation.
  Get Your API Keys: Instructions for obtaining API keys.
  Get Token: Information on how to get an authentication token.
  Open API: Details about the Open API.
```

--------------------------------

### API Reference Introduction

Source: https://docs.duix.com/api-reference/h5/methods

Provides an introduction to the Duix API Reference, guiding users on how to get started with the API.

```APIDOC
API Reference Introduction:
  This section provides an overview of the Duix API, including how to get started, authentication, and basic concepts.
```

--------------------------------

### Duix API Reference Introduction

Source: https://docs.duix.com/api-reference/h5/process

Provides an introduction to the Duix API, guiding users on how to get started with the platform's functionalities.

```APIDOC
API Reference:
  Introduction: https://docs.duix.com/api-reference/api/Introduction
  Create Your First Conversation: https://docs.duix.com/api-reference/api/createYourFirstConvsation
  Get Your API Keys: https://docs.duix.com/api-reference/api/getYourAPIKeys
  Get Token: https://docs.duix.com/api-reference/api/getToken
  Open API: https://docs.duix.com/api-reference/api/openAPI
```

--------------------------------

### H5 SDK Guide

Source: https://docs.duix.com/api-reference/h5/questions

Documentation for the Duix H5 SDK, including quick start, call process, methods, events, code examples, FAQs, and version history.

```APIDOC
H5 SDK:
  Quick Start: Initial steps to integrate the H5 SDK.
  Call Process: Explanation of the SDK's operational flow.
  Methods: Reference for available SDK methods.
  Events: Details on SDK-triggered events.
  Code Examples: Practical code demonstrations for the H5 SDK.
  Frequently Asked Questions: Answers to common queries about the H5 SDK.
  Version History: Record of SDK updates and changes.
```

--------------------------------

### Duix iOS SDK Documentation

Source: https://docs.duix.com/api-reference/api/createYourFirstConvsation

Comprehensive documentation for the Duix iOS SDK, including download, installation, SDK reference, quick start guide, key interfaces, code examples, and common error handling.

```APIDOC
iOS SDK:
  Download and Installation: Instructions for getting and installing the SDK.
  SDK Reference: Detailed reference for SDK components.
  Quick Start: A guide to quickly begin using the SDK.
  Key Interfaces: Information on important interfaces within the SDK.
  Code Example: Practical code examples for using the SDK.
  Common Errors: Guidance on handling common errors.
```

--------------------------------

### iOS SDK Quick Start

Source: https://docs.duix.com/api-reference/h5/events

Quick start guide for the Duix iOS SDK.

```APIDOC
Quick Start
https://docs.duix.com/api-reference/ios/quickstart
```

--------------------------------

### Duix Android SDK Documentation

Source: https://docs.duix.com/api-reference/android/interface

Guides for the Duix Android SDK, including download, installation, dependency management, Proguard configuration, quick start, key interfaces, and precautions.

```APIDOC
Android SDK:
  Download and Installation: https://docs.duix.com/api-reference/android/download
  Add Dependencies: https://docs.duix.com/api-reference/android/dependent
  Proguard Configuration: https://docs.duix.com/api-reference/android/proguard
  Quick Start: https://docs.duix.com/api-reference/android/quickstart
  Key Interfaces: https://docs.duix.com/api-reference/android/interface
  Precautions: https://docs.duix.com/api-reference/android/be_careful
```

--------------------------------

### Android SDK Documentation

Source: https://docs.duix.com/api-reference/avatar/Overview

Guides for the Duix Android SDK, including download, installation, dependency management, Proguard configuration, quick start, key interfaces, and precautions.

```APIDOC
Android SDK:
  Download and Installation: https://docs.duix.com/api-reference/android/download
  Add Dependencies: https://docs.duix.com/api-reference/android/dependent
  Proguard Configuration: https://docs.duix.com/api-reference/android/proguard
  Quick Start: https://docs.duix.com/api-reference/android/quickstart
  Key Interfaces: https://docs.duix.com/api-reference/android/interface
  Precautions: https://docs.duix.com/api-reference/android/be_careful
```

--------------------------------

### Duix Android SDK Documentation

Source: https://docs.duix.com/api-reference/android/proguard

Guides for the Android SDK, covering download, installation, dependency management, Proguard configuration, quick start, key interfaces, and precautions.

```APIDOC
Android SDK:
  - Download and Installation: https://docs.duix.com/api-reference/android/download
  - Add Dependencies: https://docs.duix.com/api-reference/android/dependent
  - Proguard Configuration: https://docs.duix.com/api-reference/android/proguard
  - Quick Start: https://docs.duix.com/api-reference/android/quickstart
  - Key Interfaces: https://docs.duix.com/api-reference/android/interface
  - Precautions: https://docs.duix.com/api-reference/android/be_careful
```

--------------------------------

### Duix API Reference - Introduction

Source: https://docs.duix.com/api-reference/ios/interface

Provides an introduction to the Duix API, guiding users on how to get started with the platform.

```APIDOC
Introduction:
  - Overview of the Duix API
  - Getting started guide
```

--------------------------------

### Android SDK Quick Start

Source: https://docs.duix.com/api-reference/h5/events

Quick start guide for the Duix Android SDK.

```APIDOC
Quick Start
https://docs.duix.com/api-reference/android/quickstart
```

--------------------------------

### DUIX API Documentation - Introduction

Source: https://docs.duix.com/api-reference/api/getYourAPIKeys

Provides an introduction to the DUIX API, guiding users on how to get started and authenticate their requests.

```APIDOC
API Documentation:
  Introduction: https://docs.duix.com/api-reference/api/Introduction
  Create Your First Conversation: https://docs.duix.com/api-reference/api/createYourFirstConvsation
  Get Your API Keys: https://docs.duix.com/api-reference/api/getYourAPIKeys
  Get Token: https://docs.duix.com/api-reference/api/getToken
  Open API: https://docs.duix.com/api-reference/api/openAPI
```

--------------------------------

### iOS SDK Documentation

Source: https://docs.duix.com/api-reference/h5/versions

Guides for integrating the Duix iOS SDK, including download, installation, key interfaces, code examples, and error handling.

```APIDOC
iOS SDK:
  Download and Installation: Instructions for downloading and installing the SDK.
  SDK Reference: Comprehensive reference for the iOS SDK.
  Quick Start: A quick guide to get started with the iOS SDK.
  Key Interfaces: Details on the important interfaces within the SDK.
  Code Example: Practical code examples for using the iOS SDK.
  Common Errors: Information on common errors and their solutions.
```

--------------------------------

### API Reference Introduction

Source: https://docs.duix.com/api-reference/h5/questions

Provides an overview of the Duix API, guiding users on how to get started with the API, including creating their first conversation and obtaining API keys.

```APIDOC
API Reference:
  Introduction: Overview of the Duix API.
  Create Your First Conversation: Guide to initiating a conversation.
  Get Your API Keys: Instructions for retrieving API credentials.
  Get Token: Information on obtaining authentication tokens.
  Open API: Details on accessing the open API functionalities.
```

--------------------------------

### Duix Android SDK

Source: https://docs.duix.com/api-reference/avatar/AvatarTraining

Guides for the Android SDK, including download, installation, dependency management, Proguard configuration, quick start, key interfaces, and precautions.

```APIDOC
Android SDK:
  Download and Installation: https://docs.duix.com/api-reference/android/download
  Add Dependencies: https://docs.duix.com/api-reference/android/dependent
  Proguard Configuration: https://docs.duix.com/api-reference/android/proguard
  Quick Start: https://docs.duix.com/api-reference/android/quickstart
  Key Interfaces: https://docs.duix.com/api-reference/android/interface
  Precautions: https://docs.duix.com/api-reference/android/be_careful
```

--------------------------------

### Duix H5 SDK

Source: https://docs.duix.com/api-reference/conversational/CreatingCharacter

Guides for the Duix H5 SDK, including quick start, call process, methods, events, code examples, FAQs, and version history.

```APIDOC
H5 SDK:
  - Quick Start: https://docs.duix.com/api-reference/h5/quickstart
  - Call Process: https://docs.duix.com/api-reference/h5/process
  - Methods: https://docs.duix.com/api-reference/h5/methods
  - Events: https://docs.duix.com/api-reference/h5/events
  - Code Examples: https://docs.duix.com/api-reference/h5/code
  - Frequently Asked Questions: https://docs.duix.com/api-reference/h5/questions
  - Version History: https://docs.duix.com/api-reference/h5/versions
```

--------------------------------

### Duix API Reference Introduction

Source: https://docs.duix.com/api-reference/android/interface

Provides an introduction to the Duix API Reference, guiding users on how to get started with the API.

```APIDOC
API Reference:
  Introduction: https://docs.duix.com/api-reference/api/Introduction
  Create Your First Conversation: https://docs.duix.com/api-reference/api/createYourFirstConvsation
  Get Your API Keys: https://docs.duix.com/api-reference/api/getYourAPIKeys
  Get Token: https://docs.duix.com/api-reference/api/getToken
  Open API: https://docs.duix.com/api-reference/api/openAPI
```

--------------------------------

### H5 SDK Documentation

Source: https://docs.duix.com/api-reference/avatar/Overview

Guides for the Duix H5 SDK, covering quick start, call process, methods, events, code examples, FAQs, and version history.

```APIDOC
H5 SDK:
  Quick Start: https://docs.duix.com/api-reference/h5/quickstart
  Call Process: https://docs.duix.com/api-reference/h5/process
  Methods: https://docs.duix.com/api-reference/h5/methods
  Events: https://docs.duix.com/api-reference/h5/events
  Code Examples: https://docs.duix.com/api-reference/h5/code
  Frequently Asked Questions: https://docs.duix.com/api-reference/h5/questions
  Version History: https://docs.duix.com/api-reference/h5/versions
```

--------------------------------

### Duix Android SDK Documentation

Source: https://docs.duix.com/api-reference/ios/download

Guides for the Android SDK, including download, dependency management, Proguard configuration, quick start, key interfaces, and precautions.

```APIDOC
Android SDK:
  Download and Installation: Instructions for downloading and installing the Android SDK.
  Add Dependencies: How to add the SDK dependencies.
  Proguard Configuration: Proguard configuration details for the SDK.
  Quick Start: A quick guide to get started with the Android SDK.
  Key Interfaces: Explanation of key interfaces in the Android SDK.
  Precautions: Important precautions to consider when using the Android SDK.
```

--------------------------------

### Duix API Introduction

Source: https://docs.duix.com/api-reference/conversational/CreatingCharacter

Provides an introduction to the Duix API, including guides for getting started, creating your first conversation, and managing API keys.

```APIDOC
API Reference:
  - Introduction: https://docs.duix.com/api-reference/api/Introduction
  - Create Your First Conversation: https://docs.duix.com/api-reference/api/createYourFirstConvsation
  - Get Your API Keys: https://docs.duix.com/api-reference/api/getYourAPIKeys
  - Get Token: https://docs.duix.com/api-reference/api/getToken
  - Open API: https://docs.duix.com/api-reference/api/openAPI
```

--------------------------------

### Duix Android SDK Documentation

Source: https://docs.duix.com/api-reference/android/dependent

Guides for the Duix Android SDK, including download and installation, dependency management, Proguard configuration, quick start, key interfaces, and precautions.

```APIDOC
Android SDK:
  - Download and Installation: https://docs.duix.com/api-reference/android/download
  - Add Dependencies: https://docs.duix.com/api-reference/android/dependent
  - Proguard Configuration: https://docs.duix.com/api-reference/android/proguard
  - Quick Start: https://docs.duix.com/api-reference/android/quickstart
  - Key Interfaces: https://docs.duix.com/api-reference/android/interface
  - Precautions: https://docs.duix.com/api-reference/android/be_careful
```

--------------------------------

### DUIX API Introduction and Getting Started

Source: https://docs.duix.com/api-reference/api/https/docs

Provides an overview of the DUIX API, prerequisites for using the API, and a guide to creating your first DUIX session. It explains the role of APIs in DUIX applications and the importance of conversation duration for API calls.

```APIDOC
API Documentation
# Introduction
Take a look at our Docs and API Reference to learn how to use DUIX!
## [Developer Portal The first interface that speaks our language. CVI is multimodal and understands and uses facial expressions, body language, and has natural conversational awareness including interrupts and turn-taking. ](https://duix.com/platform/cases) Contact Us The world’s fastest interface of its kind, with SLAs as fast as under 1s latency utterance-to-utterance. 
# 
Getting started
Prerequisites and how to get help All plans, even free plans, have access to API (application programming interface), allowing you to use our technology and all its functions programmatically through code. APIs are the basic components that applications that use DUIX or any other service rely on. In this section, we’ll provide a fairly concise overview of how to create our first DUIX session using the API to make a request to the endpoint. It is worth noting that the website is only the front end of the API. Therefore, if you experience a session demo or call the API directly with code, there should be no difference in quality or output under the same settings. However, it is still non-deterministic, so the delivery of the generated output may vary. The session duration is required for the API call to connect to the session. Therefore, if you have 5 minutes of conversation duration in your account, and you create a session, you need to consume the corresponding conversation duration when using the API to call the session. For your convenience, you can go first.[Purchase plan](https://duix.com/pricing), or you can use the free quota to verify the process first. Given the breadth of APIs and the almost limitless possibilities, we’ll do a very quick overview and show some examples so you can get up and running quickly.
[Create Your First Conversation](https://docs.duix.com/api-reference/api/createYourFirstConvsation)
```

--------------------------------

### Duix API Reference Introduction

Source: https://docs.duix.com/api-reference/android/proguard

Provides an introduction to the Duix API, guiding users on how to get started with the API, including creating conversations and obtaining API keys.

```APIDOC
API Reference:
  - Introduction: https://docs.duix.com/api-reference/api/Introduction
  - Create Your First Conversation: https://docs.duix.com/api-reference/api/createYourFirstConvsation
  - Get Your API Keys: https://docs.duix.com/api-reference/api/getYourAPIKeys
  - Get Token: https://docs.duix.com/api-reference/api/getToken
  - Open API: https://docs.duix.com/api-reference/api/openAPI
```

--------------------------------

### Android SDK Quick Start

Source: https://docs.duix.com/api-reference/android/quickstart

Integrates the digital human module code in an Activity, ensuring microphone permission is dynamically obtained before starting. Initializes the renderer, sets scaling type, mirror, and hardware scaler. Initializes the VirtualFactory with app credentials and gets the player. Sets up player callbacks for showing the digital human, handling errors, ASR results, and video tracks. Connects to a conversation ID and releases resources in onDestroy.

```Kotlin
class DisplayActivity : BaseActivity() {
    private var eglBaseContext = EglBase.create().eglBaseContext
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // ...
        binding.render.init(eglBaseContext, null)
        binding.render.setScalingType(RendererCommon.ScalingType.SCALE_ASPECT_FILL)
        binding.render.setMirror(false)
        binding.render.setEnableHardwareScaler(false /* enabled */)
        VirtualFactory.init("your appId", "your appSecret")
        player = VirtualFactory.getPlayer(mContext, eglBaseContext)
        player?.addCallback(object : Player.Callback {
            override fun onShow() {
                // can show digital human
            }
            override fun onError(msgType: Int, msgSubType: Int, msg: String?) {
                // Log.e(TAG, "connect error")
            }
            override fun onAsrResult(text: String?, sentenceEnd: Boolean) {
            }
            override fun onVideoTrack(
                track: VideoTrack,
            ) {
                runOnUiThread {
                    // Add source for digital human view
                    track.addSink(binding.render)
                }
            }
        })
        player?.connect("your conversation id")
    }
    override fun onDestroy() {
        super.onDestroy()
        // Release resources 
        player?.release()
        binding.render.release()
    }
}
```

--------------------------------

### API Reference Introduction

Source: https://docs.duix.com/api-reference/android/download

Provides an introduction to the Duix API Reference, covering essential information for getting started with the platform's APIs.

```APIDOC
API Reference:
  Introduction: https://docs.duix.com/api-reference/api/Introduction
  Create Your First Conversation: https://docs.duix.com/api-reference/api/createYourFirstConvsation
  Get Your API Keys: https://docs.duix.com/api-reference/api/getYourAPIKeys
  Get Token: https://docs.duix.com/api-reference/api/getToken
  Open API: https://docs.duix.com/api-reference/api/openAPI
```

--------------------------------

### Duix API Introduction

Source: https://docs.duix.com/api-reference/avatar/AvatarTraining

Provides an overview of the Duix API, including how to get started, create your first conversation, and manage API keys and tokens.

```APIDOC
API Reference:
  Introduction: https://docs.duix.com/api-reference/api/Introduction
  Create Your First Conversation: https://docs.duix.com/api-reference/api/createYourFirstConvsation
  Get Your API Keys: https://docs.duix.com/api-reference/api/getYourAPIKeys
  Get Token: https://docs.duix.com/api-reference/api/getToken
  Open API: https://docs.duix.com/api-reference/api/openAPI
```

--------------------------------

### Duix Android SDK

Source: https://docs.duix.com/api-reference/conversational/CreatingCharacter

Instructions for the Duix Android SDK, covering setup, dependency management, Proguard configuration, quick start, key interfaces, and precautions.

```APIDOC
Android SDK:
  - Download and Installation: https://docs.duix.com/api-reference/android/download
  - Add Dependencies: https://docs.duix.com/api-reference/android/dependent
  - Proguard Configuration: https://docs.duix.com/api-reference/android/proguard
  - Quick Start: https://docs.duix.com/api-reference/android/quickstart
  - Key Interfaces: https://docs.duix.com/api-reference/android/interface
  - Precautions: https://docs.duix.com/api-reference/android/be_careful
```

--------------------------------

### Android SDK Documentation

Source: https://docs.duix.com/api-reference/h5/versions

Guides for integrating the Duix Android SDK, including setup, dependencies, proguard configuration, and key interfaces.

```APIDOC
Android SDK:
  Download and Installation: Instructions for downloading and installing the SDK.
  Add Dependencies: How to add the SDK as a dependency.
  Proguard Configuration: Configuration details for Proguard.
  Quick Start: A quick guide to get started with the Android SDK.
  Key Interfaces: Details on the important interfaces within the SDK.
  Precautions: Important considerations and precautions when using the Android SDK.
```

--------------------------------

### Duix iOS SDK

Source: https://docs.duix.com/api-reference/conversational/CreatingCharacter

Guides for integrating the Duix iOS SDK, including download, installation, quick start, key interfaces, code examples, and common error handling.

```APIDOC
iOS SDK:
  - Download and Installation: https://docs.duix.com/api-reference/ios/download
  - SDK Reference: https://docs.duix.com/api-reference/ios/sdkreference
  - Quick Start: https://docs.duix.com/api-reference/ios/quickstart
  - Key Interfaces: https://docs.duix.com/api-reference/ios/interface
  - Code Example: https://docs.duix.com/api-reference/ios/example
  - Common Errors: https://docs.duix.com/api-reference/ios/error
```

--------------------------------

### Duix iOS SDK

Source: https://docs.duix.com/api-reference/avatar/FAQ

Guides for integrating the Duix SDK into iOS applications, covering installation, reference, quick start, key interfaces, code examples, and common errors.

```APIDOC
Download and Installation:
  Instructions for obtaining and setting up the iOS SDK.

SDK Reference:
  Detailed reference for all SDK components and methods.

Quick Start:
  A streamlined guide to get started quickly with the iOS SDK.

Key Interfaces:
  Description of the primary interfaces and classes within the SDK.

Code Example:
  Illustrative code snippets demonstrating SDK usage.

Common Errors:
  Information on troubleshooting and resolving common issues.
```

--------------------------------

### Duix API Reference - iOS SDK

Source: https://docs.duix.com/api-reference/conversational/CreatingConversation

Guides for integrating the Duix iOS SDK, covering download, installation, quick start, key interfaces, code examples, and common error handling.

```APIDOC
iOS SDK:
  Download and Installation: Instructions for getting the SDK.
  SDK Reference: Detailed reference for SDK components.
  Quick Start: A rapid guide to begin using the SDK.
  Key Interfaces: Explanation of essential SDK interfaces.
  Code Example: Practical code snippets for implementation.
  Common Errors: Troubleshooting common issues.
```

--------------------------------

### Duix iOS SDK Documentation

Source: https://docs.duix.com/api-reference/android/dependent

Guides for the Duix iOS SDK, including download and installation, SDK reference, quick start, key interfaces, code examples, and common error handling.

```APIDOC
iOS SDK:
  - Download and Installation: https://docs.duix.com/api-reference/ios/download
  - SDK Reference: https://docs.duix.com/api-reference/ios/sdkreference
  - Quick Start: https://docs.duix.com/api-reference/ios/quickstart
  - Key Interfaces: https://docs.duix.com/api-reference/ios/interface
  - Code Example: https://docs.duix.com/api-reference/ios/example
  - Common Errors: https://docs.duix.com/api-reference/ios/error
```

--------------------------------

### Duix API Reference - iOS SDK

Source: https://docs.duix.com/api-reference/conversational/Overview

Guides for integrating the Duix iOS SDK, including download and installation, SDK reference, quick start, key interfaces, code examples, and common error handling.

```APIDOC
iOS SDK:
  Download and Installation: https://docs.duix.com/api-reference/ios/download
  SDK Reference: https://docs.duix.com/api-reference/ios/sdkreference
  Quick Start: https://docs.duix.com/api-reference/ios/quickstart
  Key Interfaces: https://docs.duix.com/api-reference/ios/interface
  Code Example: https://docs.duix.com/api-reference/ios/example
  Common Errors: https://docs.duix.com/api-reference/ios/error
```

--------------------------------

### iOS SDK Download and Installation

Source: https://docs.duix.com/api-reference/ios/download

Instructions for downloading the iOS SDK sample code and opening it in Xcode.

```bash
Download [duix-cloud-demo-ios_1.2.6.zip](https://duix-sgp.obs.ap-southeast-3.myhuaweicloud.com/duix/sdk/duix-cloud-demo-ios_1.2.6.zip) sample code and open the project using Xcode.
```

--------------------------------

### API Reference Introduction

Source: https://docs.duix.com/api-reference/android/be_careful

Provides an introduction to the Duix API Reference, guiding users on how to get started with the API.

```APIDOC
API Reference:
  Introduction: https://docs.duix.com/api-reference/api/Introduction
```

--------------------------------

### H5 SDK Code Examples

Source: https://docs.duix.com/api-reference/h5/methods

Practical code examples demonstrating the usage of the Duix H5 SDK.

```APIDOC
H5 SDK Code Examples:
  Illustrative code snippets showcasing common use cases and functionalities of the H5 SDK.
```

--------------------------------

### Android SDK Guide

Source: https://docs.duix.com/api-reference/h5/questions

Guidance for using the Duix Android SDK, covering download, dependency management, Proguard configuration, quick start, key interfaces, and precautions.

```APIDOC
Android SDK:
  Download and Installation: How to download and install the Android SDK.
  Add Dependencies: Instructions for adding the SDK to your project.
  Proguard Configuration: Settings for Proguard to ensure proper functionality.
  Quick Start: A beginner's guide to using the SDK.
  Key Interfaces: Description of the main interfaces provided by the SDK.
  Precautions: Important considerations and best practices when using the SDK.
```
Tokens:
Raw