aws-sdk-ivsrealtime 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 664ce977c839c2e2da0513734924ecb0d4429c82ab1f6a0516803075bb346c55
-  data.tar.gz: 3fe9bc32f35eacd510dcc545750651b054b19673d28ad24d02152ec285d34bf8
+  metadata.gz: a87479caa5c86bde268e2fc9c6dec5b4946d337e274364418842bc5ad6c8b8a2
+  data.tar.gz: 17425ef09a60118266937ee22c08e4cd9ce5cbfb26e5965439dc42d0bc5cfcb3
 SHA512:
-  metadata.gz: 9dead615f492883e856b8e9b446117e248668cb745aead3e13250d48ec386df60da3f168c645f4fe85dece2072178a106a871c578d1a69b4fcf258d21fd0a010
-  data.tar.gz: a9b12054082cb71a8b074eea38e2fbe22c12807d3b21083a9b5b8297c4b632e6af23488a4e3039cff7ab57e9acdc665d228a608a1407dbedaa8bd124d808ec12
+  metadata.gz: 75603d8d97a9ac481f935f173158cb950c643d68f29704f8e34da4dcb0feb3c8a843abda10dcb0ff475e14fe8dcc1f9d4413db34480ed0dd3bdf70f3f88c06cb
+  data.tar.gz: ff3b0d543525cdb3daea0011d143e75b53de43042abe02d731bd49213bd011d485aa25d8f290cf1f9fa7b28c24ce00e896f20d122e2354e0e205a33a07f03094

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.16.0 (2024-03-13)
+------------------
+
+* Feature - adds support for multiple new composition layout configuration options (grid, pip)
+
 1.15.0 (2024-01-26)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.15.0
+1.16.0

data/lib/aws-sdk-ivsrealtime/client.rb

@@ -781,6 +781,20 @@ module Aws::IVSRealTime
     #   resp.composition.destinations[0].state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "RECONNECTING", "FAILED", "STOPPED"
     #   resp.composition.end_time #=> Time
     #   resp.composition.layout.grid.featured_participant_attribute #=> String
+    #   resp.composition.layout.grid.grid_gap #=> Integer
+    #   resp.composition.layout.grid.omit_stopped_video #=> Boolean
+    #   resp.composition.layout.grid.video_aspect_ratio #=> String, one of "AUTO", "VIDEO", "SQUARE", "PORTRAIT"
+    #   resp.composition.layout.grid.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
+    #   resp.composition.layout.pip.featured_participant_attribute #=> String
+    #   resp.composition.layout.pip.grid_gap #=> Integer
+    #   resp.composition.layout.pip.omit_stopped_video #=> Boolean
+    #   resp.composition.layout.pip.pip_behavior #=> String, one of "STATIC", "DYNAMIC"
+    #   resp.composition.layout.pip.pip_height #=> Integer
+    #   resp.composition.layout.pip.pip_offset #=> Integer
+    #   resp.composition.layout.pip.pip_participant_attribute #=> String
+    #   resp.composition.layout.pip.pip_position #=> String, one of "TOP_LEFT", "TOP_RIGHT", "BOTTOM_LEFT", "BOTTOM_RIGHT"
+    #   resp.composition.layout.pip.pip_width #=> Integer
+    #   resp.composition.layout.pip.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
     #   resp.composition.stage_arn #=> String
     #   resp.composition.start_time #=> Time
     #   resp.composition.state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "FAILED", "STOPPED"
@@ -1438,6 +1452,22 @@ module Aws::IVSRealTime
     #     layout: {
     #       grid: {
     #         featured_participant_attribute: "AttributeKey",
+    #         grid_gap: 1,
+    #         omit_stopped_video: false,
+    #         video_aspect_ratio: "AUTO", # accepts AUTO, VIDEO, SQUARE, PORTRAIT
+    #         video_fill_mode: "FILL", # accepts FILL, COVER, CONTAIN
+    #       },
+    #       pip: {
+    #         featured_participant_attribute: "AttributeKey",
+    #         grid_gap: 1,
+    #         omit_stopped_video: false,
+    #         pip_behavior: "STATIC", # accepts STATIC, DYNAMIC
+    #         pip_height: 1,
+    #         pip_offset: 1,
+    #         pip_participant_attribute: "AttributeKey",
+    #         pip_position: "TOP_LEFT", # accepts TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT
+    #         pip_width: 1,
+    #         video_fill_mode: "FILL", # accepts FILL, COVER, CONTAIN
     #       },
     #     },
     #     stage_arn: "StageArn", # required
@@ -1464,6 +1494,20 @@ module Aws::IVSRealTime
     #   resp.composition.destinations[0].state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "RECONNECTING", "FAILED", "STOPPED"
     #   resp.composition.end_time #=> Time
     #   resp.composition.layout.grid.featured_participant_attribute #=> String
+    #   resp.composition.layout.grid.grid_gap #=> Integer
+    #   resp.composition.layout.grid.omit_stopped_video #=> Boolean
+    #   resp.composition.layout.grid.video_aspect_ratio #=> String, one of "AUTO", "VIDEO", "SQUARE", "PORTRAIT"
+    #   resp.composition.layout.grid.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
+    #   resp.composition.layout.pip.featured_participant_attribute #=> String
+    #   resp.composition.layout.pip.grid_gap #=> Integer
+    #   resp.composition.layout.pip.omit_stopped_video #=> Boolean
+    #   resp.composition.layout.pip.pip_behavior #=> String, one of "STATIC", "DYNAMIC"
+    #   resp.composition.layout.pip.pip_height #=> Integer
+    #   resp.composition.layout.pip.pip_offset #=> Integer
+    #   resp.composition.layout.pip.pip_participant_attribute #=> String
+    #   resp.composition.layout.pip.pip_position #=> String, one of "TOP_LEFT", "TOP_RIGHT", "BOTTOM_LEFT", "BOTTOM_RIGHT"
+    #   resp.composition.layout.pip.pip_width #=> Integer
+    #   resp.composition.layout.pip.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
     #   resp.composition.stage_arn #=> String
     #   resp.composition.start_time #=> Time
     #   resp.composition.state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "FAILED", "STOPPED"
@@ -1621,7 +1665,7 @@ module Aws::IVSRealTime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-ivsrealtime'
-      context[:gem_version] = '1.15.0'
+      context[:gem_version] = '1.16.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-ivsrealtime/client_api.rb

@@ -75,6 +75,7 @@ module Aws::IVSRealTime
     GetStorageConfigurationRequest = Shapes::StructureShape.new(name: 'GetStorageConfigurationRequest')
     GetStorageConfigurationResponse = Shapes::StructureShape.new(name: 'GetStorageConfigurationResponse')
     GridConfiguration = Shapes::StructureShape.new(name: 'GridConfiguration')
+    GridGap = Shapes::IntegerShape.new(name: 'GridGap')
     Height = Shapes::IntegerShape.new(name: 'Height')
     InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
     LayoutConfiguration = Shapes::StructureShape.new(name: 'LayoutConfiguration')
@@ -101,6 +102,7 @@ module Aws::IVSRealTime
     MaxStageResults = Shapes::IntegerShape.new(name: 'MaxStageResults')
     MaxStageSessionResults = Shapes::IntegerShape.new(name: 'MaxStageSessionResults')
     MaxStorageConfigurationResults = Shapes::IntegerShape.new(name: 'MaxStorageConfigurationResults')
+    OmitStoppedVideo = Shapes::BooleanShape.new(name: 'OmitStoppedVideo')
     PaginationToken = Shapes::StringShape.new(name: 'PaginationToken')
     Participant = Shapes::StructureShape.new(name: 'Participant')
     ParticipantAttributes = Shapes::MapShape.new(name: 'ParticipantAttributes')
@@ -122,6 +124,12 @@ module Aws::IVSRealTime
     ParticipantTokenString = Shapes::StringShape.new(name: 'ParticipantTokenString')
     ParticipantTokenUserId = Shapes::StringShape.new(name: 'ParticipantTokenUserId')
     PendingVerification = Shapes::StructureShape.new(name: 'PendingVerification')
+    PipBehavior = Shapes::StringShape.new(name: 'PipBehavior')
+    PipConfiguration = Shapes::StructureShape.new(name: 'PipConfiguration')
+    PipHeight = Shapes::IntegerShape.new(name: 'PipHeight')
+    PipOffset = Shapes::IntegerShape.new(name: 'PipOffset')
+    PipPosition = Shapes::StringShape.new(name: 'PipPosition')
+    PipWidth = Shapes::IntegerShape.new(name: 'PipWidth')
     Published = Shapes::BooleanShape.new(name: 'Published')
     RecordingConfiguration = Shapes::StructureShape.new(name: 'RecordingConfiguration')
     RecordingConfigurationFormat = Shapes::StringShape.new(name: 'RecordingConfigurationFormat')
@@ -165,6 +173,8 @@ module Aws::IVSRealTime
     UserId = Shapes::StringShape.new(name: 'UserId')
     ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
     Video = Shapes::StructureShape.new(name: 'Video')
+    VideoAspectRatio = Shapes::StringShape.new(name: 'VideoAspectRatio')
+    VideoFillMode = Shapes::StringShape.new(name: 'VideoFillMode')
     Width = Shapes::IntegerShape.new(name: 'Width')
     errorMessage = Shapes::StringShape.new(name: 'errorMessage')
 
@@ -348,12 +358,17 @@ module Aws::IVSRealTime
     GetStorageConfigurationResponse.struct_class = Types::GetStorageConfigurationResponse
 
     GridConfiguration.add_member(:featured_participant_attribute, Shapes::ShapeRef.new(shape: AttributeKey, location_name: "featuredParticipantAttribute"))
+    GridConfiguration.add_member(:grid_gap, Shapes::ShapeRef.new(shape: GridGap, location_name: "gridGap"))
+    GridConfiguration.add_member(:omit_stopped_video, Shapes::ShapeRef.new(shape: OmitStoppedVideo, location_name: "omitStoppedVideo"))
+    GridConfiguration.add_member(:video_aspect_ratio, Shapes::ShapeRef.new(shape: VideoAspectRatio, location_name: "videoAspectRatio"))
+    GridConfiguration.add_member(:video_fill_mode, Shapes::ShapeRef.new(shape: VideoFillMode, location_name: "videoFillMode"))
     GridConfiguration.struct_class = Types::GridConfiguration
 
     InternalServerException.add_member(:exception_message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "exceptionMessage"))
     InternalServerException.struct_class = Types::InternalServerException
 
     LayoutConfiguration.add_member(:grid, Shapes::ShapeRef.new(shape: GridConfiguration, location_name: "grid"))
+    LayoutConfiguration.add_member(:pip, Shapes::ShapeRef.new(shape: PipConfiguration, location_name: "pip"))
     LayoutConfiguration.struct_class = Types::LayoutConfiguration
 
     ListCompositionsRequest.add_member(:filter_by_encoder_configuration_arn, Shapes::ShapeRef.new(shape: EncoderConfigurationArn, location_name: "filterByEncoderConfigurationArn"))
@@ -482,6 +497,18 @@ module Aws::IVSRealTime
     PendingVerification.add_member(:exception_message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "exceptionMessage"))
     PendingVerification.struct_class = Types::PendingVerification
 
+    PipConfiguration.add_member(:featured_participant_attribute, Shapes::ShapeRef.new(shape: AttributeKey, location_name: "featuredParticipantAttribute"))
+    PipConfiguration.add_member(:grid_gap, Shapes::ShapeRef.new(shape: GridGap, location_name: "gridGap"))
+    PipConfiguration.add_member(:omit_stopped_video, Shapes::ShapeRef.new(shape: OmitStoppedVideo, location_name: "omitStoppedVideo"))
+    PipConfiguration.add_member(:pip_behavior, Shapes::ShapeRef.new(shape: PipBehavior, location_name: "pipBehavior"))
+    PipConfiguration.add_member(:pip_height, Shapes::ShapeRef.new(shape: PipHeight, location_name: "pipHeight"))
+    PipConfiguration.add_member(:pip_offset, Shapes::ShapeRef.new(shape: PipOffset, location_name: "pipOffset"))
+    PipConfiguration.add_member(:pip_participant_attribute, Shapes::ShapeRef.new(shape: AttributeKey, location_name: "pipParticipantAttribute"))
+    PipConfiguration.add_member(:pip_position, Shapes::ShapeRef.new(shape: PipPosition, location_name: "pipPosition"))
+    PipConfiguration.add_member(:pip_width, Shapes::ShapeRef.new(shape: PipWidth, location_name: "pipWidth"))
+    PipConfiguration.add_member(:video_fill_mode, Shapes::ShapeRef.new(shape: VideoFillMode, location_name: "videoFillMode"))
+    PipConfiguration.struct_class = Types::PipConfiguration
+
     RecordingConfiguration.add_member(:format, Shapes::ShapeRef.new(shape: RecordingConfigurationFormat, location_name: "format"))
     RecordingConfiguration.struct_class = Types::RecordingConfiguration
 

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

@@ -840,10 +840,34 @@ module Aws::IVSRealTime
     #   ParticipantTokenConfiguration is placed in the featured slot.
     #   @return [String]
     #
+    # @!attribute [rw] grid_gap
+    #   Specifies the spacing between participant tiles in pixels. Default:
+    #   `2`.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] omit_stopped_video
+    #   Determines whether to omit participants with stopped video in the
+    #   composition. Default: `false`.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] video_aspect_ratio
+    #   Sets the non-featured participant display mode. Default: `VIDEO`.
+    #   @return [String]
+    #
+    # @!attribute [rw] video_fill_mode
+    #   Defines how video fits within the participant tile. When not set,
+    #   `videoFillMode` defaults to `COVER` fill mode for participants in
+    #   the grid and to `CONTAIN` fill mode for featured participants.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GridConfiguration AWS API Documentation
     #
     class GridConfiguration < Struct.new(
-      :featured_participant_attribute)
+      :featured_participant_attribute,
+      :grid_gap,
+      :omit_stopped_video,
+      :video_aspect_ratio,
+      :video_fill_mode)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -867,10 +891,15 @@ module Aws::IVSRealTime
     #   Configuration related to grid layout. Default: Grid layout.
     #   @return [Types::GridConfiguration]
     #
+    # @!attribute [rw] pip
+    #   Configuration related to PiP layout.
+    #   @return [Types::PipConfiguration]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/LayoutConfiguration AWS API Documentation
     #
     class LayoutConfiguration < Struct.new(
-      :grid)
+      :grid,
+      :pip)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1449,6 +1478,84 @@ module Aws::IVSRealTime
       include Aws::Structure
     end
 
+    # Configuration information specific to Picture-in-Picture (PiP) layout,
+    # for [server-side composition][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html
+    #
+    # @!attribute [rw] featured_participant_attribute
+    #   This attribute name identifies the featured slot. A participant with
+    #   this attribute set to `"true"` (as a string value) in
+    #   ParticipantTokenConfiguration is placed in the featured slot.
+    #   @return [String]
+    #
+    # @!attribute [rw] grid_gap
+    #   Specifies the spacing between participant tiles in pixels. Default:
+    #   `0`.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] omit_stopped_video
+    #   Determines whether to omit participants with stopped video in the
+    #   composition. Default: `false`.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] pip_behavior
+    #   Defines PiP behavior when all participants have left. Default:
+    #   `STATIC`.
+    #   @return [String]
+    #
+    # @!attribute [rw] pip_height
+    #   Specifies the height of the PiP window in pixels. When this is not
+    #   set explicitly, `pipHeight`’s value will be based on the size of the
+    #   composition and the aspect ratio of the participant’s video.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] pip_offset
+    #   Sets the PiP window’s offset position in pixels from the closest
+    #   edges determined by `PipPosition`. Default: `0`.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] pip_participant_attribute
+    #   Identifies the PiP slot. A participant with this attribute set to
+    #   `"true"` (as a string value) in ParticipantTokenConfiguration is
+    #   placed in the PiP slot.
+    #   @return [String]
+    #
+    # @!attribute [rw] pip_position
+    #   Determines the corner position of the PiP window. Default:
+    #   `BOTTOM_RIGHT`.
+    #   @return [String]
+    #
+    # @!attribute [rw] pip_width
+    #   Specifies the width of the PiP window in pixels. When this is not
+    #   set explicitly, `pipWidth`’s value will be based on the size of the
+    #   composition and the aspect ratio of the participant’s video.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] video_fill_mode
+    #   Defines how video fits within the participant tile. Default:
+    #   `COVER`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/PipConfiguration AWS API Documentation
+    #
+    class PipConfiguration < Struct.new(
+      :featured_participant_attribute,
+      :grid_gap,
+      :omit_stopped_video,
+      :pip_behavior,
+      :pip_height,
+      :pip_offset,
+      :pip_participant_attribute,
+      :pip_position,
+      :pip_width,
+      :video_fill_mode)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # An object representing a configuration to record a stage stream.
     #
     # @!attribute [rw] format

data/lib/aws-sdk-ivsrealtime.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-ivsrealtime/customizations'
 # @!group service
 module Aws::IVSRealTime
 
-  GEM_VERSION = '1.15.0'
+  GEM_VERSION = '1.16.0'
 
 end

data/sig/client.rbs

@@ -368,7 +368,23 @@ module Aws
                                ?idempotency_token: ::String,
                                ?layout: {
                                  grid: {
-                                   featured_participant_attribute: ::String?
+                                   featured_participant_attribute: ::String?,
+                                   grid_gap: ::Integer?,
+                                   omit_stopped_video: bool?,
+                                   video_aspect_ratio: ("AUTO" | "VIDEO" | "SQUARE" | "PORTRAIT")?,
+                                   video_fill_mode: ("FILL" | "COVER" | "CONTAIN")?
+                                 }?,
+                                 pip: {
+                                   featured_participant_attribute: ::String?,
+                                   grid_gap: ::Integer?,
+                                   omit_stopped_video: bool?,
+                                   pip_behavior: ("STATIC" | "DYNAMIC")?,
+                                   pip_height: ::Integer?,
+                                   pip_offset: ::Integer?,
+                                   pip_participant_attribute: ::String?,
+                                   pip_position: ("TOP_LEFT" | "TOP_RIGHT" | "BOTTOM_LEFT" | "BOTTOM_RIGHT")?,
+                                   pip_width: ::Integer?,
+                                   video_fill_mode: ("FILL" | "COVER" | "CONTAIN")?
                                  }?
                                },
                                stage_arn: ::String,

data/sig/types.rbs

@@ -251,6 +251,10 @@ module Aws::IVSRealTime
 
     class GridConfiguration
       attr_accessor featured_participant_attribute: ::String
+      attr_accessor grid_gap: ::Integer
+      attr_accessor omit_stopped_video: bool
+      attr_accessor video_aspect_ratio: ("AUTO" | "VIDEO" | "SQUARE" | "PORTRAIT")
+      attr_accessor video_fill_mode: ("FILL" | "COVER" | "CONTAIN")
       SENSITIVE: []
     end
 
@@ -261,6 +265,7 @@ module Aws::IVSRealTime
 
     class LayoutConfiguration
       attr_accessor grid: Types::GridConfiguration
+      attr_accessor pip: Types::PipConfiguration
       SENSITIVE: []
     end
 
@@ -418,6 +423,20 @@ module Aws::IVSRealTime
       SENSITIVE: []
     end
 
+    class PipConfiguration
+      attr_accessor featured_participant_attribute: ::String
+      attr_accessor grid_gap: ::Integer
+      attr_accessor omit_stopped_video: bool
+      attr_accessor pip_behavior: ("STATIC" | "DYNAMIC")
+      attr_accessor pip_height: ::Integer
+      attr_accessor pip_offset: ::Integer
+      attr_accessor pip_participant_attribute: ::String
+      attr_accessor pip_position: ("TOP_LEFT" | "TOP_RIGHT" | "BOTTOM_LEFT" | "BOTTOM_RIGHT")
+      attr_accessor pip_width: ::Integer
+      attr_accessor video_fill_mode: ("FILL" | "COVER" | "CONTAIN")
+      SENSITIVE: []
+    end
+
     class RecordingConfiguration
       attr_accessor format: ("HLS")
       SENSITIVE: []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-ivsrealtime
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core