Skip to content

Commit df206f8

Browse files
author
AWS
committed
Amazon Interactive Video Service Update: IVS now offers customers the ability to stream multitrack video to Channels.
1 parent 70037ec commit df206f8

File tree

2 files changed

+123
-6
lines changed

2 files changed

+123
-6
lines changed

‎.changes/next-release/feature-AmazonInteractiveVideoService-aed16cb.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Interactive Video Service",
4+
"contributor": "",
5+
"description": "IVS now offers customers the ability to stream multitrack video to Channels."
6+
}

‎services/ivs/src/main/resources/codegen-resources/service-2.json

Lines changed: 117 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -629,9 +629,17 @@
629629
"targetBitrate":{
630630
"shape":"Integer",
631631
"documentation":"<p>The expected ingest bitrate (bits per second). This is configured in the encoder.</p>"
632+
},
633+
"track":{
634+
"shape":"String",
635+
"documentation":"<p>Name of the audio track (if the stream has an audio track). If multitrack is not enabled, this is track0 (the sole track).</p>"
632636
}
633637
},
634-
"documentation":"<p>Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the <a>IngestConfiguration</a> object and used for monitoring stream health.</p>"
638+
"documentation":"<p>Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the <a>IngestConfigurations</a> object and the deprecated <a>IngestConfiguration</a> object. It is used for monitoring stream health.</p>"
639+
},
640+
"AudioConfigurationList":{
641+
"type":"list",
642+
"member":{"shape":"AudioConfiguration"}
635643
},
636644
"BatchError":{
637645
"type":"structure",
@@ -790,6 +798,10 @@
790798
"shape":"IsAuthorized",
791799
"documentation":"<p>Whether the channel is private (enabled for playback authorization). Default: <code>false</code>.</p>"
792800
},
801+
"containerFormat":{
802+
"shape":"ContainerFormat",
803+
"documentation":"<p>Indicates which content-packaging format is used (MPEG-TS or fMP4). If <code>multitrackInputConfiguration</code> is specified and <code>enabled</code> is <code>true</code>, then <code>containerFormat</code> is required and must be set to <code>FRAGMENTED_MP4</code>. Otherwise, <code>containerFormat</code> may be set to <code>TS</code> or <code>FRAGMENTED_MP4</code>. Default: <code>TS</code>.</p>"
804+
},
793805
"ingestEndpoint":{
794806
"shape":"IngestEndpoint",
795807
"documentation":"<p>Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.</p>"
@@ -802,6 +814,10 @@
802814
"shape":"ChannelLatencyMode",
803815
"documentation":"<p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. Default: <code>LOW</code>.</p>"
804816
},
817+
"multitrackInputConfiguration":{
818+
"shape":"MultitrackInputConfiguration",
819+
"documentation":"<p>Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.</p>"
820+
},
805821
"name":{
806822
"shape":"ChannelName",
807823
"documentation":"<p>Channel name.</p>"
@@ -967,13 +983,24 @@
967983
},
968984
"exception":true
969985
},
986+
"ContainerFormat":{
987+
"type":"string",
988+
"enum":[
989+
"TS",
990+
"FRAGMENTED_MP4"
991+
]
992+
},
970993
"CreateChannelRequest":{
971994
"type":"structure",
972995
"members":{
973996
"authorized":{
974997
"shape":"Boolean",
975998
"documentation":"<p>Whether the channel is private (enabled for playback authorization). Default: <code>false</code>.</p>"
976999
},
1000+
"containerFormat":{
1001+
"shape":"ContainerFormat",
1002+
"documentation":"<p>Indicates which content-packaging format is used (MPEG-TS or fMP4). If <code>multitrackInputConfiguration</code> is specified and <code>enabled</code> is <code>true</code>, then <code>containerFormat</code> is required and must be set to <code>FRAGMENTED_MP4</code>. Otherwise, <code>containerFormat</code> may be set to <code>TS</code> or <code>FRAGMENTED_MP4</code>. Default: <code>TS</code>.</p>"
1003+
},
9771004
"insecureIngest":{
9781005
"shape":"Boolean",
9791006
"documentation":"<p>Whether the channel allows insecure RTMP and SRT ingest. Default: <code>false</code>.</p>"
@@ -982,6 +1009,10 @@
9821009
"shape":"ChannelLatencyMode",
9831010
"documentation":"<p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. Default: <code>LOW</code>.</p>"
9841011
},
1012+
"multitrackInputConfiguration":{
1013+
"shape":"MultitrackInputConfiguration",
1014+
"documentation":"<p>Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.</p>"
1015+
},
9851016
"name":{
9861017
"shape":"ChannelName",
9871018
"documentation":"<p>Channel name.</p>"
@@ -1358,7 +1389,25 @@
13581389
"documentation":"<p>Encoder settings for video.</p>"
13591390
}
13601391
},
1361-
"documentation":"<p>Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.</p>"
1392+
"documentation":"<p>Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.</p> <p> <b>Note:</b> IngestConfiguration is deprecated in favor of <a>IngestConfigurations</a> but retained to ensure backward compatibility. If multitrack is not enabled, IngestConfiguration and IngestConfigurations contain the same data, namely information about track0 (the sole track). If multitrack is enabled, IngestConfiguration contains data for only the first track (track0) and IngestConfigurations contains data for all tracks.</p>"
1393+
},
1394+
"IngestConfigurations":{
1395+
"type":"structure",
1396+
"required":[
1397+
"audioConfigurations",
1398+
"videoConfigurations"
1399+
],
1400+
"members":{
1401+
"audioConfigurations":{
1402+
"shape":"AudioConfigurationList",
1403+
"documentation":"<p>Encoder settings for audio.</p>"
1404+
},
1405+
"videoConfigurations":{
1406+
"shape":"VideoConfigurationList",
1407+
"documentation":"<p>Encoder settings for video</p>"
1408+
}
1409+
},
1410+
"documentation":"<p>Object specifying the ingest configuration set up by the broadcaster, usually in an encoder. </p> <p> <b>Note:</b> Use IngestConfigurations instead of <a>IngestConfiguration</a> (which is deprecated). If multitrack is not enabled, IngestConfiguration and IngestConfigurations contain the same data, namely information about track0 (the sole track). If multitrack is enabled, IngestConfiguration contains data for only the first track (track0) and IngestConfigurations contains data for all tracks.</p>"
13621411
},
13631412
"IngestEndpoint":{"type":"string"},
13641413
"InsecureIngest":{"type":"boolean"},
@@ -1377,6 +1426,7 @@
13771426
"fault":true
13781427
},
13791428
"IsAuthorized":{"type":"boolean"},
1429+
"IsMultitrackInputEnabled":{"type":"boolean"},
13801430
"ListChannelsRequest":{
13811431
"type":"structure",
13821432
"members":{
@@ -1650,6 +1700,39 @@
16501700
"max":100,
16511701
"min":1
16521702
},
1703+
"MultitrackInputConfiguration":{
1704+
"type":"structure",
1705+
"members":{
1706+
"enabled":{
1707+
"shape":"IsMultitrackInputEnabled",
1708+
"documentation":"<p>Indicates whether multitrack input is enabled. Can be set to <code>true</code> only if channel type is <code>STANDARD</code>. Setting <code>enabled</code> to <code>true</code> with any other channel type will cause an exception. If <code>true</code>, then <code>policy</code>, <code>maximumResolution</code>, and <code>containerFormat</code> are required, and <code>containerFormat</code> must be set to <code>FRAGMENTED_MP4</code>. Default: <code>false</code>.</p>"
1709+
},
1710+
"maximumResolution":{
1711+
"shape":"MultitrackMaximumResolution",
1712+
"documentation":"<p>Maximum resolution for multitrack input. Required if <code>enabled</code> is <code>true</code>.</p>"
1713+
},
1714+
"policy":{
1715+
"shape":"MultitrackPolicy",
1716+
"documentation":"<p>Indicates whether multitrack input is allowed or required. Required if <code>enabled</code> is <code>true</code>.</p>"
1717+
}
1718+
},
1719+
"documentation":"<p>A complex type that specifies multitrack input configuration.</p>"
1720+
},
1721+
"MultitrackMaximumResolution":{
1722+
"type":"string",
1723+
"enum":[
1724+
"SD",
1725+
"HD",
1726+
"FULL_HD"
1727+
]
1728+
},
1729+
"MultitrackPolicy":{
1730+
"type":"string",
1731+
"enum":[
1732+
"ALLOW",
1733+
"REQUIRE"
1734+
]
1735+
},
16531736
"PaginationToken":{
16541737
"type":"string",
16551738
"max":1024,
@@ -2152,7 +2235,7 @@
21522235
"members":{
21532236
"code":{
21542237
"shape":"String",
2155-
"documentation":"<p>Provides additional details about the stream event. There are several values; note that the long descriptions are provided in the IVS console but not delivered through the IVS API or EventBridge:</p> <ul> <li> <p> <code>StreamTakeoverMediaMismatch</code> — The broadcast client attempted to take over with different media properties (e.g., codec, resolution, or video track type) from the original stream.</p> </li> <li> <p> <code>StreamTakeoverInvalidPriority</code> — The broadcast client attempted a takeover with either a priority integer value equal to or lower than the original stream's value or a value outside the allowed range of 1 to 2,147,483,647.</p> </li> <li> <p> <code>StreamTakeoverLimitBreached</code> — The broadcast client reached the maximum allowed takeover attempts for this stream.</p> </li> </ul>"
2238+
"documentation":"<p>Provides additional details about the stream event. There are several values; the long descriptions are provided in the IVS console but not delivered through the IVS API or EventBridge. Multitrack-related codes are used only for certain Session Ended events.</p> <ul> <li> <p> <code>MultitrackInputNotAllowed</code> — The broadcast client attempted to connect with multitrack input, but multitrack input was not enabled on the channel. Check your broadcast software settings or set <code>MultitrackInputConfiguration.Policy</code> to <code>ALLOW</code> or <code>REQUIRE</code>.</p> </li> <li> <p> <code>MultitrackInputRequired</code> — The broadcast client attempted to connect with single-track video, but multitrack input is required on this channel. Enable multitrack video in your broadcast software or configure the channel’s <code>MultitrackInputConfiguration.Policy</code> to <code>ALLOW</code>.</p> </li> <li> <p> <code>InvalidGetClientConfigurationStreamKey</code> — The broadcast client attempted to connect with an invalid, expired, or corrupt stream key.</p> </li> <li> <p> <code>GetClientConfigurationStreamKeyRequired</code> — The broadcast client attempted to stream multitrack video without providing an authenticated stream key from GetClientConfiguration.</p> </li> <li> <p> <code>InvalidMultitrackInputTrackCount</code> — The multitrack input stream contained an invalid number of tracks.</p> </li> <li> <p> <code>InvalidMultitrackInputVideoTrackMediaProperties</code> — The multitrack input stream contained one or more tracks with an invalid codec, resolution, bitrate, or framerate.</p> </li> <li> <p> <code>StreamTakeoverMediaMismatch</code> — The broadcast client attempted to take over with different media properties (e.g., codec, resolution, or video track type) from the original stream.</p> </li> <li> <p> <code>StreamTakeoverInvalidPriority</code> — The broadcast client attempted a takeover with either a priority integer value equal to or lower than the original stream's value or a value outside the allowed range of 1 to 2,147,483,647.</p> <p> <code>StreamTakeoverLimitBreached</code> — The broadcast client reached the maximum allowed takeover attempts for this stream.</p> </li> </ul>"
21562239
},
21572240
"eventTime":{
21582241
"shape":"Time",
@@ -2285,7 +2368,11 @@
22852368
},
22862369
"ingestConfiguration":{
22872370
"shape":"IngestConfiguration",
2288-
"documentation":"<p>The properties of the incoming RTMP stream for the stream.</p>"
2371+
"documentation":"<p>The properties of the incoming RTMP stream.</p> <p> <b>Note:</b> <code>ingestConfiguration</code> is deprecated in favor of <code>ingestConfigurations</code> but retained to ensure backward compatibility. If multitrack is not enabled, <code>ingestConfiguration</code> and <code>ingestConfigurations</code> contain the same data, namely information about track0 (the sole track). If multitrack is enabled, <code>ingestConfiguration</code> contains data for only the first track (track0) and <code>ingestConfigurations</code> contains data for all tracks.</p>"
2372+
},
2373+
"ingestConfigurations":{
2374+
"shape":"IngestConfigurations",
2375+
"documentation":"<p>The properties of the incoming RTMP stream. If multitrack is enabled, <code>ingestConfigurations</code> contains data for all tracks; otherwise, it contains data only for track0 (the sole track).</p>"
22892376
},
22902377
"recordingConfiguration":{
22912378
"shape":"RecordingConfiguration",
@@ -2473,7 +2560,7 @@
24732560
},
24742561
"targetIntervalSeconds":{
24752562
"shape":"TargetIntervalSeconds",
2476-
"documentation":"<p>The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if <code>recordingMode</code> is <code>INTERVAL</code>. Default: 60.</p> <p> <b>Important:</b> For the <code>BASIC</code> channel type, setting a value for <code>targetIntervalSeconds</code> does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the <code>targetIntervalSeconds</code> interval, the <code>IDR/Keyframe</code> value for the input video must be less than the <code>targetIntervalSeconds</code> value. See <a href=\"https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html\"> Amazon IVS Streaming Configuration</a> for information on setting <code>IDR/Keyframe</code> to the recommended value in video-encoder settings.</p>"
2563+
"documentation":"<p>The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if <code>recordingMode</code> is <code>INTERVAL</code>. Default: 60.</p> <p> <b>Important:</b> For the <code>BASIC</code> channel type, or the <code>STANDARD</code> channel type with multitrack input, setting a value for <code>targetIntervalSeconds</code> does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the <code>targetIntervalSeconds</code> interval, the <code>IDR/Keyframe</code> value for the input video must be less than the <code>targetIntervalSeconds</code> value. See <a href=\"https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html\"> Amazon IVS Streaming Configuration</a> for information on setting <code>IDR/Keyframe</code> to the recommended value in video-encoder settings.</p>"
24772564
}
24782565
},
24792566
"documentation":"<p>An object representing a configuration of thumbnails for recorded video.</p>"
@@ -2547,6 +2634,10 @@
25472634
"shape":"Boolean",
25482635
"documentation":"<p>Whether the channel is private (enabled for playback authorization).</p>"
25492636
},
2637+
"containerFormat":{
2638+
"shape":"ContainerFormat",
2639+
"documentation":"<p>Indicates which content-packaging format is used (MPEG-TS or fMP4). If <code>multitrackInputConfiguration</code> is specified and <code>enabled</code> is <code>true</code>, then <code>containerFormat</code> is required and must be set to <code>FRAGMENTED_MP4</code>. Otherwise, <code>containerFormat</code> may be set to <code>TS</code> or <code>FRAGMENTED_MP4</code>. Default: <code>TS</code>.</p>"
2640+
},
25502641
"insecureIngest":{
25512642
"shape":"Boolean",
25522643
"documentation":"<p>Whether the channel allows insecure RTMP and SRT ingest. Default: <code>false</code>.</p>"
@@ -2555,6 +2646,10 @@
25552646
"shape":"ChannelLatencyMode",
25562647
"documentation":"<p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to Full HD. Use <code>LOW</code> for near-real-time interaction with viewers.</p>"
25572648
},
2649+
"multitrackInputConfiguration":{
2650+
"shape":"MultitrackInputConfiguration",
2651+
"documentation":"<p>Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.</p>"
2652+
},
25582653
"name":{
25592654
"shape":"ChannelName",
25602655
"documentation":"<p>Channel name.</p>"
@@ -2655,6 +2750,14 @@
26552750
"shape":"String",
26562751
"documentation":"<p>Software or hardware used to encode the video.</p>"
26572752
},
2753+
"level":{
2754+
"shape":"String",
2755+
"documentation":"<p>Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. When an AVC codec is used, this field has the same value as <code>avcLevel</code>.</p>"
2756+
},
2757+
"profile":{
2758+
"shape":"String",
2759+
"documentation":"<p>Indicates to the decoder the requirements for decoding the stream. When an AVC codec is used, this field has the same value as <code>avcProfile</code>.</p>"
2760+
},
26582761
"targetBitrate":{
26592762
"shape":"Integer",
26602763
"documentation":"<p>The expected ingest bitrate (bits per second). This is configured in the encoder.</p>"
@@ -2663,6 +2766,10 @@
26632766
"shape":"Integer",
26642767
"documentation":"<p>The expected ingest framerate. This is configured in the encoder.</p>"
26652768
},
2769+
"track":{
2770+
"shape":"String",
2771+
"documentation":"<p>Name of the video track. If multitrack is not enabled, this is track0 (the sole track).</p>"
2772+
},
26662773
"videoHeight":{
26672774
"shape":"Integer",
26682775
"documentation":"<p>Video-resolution height in pixels.</p>"
@@ -2672,7 +2779,11 @@
26722779
"documentation":"<p>Video-resolution width in pixels.</p>"
26732780
}
26742781
},
2675-
"documentation":"<p>Object specifying a stream’s video configuration, as set up by the broadcaster (usually in an encoder). This is part of the <a>IngestConfiguration</a> object and used for monitoring stream health.</p>"
2782+
"documentation":"<p>Object specifying a stream’s video configuration, as set up by the broadcaster (usually in an encoder). This is part of the <a>IngestConfigurations</a> object and the deprecated <a>IngestConfiguration</a> object. It is used for monitoring stream health. </p>"
2783+
},
2784+
"VideoConfigurationList":{
2785+
"type":"list",
2786+
"member":{"shape":"VideoConfiguration"}
26762787
},
26772788
"ViewerId":{
26782789
"type":"string",

0 commit comments

Comments
 (0)