MediaBuilder
Defined in: builder.ts:639
Extends
Section titled “Extends”BuilderTerminal<Args,O>
Type Parameters
Section titled “Type Parameters”Args
O = object
Call Signature
Section titled “Call Signature”MediaBuilder(
title,body):void
Defined in: builder.ts:639
Parameters
Section titled “Parameters”string
BodyFn<MergeArgs<Args, O>>
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”MediaBuilder(
title,details,body):void
Defined in: builder.ts:639
Parameters
Section titled “Parameters”string
details
Section titled “details”TestDetails
BodyFn<MergeArgs<Args, O>>
Returns
Section titled “Returns”void
Methods
Section titled “Methods”each()
Section titled “each()”each(
variants):MediaBuilder<Args,O>
Defined in: builder.ts:685
Produce a separate video per variant (viewport, theme, …).
Parameters
Section titled “Parameters”variants
Section titled “variants”Returns
Section titled “Returns”MediaBuilder<Args, O>
languages()
Section titled “languages()”languages(
arg?):MediaBuilder<Args,O>
Defined in: builder.ts:671
Declare the recorded language set / capture mode.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”MediaBuilder<Args, O>
narration()
Section titled “narration()”narration<
A>(arg):MediaBuilder<Args,O&NarrationOverrideFor<Args,A>>
Defined in: builder.ts:644
Declare narration cues: blank names (array) or code values (object).
Type Parameters
Section titled “Type Parameters”A extends FeatureArg<LocalizeNarrationValue>
Parameters
Section titled “Parameters”A
Returns
Section titled “Returns”MediaBuilder<Args, O & NarrationOverrideFor<Args, A>>
overlays()
Section titled “overlays()”overlays<
A>(arg):MediaBuilder<Args,O&OverlayOverrideFor<Args,A>>
Defined in: builder.ts:657
Declare overlays: blank names (array) or content values (object). Overlays are shared across languages, so the language-major form is not accepted.
Type Parameters
Section titled “Type Parameters”A extends readonly string[] | ContentMajor<OverlayInputOrFactory>
Parameters
Section titled “Parameters”A
Returns
Section titled “Returns”MediaBuilder<Args, O & OverlayOverrideFor<Args, A>>
recordOptions()
Section titled “recordOptions()”recordOptions(
arg):MediaBuilder<Args,O>
Defined in: builder.ts:677
Declare capture options (aspect ratio, quality, fps, …): a flat object
shared across languages, or a language-major object ({ default, de, ... })
with per-language overrides. The values stay editable in the web app.
Parameters
Section titled “Parameters”OptionsArg<RecordOptions>
Returns
Section titled “Returns”MediaBuilder<Args, O>
renderOptions()
Section titled “renderOptions()”renderOptions(
arg):MediaBuilder<Args,O>
Defined in: builder.ts:683
Declare render options (framing, narration voice, output, …): a flat object shared across languages, or a language-major object with per-language overrides. The values stay editable in the web app.
Parameters
Section titled “Parameters”OptionsArg<RenderOptions>
Returns
Section titled “Returns”MediaBuilder<Args, O>
Properties
Section titled “Properties”fail:
BuilderTerminal<Args,O>
Defined in: builder.ts:689
fixme:
BuilderTerminal<Args,O>
Defined in: builder.ts:688
only:
BuilderTerminal<Args,O>
Defined in: builder.ts:686
skip:
BuilderTerminal<Args,O>
Defined in: builder.ts:687