Class VideoCaptioner

Transcribes a <video> element, rendering the results as captions on the video.

Hierarchy (View Summary)

MediaElementTranscriber
- VideoCaptioner

Index

Constructors

Properties

audioContext callbacks isActive

Methods

attachStream detachStream getAudioBuffer load start stop

Constructors

constructor

new VideoCaptioner(
    videoElement: HTMLVideoElement,
    modelURL: string,
    useVAD?: boolean,
    wrapperStyle?: Partial<CSSStyleDeclaration>,
    captionsStyle?: Partial<CSSStyleDeclaration>,
    commitElementStyle?: Partial<CSSStyleDeclaration>,
    updateElementStyle?: Partial<CSSStyleDeclaration>,
    precision?: string,
): VideoCaptioner
Creates a transcriber that overlays transcription output as captions on a <video> element.
Parameters
- videoElement: HTMLVideoElement
- modelURL: string
- useVAD: boolean = false
- wrapperStyle: Partial<CSSStyleDeclaration> = {}
- captionsStyle: Partial<CSSStyleDeclaration> = {}
- commitElementStyle: Partial<CSSStyleDeclaration> = {}
- updateElementStyle: Partial<CSSStyleDeclaration> = {}
- precision: string = "quantized"
Returns VideoCaptioner
Overrides MediaElementTranscriber.constructor
- Defined in mediaElementTranscriber.ts:61

Properties

`Protected`audioContext

audioContext: AudioContext

callbacks

callbacks: TranscriberCallbacks

isActive

isActive: boolean = false

Methods

attachStream

attachStream(stream: MediaStream): void
Attaches a MediaStream to this Transcriber for transcription. A MediaStream must be attached before starting transcription.
Parameters
- stream: MediaStream
  A MediaStream to transcribe
Returns void
Inherited from MediaElementTranscriber.attachStream
- Defined in transcriber.ts:388

detachStream

detachStream(): void
Detaches the MediaStream used for transcription. TODO

Returns void
Inherited from MediaElementTranscriber.detachStream
- Defined in transcriber.ts:412

getAudioBuffer

getAudioBuffer(buffer: Float32Array): AudioBuffer
Returns the most recent AudioBuffer that was input to the underlying model for text generation. This is useful in cases where we want to double-check the audio being input to the model while debugging.
Parameters
- buffer: Float32Array
Returns AudioBuffer
An AudioBuffer
Inherited from MediaElementTranscriber.getAudioBuffer
- Defined in transcriber.ts:422

load

load(): Promise<void>
Preloads the models and initializes the buffer required for transcription.

Returns Promise<void>
Inherited from MediaElementTranscriber.load
- Defined in transcriber.ts:284

start

start(): Promise<void>
Starts transcription.

Transcription will stop when stop is called.

Note that the Transcriber must have a MediaStream attached via Transcriber.attachStream before starting transcription.

Returns Promise<void>
Inherited from MediaElementTranscriber.start
- Defined in mediaElementTranscriber.ts:30

stop

stop(): void
Stops transcription.

Returns void
Inherited from MediaElementTranscriber.stop
- Defined in transcriber.ts:469