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.

Returns:

  • (String) 


865
866
867
868
869
870
871
872
873
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 865

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

#grid_gap ⇒ Integer

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

Returns:

  • (Integer) 


865
866
867
868
869
870
871
872
873
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 865

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

#omit_stopped_video ⇒ Boolean

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

Returns:

  • (Boolean) 


865
866
867
868
869
870
871
872
873
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 865

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

#video_aspect_ratio ⇒ String

Sets the non-featured participant display mode. Default: VIDEO.

Returns:

  • (String) 


865
866
867
868
869
870
871
872
873
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 865

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

#video_fill_mode ⇒ String

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.

Returns:

  • (String) 


865
866
867
868
869
870
871
872
873
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 865

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