MediaBuilder
Defined in: builder.ts:709
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:709
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:709
Parameters
Section titled “Parameters”string
details
Section titled “details”TestDetails
BodyFn<MergeArgs<Args, O>>
Returns
Section titled “Returns”void
Methods
Section titled “Methods”audio()
Section titled “audio()”audio<
A>(arg):MediaBuilder<Args,O&AudioOverrideFor<Args,A>>
Defined in: builder.ts:726
Declare background-audio tracks.
Type Parameters
Section titled “Type Parameters”A extends FeatureArg<AudioInput>
Parameters
Section titled “Parameters”A
Returns
Section titled “Returns”MediaBuilder<Args, O & AudioOverrideFor<Args, A>>
each()
Section titled “each()”each(
variants):MediaBuilder<Args,O>
Defined in: builder.ts:744
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:730
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:714
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:722
Declare overlays.
Type Parameters
Section titled “Type Parameters”A extends FeatureArg<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:736
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:742
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>
values()
Section titled “values()”values<
A>(arg):MediaBuilder<Args,O&ValuesOverrideFor<Args,A>>
Defined in: builder.ts:718
Declare on-screen values fields.
Type Parameters
Section titled “Type Parameters”A extends FeatureArg<string>
Parameters
Section titled “Parameters”A
Returns
Section titled “Returns”MediaBuilder<Args, O & ValuesOverrideFor<Args, A>>
Properties
Section titled “Properties”fail:
BuilderTerminal<Args,O>
Defined in: builder.ts:748
fixme:
BuilderTerminal<Args,O>
Defined in: builder.ts:747
only:
BuilderTerminal<Args,O>
Defined in: builder.ts:745
skip:
BuilderTerminal<Args,O>
Defined in: builder.ts:746