chrome/browser/resources/chromeos/accessibility/definitions/tts_engine.d.ts

// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

/**
 * @fileoverview Definitions for chrome.ttsEngine API
 * Generated from: chrome/common/extensions/api/tts_engine.json
 * run `tools/json_schema_compiler/compiler.py
 * chrome/common/extensions/api/tts_engine.json -g ts_definitions` to
 * regenerate.
 */

import type {ChromeEvent} from '../../../../../../tools/typescript/definitions/chrome_event.js';

declare global {
  export namespace chrome {

    export namespace ttsEngine {

      export enum TtsClientSource {
        CHROMEFEATURE = 'chromefeature',
        EXTENSION = 'extension',
      }

      export interface TtsClient {
        id: string;
        source: TtsClientSource;
      }

      export enum VoiceGender {
        MALE = 'male',
        FEMALE = 'female',
      }

      export interface LanguageUninstallOptions {
        uninstallImmediately: boolean;
      }

      export enum LanguageInstallStatus {
        NOT_INSTALLED = 'notInstalled',
        INSTALLING = 'installing',
        INSTALLED = 'installed',
        FAILED = 'failed',
      }

      export interface LanguageStatus {
        lang: string;
        installStatus: LanguageInstallStatus;
        error?: string;
      }

      export interface SpeakOptions {
        voiceName?: string;
        lang?: string;
        gender?: VoiceGender;
        rate?: number;
        pitch?: number;
        volume?: number;
      }

      export interface AudioStreamOptions {
        sampleRate: number;
        bufferSize: number;
      }

      export interface AudioBuffer {
        audioBuffer: Float32Array;
        charIndex?: number;
        isLastBuffer?: boolean;
      }

      export function updateVoices(voices: tts.TtsVoice[]): void;

      export function sendTtsEvent(requestId: number, event: tts.TtsEvent):
          void;

      export function sendTtsAudio(requestId: number, audio: AudioBuffer): void;

      export function updateLanguage(status: LanguageStatus): void;

      export const onSpeak: ChromeEvent<
          (utterance: string, options: SpeakOptions,
           sendTtsEvent: (event: tts.TtsEvent) => void) => void>;

      export const onSpeakWithAudioStream: ChromeEvent<
          (utterance: string, options: SpeakOptions,
           audioStreamOptions: AudioStreamOptions,
           sendTtsAudio: (audioBufferParams: AudioBuffer) => void,
           sendError: (errorMessage?: string) => void) => void>;

      export const onStop: ChromeEvent<() => void>;

      export const onPause: ChromeEvent<() => void>;

      export const onResume: ChromeEvent<() => void>;

      export const onInstallLanguageRequest:
          ChromeEvent<(requestor: TtsClient, lang: string) => void>;

      export const onUninstallLanguageRequest: ChromeEvent<
          (requestor: TtsClient, lang: string,
           uninstallOptions: LanguageUninstallOptions) => void>;

      export const onLanguageStatusRequest:
          ChromeEvent<(requestor: TtsClient, lang: string) => void>;
    }
  }
}