GetComposition

Source: src/AWS/IVSRealtime/GetComposition.ts

Read a composition’s detail — state, layout, destinations, and per destination progress. Compositions are addressed by the server-generated ARN returned by StartComposition.

Compositing a Stage

// init
const getComposition = yield* IVSRealtime.GetComposition();

// runtime
const { composition } = yield* getComposition({ arn: compositionArn });
// composition.state → "ACTIVE" | "STOPPED" | "FAILED" | …