mcut SDK

mcut SDK / transcription/src / BuildApplyCaptionsOptions

Interface: BuildApplyCaptionsOptions

Defined in: packages/transcription/src/captions.ts:202

Extends

• ToCaptionElementsOptions

Properties

maxChars?

optional maxChars?: number;

Defined in: packages/transcription/src/captions.ts:12

Soft maximum characters per caption line group. Default 36.

Inherited from

ToCaptionElementsOptions.maxChars

maxDurationMs?

optional maxDurationMs?: number;

Defined in: packages/transcription/src/captions.ts:14

Maximum duration of one caption. Default 5000ms.

Inherited from

ToCaptionElementsOptions.maxDurationMs

maxGapMs?

optional maxGapMs?: number;

Defined in: packages/transcription/src/captions.ts:16

A silence gap longer than this starts a new caption. Default 800ms.

Inherited from

ToCaptionElementsOptions.maxGapMs

replace?

optional replace?: boolean;

Defined in: packages/transcription/src/captions.ts:205

Replace existing captions on the target track. Default true.

sourceEndMs?

optional sourceEndMs?: number;

Defined in: packages/transcription/src/captions.ts:83

Ignore transcript content at or after this source-media timestamp.

Inherited from

ToCaptionElementsOptions.sourceEndMs

sourceStartMs?

optional sourceStartMs?: number;

Defined in: packages/transcription/src/captions.ts:81

Ignore transcript content before this source-media timestamp.

Inherited from

ToCaptionElementsOptions.sourceStartMs

style?

optional style?: Partial<{
  activeWordColor?: string;
  backgroundColor: string;
  color: string;
  fontFamily: string;
  fontSize: number;
  fontWeight: number;
  position: "top" | "middle" | "bottom";
}>;

Defined in: packages/transcription/src/captions.ts:74

Inherited from

ToCaptionElementsOptions.style

timeOffsetMs?

optional timeOffsetMs?: number;

Defined in: packages/transcription/src/captions.ts:79

Shift generated captions onto a timeline position. For example, a transcript from a clip starting at 10s should use timeOffsetMs: 10000.

Inherited from

ToCaptionElementsOptions.timeOffsetMs

trackId?

optional trackId?: `t-${string}`;

Defined in: packages/transcription/src/captions.ts:203