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

Inherits:

Struct

• Object
• Struct
• Aws::IVSRealTime::Types::GridConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-ivsrealtime/types.rb

Overview

Configuration information specific to Grid layout, for server-side composition. See “Layouts” in [Server-Side Composition].

[1]: docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #featured_participant_attribute ⇒ String

  This attribute name identifies the featured slot.

• #grid_gap ⇒ Integer

  Specifies the spacing between participant tiles in pixels.

• #omit_stopped_video ⇒ Boolean

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

• #video_aspect_ratio ⇒ String

  Sets the non-featured participant display mode, to control the aspect ratio of video tiles.

• #video_fill_mode ⇒ String

  Defines how video content fits within the participant tile: ‘FILL` (stretched), `COVER` (cropped), or `CONTAIN` (letterboxed).

Instance Attribute Details

#featured_participant_attribute ⇒ String

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)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1145

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

#grid_gap ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1145

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

#omit_stopped_video ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1145

class GridConfiguration < Struct.new(
  :featured_participant_attribute,
  :omit_stopped_video,
  :video_aspect_ratio,
  :video_fill_mode,
  :grid_gap)
  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)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1145

class GridConfiguration < Struct.new(
  :featured_participant_attribute,
  :omit_stopped_video,
  :video_aspect_ratio,
  :video_fill_mode,
  :grid_gap)
  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)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1145

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