TextReader (Read Control)

Module Import

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

init

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

Initializes the TextReader, that is, the TTS engine and underlying player. If the initialization fails, the corresponding error code is returned.

This API returns the result asynchronously through a promise. To configure long-duration permissions, please refer to step 8 in the development guide.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Returns:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

start

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

Shows the player panel and starts playback. If the playback fails, the corresponding error code is returned.

This API returns the result asynchronously through a promise.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Returns:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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

const readInfoList: TextReader.ReadInfo[] = [{
  id: '001',
  title: {
    text:'Title of the text to read',
    isClickable:true
  },
  author:{
    text:'Author of the text to read',
    isClickable:true
  },
  date: {
    text:'2024/01/01',
    isClickable:false
  },
  bodyInfo: 'Text body to read'
}];
// Start the TextReader.
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>

Stops reading, closes the playback panel, deregisters the listener, and resets parameters.

This API returns the result asynchronously through a promise.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Returns:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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>

Releases all resources of the TextReader.

This API returns the result asynchronously through a promise.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Returns:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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

Pauses playback.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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

Resumes playback.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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

Plays the previous article.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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

Plays the next article.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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

Hides the playback panel.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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

Shows the playback panel.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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

Queries the article reading status.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Returns:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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

Sets the article content.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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

try {
  TextReader.setArticleContent('article_01', 'Text body to read');
} catch (e) {
  console.error(`TextReader failed to setArticleContent. Code: ${e.code}, message: ${e.message}`);
}

setArticle

setArticle(readInfo: ReadInfo): void

Sets the article information.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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

const readInfo: TextReader.ReadInfo = {
  id: '001',
  title: {
    text:'Title of the text to read',
    isClickable:true
  },
  author:{
    text:'Author of the text to read',
    isClickable:true
  },
  date: {
    text:'2024/01/01',
    isClickable:false
  },
  bodyInfo: 'Text body to read',
  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

Loads more articles to the article list. This API must be called after init and start are called in the project. You are advised to use this API in the 'requestMore' operation listener.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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

@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(){
    /**
     * Load the data.
     */
    console.info(`ReadStateCode: ${JSON.stringify(this.readState)}`);
    let readInfoList: TextReader.ReadInfo[] = [{
      id: '001',
      title: {
    text:'Title of the text to read',
        isClickable:true
      },
      author:{
    text:'Author of the text to read',
        isClickable:true
      },
      date: {
        text:'2024/01/01',
        isClickable:false
      },
  bodyInfo: 'Text body to read'
    }];
    this.readInfoList = readInfoList;
    this.selectedReadInfo = this.readInfoList[0];
  }

  // Set the operation listener.
  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

Registers an article setting, which is triggered if the target article is empty (bodyInfo being empty) when an article is tapped or switched.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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

Deregisters an article setting, which is used after on(type: 'setArticle') is called.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

Example:

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

Registers the tap event, which is triggered when the title, author, or notification bar is tapped.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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

Deregisters a tap event, which is used after on(type: 'clickArticle' | 'clickAuthor' | 'clickNotification') is called.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

Example:

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

Callback triggered when the playback panel is shown or hidden.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

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

Deregisters the listening event for showing or hiding the playback panel, which is used after on(type: 'showPanel' | 'hidePanel') is called.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

Example:

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

Callback triggered when stop or release is called.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

Example:

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

Deregisters the stop/release event, which is used after on(type: 'stop' | 'release') is called.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

Example:

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

Callback triggered when the status of the article that is being played changes.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

Example:

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

Deregisters the event indicating that the status of the article that is being played changes, which is used after on(type: 'stateChange') is called.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

Example:

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

Callback triggered when a user swipes the screen to the bottom of a reading list.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

Example:

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

Deregisters the event for swiping to the bottom of the reading list, which is used after on(type: 'requestMore') is called.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

Example:

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

Callback triggered when the status of the notification bar and media controller or playback panel changes.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

Example:

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

Used after on(type: 'eventNotification' | 'eventPanel') is called, to deregister the callback executed when the status of the notification bar and media controller or playback panel changes.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

Example:

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

Registers a listener for events related to the reading list. When an event related to the reading list occurs, the callback is triggered.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

Example:

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

Deregisters events related to the reading list, which is used after on(type: 'eventReadList') is called.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

Error codes:

For details about the error codes, please refer to ArkTS API Error Codes.

Example:

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

Reading parameters.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

BusinessBrandInfo

Brand information.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

ReadState

Reading status.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

ReadInfo

Reading information.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

TextInfo

Text information.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

PanelEvent

Playback panel event.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

NotificationEvent

Notification bar event.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters:

ListEventState

List event status.

System capability: SystemCapability.AI.Component.TextReader

Start version: 5.0.0(12)

Parameters: