Class Speechify

The Speechify client.

Index

Constructors

Accessors

Methods

accessTokenIssue audioGenerate audioStream setAccessToken setApiKey voicesCreate voicesDelete voicesList

Constructors

constructor

new Speechify(options: SpeechifyOptions): Speechify
Parameters
- options: SpeechifyOptions
Returns Speechify
- Defined in src/index.ts:91

Accessors

version

get version(): string
Get the current version of the package

Returns string
- Defined in src/index.ts:134

Methods

accessTokenIssue

accessTokenIssue(
scope: AccessTokenScope | AccessTokenScope[],
): Promise<AccessTokenResponse>
Issue a short-living access token to be used by the public-client. API Reference. This method must only be called server-side, and the resultant token should be passed to the client. Read more about this at https://docs.sws.speechify.com/docs/authentication#access-tokens. You need to call this method regularly to issue the new token and keep it fresh. The expiration time is defined by the expiresIn property on the return value.
Parameters
- scope: AccessTokenScope | AccessTokenScope[]
  a single scope, or an array of scopes to issue the token for.
Returns Promise<AccessTokenResponse>
The token details
- Defined in src/index.ts:284

audioGenerate

audioGenerate(req: AudioSpeechRequest): Promise<AudioSpeechResponse>
Generate audio from text. API Reference.
Parameters
- req: AudioSpeechRequest
  Request details.
Returns Promise<AudioSpeechResponse>
The object containing raw audio data and additional information.
- Defined in src/index.ts:320

audioStream

audioStream(req: AudioStreamRequest): Promise<ReadableStream<Uint8Array>>
Stream audio from text. API Reference.
Parameters
- req: AudioStreamRequest
Returns Promise<ReadableStream<Uint8Array>>
- Defined in src/index.ts:352

setAccessToken

setAccessToken(token: undefined | string): void
Set the access token for the client.
Parameters
- token: undefined | string
  The Access Token to set.
Returns void
- Defined in src/index.ts:142

setApiKey

setApiKey(key: undefined | string): void
Set the API key for the client.
Parameters
- key: undefined | string
  The API Key to set.
Returns void
- Defined in src/index.ts:150

voicesCreate

voicesCreate(req: VoicesCreateRequest): Promise<VoicesCreateResponse>
Create a new voice. API Reference.
Parameters
- req: VoicesCreateRequest
  Request details.
Returns Promise<VoicesCreateResponse>
The newly created voice details.
- Defined in src/index.ts:224

voicesDelete

voicesDelete(voiceId: string): Promise<void>
Delete a voice. API Reference.
Parameters
- voiceId: string
  The ID of the voice to delete.
Returns Promise<void>
- Defined in src/index.ts:259

voicesList

voicesList(): Promise<VoicesListResponse>
Get the list of available voices. API Reference.

Returns Promise<VoicesListResponse>
The list of available voices.
- Defined in src/index.ts:208