dist¶

Interfaces¶

AwsPollySynthesizeSpeechInput¶

Properties¶

engine?¶

optional engine?: AwsPollyEngine;

languageCode?¶

optional languageCode?: AwsPollyLanguageCode;

lexiconNames?¶

optional lexiconNames?: string[];

outputFormat?¶

optional outputFormat?: AwsPollyOutputFormat;

sampleRate?¶

optional sampleRate?: string;

signal?¶

optional signal?: AbortSignal;

speechMarkTypes?¶

optional speechMarkTypes?: SpeechMarkType[];

text¶

text: string;

textType?¶

optional textType?: AwsPollyTextType;

voiceId¶

voiceId: AwsPollyVoiceId;

AwsPollySynthesizeSpeechResult¶

Properties¶

audio¶

audio:
  | ArrayBuffer
  | Uint8Array<ArrayBufferLike>
| ReadableStream<Uint8Array<ArrayBufferLike>>;

contentType?¶

optional contentType?: string;

outputFormat?¶

optional outputFormat?: AwsPollyOutputFormat;

requestCharacters?¶

optional requestCharacters?: number;

AwsSdkCommandClient¶

Type Parameters¶

Type Parameter
`Output`

Methods¶

send()¶

send(command, options?): Promise<Output>;

Parameters¶

Parameter	Type
`command`	`unknown`
`options?`	{ `abortSignal?`: `AbortSignal`; }
`options.abortSignal?`	`AbortSignal`

Returns¶

Promise\<Output>

AwsSdkCommandConstructor¶

Type Parameters¶

Type Parameter
`Input`

Constructors¶

Constructor¶

new AwsSdkCommandConstructor(input): unknown;

Parameters¶

Parameter	Type
`input`	`Input`

Returns¶

unknown

AwsSdkSpeechClientOptions¶

Properties¶

pollyClient¶

pollyClient: AwsSdkCommandClient<SynthesizeSpeechCommandOutput>;

StartStreamTranscriptionCommand¶

StartStreamTranscriptionCommand: AwsSdkCommandConstructor<StartStreamTranscriptionCommandInput>;

SynthesizeSpeechCommand¶

SynthesizeSpeechCommand: AwsSdkCommandConstructor<SynthesizeSpeechCommandInput>;

transcribeStreamingClient¶

transcribeStreamingClient: AwsSdkCommandClient<StartStreamTranscriptionCommandOutput>;

AwsSpeechClient¶

Type Parameters¶

Type Parameter	Default type
`RawClients` extends `AwsSpeechCommandClients`	`AwsSpeechCommandClients`

Properties¶

rawClients¶

rawClients: RawClients;

Methods¶

getRawClient()¶

getRawClient(): RawClients;

Returns¶

RawClients

synthesizeSpeech()¶

synthesizeSpeech(input): Promise<AwsPollySynthesizeSpeechResult>;

Parameters¶

Parameter	Type
`input`	`AwsPollySynthesizeSpeechInput`

Returns¶

Promise\<AwsPollySynthesizeSpeechResult>

transcribeSpeech()¶

transcribeSpeech(input): Promise<AwsTranscribeSpeechResult>;

Parameters¶

Parameter	Type
`input`	`AwsTranscribeSpeechInput`

Returns¶

Promise\<AwsTranscribeSpeechResult>

AwsSpeechClientOptions¶

Extends¶

AwsSpeechCredentialStatusInput

Properties¶

accessKeyId?¶

optional accessKeyId?: string;

Inherited from¶

AwsSpeechCredentialStatusInput.accessKeyId

pollyClient?¶

optional pollyClient?: PollyClient;

pollyClientConfig?¶

optional pollyClientConfig?: PollyClientConfig;

region?¶

optional region?: string;

Inherited from¶

AwsSpeechCredentialStatusInput.region

secretAccessKey?¶

optional secretAccessKey?: string;

Inherited from¶

AwsSpeechCredentialStatusInput.secretAccessKey

sessionToken?¶

optional sessionToken?: string;

Inherited from¶

AwsSpeechCredentialStatusInput.sessionToken

transcribeStreamingClient?¶

optional transcribeStreamingClient?: TranscribeStreamingClient;

transcribeStreamingClientConfig?¶

optional transcribeStreamingClientConfig?: TranscribeStreamingClientConfig;

AwsSpeechCommandClients¶

Extended by¶

AwsSpeechRawClients

Properties¶

pollyClient¶

pollyClient: AwsSdkCommandClient<SynthesizeSpeechCommandOutput>;

transcribeStreamingClient¶

transcribeStreamingClient: AwsSdkCommandClient<StartStreamTranscriptionCommandOutput>;

AwsSpeechCredentialStatusInput¶

Extended by¶

AwsSpeechClientOptions

Properties¶

accessKeyId?¶

optional accessKeyId?: string;

region?¶

optional region?: string;

secretAccessKey?¶

optional secretAccessKey?: string;

sessionToken?¶

optional sessionToken?: string;

AwsSpeechJsonObject¶

Indexable¶

[key: string]: AwsSpeechProviderExtensionValue

AwsSpeechOperationRequestInput¶

Properties¶

body?¶

optional body?: AwsSpeechProviderPayload;

contentType?¶

optional contentType?: string;

headers?¶

optional headers?: Record<string, string>;

pathParams?¶

optional pathParams?: Record<string, string | number>;

query?¶

optional query?: AwsSpeechProviderQuery;

responseType?¶

optional responseType?: "response" | "json" | "arrayBuffer" | "stream";

AwsSpeechProviderExtensionFields¶

Extends¶

AwsSpeechJsonObject

Indexable¶

[key: string]: AwsSpeechProviderExtensionValue

AwsSpeechProviderResponse¶

Extends¶

AwsSpeechJsonObject

Indexable¶

[key: string]: AwsSpeechProviderExtensionValue

AwsSpeechRawClients¶

Extends¶

AwsSpeechCommandClients

Properties¶

pollyClient¶

pollyClient: PollyClient;

Overrides¶

AwsSpeechCommandClients.pollyClient

transcribeStreamingClient¶

transcribeStreamingClient: TranscribeStreamingClient;

Overrides¶

AwsSpeechCommandClients.transcribeStreamingClient

AwsSpeechVoiceProviderOptions¶

Extends¶

Omit\<Partial\<SpeechPipelineVoiceProviderOptions>, "provider" | "transcriptionSource" | "transcribe" | "synthesize">

Properties¶

accessKeyId?¶

optional accessKeyId?: string;

client?¶

optional client?: AwsSpeechClient;

contentIdentificationType?¶

optional contentIdentificationType?: "PII";

contentRedactionType?¶

optional contentRedactionType?: "PII";

enableChannelIdentification?¶

optional enableChannelIdentification?: boolean;

enablePartialResultsStabilization?¶

optional enablePartialResultsStabilization?: boolean;

endSilenceMs?¶

optional endSilenceMs?: number;

Inherited from¶

Omit.endSilenceMs

engine?¶

optional engine?: AwsPollyEngine;

id?¶

optional id?: string;

Inherited from¶

Omit.id

identifyLanguage?¶

optional identifyLanguage?: boolean;

identifyMultipleLanguages?¶

optional identifyMultipleLanguages?: boolean;

languageCode?¶

optional languageCode?: AwsTranscribeLanguageCode;

languageModelName?¶

optional languageModelName?: string;

languageOptions?¶

optional languageOptions?: string[];

lexiconNames?¶

optional lexiconNames?: string[];

maxSpeechMs?¶

optional maxSpeechMs?: number;

Inherited from¶

Omit.maxSpeechMs

mediaEncoding?¶

optional mediaEncoding?: AwsTranscribeMediaEncoding;

minSpeechMs?¶

optional minSpeechMs?: number;

Inherited from¶

Omit.minSpeechMs

model?¶

optional model?: string;

Inherited from¶

Omit.model

numberOfChannels?¶

optional numberOfChannels?: number;

outputFormat?¶

optional outputFormat?: AwsPollyOutputFormat;

partialResultsStability?¶

optional partialResultsStability?: AwsTranscribePartialResultsStability;

piiEntityTypes?¶

optional piiEntityTypes?: string[];

pollyClient?¶

optional pollyClient?: AwsSdkCommandClient<SynthesizeSpeechCommandOutput>;

pollyClientConfig?¶

optional pollyClientConfig?: PollyClientConfig;

pollyLanguageCode?¶

optional pollyLanguageCode?: AwsPollyLanguageCode;

pollySampleRate?¶

optional pollySampleRate?: string;

preferredLanguage?¶

optional preferredLanguage?: AwsTranscribeLanguageCode;

region?¶

optional region?: string;

sampleRate?¶

optional sampleRate?: number;

Inherited from¶

Omit.sampleRate

secretAccessKey?¶

optional secretAccessKey?: string;

sessionResumeWindow?¶

optional sessionResumeWindow?: number;

sessionToken?¶

optional sessionToken?: string;

showSpeakerLabel?¶

optional showSpeakerLabel?: boolean;

silenceThreshold?¶

optional silenceThreshold?: number;

Inherited from¶

Omit.silenceThreshold

speechMarkTypes?¶

optional speechMarkTypes?: SpeechMarkType[];

StartStreamTranscriptionCommand?¶

optional StartStreamTranscriptionCommand?: AwsSdkCommandConstructor<StartStreamTranscriptionCommandInput>;

SynthesizeSpeechCommand?¶

optional SynthesizeSpeechCommand?: AwsSdkCommandConstructor<SynthesizeSpeechCommandInput>;

textType?¶

optional textType?: AwsPollyTextType;

transcribeStreamingClient?¶

optional transcribeStreamingClient?: AwsSdkCommandClient<StartStreamTranscriptionCommandOutput>;

transcribeStreamingClientConfig?¶

optional transcribeStreamingClientConfig?: TranscribeStreamingClientConfig;

vocabularyFilterMethod?¶

optional vocabularyFilterMethod?: AwsTranscribeVocabularyFilterMethod;

vocabularyFilterName?¶

optional vocabularyFilterName?: string;

vocabularyFilterNames?¶

optional vocabularyFilterNames?: string[];

vocabularyName?¶

optional vocabularyName?: string;

vocabularyNames?¶

optional vocabularyNames?: string[];

voiceId¶

voiceId: AwsPollyVoiceId;

AwsTranscribeSpeechInput¶

Properties¶

audio¶

audio: Uint8Array;

contentIdentificationType?¶

optional contentIdentificationType?: "PII";

contentRedactionType?¶

optional contentRedactionType?: "PII";

enableChannelIdentification?¶

optional enableChannelIdentification?: boolean;

enablePartialResultsStabilization?¶

optional enablePartialResultsStabilization?: boolean;

identifyLanguage?¶

optional identifyLanguage?: boolean;

identifyMultipleLanguages?¶

optional identifyMultipleLanguages?: boolean;

languageCode?¶

optional languageCode?: AwsTranscribeLanguageCode;

languageModelName?¶

optional languageModelName?: string;

languageOptions?¶

optional languageOptions?: string[];

mediaEncoding?¶

optional mediaEncoding?: AwsTranscribeMediaEncoding;

numberOfChannels?¶

optional numberOfChannels?: number;

partialResultsStability?¶

optional partialResultsStability?: AwsTranscribePartialResultsStability;

piiEntityTypes?¶

optional piiEntityTypes?: string[];

preferredLanguage?¶

optional preferredLanguage?: AwsTranscribeLanguageCode;

sampleRate?¶

optional sampleRate?: number;

sessionId?¶

optional sessionId?: string;

sessionResumeWindow?¶

optional sessionResumeWindow?: number;

showSpeakerLabel?¶

optional showSpeakerLabel?: boolean;

signal?¶

optional signal?: AbortSignal;

vocabularyFilterMethod?¶

optional vocabularyFilterMethod?: AwsTranscribeVocabularyFilterMethod;

vocabularyFilterName?¶

optional vocabularyFilterName?: string;

vocabularyFilterNames?¶

optional vocabularyFilterNames?: string[];

vocabularyName?¶

optional vocabularyName?: string;

vocabularyNames?¶

optional vocabularyNames?: string[];

AwsTranscribeSpeechResult¶

Properties¶

endedAtSeconds?¶

optional endedAtSeconds?: number;

languageCode?¶

optional languageCode?: string;

resultCount?¶

optional resultCount?: number;

resultId?¶

optional resultId?: string;

resultIds?¶

optional resultIds?: string[];

startedAtSeconds?¶

optional startedAtSeconds?: number;

text¶

text: string;

Type Aliases¶

AwsPollyEngine¶

type AwsPollyEngine = NonNullable<SynthesizeSpeechCommandInput["Engine"]>;

AwsPollyLanguageCode¶

type AwsPollyLanguageCode = NonNullable<SynthesizeSpeechCommandInput["LanguageCode"]>;

AwsPollyOutputFormat¶

type AwsPollyOutputFormat = NonNullable<SynthesizeSpeechCommandInput["OutputFormat"]>;

AwsPollySpeechMarkType¶

type AwsPollySpeechMarkType = NonNullable<SynthesizeSpeechCommandInput["SpeechMarkTypes"]>[number];

AwsPollySynthesizeCommandInput¶

type AwsPollySynthesizeCommandInput = SynthesizeSpeechCommandInput;

AwsPollySynthesizeCommandOutput¶

type AwsPollySynthesizeCommandOutput = SynthesizeSpeechCommandOutput;

AwsPollyTextType¶

type AwsPollyTextType = NonNullable<SynthesizeSpeechCommandInput["TextType"]>;

AwsPollyVoiceId¶

type AwsPollyVoiceId = NonNullable<SynthesizeSpeechCommandInput["VoiceId"]>;

AwsSpeechJsonPrimitive¶

type AwsSpeechJsonPrimitive = string | number | boolean | null;

AwsSpeechJsonValue¶

type AwsSpeechJsonValue =
  | AwsSpeechJsonPrimitive
  | AwsSpeechJsonObject
  | readonly AwsSpeechJsonValue[];

AwsSpeechProviderExtensionValue¶

type AwsSpeechProviderExtensionValue = AwsSpeechJsonValue | object | undefined;

AwsSpeechProviderPayload¶

type AwsSpeechProviderPayload = AwsSpeechJsonObject | object;

AwsSpeechProviderQuery¶

type AwsSpeechProviderQuery = Record<string, AwsSpeechProviderExtensionValue>;

AwsSpeechResource¶

type AwsSpeechResource =
  | AwsSpeechJsonValue
  | AwsSpeechProviderPayload;

AwsTranscribeContentIdentificationType¶

type AwsTranscribeContentIdentificationType = NonNullable<StartStreamTranscriptionCommandInput["ContentIdentificationType"]>;

AwsTranscribeContentRedactionType¶

type AwsTranscribeContentRedactionType = NonNullable<StartStreamTranscriptionCommandInput["ContentRedactionType"]>;

AwsTranscribeLanguageCode¶

type AwsTranscribeLanguageCode = NonNullable<StartStreamTranscriptionCommandInput["LanguageCode"]>;

AwsTranscribeMediaEncoding¶

type AwsTranscribeMediaEncoding = NonNullable<StartStreamTranscriptionCommandInput["MediaEncoding"]>;

AwsTranscribePartialResultsStability¶

type AwsTranscribePartialResultsStability = NonNullable<StartStreamTranscriptionCommandInput["PartialResultsStability"]>;

AwsTranscribeStreamingAudioStreamEvent¶

type AwsTranscribeStreamingAudioStreamEvent = NonNullable<StartStreamTranscriptionCommandInput["AudioStream"]> extends AsyncIterable<infer Event> ? Event : never;

AwsTranscribeStreamingCommandInput¶

type AwsTranscribeStreamingCommandInput = StartStreamTranscriptionCommandInput;

AwsTranscribeStreamingCommandOutput¶

type AwsTranscribeStreamingCommandOutput = StartStreamTranscriptionCommandOutput;

AwsTranscribeStreamingResponseEvent¶

type AwsTranscribeStreamingResponseEvent = NonNullable<StartStreamTranscriptionCommandOutput["TranscriptResultStream"]> extends AsyncIterable<infer Event> ? Event : never;

AwsTranscribeVocabularyFilterMethod¶

type AwsTranscribeVocabularyFilterMethod = NonNullable<StartStreamTranscriptionCommandInput["VocabularyFilterMethod"]>;

Variables¶

AWS_SPEECH_API_SOURCES¶

const AWS_SPEECH_API_SOURCES: {
  pollyApiReference: "https://docs.aws.amazon.com/polly/latest/dg/API_Reference.html";
  pollySdk: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/polly";
  pollySynthesizeSpeech: "https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html";
  transcribeSdk: "https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe-streaming";
  transcribeStreamingApi: "https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html";
  transcribeStreamingSetup: "https://docs.aws.amazon.com/transcribe/latest/dg/streaming-setting-up.html";
};

Type Declaration¶

Name	Type
`pollyApiReference`	`"https://docs.aws.amazon.com/polly/latest/dg/API_Reference.html"`
`pollySdk`	`"https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/polly"`
`pollySynthesizeSpeech`	`"https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html"`
`transcribeSdk`	`"https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe-streaming"`
`transcribeStreamingApi`	`"https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html"`
`transcribeStreamingSetup`	`"https://docs.aws.amazon.com/transcribe/latest/dg/streaming-setting-up.html"`

createAwsSpeechVoiceAdapter¶

const createAwsSpeechVoiceAdapter: typeof createAwsSpeechVoiceProvider;

Functions¶

awsSpeechCredentialStatuses()¶

function awsSpeechCredentialStatuses(input): {
  expiresAt?: string;
  message?: string;
  providerPackageId?: string;
  requirementId: string;
  scopes?: string[];
  state:   | "required"
     | "configured"
     | "permission-blocked"
     | "not-required"
     | "missing"
     | "expired"
     | "insufficient-scope"
     | "unavailable";
}[];

Parameters¶

Parameter	Type
`input`	`AwsSpeechCredentialStatusInput`

Returns¶

{ expiresAt?: string; message?: string; providerPackageId?: string; requirementId: string; scopes?: string[]; state: | "required" | "configured" | "permission-blocked" | "not-required" | "missing" | "expired" | "insufficient-scope" | "unavailable"; }[]

createAwsSdkSpeechClient()¶

function createAwsSdkSpeechClient(options): AwsSpeechClient;

Parameters¶

Parameter	Type
`options`	`AwsSdkSpeechClientOptions`

Returns¶

AwsSpeechClient

createAwsSpeechClient()¶

function createAwsSpeechClient(options): AwsSpeechClient<AwsSpeechRawClients>;

Parameters¶

Parameter	Type
`options`	`AwsSpeechClientOptions`

Returns¶

AwsSpeechClient\<AwsSpeechRawClients>

createAwsSpeechRawClients()¶

function createAwsSpeechRawClients(options): AwsSpeechRawClients;

Parameters¶

Parameter	Type
`options`	`AwsSpeechClientOptions`

Returns¶

AwsSpeechRawClients

createAwsSpeechVoiceProvider()¶

function createAwsSpeechVoiceProvider(options): VoiceProvider;

Parameters¶

Parameter	Type
`options`	`AwsSpeechVoiceProviderOptions`

Returns¶

VoiceProvider

References¶

awsSpeechIntegration¶

Re-exports awsSpeechIntegration

awsSpeechProviderManifest¶

Re-exports awsSpeechProviderManifest