Skip to content

Commit a5b944a

Browse files
kdailykdaily
authored
Merge pull request aws#9410 from daniil-millwood/awsdocs-032125
cli examples for ivs realtime
2 parents 0a2c9db + 0b3cb0f commit a5b944a

5 files changed

Lines changed: 78 additions & 36 deletions

File tree

‎awscli/examples/ivs-realtime/create-stage.rst‎

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ Output::
3030
"SEQUENTIAL"
3131
],
3232
"recordingMode": "DISABLED"
33+
},
34+
"recordingReconnectWindowSeconds": 0,
35+
"hlsConfiguration": {
36+
"targetSegmentDurationSeconds": 6
3337
}
3438
},
3539
"endpoints": {
@@ -43,15 +47,16 @@ Output::
4347
}
4448
}
4549

46-
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*.
50+
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*.
4751

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

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

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

5661
Output::
5762

@@ -70,8 +75,12 @@ Output::
7075
"SEQUENTIAL"
7176
],
7277
"recordingMode": "DISABLED"
78+
},
79+
"recordingReconnectWindowSeconds": 100,
80+
"hlsConfiguration": {
81+
"targetSegmentDurationSeconds": 5
7382
}
74-
},
83+
},
7584
"endpoints": {
7685
"events": "wss://global.events.live-video.net",
7786
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
@@ -83,7 +92,7 @@ Output::
8392
}
8493
}
8594

86-
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*.
95+
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*.
8796

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

@@ -111,8 +120,12 @@ Output::
111120
"SEQUENTIAL"
112121
],
113122
"recordingMode": "INTERVAL"
123+
},
124+
"recordingReconnectWindowSeconds": 0,
125+
"hlsConfiguration": {
126+
"targetSegmentDurationSeconds": 6
114127
}
115-
},
128+
},
116129
"endpoints": {
117130
"events": "wss://global.events.live-video.net",
118131
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
@@ -124,4 +137,4 @@ Output::
124137
}
125138
}
126139

127-
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*.
140+
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*.

‎awscli/examples/ivs-realtime/get-composition.rst‎

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,10 @@ Output::
3131
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
3232
],
3333
"recordingConfiguration": {
34-
"format": "HLS"
34+
"format": "HLS",
35+
"hlsConfiguration": {
36+
"targetSegmentDurationSeconds": 2
37+
}
3538
},
3639
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
3740
}
@@ -52,7 +55,8 @@ Output::
5255
"gridGap": 2,
5356
"omitStoppedVideo": false,
5457
"videoAspectRatio": "VIDEO",
55-
"videoFillMode": "" }
58+
"videoFillMode": ""
59+
}
5660
},
5761
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
5862
"startTime": "2023-10-16T23:24:00+00:00",
@@ -61,7 +65,7 @@ Output::
6165
}
6266
}
6367

64-
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*.
68+
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*.
6569

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

@@ -96,7 +100,10 @@ Output::
96100
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
97101
],
98102
"recordingConfiguration": {
99-
"format": "HLS"
103+
"format": "HLS",
104+
"hlsConfiguration": {
105+
"targetSegmentDurationSeconds": 2
106+
}
100107
},
101108
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
102109
}
@@ -130,7 +137,7 @@ Output::
130137
}
131138
}
132139

133-
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*.
140+
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*.
134141

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

@@ -165,7 +172,10 @@ Output::
165172
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
166173
],
167174
"recordingConfiguration": {
168-
"format": "HLS"
175+
"format": "HLS",
176+
"hlsConfiguration": {
177+
"targetSegmentDurationSeconds": 2
178+
}
169179
},
170180
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
171181
"thumbnailConfigurations": [
@@ -203,4 +213,4 @@ Output::
203213
}
204214
}
205215

206-
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*.
216+
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*.

‎awscli/examples/ivs-realtime/get-stage.rst‎

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,22 @@ Output::
1212
"activeSessionId": "st-a1b2c3d4e5f6g",
1313
"arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
1414
"autoParticipantRecordingConfiguration": {
15-
"storageConfigurationArn": "",
16-
"mediaTypes": [
17-
"AUDIO_VIDEO"
18-
],
19-
"thumbnailConfiguration": {
20-
"targetIntervalSeconds": 60,
21-
"storage": [
22-
"SEQUENTIAL"
23-
],
24-
"recordingMode": "DISABLED",
25-
}
26-
},
15+
"storageConfigurationArn": "",
16+
"mediaTypes": [
17+
"AUDIO_VIDEO"
18+
],
19+
"thumbnailConfiguration": {
20+
"targetIntervalSeconds": 60,
21+
"storage": [
22+
"SEQUENTIAL"
23+
],
24+
"recordingMode": "DISABLED",
25+
},
26+
"recordingReconnectWindowSeconds": 0,
27+
"hlsConfiguration": {
28+
"targetSegmentDurationSeconds": 6
29+
}
30+
},
2731
"endpoints": {
2832
"events": "wss://global.events.live-video.net",
2933
"rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
@@ -35,4 +39,4 @@ Output::
3539
}
3640
}
3741

38-
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*.
42+
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*.

‎awscli/examples/ivs-realtime/start-composition.rst‎

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ The following ``start-composition`` example starts a composition for the specifi
77
--destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
88
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
99
{"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
10+
"recordingConfiguration": {"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}, \
1011
"storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]'
1112

1213
Output::
@@ -34,7 +35,10 @@ Output::
3435
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
3536
],
3637
"recordingConfiguration": {
37-
"format": "HLS"
38+
"format": "HLS",
39+
"hlsConfiguration": {
40+
"targetSegmentDurationSeconds": 5
41+
}
3842
},
3943
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
4044
}
@@ -64,7 +68,7 @@ Output::
6468
}
6569
}
6670

67-
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*.
71+
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*.
6872

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

@@ -103,7 +107,10 @@ Output::
103107
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
104108
],
105109
"recordingConfiguration": {
106-
"format": "HLS"
110+
"format": "HLS",
111+
"hlsConfiguration": {
112+
"targetSegmentDurationSeconds": 2
113+
}
107114
},
108115
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
109116
}
@@ -136,9 +143,9 @@ Output::
136143
}
137144
}
138145

139-
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*.
146+
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*.
140147

141-
**Example 3: To start a composition with thubnail recording enabled**
148+
**Example 3: To start a composition with thumbnail recording enabled**
142149

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

@@ -175,7 +182,10 @@ Output::
175182
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
176183
],
177184
"recordingConfiguration": {
178-
"format": "HLS"
185+
"format": "HLS",
186+
"hlsConfiguration": {
187+
"targetSegmentDurationSeconds": 2
188+
}
179189
},
180190
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
181191
"thumbnailConfigurations": [
@@ -213,4 +223,4 @@ Output::
213223
}
214224
}
215225

216-
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*.
226+
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*.

‎awscli/examples/ivs-realtime/update-stage.rst‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ The following ``update-stage`` example updates a stage for a specified stage ARN
44

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

1112
Output::
@@ -24,6 +25,10 @@ Output::
2425
"SEQUENTIAL"
2526
],
2627
"recordingMode": "INTERVAL"
28+
},
29+
"recordingReconnectWindowSeconds": 100,
30+
"hlsConfiguration": {
31+
"targetSegmentDurationSeconds": 5
2732
}
2833
},
2934
"endpoints": {
@@ -37,4 +42,4 @@ Output::
3742
}
3843
}
3944

40-
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*.
45+
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*.

0 commit comments

Comments
 (0)