Skip to content
1 min read · 288 words

Interface: MediaPipeline() ​

Defined in: src/batteries/media/index.ts:212

The callable pipeline returned by createMediaPipeline: mp(payload) opens a chainable builder; mp.query(payload, q) runs a pipe-string statement; mp.ops(payload, ops) runs a JSON ops array. All three compile to the same plan and execute on the same runtime.

ts
MediaPipeline(input: StepPayload): MediaChain;

Defined in: src/batteries/media/index.ts:214

Open a fresh chainable builder over input.

Parameters ​

ParameterType
inputStepPayload

Returns ​

MediaChain

Properties ​

PropertyModifierTypeDescriptionDefined in
capabilitiesreadonlyEngineRegistryThe deployment's engine registry (drives verb narrowing AND generation/edit dispatch — the runtime value has always been the registry; the declared type now says so).src/batteries/media/index.ts:225
enginesreadonlyreadonly MediaEngine[]The resolved engines, in supply order — inspect ids and declared capabilities.src/batteries/media/index.ts:227

Methods ​

compile() ​

ts
compile(statement: string | MediaOp[]): MediaPlan;

Defined in: src/batteries/media/index.ts:220

Validate a pipe string or ops array to a plan WITHOUT executing (dry-run/compile).

Parameters ​

ParameterType
statementstring | MediaOp[]

Returns ​

MediaPlan


ops() ​

ts
ops(
   input: StepPayload,
   ops: MediaOp[],
options?: RunOptions): Promise<StepResult>;

Defined in: src/batteries/media/index.ts:218

Validate and execute a JSON ops array.

Parameters ​

ParameterType
inputStepPayload
opsMediaOp[]
options?RunOptions

Returns ​

Promise<StepResult>


query() ​

ts
query(
   input: StepPayload,
   q: string,
options?: RunOptions): Promise<StepResult>;

Defined in: src/batteries/media/index.ts:216

Parse, validate, and execute a pipe-string statement.

Parameters ​

ParameterType
inputStepPayload
qstring
options?RunOptions

Returns ​

Promise<StepResult>