PutMetadata

Source: src/AWS/IVS/PutMetadata.ts

Runtime binding for ivs:PutMetadata.

Inserts timed metadata (max 1 KB) into the bound Channel’s active stream — the payload is embedded in the video and surfaced to players in sync with playback. Fails with the typed ChannelNotBroadcasting tag when the channel is not live. At most 5 requests per second per channel. The channel ARN is injected from the binding. Provide the implementation with Effect.provide(AWS.IVS.PutMetadataHttp).

Embedding Timed Metadata

// init — bind the operation to the channel
const putMetadata = yield* AWS.IVS.PutMetadata(channel);

// runtime
yield* putMetadata({
  metadata: JSON.stringify({ question: "Who wins?", options: ["A", "B"] }),
});