AICaptionComponent（AI字幕组件）

导入模块

import {
  AICaptionComponent, AudioInfo, AudioData, AICaptionOptions, AICaptionController, AICaptionFontSize
} from '@kit.SpeechKit';

AICaptionComponent

AI字幕组件，可以作为动态组件加载。

装饰器类型： @Component

系统能力： SystemCapability.AI.AICaption

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

参数：

build

build(): void

用于创建对象AICaptionComponent的构造函数。

系统能力： SystemCapability.AI.AICaption

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

示例：

import { AICaptionComponent, AICaptionController, AICaptionOptions } from '@kit.SpeechKit';

@Entry
@Component
struct Index {
  private captionOption?: AICaptionOptions;
  private controller = new AICaptionController();
  @State isShow: boolean = false;

  aboutToAppear(): void {
    this.captionOption = {
      initialOpacity: 1,
      onPrepared: () => {
        // ...
      },
      onError: () => {
        // ...
      }
    };
  }

  build() {
    Column() {
      // 调用AICaptionComponent组件初始化字幕
      AICaptionComponent({
        isShown: this.isShow,
        controller: this.controller,
        options: this.captionOption
      })
    }
  }
}

组件如下图：

AICaptionController

AI字幕控件的主要功能入口类。

系统能力： SystemCapability.AI.AICaption

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

示例：

import { AICaptionComponent, AICaptionOptions, AICaptionController } from '@kit.SpeechKit';

@Entry
@Component
struct Index {
  private options?: AICaptionOptions;
  private controller = new AICaptionController();
  @State isShown: boolean = false;

  aboutToAppear(): void {
    this.options = {
      initialOpacity: 1,
      onPrepared: () => {
        // ...
      },
      onError: () => {
        // ...
      }
    };
  }

  build() {
    Column() {
      // 调用AICaptionComponent组件初始化字幕
      AICaptionComponent({
        isShown: this.isShown,
        controller: this.controller,
        options: this.options
      })
    }
  }
}

isCapabilitySupported

isCapabilitySupported(): boolean

检测设备是否支持AI字幕功能。

系统能力： SystemCapability.AI.AICaption

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 26.0.0

返回值：

示例：

import { AICaptionComponent, AICaptionOptions, AICaptionController } from '@kit.SpeechKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Index {
  private captionOption?: AICaptionOptions;
  private controller: AICaptionController = new AICaptionController();
  @State isSupport: boolean = false;
  @State isShown: boolean = false;

  aboutToAppear(): void {
    // AI字幕初始化参数，设置字幕的不透明度和回调函数
    this.captionOption = {
      initialOpacity: 1,
      onPrepared: () => {
        console.info('onPrepared')
      },
      onError: (error: BusinessError) => {
        console.error(`AICaption component error. Error code: ${error.code}, message: ${error.message}`);
      }
    };
    this.isSupport = this.controller.isCapabilitySupported();
    this.isShown = true;
  }

  build() {
    Column({ space: 20 }) {
      // 调用AICaptionComponent组件初始化字幕
      if (this.isSupport) {
        AICaptionComponent({
          isShown: this.isShown,
          controller: this.controller,
          options: this.captionOption
        })
      }
    }
  }
}

getAudioInfo

getAudioInfo(): AudioInfo

获取要被识别的音频信息。

系统能力： SystemCapability.AI.AICaption

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

返回值：

示例：

import { AICaptionController, AudioInfo } from '@kit.SpeechKit';

try {
  let controller = new AICaptionController();
  let audioInfo: AudioInfo = controller.getAudioInfo();
} catch (e) {
  console.error(`GetAudioInfo failed. Code: ${e.code}, message: ${e.message}`);
}

writeAudio

writeAudio(audioData: AudioData): void

写入音频数据。音频流信息格式从getAudioInfo方法获取（调用此方法会停止自动获取应用音频生成字幕，以写入的音频流为准）。

系统能力： SystemCapability.AI.AICaption

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

参数：

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

示例：

import { AICaptionController, AudioData } from '@kit.SpeechKit';


let audioData: AudioData = {
  data: new Uint8Array()
};
try {
  let controller = new AICaptionController();
  controller.writeAudio(audioData);
} catch (e) {
  console.error(`WriteAudio failed. Code: ${e.code}, message: ${e.message}`);
}

AudioInfo

音频流信息。

系统能力： SystemCapability.AI.AICaption

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

AudioData

音频数据。

系统能力： SystemCapability.AI.AICaption

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

AICaptionOptions

字幕初始化选项。

系统能力： SystemCapability.AI.AICaption

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 5.0.0(12)

错误码：

以下错误码的详细介绍请参见ArkTS API错误码。

AICaptionFontSize

AI字幕字体大小的枚举类。

系统能力： SystemCapability.AI.AICaption

模型约束： 此接口仅可在Stage模型下使用。

起始版本： 6.1.1(24)