TextReader（朗读控件）

导入模块

import { TextReader } from '@kit.SpeechKit';

init

init(context: common.BaseContext, readParams: ReaderParam): Promise<void>

朗读控件初始化，用于初始化TTS引擎和底层播放器，初始化失败会返回对应错误码。

使用Promise异步回调。若要配置长时权限，请参考开发指南步骤8。

系统能力： SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

返回值：

错误码：

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

start

start(readInfoList: ReadInfo[], articleId?: string): Promise<void>

朗读控件起播，拉起播放器面板并开始播放。播放失败返回对应错误码。

使用Promise异步回调。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

返回值：

错误码：

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

import { TextReader } from '@kit.SpeechKit';
import { BusinessError } from '@kit.BasicServicesKit';

const readInfoList: TextReader.ReadInfo[] = [{
  id: '001',
  title: {
    text:'水调歌头.明月几时有',
    isClickable:true
  },
  author:{
    text:'宋.苏轼',
    isClickable:true
  },
  date: {
    text:'2024/01/01',
    isClickable:false
  },
  bodyInfo: '明月几时有？把酒问青天。'
}];
// 启动朗读控件
TextReader.start(readInfoList).then(() => {
  console.info(`TextReader succeeded in starting`);
}).catch((e: BusinessError) => {
  console.error(`TextReader failed to start. Code: ${e.code}, message: ${e.message}`);
})

stop

stop(): Promise<void>

朗读控件停止朗读，执行播放面板的关闭，注销监听，重置参数。

使用Promise异步回调。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

返回值：

错误码：

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

import { TextReader } from '@kit.SpeechKit';
import { BusinessError } from '@kit.BasicServicesKit';

TextReader.stop().then(() => {
  console.info(`TextReader succeeded in stopping.`);
}).catch((e: BusinessError) => {
  console.error(`TextReader failed to stop. Code: ${e.code}, message: ${e.message}`);
})

release

release(): Promise<void>

释放朗读控件的所有资源。

使用Promise异步回调。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

返回值：

错误码：

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

import { TextReader } from '@kit.SpeechKit';
import { BusinessError } from '@kit.BasicServicesKit';

TextReader.release().then(() => {
  console.info(`TextReader succeeded in releasing.`);
}).catch((e: BusinessError) => {
  console.error(`TextReader failed to release. Code: ${e.code}, message: ${e.message}`);
})

pause

pause(): void

暂停播放。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

错误码：

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

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.pause();
} catch (e) {
  console.error(`TextReader failed to pause. Code: ${e.code}, message: ${e.message}`);
}

resume

resume(): void

继续播放。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

错误码：

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

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.resume();
} catch (e) {
  console.error(`TextReader failed to resume. Code: ${e.code}, message: ${e.message}`);
}

playPrev

playPrev(): void

播放上一篇文章。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

错误码：

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

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.playPrev();
} catch (e) {
  console.error(`TextReader failed to play previous article. Code: ${e.code}, message: ${e.message}`);
}

playNext

playNext(): void

播放下一篇文章。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

错误码：

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

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.playNext();
} catch (e) {
  console.error(`TextReader failed to play next article. Code: ${e.code}, message: ${e.message}`);
}

hidePanel

hidePanel(): void

隐藏播放面板。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

错误码：

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

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.hidePanel();
} catch (e) {
  console.error(`TextReader failed to hide panel. Code: ${e.code}, message: ${e.message}`);
}

showPanel

showPanel(): void

打开播放面板。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

错误码：

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

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.showPanel();
} catch (e) {
  console.error(`TextReader failed to show panel. Code: ${e.code}, message: ${e.message}`);
}

queryReadState

queryReadState(id?: string): ReadState

查询文章播报状态。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

返回值：

错误码：

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

import { TextReader } from '@kit.SpeechKit';

try {
  let readState = TextReader.queryReadState('article_01');
  console.info(`Succeeded in querying read state, read state: ${JSON.stringify(readState)}`);
} catch(e) {
  console.error(`TextReader failed to queryReadState. Code: ${e.code}, message: ${e.message}`);
}

setArticleContent

setArticleContent(id: string, content?: string): void

设置文章内容。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.setArticleContent('article_01', '明月几时有？把酒问青天。');
} catch (e) {
  console.error(`TextReader failed to setArticleContent. Code: ${e.code}, message: ${e.message}`);
}

setArticle

setArticle(readInfo: ReadInfo): void

设置指定文章的信息，并立即播放。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

import { TextReader } from '@kit.SpeechKit';
import { image } from '@kit.ImageKit';

const readInfo: TextReader.ReadInfo = {
  id: '001',
  title: {
    text:'水调歌头.明月几时有',
    isClickable:true
  },
  author:{
    text:'宋.苏轼',
    isClickable:true
  },
  date: {
    text:'2024/01/01',
    isClickable:false
  },
  bodyInfo: '明月几时有？把酒问青天。',
  image: {} as image.PixelMap
};
try {
  TextReader.setArticle(readInfo);
} catch (e) {
  console.error(`TextReader failed to setArticle. Code: ${e.code}, message: ${e.message}`);
}

loadMore

loadMore(readInfos: ReadInfo[], isEnd: boolean): void

加载更多文章到文章列表。需在项目init和start之后调用，建议在'requestMore'操作监听中使用。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

import { ReadStateCode, TextReader, TextReaderIcon } from '@kit.SpeechKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Index {

  @State readInfoList: TextReader.ReadInfo[] = [];
  @State readState: ReadStateCode = ReadStateCode.WAITING;
  @State isInit: boolean = false;
  @State selectedReadInfo: TextReader.ReadInfo = this.readInfoList[0];
  async aboutToAppear(){

    let context: Context = getContext(this);

    // 设置朗读参数
    const readerParams: TextReader.ReaderParam = {
      isVoiceBrandVisible: true,
      businessBrandInfo: {
        panelName: '小艺朗读',
        panelIcon: $r('app.media.startIcon')
      }
    };

    // 初始化朗读控件
    TextReader.init(context, readerParams).then(() => {
      console.info(`TextReader succeeded in initializing.`);
    }).catch((e: BusinessError) => {
      console.error(`TextReader failed to initialize. Code: ${e.code}, message: ${e.message}`);
    })

    /**
     * 加载数据
     */
    console.info(`ReadStateCode: ${JSON.stringify(this.readState)}`);
    let readInfoList: TextReader.ReadInfo[] = [{
      id: '001',
      title: {
        text:'水调歌头.明月几时有',
        isClickable:true
      },
      author:{
        text:'宋.苏轼',
        isClickable:true
      },
      date: {
        text:'2024/01/01',
        isClickable:false
      },
      bodyInfo: '明月几时有？把酒问青天。'
    }];
    this.readInfoList = readInfoList;
    this.selectedReadInfo = this.readInfoList[0];
  }

  // 设置操作监听
  setActionListener() {
    //...
    TextReader.on('requestMore', () => {
      console.info(`requestMore`);
      try {
        console.info(`loadMore`);
        TextReader.loadMore(this.readInfoList, true);
      } catch (e) {
        console.error(`TextReader failed to loadMore. Code: ${e.code}, message: ${e.message}`);
      }
    });
  }


  build() {
    Column() {
      TextReaderIcon({ readState: this.readState })
        .margin({ right: 20 })
        .width(32)
        .height(32)
        .onClick(async () => {
          try {
            this.setActionListener();
            await TextReader.start(this.readInfoList, this.selectedReadInfo?.id);
          } catch(e) {
            console.error(`TextReader failed to start`);
          }
        })
    }
    .height('100%')
  }
}

on(type: 'setArticle')

on(type: 'setArticle', callback: Callback<string>): void

注册设置文章回调函数，点击文章或者切换文章时，若目标文章内容为空（bodyInfo值为空）时，触发该回调执行。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.on('setArticle', (id: string) => {
    console.info(`Succeeded in setting setArticleListener: ${id}`);
  });
} catch (e) {
  console.error(`TextReader failed to set eventListener. Code: ${e.code}, message: ${e.message}`);
}

off(type: 'setArticle')

off(type: 'setArticle', callback?: Callback<string>): void

在on(type: 'setArticle')函数调用之后使用，用于注销设置文章回调函数。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

示例：

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.off('setArticle');
} catch (e) {
  console.error(`TextReader failed to unset eventListener. Code: ${e.code}, message: ${e.message}`);
}

on(type: 'clickArticle' | 'clickAuthor' | 'clickNotification')

on(type: 'clickArticle' | 'clickAuthor' | 'clickNotification', callback: Callback<string>): void

注册点击事件回调函数，点击标题、作者、通知栏时，触发该回调执行。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.on('clickArticle', (id: string) => {
    console.info(`Succeeded in setting clickArticleListener: ${id}`);
  });
  TextReader.on('clickAuthor', (id: string) => {
    console.info(`Succeeded in setting clickAuthorListener: ${id}`);
  });
  TextReader.on('clickNotification', (id: string) => {
    console.info(`Succeeded in setting clickNotificationListener: ${id}`);
  });
} catch (e) {
  console.error(`TextReader failed to set eventListener. Code: ${e.code}, message: ${e.message}`);
}

off(type: 'clickArticle' | 'clickAuthor' | 'clickNotification')

off(type: 'clickArticle' | 'clickAuthor' | 'clickNotification', callback?: Callback<string>): void

在on(type: 'clickArticle' | 'clickAuthor' | 'clickNotification')函数调用之后使用，用于注销点击事件回调函数。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

示例：

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.off('clickArticle');
  TextReader.off('clickAuthor');
  TextReader.off('clickNotification');
} catch (e) {
  console.error(`TextReader failed to unset eventListener. Code: ${e.code}, message: ${e.message}`);
}

on(type: 'showPanel' | 'hidePanel')

on(type: 'showPanel' | 'hidePanel', callback: Callback<void>): void

拉起/收回播放面板时，触发该回调执行。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.on('showPanel', () => {
    console.info(`Succeeded in setting showPanelListener.`);
  });
  TextReader.on('hidePanel', () => {
    console.info(`Succeeded in setting hidePanelListener.`);
  });
} catch (e) {
  console.error(`TextReader failed to set eventListener. Code: ${e.code}, message: ${e.message}`);
}

off(type: 'showPanel' | 'hidePanel')

off(type: 'showPanel' | 'hidePanel', callback?: Callback<void>): void

在on(type: 'showPanel' | 'hidePanel')函数调用之后使用，用于注销拉起/收回播放面板监听事件。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

示例：

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.off('showPanel');
  TextReader.off('hidePanel');
} catch (e) {
  console.error(`TextReader failed to unset eventListener. Code: ${e.code}, message: ${e.message}`);
}

on(type: 'stop' | 'release')

on(type: 'stop' | 'release', callback: Callback<void>): void

调用stop/release时，触发该回调执行。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

示例：

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.on('stop', () => {
    console.info(`Succeeded in setting stopListener.`);
  });
  TextReader.on('release', () => {
    console.info(`Succeeded in setting releaseListener.`);
  });
} catch (e) {
  console.error(`TextReader failed to set eventListener. Code: ${e.code}, message: ${e.message}`);
}

off(type: 'stop' | 'release')

off(type: 'stop' | 'release', callback?: Callback<void>): void

在on(type: 'stop' | 'release')函数调用之后使用，用于注销stop/release事件的回调函数。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

示例：

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.off('stop');
  TextReader.off('release');
} catch (e) {
  console.error(`TextReader failed to unset eventListener. Code: ${e.code}, message: ${e.message}`);
}

on(type: 'stateChange')

on(type: 'stateChange', callback: Callback<ReadState>): void

当前正在播放的文章状态变更时，触发该回调执行。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

示例：

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.on('stateChange', (state: TextReader.ReadState) => {
    console.info(`Succeeded in setting stateChangeListener: ${JSON.stringify(state)}`);
  });
} catch (e) {
  console.error(`TextReader failed to set eventListener. Code: ${e.code}, message: ${e.message}`);
}

off(type: 'stateChange')

off(type: 'stateChange', callback?: Callback<ReadState>): void

在on(type: 'stateChange')函数调用之后使用，用于注销正在播放的文章状态变更的回调函数。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

示例：

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.off('stateChange');
} catch (e) {
  console.error(`TextReader failed to unset eventListener. Code: ${e.code}, message: ${e.message}`);
}

on(type: 'requestMore')

on(type: 'requestMore', callback: Callback<void>): void

拉到播放列表底端或播放到文章最后一篇，触发该回调执行。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

示例：

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.on('requestMore', () => {
    console.info(`Succeeded in setting requestMoreListener.`);
  });
} catch (e) {
  console.error(`TextReader failed to set eventListener. Code: ${e.code}, message: ${e.message}`);
}

off(type: 'requestMore')

off(type: 'requestMore', callback?: Callback<void>): void

在on(type: 'requestMore')函数调用之后使用，用于注销拉到播放列表底端或播放到文章最后一篇的回调函数。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

示例：

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.off('requestMore');
} catch (e) {
  console.error(`TextReader failed to unset eventListener. Code: ${e.code}, message: ${e.message}`);
}

on(type: 'eventNotification' | 'eventPanel')

on(type: 'eventNotification' | 'eventPanel', callback: Callback<NotificationEvent| PanelEvent>): void

通知栏+播控中心、播放面板状态发生变化时，触发该回调执行。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

示例：

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.on('eventNotification', (ne: TextReader.NotificationEvent) => {
    console.info(`Succeeded in setting eventNotificationListener: ${JSON.stringify(ne)}`);
  });
  TextReader.on('eventPanel', (pe: TextReader.PanelEvent) => {
    console.info(`Succeeded in setting eventPanelListener: ${JSON.stringify(pe)}`);
  });
} catch (e) {
  console.error(`TextReader failed to set eventListener. Code: ${e.code}, message: ${e.message}`);
}

off(type: 'eventNotification' | 'eventPanel')

off(type: 'eventNotification' | 'eventPanel', callback?: Callback<NotificationEvent | PanelEvent>): void

在on(type: 'eventNotification' | 'eventPanel')函数调用之后使用，用于注销通知栏+播控中心、播放面板状态发生变化的回调函数。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

示例：

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.off('eventNotification');
  TextReader.off('eventPanel');
} catch (e) {
  console.error(`TextReader failed to unset eventListener. Code: ${e.code}, message: ${e.message}`);
}

on(type: 'eventReadList')

on(type: 'eventReadList', callback: Callback<Array<ListEventState>>): void

注册播报列表相关事件监听，点击播报列表图标时，触发该回调执行。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

示例：

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.on('eventReadList', (list: Array<TextReader.ListEventState>) => {
    list.forEach((id) => {
      console.info(`Succeeded in setting eventReadListListener, article id: ${id}`);
    })
  });
} catch (e) {
  console.error(`TextReader failed to set eventListener. Code: ${e.code}, message: ${e.message}`);
}

off(type: 'eventReadList')

off(type: 'eventReadList', callback?: Callback<Array<ListEventState>>): void

在on(type: 'eventReadList')函数调用之后使用，用于注销播报列表相关事件的回调函数。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

错误码：

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

示例：

import { TextReader } from '@kit.SpeechKit';

try {
  TextReader.off('eventReadList');
} catch (e) {
  console.error(`TextReader failed to unset eventListener. Code: ${e.code}, message: ${e.message}`);
}

ReaderParam

朗读参数

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

BusinessBrandInfo

播报品牌信息

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

ReadState

播报状态。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

ReadInfo

朗读信息。

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

TextInfo

文字信息

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

PanelEvent

播放面板事件

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

NotificationEvent

通知栏事件

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：

ListEventState

列表事件状态

系统能力：SystemCapability.AI.Component.TextReader

起始版本：5.0.0(12)

参数：