scrptly/src/layers/TTSLayer.ts

Scrptly is a Video Development Kit (VDK) for programmatically generating AI-powered videos.

import AuditoryLayer, { AuditoryLayerProperties, AuditoryLayerSettings } from './AuditoryLayer';

export type TTSLayerSettings = AuditoryLayerSettings & {
	/*
		ElevenLabs: A search term for finding the voice, or "default", or "id:<voice_id>" for a specific voice ID, or "auto" to let Scrptly choose the best voice
		Google Gemini: "default" or "auto" or a specific voice name: https://ai.google.dev/gemini-api/docs/speech-generation#voices
		OpenAi: "default" or "auto" or a specific voice name: https://platform.openai.com/docs/guides/text-to-speech
		ResembleAi: "default" or "auto" or a specific voice id
	*/
	voice?: string | "default";
	model: string;
	modelSettings?: any;
	cache?: boolean; // whether to cache the TTS output (default: true)
};
export type TTSLayerProperties = AuditoryLayerProperties;

export default class TTSLayer extends AuditoryLayer {
	static type = 'tts';
	declare settings: TTSLayerSettings;
	declare properties: TTSLayerProperties;
	constructor(parent: any, properties: TTSLayerProperties = {}, settings: TTSLayerSettings) {
		super(parent, properties, settings);
	}

	static get defaultSettings(): Partial<TTSLayerSettings> {
		return {
			...super.defaultSettings,
		};
	}
	static get defaultProperties(): Partial<TTSLayerProperties> {
		return {
			...super.defaultProperties,
		};
	}
	

	say(text: string, settings: {
		wait?: boolean // default: true
	} = {}) {
		this.parent.pushAction({ statement: 'ttsSay', id: this.id, text, settings });
		return this;
	}
}