Put Metadata

ivs_put_metadata

R Documentation

Inserts metadata into the active stream of the specified channel¶

Description¶

Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.

Usage¶

ivs_put_metadata(channelArn, metadata)

Arguments¶

channelArn

[required] ARN of the channel into which metadata is inserted. This channel must have an active stream.

metadata

[required] Metadata to insert into the stream. Maximum: 1 KB per request.

Value¶

An empty list.

Request syntax¶

svc$put_metadata(
  channelArn = "string",
  metadata = "string"
)