Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cli examples for ivs realtime #9410

Merged
merged 1 commit into from
Mar 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions awscli/examples/ivs-realtime/create-stage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ Output::
"SEQUENTIAL"
],
"recordingMode": "DISABLED"
},
"recordingReconnectWindowSeconds": 0,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 6
}
},
"endpoints": {
Expand All @@ -43,15 +47,16 @@ Output::
}
}

For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon Interactive Video Service User Guide*.
For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon IVS Low-Latency Streaming User Guide*.

**Example 2: To create a stage and configure individial participant recording**

The following ``create-stage`` example creates a stage and configures individual participant recording. ::

aws ivs-realtime create-stage \
--name stage1 \
--auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh"}'
--auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \
"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}'

Output::

Expand All @@ -70,8 +75,12 @@ Output::
"SEQUENTIAL"
],
"recordingMode": "DISABLED"
},
"recordingReconnectWindowSeconds": 100,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 5
}
},
},
"endpoints": {
"events": "wss://global.events.live-video.net",
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
Expand All @@ -83,7 +92,7 @@ Output::
}
}

For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon Interactive Video Service User Guide*.
For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon IVS Low-Latency Streaming User Guide*.

**Example 3: To create a stage and configure individial participant recording with thumbnail recording enabled**

Expand Down Expand Up @@ -111,8 +120,12 @@ Output::
"SEQUENTIAL"
],
"recordingMode": "INTERVAL"
},
"recordingReconnectWindowSeconds": 0,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 6
}
},
},
"endpoints": {
"events": "wss://global.events.live-video.net",
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
Expand All @@ -124,4 +137,4 @@ Output::
}
}

For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon Interactive Video Service User Guide*.
For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon IVS Low-Latency Streaming User Guide*.
24 changes: 17 additions & 7 deletions awscli/examples/ivs-realtime/get-composition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,10 @@ Output::
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS"
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
}
Expand All @@ -52,7 +55,8 @@ Output::
"gridGap": 2,
"omitStoppedVideo": false,
"videoAspectRatio": "VIDEO",
"videoFillMode": "" }
"videoFillMode": ""
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
Expand All @@ -61,7 +65,7 @@ Output::
}
}

For more information, see `Composite Recording (Real-Time Streaming) <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.

**Example 2: To get a composition with PiP layout**

Expand Down Expand Up @@ -96,7 +100,10 @@ Output::
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS"
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
}
Expand Down Expand Up @@ -130,7 +137,7 @@ Output::
}
}

For more information, see `Composite Recording (Real-Time Streaming) <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.

**Example 3: To get a composition with thumbnail recording enabled**

Expand Down Expand Up @@ -165,7 +172,10 @@ Output::
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS"
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
"thumbnailConfigurations": [
Expand Down Expand Up @@ -203,4 +213,4 @@ Output::
}
}

For more information, see `Composite Recording (Real-Time Streaming) <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.
30 changes: 17 additions & 13 deletions awscli/examples/ivs-realtime/get-stage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,22 @@ Output::
"activeSessionId": "st-a1b2c3d4e5f6g",
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
"autoParticipantRecordingConfiguration": {
"storageConfigurationArn": "",
"mediaTypes": [
"AUDIO_VIDEO"
],
"thumbnailConfiguration": {
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
"recordingMode": "DISABLED",
}
},
"storageConfigurationArn": "",
"mediaTypes": [
"AUDIO_VIDEO"
],
"thumbnailConfiguration": {
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
"recordingMode": "DISABLED",
},
"recordingReconnectWindowSeconds": 0,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 6
}
},
"endpoints": {
"events": "wss://global.events.live-video.net",
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
Expand All @@ -35,4 +39,4 @@ Output::
}
}

For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon Interactive Video Service User Guide*.
For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon IVS Low-Latency Streaming User Guide*.
24 changes: 17 additions & 7 deletions awscli/examples/ivs-realtime/start-composition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ The following ``start-composition`` example starts a composition for the specifi
--destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
{"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
"recordingConfiguration": {"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}, \
"storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]'

Output::
Expand Down Expand Up @@ -34,7 +35,10 @@ Output::
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS"
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 5
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
}
Expand Down Expand Up @@ -64,7 +68,7 @@ Output::
}
}

For more information, see `Composite Recording (Real-Time Streaming) <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.

**Example 2: To start a composition with PiP layout**

Expand Down Expand Up @@ -103,7 +107,10 @@ Output::
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS"
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
}
Expand Down Expand Up @@ -136,9 +143,9 @@ Output::
}
}

For more information, see `Composite Recording (Real-Time Streaming) <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.

**Example 3: To start a composition with thubnail recording enabled**
**Example 3: To start a composition with thumbnail recording enabled**

The following ``start-composition`` example starts a composition for the specified stage to be streamed to the specified locations with thumbnail recording enabled. ::

Expand Down Expand Up @@ -175,7 +182,10 @@ Output::
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS"
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
"thumbnailConfigurations": [
Expand Down Expand Up @@ -213,4 +223,4 @@ Output::
}
}

For more information, see `Composite Recording (Real-Time Streaming) <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon Interactive Video Service User Guide*.
For more information, see `IVS Composite Recording | Real-Time Streaming <https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html>`__ in the *Amazon IVS Real-Time Streaming User Guide*.
11 changes: 8 additions & 3 deletions awscli/examples/ivs-realtime/update-stage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ The following ``update-stage`` example updates a stage for a specified stage ARN

aws ivs-realtime update-stage \
--arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", \
"thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}}' \
--auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100, \
"thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}} \
"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}' \
--name stage1a

Output::
Expand All @@ -24,6 +25,10 @@ Output::
"SEQUENTIAL"
],
"recordingMode": "INTERVAL"
},
"recordingReconnectWindowSeconds": 100,
"hlsConfiguration": {
"targetSegmentDurationSeconds": 5
}
},
"endpoints": {
Expand All @@ -37,4 +42,4 @@ Output::
}
}

For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon Interactive Video Service User Guide*.
For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream <https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html>`__ in the *Amazon IVS Low-Latency Streaming User Guide*.
Loading