Class: Aws::IVSRealTime::Types::GridConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb

Overview

Configuration information specific to Grid layout, for server-side composition. See "Layouts" in Server-Side Composition.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

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. Default: "" (no featured participant).

Returns:

  • (String) 


1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1335

class GridConfiguration < Struct.new(
  :featured_participant_attribute,
  :omit_stopped_video,
  :video_aspect_ratio,
  :video_fill_mode,
  :grid_gap,
  :participant_order_attribute)
  SENSITIVE = []
  include Aws::Structure
end

#grid_gap ⇒ Integer

Specifies the spacing between participant tiles in pixels. Default: 2.

Returns:

  • (Integer) 


1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1335

class GridConfiguration < Struct.new(
  :featured_participant_attribute,
  :omit_stopped_video,
  :video_aspect_ratio,
  :video_fill_mode,
  :grid_gap,
  :participant_order_attribute)
  SENSITIVE = []
  include Aws::Structure
end

#omit_stopped_video ⇒ Boolean

Determines whether to omit participants with stopped video in the composition. Default: false.

Returns:

  • (Boolean) 


1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1335

class GridConfiguration < Struct.new(
  :featured_participant_attribute,
  :omit_stopped_video,
  :video_aspect_ratio,
  :video_fill_mode,
  :grid_gap,
  :participant_order_attribute)
  SENSITIVE = []
  include Aws::Structure
end

#participant_order_attribute ⇒ String

Attribute name in ParticipantTokenConfiguration identifying the participant ordering key. Participants with participantOrderAttribute set to "" or not specified are ordered based on their arrival time into the stage.

Returns:

  • (String) 


1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1335

class GridConfiguration < Struct.new(
  :featured_participant_attribute,
  :omit_stopped_video,
  :video_aspect_ratio,
  :video_fill_mode,
  :grid_gap,
  :participant_order_attribute)
  SENSITIVE = []
  include Aws::Structure
end

#video_aspect_ratio ⇒ String

Sets the non-featured participant display mode, to control the aspect ratio of video tiles. VIDEO is 16:9, SQUARE is 1:1, and PORTRAIT is 3:4. Default: VIDEO.

Returns:

  • (String) 


1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1335

class GridConfiguration < Struct.new(
  :featured_participant_attribute,
  :omit_stopped_video,
  :video_aspect_ratio,
  :video_fill_mode,
  :grid_gap,
  :participant_order_attribute)
  SENSITIVE = []
  include Aws::Structure
end

#video_fill_mode ⇒ String

Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.

Returns:

  • (String) 


1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1335

class GridConfiguration < Struct.new(
  :featured_participant_attribute,
  :omit_stopped_video,
  :video_aspect_ratio,
  :video_fill_mode,
  :grid_gap,
  :participant_order_attribute)
  SENSITIVE = []
  include Aws::Structure
end