aws-sdk-ivs 1.62.0 → 1.64.0

data/lib/aws-sdk-ivs/types.rb

@@ -24,7 +24,8 @@ module Aws::IVS
 
     # Object specifying a stream’s audio configuration, as set up by the
     # broadcaster (usually in an encoder). This is part of the
-    # IngestConfiguration object and used for monitoring stream health.
+    # IngestConfigurations object and the deprecated IngestConfiguration
+    # object. It is used for monitoring stream health.
     #
     # @!attribute [rw] channels
     #   Number of audio channels.
@@ -43,13 +44,19 @@ module Aws::IVS
     #   the encoder.
     #   @return [Integer]
     #
+    # @!attribute [rw] track
+    #   Name of the audio track (if the stream has an audio track). If
+    #   multitrack is not enabled, this is track0 (the sole track).
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/AudioConfiguration AWS API Documentation
     #
     class AudioConfiguration < Struct.new(
       :channels,
       :codec,
       :sample_rate,
-      :target_bitrate)
+      :target_bitrate,
+      :track)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -229,6 +236,14 @@ module Aws::IVS
     #   Default: `false`.
     #   @return [Boolean]
     #
+    # @!attribute [rw] container_format
+    #   Indicates which content-packaging format is used (MPEG-TS or fMP4).
+    #   If `multitrackInputConfiguration` is specified and `enabled` is
+    #   `true`, then `containerFormat` is required and must be set to
+    #   `FRAGMENTED_MP4`. Otherwise, `containerFormat` may be set to `TS` or
+    #   `FRAGMENTED_MP4`. Default: `TS`.
+    #   @return [String]
+    #
     # @!attribute [rw] ingest_endpoint
     #   Channel ingest endpoint, part of the definition of an ingest server,
     #   used when you set up streaming software.
@@ -244,6 +259,11 @@ module Aws::IVS
     #   viewers. Default: `LOW`.
     #   @return [String]
     #
+    # @!attribute [rw] multitrack_input_configuration
+    #   Object specifying multitrack input configuration. Default: no
+    #   multitrack input configuration is specified.
+    #   @return [Types::MultitrackInputConfiguration]
+    #
     # @!attribute [rw] name
     #   Channel name.
     #   @return [String]
@@ -306,9 +326,11 @@ module Aws::IVS
     class Channel < Struct.new(
       :arn,
       :authorized,
+      :container_format,
       :ingest_endpoint,
       :insecure_ingest,
       :latency_mode,
+      :multitrack_input_configuration,
       :name,
       :playback_restriction_policy_arn,
       :playback_url,
@@ -436,6 +458,14 @@ module Aws::IVS
     #   Default: `false`.
     #   @return [Boolean]
     #
+    # @!attribute [rw] container_format
+    #   Indicates which content-packaging format is used (MPEG-TS or fMP4).
+    #   If `multitrackInputConfiguration` is specified and `enabled` is
+    #   `true`, then `containerFormat` is required and must be set to
+    #   `FRAGMENTED_MP4`. Otherwise, `containerFormat` may be set to `TS` or
+    #   `FRAGMENTED_MP4`. Default: `TS`.
+    #   @return [String]
+    #
     # @!attribute [rw] insecure_ingest
     #   Whether the channel allows insecure RTMP and SRT ingest. Default:
     #   `false`.
@@ -447,6 +477,11 @@ module Aws::IVS
     #   viewers. Default: `LOW`.
     #   @return [String]
     #
+    # @!attribute [rw] multitrack_input_configuration
+    #   Object specifying multitrack input configuration. Default: no
+    #   multitrack input configuration is specified.
+    #   @return [Types::MultitrackInputConfiguration]
+    #
     # @!attribute [rw] name
     #   Channel name.
     #   @return [String]
@@ -499,8 +534,10 @@ module Aws::IVS
     #
     class CreateChannelRequest < Struct.new(
       :authorized,
+      :container_format,
       :insecure_ingest,
       :latency_mode,
+      :multitrack_input_configuration,
       :name,
       :playback_restriction_policy_arn,
       :preset,
@@ -1002,6 +1039,14 @@ module Aws::IVS
     # Object specifying the ingest configuration set up by the broadcaster,
     # usually in an encoder.
     #
+    # **Note:** IngestConfiguration is deprecated in favor of
+    # IngestConfigurations 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.
+    #
     # @!attribute [rw] audio
     #   Encoder settings for audio.
     #   @return [Types::AudioConfiguration]
@@ -1019,6 +1064,33 @@ module Aws::IVS
       include Aws::Structure
     end
 
+    # Object specifying the ingest configuration set up by the broadcaster,
+    # usually in an encoder.
+    #
+    # **Note:** Use IngestConfigurations instead of IngestConfiguration
+    # (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.
+    #
+    # @!attribute [rw] audio_configurations
+    #   Encoder settings for audio.
+    #   @return [Array<Types::AudioConfiguration>]
+    #
+    # @!attribute [rw] video_configurations
+    #   Encoder settings for video
+    #   @return [Array<Types::VideoConfiguration>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/IngestConfigurations AWS API Documentation
+    #
+    class IngestConfigurations < Struct.new(
+      :audio_configurations,
+      :video_configurations)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] exception_message
     #   Unexpected error during processing of request.
     #   @return [String]
@@ -1342,6 +1414,37 @@ module Aws::IVS
       include Aws::Structure
     end
 
+    # A complex type that specifies multitrack input configuration.
+    #
+    # @!attribute [rw] enabled
+    #   Indicates whether multitrack input is enabled. Can be set to `true`
+    #   only if channel type is `STANDARD`. Setting `enabled` to `true` with
+    #   any other channel type will cause an exception. If `true`, then
+    #   `policy`, `maximumResolution`, and `containerFormat` are required,
+    #   and `containerFormat` must be set to `FRAGMENTED_MP4`. Default:
+    #   `false`.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] maximum_resolution
+    #   Maximum resolution for multitrack input. Required if `enabled` is
+    #   `true`.
+    #   @return [String]
+    #
+    # @!attribute [rw] policy
+    #   Indicates whether multitrack input is allowed or required. Required
+    #   if `enabled` is `true`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/MultitrackInputConfiguration AWS API Documentation
+    #
+    class MultitrackInputConfiguration < Struct.new(
+      :enabled,
+      :maximum_resolution,
+      :policy)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] exception_message
     #   Your account is pending verification.
     #   @return [String]
@@ -1884,8 +1987,36 @@ module Aws::IVS
     #
     # @!attribute [rw] code
     #   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:
+    #   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.
+    #
+    #   * `MultitrackInputNotAllowed` — 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 `MultitrackInputConfiguration.Policy` to `ALLOW` or `REQUIRE`.
+    #
+    #   * `MultitrackInputRequired` — 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
+    #     `MultitrackInputConfiguration.Policy` to `ALLOW`.
+    #
+    #   * `InvalidGetClientConfigurationStreamKey` — The broadcast client
+    #     attempted to connect with an invalid, expired, or corrupt stream
+    #     key.
+    #
+    #   * `GetClientConfigurationStreamKeyRequired` — The broadcast client
+    #     attempted to stream multitrack video without providing an
+    #     authenticated stream key from GetClientConfiguration.
+    #
+    #   * `InvalidMultitrackInputTrackCount` — The multitrack input stream
+    #     contained an invalid number of tracks.
+    #
+    #   * `InvalidMultitrackInputVideoTrackMediaProperties` — The multitrack
+    #     input stream contained one or more tracks with an invalid codec,
+    #     resolution, bitrate, or framerate.
     #
     #   * `StreamTakeoverMediaMismatch` — The broadcast client attempted to
     #     take over with different media properties (e.g., codec,
@@ -1896,7 +2027,7 @@ module Aws::IVS
     #     than the original stream's value or a value outside the allowed
     #     range of 1 to 2,147,483,647.
     #
-    #   * `StreamTakeoverLimitBreached` — The broadcast client reached the
+    #     `StreamTakeoverLimitBreached` — The broadcast client reached the
     #     maximum allowed takeover attempts for this stream.
     #   @return [String]
     #
@@ -2024,9 +2155,23 @@ module Aws::IVS
     #   @return [Time]
     #
     # @!attribute [rw] ingest_configuration
-    #   The properties of the incoming RTMP stream for the stream.
+    #   The properties of the incoming RTMP stream.
+    #
+    #   **Note:** `ingestConfiguration` is deprecated in favor of
+    #   `ingestConfigurations` 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.
     #   @return [Types::IngestConfiguration]
     #
+    # @!attribute [rw] ingest_configurations
+    #   The properties of the incoming RTMP stream. If multitrack is
+    #   enabled, `ingestConfigurations` contains data for all tracks;
+    #   otherwise, it contains data only for track0 (the sole track).
+    #   @return [Types::IngestConfigurations]
+    #
     # @!attribute [rw] recording_configuration
     #   The properties of recording the live stream.
     #   @return [Types::RecordingConfiguration]
@@ -2058,6 +2203,7 @@ module Aws::IVS
       :channel,
       :end_time,
       :ingest_configuration,
+      :ingest_configurations,
       :recording_configuration,
       :start_time,
       :stream_id,
@@ -2236,7 +2382,8 @@ module Aws::IVS
     #   configurable (and required) only if `recordingMode` is `INTERVAL`.
     #   Default: 60.
     #
-    #   **Important:** For the `BASIC` channel type, setting a value for
+    #   **Important:** For the `BASIC` channel type, or the `STANDARD`
+    #   channel type with multitrack input, setting a value for
     #   `targetIntervalSeconds` does not guarantee that thumbnails are
     #   generated at the specified interval. For thumbnails to be generated
     #   at the `targetIntervalSeconds` interval, the `IDR/Keyframe` value
@@ -2300,6 +2447,14 @@ module Aws::IVS
     #   Whether the channel is private (enabled for playback authorization).
     #   @return [Boolean]
     #
+    # @!attribute [rw] container_format
+    #   Indicates which content-packaging format is used (MPEG-TS or fMP4).
+    #   If `multitrackInputConfiguration` is specified and `enabled` is
+    #   `true`, then `containerFormat` is required and must be set to
+    #   `FRAGMENTED_MP4`. Otherwise, `containerFormat` may be set to `TS` or
+    #   `FRAGMENTED_MP4`. Default: `TS`.
+    #   @return [String]
+    #
     # @!attribute [rw] insecure_ingest
     #   Whether the channel allows insecure RTMP and SRT ingest. Default:
     #   `false`.
@@ -2311,6 +2466,11 @@ module Aws::IVS
     #   viewers.
     #   @return [String]
     #
+    # @!attribute [rw] multitrack_input_configuration
+    #   Object specifying multitrack input configuration. Default: no
+    #   multitrack input configuration is specified.
+    #   @return [Types::MultitrackInputConfiguration]
+    #
     # @!attribute [rw] name
     #   Channel name.
     #   @return [String]
@@ -2351,8 +2511,10 @@ module Aws::IVS
     class UpdateChannelRequest < Struct.new(
       :arn,
       :authorized,
+      :container_format,
       :insecure_ingest,
       :latency_mode,
+      :multitrack_input_configuration,
       :name,
       :playback_restriction_policy_arn,
       :preset,
@@ -2448,7 +2610,8 @@ module Aws::IVS
 
     # Object specifying a stream’s video configuration, as set up by the
     # broadcaster (usually in an encoder). This is part of the
-    # IngestConfiguration object and used for monitoring stream health.
+    # IngestConfigurations object and the deprecated IngestConfiguration
+    # object. It is used for monitoring stream health.
     #
     # @!attribute [rw] avc_level
     #   Indicates the degree of required decoder performance for a profile.
@@ -2469,6 +2632,18 @@ module Aws::IVS
     #   Software or hardware used to encode the video.
     #   @return [String]
     #
+    # @!attribute [rw] level
+    #   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 `avcLevel`.
+    #   @return [String]
+    #
+    # @!attribute [rw] profile
+    #   Indicates to the decoder the requirements for decoding the stream.
+    #   When an AVC codec is used, this field has the same value as
+    #   `avcProfile`.
+    #   @return [String]
+    #
     # @!attribute [rw] target_bitrate
     #   The expected ingest bitrate (bits per second). This is configured in
     #   the encoder.
@@ -2478,6 +2653,11 @@ module Aws::IVS
     #   The expected ingest framerate. This is configured in the encoder.
     #   @return [Integer]
     #
+    # @!attribute [rw] track
+    #   Name of the video track. If multitrack is not enabled, this is
+    #   track0 (the sole track).
+    #   @return [String]
+    #
     # @!attribute [rw] video_height
     #   Video-resolution height in pixels.
     #   @return [Integer]
@@ -2493,8 +2673,11 @@ module Aws::IVS
       :avc_profile,
       :codec,
       :encoder,
+      :level,
+      :profile,
       :target_bitrate,
       :target_framerate,
+      :track,
       :video_height,
       :video_width)
       SENSITIVE = []

data/lib/aws-sdk-ivs.rb

@@ -54,7 +54,7 @@ module Aws::IVS
   autoload :EndpointProvider, 'aws-sdk-ivs/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-ivs/endpoints'
 
-  GEM_VERSION = '1.62.0'
+  GEM_VERSION = '1.64.0'
 
 end
 

data/sig/client.rbs

@@ -121,8 +121,14 @@ module Aws
       # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#create_channel-instance_method
       def create_channel: (
                             ?authorized: bool,
+                            ?container_format: ("TS" | "FRAGMENTED_MP4"),
                             ?insecure_ingest: bool,
                             ?latency_mode: ("NORMAL" | "LOW"),
+                            ?multitrack_input_configuration: {
+                              enabled: bool?,
+                              maximum_resolution: ("SD" | "HD" | "FULL_HD")?,
+                              policy: ("ALLOW" | "REQUIRE")?
+                            },
                             ?name: ::String,
                             ?playback_restriction_policy_arn: ::String,
                             ?preset: ("HIGHER_BANDWIDTH_DELIVERY" | "CONSTRAINED_BANDWIDTH_DELIVERY"),
@@ -457,8 +463,14 @@ module Aws
       def update_channel: (
                             arn: ::String,
                             ?authorized: bool,
+                            ?container_format: ("TS" | "FRAGMENTED_MP4"),
                             ?insecure_ingest: bool,
                             ?latency_mode: ("NORMAL" | "LOW"),
+                            ?multitrack_input_configuration: {
+                              enabled: bool?,
+                              maximum_resolution: ("SD" | "HD" | "FULL_HD")?,
+                              policy: ("ALLOW" | "REQUIRE")?
+                            },
                             ?name: ::String,
                             ?playback_restriction_policy_arn: ::String,
                             ?preset: ("HIGHER_BANDWIDTH_DELIVERY" | "CONSTRAINED_BANDWIDTH_DELIVERY"),

data/sig/types.rbs

@@ -18,6 +18,7 @@ module Aws::IVS
       attr_accessor codec: ::String
       attr_accessor sample_rate: ::Integer
       attr_accessor target_bitrate: ::Integer
+      attr_accessor track: ::String
       SENSITIVE: []
     end
 
@@ -78,9 +79,11 @@ module Aws::IVS
     class Channel
       attr_accessor arn: ::String
       attr_accessor authorized: bool
+      attr_accessor container_format: ("TS" | "FRAGMENTED_MP4")
       attr_accessor ingest_endpoint: ::String
       attr_accessor insecure_ingest: bool
       attr_accessor latency_mode: ("NORMAL" | "LOW")
+      attr_accessor multitrack_input_configuration: Types::MultitrackInputConfiguration
       attr_accessor name: ::String
       attr_accessor playback_restriction_policy_arn: ::String
       attr_accessor playback_url: ::String
@@ -118,8 +121,10 @@ module Aws::IVS
 
     class CreateChannelRequest
       attr_accessor authorized: bool
+      attr_accessor container_format: ("TS" | "FRAGMENTED_MP4")
       attr_accessor insecure_ingest: bool
       attr_accessor latency_mode: ("NORMAL" | "LOW")
+      attr_accessor multitrack_input_configuration: Types::MultitrackInputConfiguration
       attr_accessor name: ::String
       attr_accessor playback_restriction_policy_arn: ::String
       attr_accessor preset: ("HIGHER_BANDWIDTH_DELIVERY" | "CONSTRAINED_BANDWIDTH_DELIVERY")
@@ -297,6 +302,12 @@ module Aws::IVS
       SENSITIVE: []
     end
 
+    class IngestConfigurations
+      attr_accessor audio_configurations: ::Array[Types::AudioConfiguration]
+      attr_accessor video_configurations: ::Array[Types::VideoConfiguration]
+      SENSITIVE: []
+    end
+
     class InternalServerException
       attr_accessor exception_message: ::String
       SENSITIVE: []
@@ -402,6 +413,13 @@ module Aws::IVS
       SENSITIVE: []
     end
 
+    class MultitrackInputConfiguration
+      attr_accessor enabled: bool
+      attr_accessor maximum_resolution: ("SD" | "HD" | "FULL_HD")
+      attr_accessor policy: ("ALLOW" | "REQUIRE")
+      SENSITIVE: []
+    end
+
     class PendingVerification
       attr_accessor exception_message: ::String
       SENSITIVE: []
@@ -557,6 +575,7 @@ module Aws::IVS
       attr_accessor channel: Types::Channel
       attr_accessor end_time: ::Time
       attr_accessor ingest_configuration: Types::IngestConfiguration
+      attr_accessor ingest_configurations: Types::IngestConfigurations
       attr_accessor recording_configuration: Types::RecordingConfiguration
       attr_accessor start_time: ::Time
       attr_accessor stream_id: ::String
@@ -621,8 +640,10 @@ module Aws::IVS
     class UpdateChannelRequest
       attr_accessor arn: ::String
       attr_accessor authorized: bool
+      attr_accessor container_format: ("TS" | "FRAGMENTED_MP4")
       attr_accessor insecure_ingest: bool
       attr_accessor latency_mode: ("NORMAL" | "LOW")
+      attr_accessor multitrack_input_configuration: Types::MultitrackInputConfiguration
       attr_accessor name: ::String
       attr_accessor playback_restriction_policy_arn: ::String
       attr_accessor preset: ("HIGHER_BANDWIDTH_DELIVERY" | "CONSTRAINED_BANDWIDTH_DELIVERY")
@@ -660,8 +681,11 @@ module Aws::IVS
       attr_accessor avc_profile: ::String
       attr_accessor codec: ::String
       attr_accessor encoder: ::String
+      attr_accessor level: ::String
+      attr_accessor profile: ::String
       attr_accessor target_bitrate: ::Integer
       attr_accessor target_framerate: ::Integer
+      attr_accessor track: ::String
       attr_accessor video_height: ::Integer
       attr_accessor video_width: ::Integer
       SENSITIVE: []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-ivs
 version: !ruby/object:Gem::Version
-  version: 1.62.0
+  version: 1.64.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-15 00:00:00.000000000 Z
+date: 2024-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.207.0
+        version: 3.210.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.207.0
+        version: 3.210.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement