eo-typewriterjs

---

eo-typewriterjs / TTypewriter

Type Alias: TTypewriter

type TTypewriter = object;

Defined in: index.ts:85

Description

A typewriter instance returned by createTypewriter. Provides a fluent timeline builder and full playback controls.

Properties

Property	Modifier	Type	Description	Defined in
timeline	readonly	TimelineBuilder	-	index.ts:86
play	public	() => Promise<void>	-	index.ts:87
pause	public	() => void	-	index.ts:88
stop	public	() => void	-	index.ts:89
cancel	public	() => void	-	index.ts:90
replay	public	() => Promise<void>	-	index.ts:91
seek	public	(time) => void	-	index.ts:92
stepForward	public	() => void	-	index.ts:93
stepBackward	public	() => void	-	index.ts:94
setRate	public	(rate) => void	-	index.ts:95
getState	public	() => TPlaybackControllerState	-	index.ts:96
getLiveState	public	() => TTypewriterState	Description Return the current live typewriter state (document, cursors, selections). Unlike getState() which returns playback metadata, this returns the full document content and cursor positions at the current point in playback.	index.ts:106
setAudioEnabled	public	(enabled) => void	Description Enable or disable typing/delete audio at runtime.	index.ts:114
setAudioVolume	public	(volume) => void	Description Set the master audio volume at runtime. Clamped to [0, 1].	index.ts:122
setAudioOptions	public	(options) => void	Description Replace the full audio configuration at runtime. Channel selection state (shuffle-bag, round-robin) is reset so new sfxs and strategies take effect immediately on the next keystroke.	index.ts:132
getAudioOptions	public	() => TAudioOptions | null	Description Return a snapshot of the current audio options	index.ts:140
setCursorVisible	public	(visible, cursor?) => void	Description Show or hide one or all cursors at runtime. Changes take effect immediately on the next render.	index.ts:150
setCursorOptions	public	(options, cursor?) => void	Description Update the render options of one or all cursors at runtime. Only the provided fields are changed; others keep their current values. Changes take effect immediately on the next render.	index.ts:161