aws-sdk-ivsrealtime 1.14.0 → 1.16.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: eccc2b27c429b467f0aa0c6d33ab33ea2847d26383d74605247d046e16d885c0
4
- data.tar.gz: e6c76fe3624a0c9011a3364ed2958f72daed41205d785c776bdc63aed9399bc4
3
+ metadata.gz: a87479caa5c86bde268e2fc9c6dec5b4946d337e274364418842bc5ad6c8b8a2
4
+ data.tar.gz: 17425ef09a60118266937ee22c08e4cd9ce5cbfb26e5965439dc42d0bc5cfcb3
5
5
  SHA512:
6
- metadata.gz: 4ecba67e682c8b2929801312e51f799e0c3a64877a50facae8fa28336a898948748a445d48f13504d87d605566a665bb1cb4e53a2d7841047142ed60f552db5f
7
- data.tar.gz: 82bf096faf01c1629ef29a4f4bf117cea53142d5bf6eb317682aeebedf903159229f67c58a2edfe043e04bdae70d06ff5a98589c3cf1b806c7c68f3ac4c35ac1
6
+ metadata.gz: 75603d8d97a9ac481f935f173158cb950c643d68f29704f8e34da4dcb0feb3c8a843abda10dcb0ff475e14fe8dcc1f9d4413db34480ed0dd3bdf70f3f88c06cb
7
+ data.tar.gz: ff3b0d543525cdb3daea0011d143e75b53de43042abe02d731bd49213bd011d485aa25d8f290cf1f9fa7b28c24ce00e896f20d122e2354e0e205a33a07f03094
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.16.0 (2024-03-13)
5
+ ------------------
6
+
7
+ * Feature - adds support for multiple new composition layout configuration options (grid, pip)
8
+
9
+ 1.15.0 (2024-01-26)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
4
14
  1.14.0 (2023-11-28)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.14.0
1
+ 1.16.0
@@ -781,6 +781,20 @@ module Aws::IVSRealTime
781
781
  # resp.composition.destinations[0].state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "RECONNECTING", "FAILED", "STOPPED"
782
782
  # resp.composition.end_time #=> Time
783
783
  # resp.composition.layout.grid.featured_participant_attribute #=> String
784
+ # resp.composition.layout.grid.grid_gap #=> Integer
785
+ # resp.composition.layout.grid.omit_stopped_video #=> Boolean
786
+ # resp.composition.layout.grid.video_aspect_ratio #=> String, one of "AUTO", "VIDEO", "SQUARE", "PORTRAIT"
787
+ # resp.composition.layout.grid.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
788
+ # resp.composition.layout.pip.featured_participant_attribute #=> String
789
+ # resp.composition.layout.pip.grid_gap #=> Integer
790
+ # resp.composition.layout.pip.omit_stopped_video #=> Boolean
791
+ # resp.composition.layout.pip.pip_behavior #=> String, one of "STATIC", "DYNAMIC"
792
+ # resp.composition.layout.pip.pip_height #=> Integer
793
+ # resp.composition.layout.pip.pip_offset #=> Integer
794
+ # resp.composition.layout.pip.pip_participant_attribute #=> String
795
+ # resp.composition.layout.pip.pip_position #=> String, one of "TOP_LEFT", "TOP_RIGHT", "BOTTOM_LEFT", "BOTTOM_RIGHT"
796
+ # resp.composition.layout.pip.pip_width #=> Integer
797
+ # resp.composition.layout.pip.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
784
798
  # resp.composition.stage_arn #=> String
785
799
  # resp.composition.start_time #=> Time
786
800
  # resp.composition.state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "FAILED", "STOPPED"
@@ -1438,6 +1452,22 @@ module Aws::IVSRealTime
1438
1452
  # layout: {
1439
1453
  # grid: {
1440
1454
  # featured_participant_attribute: "AttributeKey",
1455
+ # grid_gap: 1,
1456
+ # omit_stopped_video: false,
1457
+ # video_aspect_ratio: "AUTO", # accepts AUTO, VIDEO, SQUARE, PORTRAIT
1458
+ # video_fill_mode: "FILL", # accepts FILL, COVER, CONTAIN
1459
+ # },
1460
+ # pip: {
1461
+ # featured_participant_attribute: "AttributeKey",
1462
+ # grid_gap: 1,
1463
+ # omit_stopped_video: false,
1464
+ # pip_behavior: "STATIC", # accepts STATIC, DYNAMIC
1465
+ # pip_height: 1,
1466
+ # pip_offset: 1,
1467
+ # pip_participant_attribute: "AttributeKey",
1468
+ # pip_position: "TOP_LEFT", # accepts TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT
1469
+ # pip_width: 1,
1470
+ # video_fill_mode: "FILL", # accepts FILL, COVER, CONTAIN
1441
1471
  # },
1442
1472
  # },
1443
1473
  # stage_arn: "StageArn", # required
@@ -1464,6 +1494,20 @@ module Aws::IVSRealTime
1464
1494
  # resp.composition.destinations[0].state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "RECONNECTING", "FAILED", "STOPPED"
1465
1495
  # resp.composition.end_time #=> Time
1466
1496
  # resp.composition.layout.grid.featured_participant_attribute #=> String
1497
+ # resp.composition.layout.grid.grid_gap #=> Integer
1498
+ # resp.composition.layout.grid.omit_stopped_video #=> Boolean
1499
+ # resp.composition.layout.grid.video_aspect_ratio #=> String, one of "AUTO", "VIDEO", "SQUARE", "PORTRAIT"
1500
+ # resp.composition.layout.grid.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
1501
+ # resp.composition.layout.pip.featured_participant_attribute #=> String
1502
+ # resp.composition.layout.pip.grid_gap #=> Integer
1503
+ # resp.composition.layout.pip.omit_stopped_video #=> Boolean
1504
+ # resp.composition.layout.pip.pip_behavior #=> String, one of "STATIC", "DYNAMIC"
1505
+ # resp.composition.layout.pip.pip_height #=> Integer
1506
+ # resp.composition.layout.pip.pip_offset #=> Integer
1507
+ # resp.composition.layout.pip.pip_participant_attribute #=> String
1508
+ # resp.composition.layout.pip.pip_position #=> String, one of "TOP_LEFT", "TOP_RIGHT", "BOTTOM_LEFT", "BOTTOM_RIGHT"
1509
+ # resp.composition.layout.pip.pip_width #=> Integer
1510
+ # resp.composition.layout.pip.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
1467
1511
  # resp.composition.stage_arn #=> String
1468
1512
  # resp.composition.start_time #=> Time
1469
1513
  # resp.composition.state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "FAILED", "STOPPED"
@@ -1621,7 +1665,7 @@ module Aws::IVSRealTime
1621
1665
  params: params,
1622
1666
  config: config)
1623
1667
  context[:gem_name] = 'aws-sdk-ivsrealtime'
1624
- context[:gem_version] = '1.14.0'
1668
+ context[:gem_version] = '1.16.0'
1625
1669
  Seahorse::Client::Request.new(handlers, context)
1626
1670
  end
1627
1671
 
@@ -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
 
@@ -14,6 +14,7 @@ module Aws::IVSRealTime
14
14
  option(
15
15
  :endpoint_provider,
16
16
  doc_type: 'Aws::IVSRealTime::EndpointProvider',
17
+ rbs_type: 'untyped',
17
18
  docstring: 'The endpoint provider used to resolve endpoints. Any '\
18
19
  'object that responds to `#resolve_endpoint(parameters)` '\
19
20
  'where `parameters` is a Struct similar to '\
@@ -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.14.0'
55
+ GEM_VERSION = '1.16.0'
56
56
 
57
57
  end