aws-sdk-ivsrealtime 1.15.0 → 1.17.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 664ce977c839c2e2da0513734924ecb0d4429c82ab1f6a0516803075bb346c55
4
- data.tar.gz: 3fe9bc32f35eacd510dcc545750651b054b19673d28ad24d02152ec285d34bf8
3
+ metadata.gz: af7c75767d5362f74ed1a6060681fcf40bd5a4d035cfa7d834df6b3b918b1fe7
4
+ data.tar.gz: 84152cbe11557a2c881cea0c64d8f3975ce923c9a5084f883a68fd0c9178c6c3
5
5
  SHA512:
6
- metadata.gz: 9dead615f492883e856b8e9b446117e248668cb745aead3e13250d48ec386df60da3f168c645f4fe85dece2072178a106a871c578d1a69b4fcf258d21fd0a010
7
- data.tar.gz: a9b12054082cb71a8b074eea38e2fbe22c12807d3b21083a9b5b8297c4b632e6af23488a4e3039cff7ab57e9acdc665d228a608a1407dbedaa8bd124d808ec12
6
+ metadata.gz: a6d7525146fcb8a03d69d05d62db2b764532fe994efbb74bdeb871d2e57ab9b881d7935adabefb6b90156c0336e15d525ddef238b207f0cedfbef9a181b528a0
7
+ data.tar.gz: 1bb43b967f0a537a11b4ad26a355c4d6a8cd02f0f6a83d70203e5c62278d1f9a808ff457071b2192dab68ff50b50f2b0132826bee932ab9daac8ac605832d160
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.17.0 (2024-04-25)
5
+ ------------------
6
+
7
+ * Feature - Bug Fix: IVS Real Time does not support ARNs using the `svs` prefix.
8
+
9
+ 1.16.0 (2024-03-13)
10
+ ------------------
11
+
12
+ * Feature - adds support for multiple new composition layout configuration options (grid, pip)
13
+
4
14
  1.15.0 (2024-01-26)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.15.0
1
+ 1.17.0
@@ -22,6 +22,7 @@ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
22
  require 'aws-sdk-core/plugins/response_paging.rb'
23
23
  require 'aws-sdk-core/plugins/stub_responses.rb'
24
24
  require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/invocation_id.rb'
25
26
  require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
27
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
28
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
@@ -72,6 +73,7 @@ module Aws::IVSRealTime
72
73
  add_plugin(Aws::Plugins::ResponsePaging)
73
74
  add_plugin(Aws::Plugins::StubResponses)
74
75
  add_plugin(Aws::Plugins::IdempotencyToken)
76
+ add_plugin(Aws::Plugins::InvocationId)
75
77
  add_plugin(Aws::Plugins::JsonvalueConverter)
76
78
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
77
79
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
@@ -196,10 +198,17 @@ module Aws::IVSRealTime
196
198
  # When set to 'true' the request body will not be compressed
197
199
  # for supported operations.
198
200
  #
199
- # @option options [String] :endpoint
200
- # The client endpoint is normally constructed from the `:region`
201
- # option. You should only configure an `:endpoint` when connecting
202
- # to test or custom endpoints. This should be a valid HTTP(S) URI.
201
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
202
+ # Normally you should not configure the `:endpoint` option
203
+ # directly. This is normally constructed from the `:region`
204
+ # option. Configuring `:endpoint` is normally reserved for
205
+ # connecting to test or custom endpoints. The endpoint should
206
+ # be a URI formatted like:
207
+ #
208
+ # 'http://example.com'
209
+ # 'https://example.com'
210
+ # 'http://example.com:123'
211
+ #
203
212
  #
204
213
  # @option options [Integer] :endpoint_cache_max_entries (1000)
205
214
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -337,50 +346,65 @@ module Aws::IVSRealTime
337
346
  # @option options [Aws::IVSRealTime::EndpointProvider] :endpoint_provider
338
347
  # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::IVSRealTime::EndpointParameters`
339
348
  #
340
- # @option options [URI::HTTP,String] :http_proxy A proxy to send
341
- # requests through. Formatted like 'http://proxy.com:123'.
342
- #
343
- # @option options [Float] :http_open_timeout (15) The number of
344
- # seconds to wait when opening a HTTP session before raising a
345
- # `Timeout::Error`.
346
- #
347
- # @option options [Float] :http_read_timeout (60) The default
348
- # number of seconds to wait for response data. This value can
349
- # safely be set per-request on the session.
350
- #
351
- # @option options [Float] :http_idle_timeout (5) The number of
352
- # seconds a connection is allowed to sit idle before it is
353
- # considered stale. Stale connections are closed and removed
354
- # from the pool before making a request.
355
- #
356
- # @option options [Float] :http_continue_timeout (1) The number of
357
- # seconds to wait for a 100-continue response before sending the
358
- # request body. This option has no effect unless the request has
359
- # "Expect" header set to "100-continue". Defaults to `nil` which
360
- # disables this behaviour. This value can safely be set per
361
- # request on the session.
362
- #
363
- # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
364
- # in seconds.
365
- #
366
- # @option options [Boolean] :http_wire_trace (false) When `true`,
367
- # HTTP debug output will be sent to the `:logger`.
349
+ # @option options [Float] :http_continue_timeout (1)
350
+ # The number of seconds to wait for a 100-continue response before sending the
351
+ # request body. This option has no effect unless the request has "Expect"
352
+ # header set to "100-continue". Defaults to `nil` which disables this
353
+ # behaviour. This value can safely be set per request on the session.
354
+ #
355
+ # @option options [Float] :http_idle_timeout (5)
356
+ # The number of seconds a connection is allowed to sit idle before it
357
+ # is considered stale. Stale connections are closed and removed from the
358
+ # pool before making a request.
359
+ #
360
+ # @option options [Float] :http_open_timeout (15)
361
+ # The default number of seconds to wait for response data.
362
+ # This value can safely be set per-request on the session.
363
+ #
364
+ # @option options [URI::HTTP,String] :http_proxy
365
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
366
+ #
367
+ # @option options [Float] :http_read_timeout (60)
368
+ # The default number of seconds to wait for response data.
369
+ # This value can safely be set per-request on the session.
370
+ #
371
+ # @option options [Boolean] :http_wire_trace (false)
372
+ # When `true`, HTTP debug output will be sent to the `:logger`.
373
+ #
374
+ # @option options [Proc] :on_chunk_received
375
+ # When a Proc object is provided, it will be used as callback when each chunk
376
+ # of the response body is received. It provides three arguments: the chunk,
377
+ # the number of bytes received, and the total number of
378
+ # bytes in the response (or nil if the server did not send a `content-length`).
379
+ #
380
+ # @option options [Proc] :on_chunk_sent
381
+ # When a Proc object is provided, it will be used as callback when each chunk
382
+ # of the request body is sent. It provides three arguments: the chunk,
383
+ # the number of bytes read from the body, and the total number of
384
+ # bytes in the body.
385
+ #
386
+ # @option options [Boolean] :raise_response_errors (true)
387
+ # When `true`, response errors are raised.
388
+ #
389
+ # @option options [String] :ssl_ca_bundle
390
+ # Full path to the SSL certificate authority bundle file that should be used when
391
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
392
+ # `:ssl_ca_directory` the the system default will be used if available.
393
+ #
394
+ # @option options [String] :ssl_ca_directory
395
+ # Full path of the directory that contains the unbundled SSL certificate
396
+ # authority files for verifying peer certificates. If you do
397
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
398
+ # default will be used if available.
368
399
  #
369
- # @option options [Boolean] :ssl_verify_peer (true) When `true`,
370
- # SSL peer certificates are verified when establishing a
371
- # connection.
400
+ # @option options [String] :ssl_ca_store
401
+ # Sets the X509::Store to verify peer certificate.
372
402
  #
373
- # @option options [String] :ssl_ca_bundle Full path to the SSL
374
- # certificate authority bundle file that should be used when
375
- # verifying peer certificates. If you do not pass
376
- # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
377
- # will be used if available.
403
+ # @option options [Float] :ssl_timeout
404
+ # Sets the SSL timeout in seconds
378
405
  #
379
- # @option options [String] :ssl_ca_directory Full path of the
380
- # directory that contains the unbundled SSL certificate
381
- # authority files for verifying peer certificates. If you do
382
- # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
383
- # system default will be used if available.
406
+ # @option options [Boolean] :ssl_verify_peer (true)
407
+ # When `true`, SSL peer certificates are verified when establishing a connection.
384
408
  #
385
409
  def initialize(*args)
386
410
  super
@@ -781,6 +805,20 @@ module Aws::IVSRealTime
781
805
  # resp.composition.destinations[0].state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "RECONNECTING", "FAILED", "STOPPED"
782
806
  # resp.composition.end_time #=> Time
783
807
  # resp.composition.layout.grid.featured_participant_attribute #=> String
808
+ # resp.composition.layout.grid.grid_gap #=> Integer
809
+ # resp.composition.layout.grid.omit_stopped_video #=> Boolean
810
+ # resp.composition.layout.grid.video_aspect_ratio #=> String, one of "AUTO", "VIDEO", "SQUARE", "PORTRAIT"
811
+ # resp.composition.layout.grid.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
812
+ # resp.composition.layout.pip.featured_participant_attribute #=> String
813
+ # resp.composition.layout.pip.grid_gap #=> Integer
814
+ # resp.composition.layout.pip.omit_stopped_video #=> Boolean
815
+ # resp.composition.layout.pip.pip_behavior #=> String, one of "STATIC", "DYNAMIC"
816
+ # resp.composition.layout.pip.pip_height #=> Integer
817
+ # resp.composition.layout.pip.pip_offset #=> Integer
818
+ # resp.composition.layout.pip.pip_participant_attribute #=> String
819
+ # resp.composition.layout.pip.pip_position #=> String, one of "TOP_LEFT", "TOP_RIGHT", "BOTTOM_LEFT", "BOTTOM_RIGHT"
820
+ # resp.composition.layout.pip.pip_width #=> Integer
821
+ # resp.composition.layout.pip.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
784
822
  # resp.composition.stage_arn #=> String
785
823
  # resp.composition.start_time #=> Time
786
824
  # resp.composition.state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "FAILED", "STOPPED"
@@ -1438,6 +1476,22 @@ module Aws::IVSRealTime
1438
1476
  # layout: {
1439
1477
  # grid: {
1440
1478
  # featured_participant_attribute: "AttributeKey",
1479
+ # grid_gap: 1,
1480
+ # omit_stopped_video: false,
1481
+ # video_aspect_ratio: "AUTO", # accepts AUTO, VIDEO, SQUARE, PORTRAIT
1482
+ # video_fill_mode: "FILL", # accepts FILL, COVER, CONTAIN
1483
+ # },
1484
+ # pip: {
1485
+ # featured_participant_attribute: "AttributeKey",
1486
+ # grid_gap: 1,
1487
+ # omit_stopped_video: false,
1488
+ # pip_behavior: "STATIC", # accepts STATIC, DYNAMIC
1489
+ # pip_height: 1,
1490
+ # pip_offset: 1,
1491
+ # pip_participant_attribute: "AttributeKey",
1492
+ # pip_position: "TOP_LEFT", # accepts TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT
1493
+ # pip_width: 1,
1494
+ # video_fill_mode: "FILL", # accepts FILL, COVER, CONTAIN
1441
1495
  # },
1442
1496
  # },
1443
1497
  # stage_arn: "StageArn", # required
@@ -1464,6 +1518,20 @@ module Aws::IVSRealTime
1464
1518
  # resp.composition.destinations[0].state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "RECONNECTING", "FAILED", "STOPPED"
1465
1519
  # resp.composition.end_time #=> Time
1466
1520
  # resp.composition.layout.grid.featured_participant_attribute #=> String
1521
+ # resp.composition.layout.grid.grid_gap #=> Integer
1522
+ # resp.composition.layout.grid.omit_stopped_video #=> Boolean
1523
+ # resp.composition.layout.grid.video_aspect_ratio #=> String, one of "AUTO", "VIDEO", "SQUARE", "PORTRAIT"
1524
+ # resp.composition.layout.grid.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
1525
+ # resp.composition.layout.pip.featured_participant_attribute #=> String
1526
+ # resp.composition.layout.pip.grid_gap #=> Integer
1527
+ # resp.composition.layout.pip.omit_stopped_video #=> Boolean
1528
+ # resp.composition.layout.pip.pip_behavior #=> String, one of "STATIC", "DYNAMIC"
1529
+ # resp.composition.layout.pip.pip_height #=> Integer
1530
+ # resp.composition.layout.pip.pip_offset #=> Integer
1531
+ # resp.composition.layout.pip.pip_participant_attribute #=> String
1532
+ # resp.composition.layout.pip.pip_position #=> String, one of "TOP_LEFT", "TOP_RIGHT", "BOTTOM_LEFT", "BOTTOM_RIGHT"
1533
+ # resp.composition.layout.pip.pip_width #=> Integer
1534
+ # resp.composition.layout.pip.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
1467
1535
  # resp.composition.stage_arn #=> String
1468
1536
  # resp.composition.start_time #=> Time
1469
1537
  # resp.composition.state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "FAILED", "STOPPED"
@@ -1621,7 +1689,7 @@ module Aws::IVSRealTime
1621
1689
  params: params,
1622
1690
  config: config)
1623
1691
  context[:gem_name] = 'aws-sdk-ivsrealtime'
1624
- context[:gem_version] = '1.15.0'
1692
+ context[:gem_version] = '1.17.0'
1625
1693
  Seahorse::Client::Request.new(handlers, context)
1626
1694
  end
1627
1695
 
@@ -75,6 +75,7 @@ module Aws::IVSRealTime
75
75
  GetStorageConfigurationRequest = Shapes::StructureShape.new(name: 'GetStorageConfigurationRequest')
76
76
  GetStorageConfigurationResponse = Shapes::StructureShape.new(name: 'GetStorageConfigurationResponse')
77
77
  GridConfiguration = Shapes::StructureShape.new(name: 'GridConfiguration')
78
+ GridGap = Shapes::IntegerShape.new(name: 'GridGap')
78
79
  Height = Shapes::IntegerShape.new(name: 'Height')
79
80
  InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
80
81
  LayoutConfiguration = Shapes::StructureShape.new(name: 'LayoutConfiguration')
@@ -101,6 +102,7 @@ module Aws::IVSRealTime
101
102
  MaxStageResults = Shapes::IntegerShape.new(name: 'MaxStageResults')
102
103
  MaxStageSessionResults = Shapes::IntegerShape.new(name: 'MaxStageSessionResults')
103
104
  MaxStorageConfigurationResults = Shapes::IntegerShape.new(name: 'MaxStorageConfigurationResults')
105
+ OmitStoppedVideo = Shapes::BooleanShape.new(name: 'OmitStoppedVideo')
104
106
  PaginationToken = Shapes::StringShape.new(name: 'PaginationToken')
105
107
  Participant = Shapes::StructureShape.new(name: 'Participant')
106
108
  ParticipantAttributes = Shapes::MapShape.new(name: 'ParticipantAttributes')
@@ -122,6 +124,12 @@ module Aws::IVSRealTime
122
124
  ParticipantTokenString = Shapes::StringShape.new(name: 'ParticipantTokenString')
123
125
  ParticipantTokenUserId = Shapes::StringShape.new(name: 'ParticipantTokenUserId')
124
126
  PendingVerification = Shapes::StructureShape.new(name: 'PendingVerification')
127
+ PipBehavior = Shapes::StringShape.new(name: 'PipBehavior')
128
+ PipConfiguration = Shapes::StructureShape.new(name: 'PipConfiguration')
129
+ PipHeight = Shapes::IntegerShape.new(name: 'PipHeight')
130
+ PipOffset = Shapes::IntegerShape.new(name: 'PipOffset')
131
+ PipPosition = Shapes::StringShape.new(name: 'PipPosition')
132
+ PipWidth = Shapes::IntegerShape.new(name: 'PipWidth')
125
133
  Published = Shapes::BooleanShape.new(name: 'Published')
126
134
  RecordingConfiguration = Shapes::StructureShape.new(name: 'RecordingConfiguration')
127
135
  RecordingConfigurationFormat = Shapes::StringShape.new(name: 'RecordingConfigurationFormat')
@@ -165,6 +173,8 @@ module Aws::IVSRealTime
165
173
  UserId = Shapes::StringShape.new(name: 'UserId')
166
174
  ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
167
175
  Video = Shapes::StructureShape.new(name: 'Video')
176
+ VideoAspectRatio = Shapes::StringShape.new(name: 'VideoAspectRatio')
177
+ VideoFillMode = Shapes::StringShape.new(name: 'VideoFillMode')
168
178
  Width = Shapes::IntegerShape.new(name: 'Width')
169
179
  errorMessage = Shapes::StringShape.new(name: 'errorMessage')
170
180
 
@@ -348,12 +358,17 @@ module Aws::IVSRealTime
348
358
  GetStorageConfigurationResponse.struct_class = Types::GetStorageConfigurationResponse
349
359
 
350
360
  GridConfiguration.add_member(:featured_participant_attribute, Shapes::ShapeRef.new(shape: AttributeKey, location_name: "featuredParticipantAttribute"))
361
+ GridConfiguration.add_member(:grid_gap, Shapes::ShapeRef.new(shape: GridGap, location_name: "gridGap"))
362
+ GridConfiguration.add_member(:omit_stopped_video, Shapes::ShapeRef.new(shape: OmitStoppedVideo, location_name: "omitStoppedVideo"))
363
+ GridConfiguration.add_member(:video_aspect_ratio, Shapes::ShapeRef.new(shape: VideoAspectRatio, location_name: "videoAspectRatio"))
364
+ GridConfiguration.add_member(:video_fill_mode, Shapes::ShapeRef.new(shape: VideoFillMode, location_name: "videoFillMode"))
351
365
  GridConfiguration.struct_class = Types::GridConfiguration
352
366
 
353
367
  InternalServerException.add_member(:exception_message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "exceptionMessage"))
354
368
  InternalServerException.struct_class = Types::InternalServerException
355
369
 
356
370
  LayoutConfiguration.add_member(:grid, Shapes::ShapeRef.new(shape: GridConfiguration, location_name: "grid"))
371
+ LayoutConfiguration.add_member(:pip, Shapes::ShapeRef.new(shape: PipConfiguration, location_name: "pip"))
357
372
  LayoutConfiguration.struct_class = Types::LayoutConfiguration
358
373
 
359
374
  ListCompositionsRequest.add_member(:filter_by_encoder_configuration_arn, Shapes::ShapeRef.new(shape: EncoderConfigurationArn, location_name: "filterByEncoderConfigurationArn"))
@@ -482,6 +497,18 @@ module Aws::IVSRealTime
482
497
  PendingVerification.add_member(:exception_message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "exceptionMessage"))
483
498
  PendingVerification.struct_class = Types::PendingVerification
484
499
 
500
+ PipConfiguration.add_member(:featured_participant_attribute, Shapes::ShapeRef.new(shape: AttributeKey, location_name: "featuredParticipantAttribute"))
501
+ PipConfiguration.add_member(:grid_gap, Shapes::ShapeRef.new(shape: GridGap, location_name: "gridGap"))
502
+ PipConfiguration.add_member(:omit_stopped_video, Shapes::ShapeRef.new(shape: OmitStoppedVideo, location_name: "omitStoppedVideo"))
503
+ PipConfiguration.add_member(:pip_behavior, Shapes::ShapeRef.new(shape: PipBehavior, location_name: "pipBehavior"))
504
+ PipConfiguration.add_member(:pip_height, Shapes::ShapeRef.new(shape: PipHeight, location_name: "pipHeight"))
505
+ PipConfiguration.add_member(:pip_offset, Shapes::ShapeRef.new(shape: PipOffset, location_name: "pipOffset"))
506
+ PipConfiguration.add_member(:pip_participant_attribute, Shapes::ShapeRef.new(shape: AttributeKey, location_name: "pipParticipantAttribute"))
507
+ PipConfiguration.add_member(:pip_position, Shapes::ShapeRef.new(shape: PipPosition, location_name: "pipPosition"))
508
+ PipConfiguration.add_member(:pip_width, Shapes::ShapeRef.new(shape: PipWidth, location_name: "pipWidth"))
509
+ PipConfiguration.add_member(:video_fill_mode, Shapes::ShapeRef.new(shape: VideoFillMode, location_name: "videoFillMode"))
510
+ PipConfiguration.struct_class = Types::PipConfiguration
511
+
485
512
  RecordingConfiguration.add_member(:format, Shapes::ShapeRef.new(shape: RecordingConfigurationFormat, location_name: "format"))
486
513
  RecordingConfiguration.struct_class = Types::RecordingConfiguration
487
514
 
@@ -986,6 +1013,7 @@ module Aws::IVSRealTime
986
1013
  o.errors << Shapes::ShapeRef.new(shape: ValidationException)
987
1014
  o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
988
1015
  o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
1016
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
989
1017
  o.errors << Shapes::ShapeRef.new(shape: PendingVerification)
990
1018
  end)
991
1019
  end
@@ -840,10 +840,34 @@ module Aws::IVSRealTime
840
840
  # ParticipantTokenConfiguration is placed in the featured slot.
841
841
  # @return [String]
842
842
  #
843
+ # @!attribute [rw] grid_gap
844
+ # Specifies the spacing between participant tiles in pixels. Default:
845
+ # `2`.
846
+ # @return [Integer]
847
+ #
848
+ # @!attribute [rw] omit_stopped_video
849
+ # Determines whether to omit participants with stopped video in the
850
+ # composition. Default: `false`.
851
+ # @return [Boolean]
852
+ #
853
+ # @!attribute [rw] video_aspect_ratio
854
+ # Sets the non-featured participant display mode. Default: `VIDEO`.
855
+ # @return [String]
856
+ #
857
+ # @!attribute [rw] video_fill_mode
858
+ # Defines how video fits within the participant tile. When not set,
859
+ # `videoFillMode` defaults to `COVER` fill mode for participants in
860
+ # the grid and to `CONTAIN` fill mode for featured participants.
861
+ # @return [String]
862
+ #
843
863
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GridConfiguration AWS API Documentation
844
864
  #
845
865
  class GridConfiguration < Struct.new(
846
- :featured_participant_attribute)
866
+ :featured_participant_attribute,
867
+ :grid_gap,
868
+ :omit_stopped_video,
869
+ :video_aspect_ratio,
870
+ :video_fill_mode)
847
871
  SENSITIVE = []
848
872
  include Aws::Structure
849
873
  end
@@ -867,10 +891,15 @@ module Aws::IVSRealTime
867
891
  # Configuration related to grid layout. Default: Grid layout.
868
892
  # @return [Types::GridConfiguration]
869
893
  #
894
+ # @!attribute [rw] pip
895
+ # Configuration related to PiP layout.
896
+ # @return [Types::PipConfiguration]
897
+ #
870
898
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/LayoutConfiguration AWS API Documentation
871
899
  #
872
900
  class LayoutConfiguration < Struct.new(
873
- :grid)
901
+ :grid,
902
+ :pip)
874
903
  SENSITIVE = []
875
904
  include Aws::Structure
876
905
  end
@@ -1449,6 +1478,84 @@ module Aws::IVSRealTime
1449
1478
  include Aws::Structure
1450
1479
  end
1451
1480
 
1481
+ # Configuration information specific to Picture-in-Picture (PiP) layout,
1482
+ # for [server-side composition][1].
1483
+ #
1484
+ #
1485
+ #
1486
+ # [1]: https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html
1487
+ #
1488
+ # @!attribute [rw] featured_participant_attribute
1489
+ # This attribute name identifies the featured slot. A participant with
1490
+ # this attribute set to `"true"` (as a string value) in
1491
+ # ParticipantTokenConfiguration is placed in the featured slot.
1492
+ # @return [String]
1493
+ #
1494
+ # @!attribute [rw] grid_gap
1495
+ # Specifies the spacing between participant tiles in pixels. Default:
1496
+ # `0`.
1497
+ # @return [Integer]
1498
+ #
1499
+ # @!attribute [rw] omit_stopped_video
1500
+ # Determines whether to omit participants with stopped video in the
1501
+ # composition. Default: `false`.
1502
+ # @return [Boolean]
1503
+ #
1504
+ # @!attribute [rw] pip_behavior
1505
+ # Defines PiP behavior when all participants have left. Default:
1506
+ # `STATIC`.
1507
+ # @return [String]
1508
+ #
1509
+ # @!attribute [rw] pip_height
1510
+ # Specifies the height of the PiP window in pixels. When this is not
1511
+ # set explicitly, `pipHeight`’s value will be based on the size of the
1512
+ # composition and the aspect ratio of the participant’s video.
1513
+ # @return [Integer]
1514
+ #
1515
+ # @!attribute [rw] pip_offset
1516
+ # Sets the PiP window’s offset position in pixels from the closest
1517
+ # edges determined by `PipPosition`. Default: `0`.
1518
+ # @return [Integer]
1519
+ #
1520
+ # @!attribute [rw] pip_participant_attribute
1521
+ # Identifies the PiP slot. A participant with this attribute set to
1522
+ # `"true"` (as a string value) in ParticipantTokenConfiguration is
1523
+ # placed in the PiP slot.
1524
+ # @return [String]
1525
+ #
1526
+ # @!attribute [rw] pip_position
1527
+ # Determines the corner position of the PiP window. Default:
1528
+ # `BOTTOM_RIGHT`.
1529
+ # @return [String]
1530
+ #
1531
+ # @!attribute [rw] pip_width
1532
+ # Specifies the width of the PiP window in pixels. When this is not
1533
+ # set explicitly, `pipWidth`’s value will be based on the size of the
1534
+ # composition and the aspect ratio of the participant’s video.
1535
+ # @return [Integer]
1536
+ #
1537
+ # @!attribute [rw] video_fill_mode
1538
+ # Defines how video fits within the participant tile. Default:
1539
+ # `COVER`.
1540
+ # @return [String]
1541
+ #
1542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/PipConfiguration AWS API Documentation
1543
+ #
1544
+ class PipConfiguration < Struct.new(
1545
+ :featured_participant_attribute,
1546
+ :grid_gap,
1547
+ :omit_stopped_video,
1548
+ :pip_behavior,
1549
+ :pip_height,
1550
+ :pip_offset,
1551
+ :pip_participant_attribute,
1552
+ :pip_position,
1553
+ :pip_width,
1554
+ :video_fill_mode)
1555
+ SENSITIVE = []
1556
+ include Aws::Structure
1557
+ end
1558
+
1452
1559
  # An object representing a configuration to record a stage stream.
1453
1560
  #
1454
1561
  # @!attribute [rw] format
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-ivsrealtime/customizations'
52
52
  # @!group service
53
53
  module Aws::IVSRealTime
54
54
 
55
- GEM_VERSION = '1.15.0'
55
+ GEM_VERSION = '1.17.0'
56
56
 
57
57
  end
data/sig/client.rbs CHANGED
@@ -368,7 +368,23 @@ module Aws
368
368
  ?idempotency_token: ::String,
369
369
  ?layout: {
370
370
  grid: {
371
- featured_participant_attribute: ::String?
371
+ featured_participant_attribute: ::String?,
372
+ grid_gap: ::Integer?,
373
+ omit_stopped_video: bool?,
374
+ video_aspect_ratio: ("AUTO" | "VIDEO" | "SQUARE" | "PORTRAIT")?,
375
+ video_fill_mode: ("FILL" | "COVER" | "CONTAIN")?
376
+ }?,
377
+ pip: {
378
+ featured_participant_attribute: ::String?,
379
+ grid_gap: ::Integer?,
380
+ omit_stopped_video: bool?,
381
+ pip_behavior: ("STATIC" | "DYNAMIC")?,
382
+ pip_height: ::Integer?,
383
+ pip_offset: ::Integer?,
384
+ pip_participant_attribute: ::String?,
385
+ pip_position: ("TOP_LEFT" | "TOP_RIGHT" | "BOTTOM_LEFT" | "BOTTOM_RIGHT")?,
386
+ pip_width: ::Integer?,
387
+ video_fill_mode: ("FILL" | "COVER" | "CONTAIN")?
372
388
  }?
373
389
  },
374
390
  stage_arn: ::String,
data/sig/types.rbs CHANGED
@@ -251,6 +251,10 @@ module Aws::IVSRealTime
251
251
 
252
252
  class GridConfiguration
253
253
  attr_accessor featured_participant_attribute: ::String
254
+ attr_accessor grid_gap: ::Integer
255
+ attr_accessor omit_stopped_video: bool
256
+ attr_accessor video_aspect_ratio: ("AUTO" | "VIDEO" | "SQUARE" | "PORTRAIT")
257
+ attr_accessor video_fill_mode: ("FILL" | "COVER" | "CONTAIN")
254
258
  SENSITIVE: []
255
259
  end
256
260
 
@@ -261,6 +265,7 @@ module Aws::IVSRealTime
261
265
 
262
266
  class LayoutConfiguration
263
267
  attr_accessor grid: Types::GridConfiguration
268
+ attr_accessor pip: Types::PipConfiguration
264
269
  SENSITIVE: []
265
270
  end
266
271
 
@@ -418,6 +423,20 @@ module Aws::IVSRealTime
418
423
  SENSITIVE: []
419
424
  end
420
425
 
426
+ class PipConfiguration
427
+ attr_accessor featured_participant_attribute: ::String
428
+ attr_accessor grid_gap: ::Integer
429
+ attr_accessor omit_stopped_video: bool
430
+ attr_accessor pip_behavior: ("STATIC" | "DYNAMIC")
431
+ attr_accessor pip_height: ::Integer
432
+ attr_accessor pip_offset: ::Integer
433
+ attr_accessor pip_participant_attribute: ::String
434
+ attr_accessor pip_position: ("TOP_LEFT" | "TOP_RIGHT" | "BOTTOM_LEFT" | "BOTTOM_RIGHT")
435
+ attr_accessor pip_width: ::Integer
436
+ attr_accessor video_fill_mode: ("FILL" | "COVER" | "CONTAIN")
437
+ SENSITIVE: []
438
+ end
439
+
421
440
  class RecordingConfiguration
422
441
  attr_accessor format: ("HLS")
423
442
  SENSITIVE: []
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-ivsrealtime
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.15.0
4
+ version: 1.17.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-01-26 00:00:00.000000000 Z
11
+ date: 2024-04-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.191.0
22
+ version: 3.193.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.191.0
32
+ version: 3.193.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement