VoiceManagement

interface VoiceManagement

Manages saved custom voices and consent recordings in the authenticated project. Default operations throw UnsupportedOperationException, allowing existing custom clients to omit this capability.

Inheritors

Functions

Link copied to clipboard
open suspend fun createVoice(request: VoiceCreateRequest, requestOptions: RequestOptions? = null): VoiceResource

Creates a prompt-generated or consented sample-based voice. Sample sources are consumed and closed on success or failure, without automatic retries.

Link copied to clipboard
open suspend fun createVoiceConsent(request: VoiceConsentRequest, requestOptions: RequestOptions? = null): VoiceConsent

Uploads a recording of the speaker providing the required consent phrase. Its source is consumed and closed on success or failure, without automatic retries.

Link copied to clipboard
open suspend fun deleteVoice(id: String, requestOptions: RequestOptions? = null): Boolean

Deletes a voice; returns false when it does not exist. Its consent recording remains available.

Link copied to clipboard
open suspend fun deleteVoiceConsent(id: String, requestOptions: RequestOptions? = null): Boolean

Deletes a consent recording; returns false when it does not exist.

Link copied to clipboard
open suspend fun updateVoiceConsent(id: String, request: VoiceConsentUpdateRequest, requestOptions: RequestOptions? = null): VoiceConsent

Changes only the recording's label; its audio and language are unchanged.

Link copied to clipboard
open suspend fun voiceConsent(id: String, requestOptions: RequestOptions? = null): VoiceConsent?

Retrieves a consent recording's metadata, or null when it does not exist.

Link copied to clipboard
open suspend fun voiceConsents(after: String? = null, limit: Int? = null, requestOptions: RequestOptions? = null): VoiceConsentPage

Lists consent recordings; use the lastId cursor to retrieve another page.