# SpeechKit-SampleCode_AICaption-ArkTS

**Repository Path**: harmonyos_samples/sample-code_-aicaption-arkts

## Basic Information

- **Project Name**: SpeechKit-SampleCode_AICaption-ArkTS
- **Description**: 本示例基于场景化语音服务能力，提供了将音频文件识别为文字的服务。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 1
- **Created**: 2024-07-31
- **Last Updated**: 2026-01-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Implementing AICaption

### Overview
This sample code illustrates how to use the AICaptionComponent in voice AI capabilities.

This example simulates a scenario where you tap **Switch caption display status** and **Read PCM audio** buttons in sequence to start the AICaptionComponent and convert the audio to text.

You need to use **@kit.SpeechKit.d.ts**, which contains related APIs.

### Preview
<img src="screenshots/AICaption_en.png" height="820">

### Project Directory
```
├─entry/src/main/ets                         // Code area
│  ├─entryability
│  │  └─EntryAbility.ets                     // EntryAbility
│  └─pages
│     └─Index.ets                            // Home page
├─entry/src/main/resources                   // App resource directory
│  └─chineseAudio.pcm                        // PCM audio file
└─screenshots                                // Screenshots
```

### How to Implement

This example simulates a scenario where you tap **Switch caption display status** and **Read PCM audio** buttons in sequence to start the AICaptionComponent and convert the audio to text.
Before using the service, you need to perform the following operation: `import { AICaptionComponent, AICaptionOptions, AICaptionController, AudioData } from '@kit.SpeechKit'`

The following APIs are involved:
* `writeAudio(audioData: AudioData): void` [Link](https://developer.huawei.com/consumer/en/doc/harmonyos-references/speech-aicaptioncomponent#section272302165
)
* `AudioData` [Link](https://developer.huawei.com/consumer/en/doc/harmonyos-references/speech-aicaptioncomponent#section1869988122518)
* `AICaptionOptions` [Link](https://developer.huawei.com/consumer/en/doc/harmonyos-references/speech-aicaptioncomponent#section15787428226)

The following components are involved:
* `AICaptionComponent` [Link](https://developer.huawei.com/consumer/en/doc/harmonyos-references/speech-aicaptioncomponent#section7266241469)
* `AICaptionController` [Link](https://developer.huawei.com/consumer/en/doc/harmonyos-references/speech-aicaptioncomponent#section816451553012)

For details, please refer to **entry/src/main/ets/pages/Index.ets**.

### Required Permissions
None

### Constraints

1. The sample app is supported only on Huawei phones, tablets, and 2in1 devices running the standard system.
2. The HarmonyOS version must be HarmonyOS 5.0.0 Release or later.
3. The DevEco Studio version must be DevEco Studio 6.0.0 Release or later.
4. The HarmonyOS SDK version must be HarmonyOS 6.0.0 Release or later.