Skip to content

StartComposition

Source: src/AWS/IVSRealtime/StartComposition.ts

Start a server-side composition of the bound stage — IVS mixes the stage’s participants into a single video according to the layout and delivers it to the given destinations (an IVS low-latency channel and/or an S3 storage configuration).

// init
const startComposition = yield* IVSRealtime.StartComposition(stage);
// runtime
const { composition } = yield* startComposition({
destinations: [{ channel: { channelArn } }],
layout: { grid: { videoAspectRatio: "VIDEO" } },
});