Class: Aws::IVSRealTime::Types::PipConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::IVSRealTime::Types::PipConfiguration

Defined in:

gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb

Overview

Configuration information specific to Picture-in-Picture (PiP) layout, for server-side composition.

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.

• #pip_behavior ⇒ String

  Defines PiP behavior when all participants have left.

• #pip_height ⇒ Integer

  Specifies the height of the PiP window in pixels.

• #pip_offset ⇒ Integer

  Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition.

• #pip_participant_attribute ⇒ String

  Identifies the PiP slot.

• #pip_position ⇒ String

  Determines the corner position of the PiP window.

• #pip_width ⇒ Integer

  Specifies the width of the PiP window in pixels.

• #video_fill_mode ⇒ String

  Defines how video fits within the participant tile.

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.

Returns:

• (String)

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

class PipConfiguration < Struct.new(
  :featured_participant_attribute,
  :grid_gap,
  :omit_stopped_video,
  :pip_behavior,
  :pip_height,
  :pip_offset,
  :pip_participant_attribute,
  :pip_position,
  :pip_width,
  :video_fill_mode)
  SENSITIVE = []
  include Aws::Structure
end

#grid_gap ⇒ Integer

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

Returns:

• (Integer)

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

class PipConfiguration < Struct.new(
  :featured_participant_attribute,
  :grid_gap,
  :omit_stopped_video,
  :pip_behavior,
  :pip_height,
  :pip_offset,
  :pip_participant_attribute,
  :pip_position,
  :pip_width,
  :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)

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

class PipConfiguration < Struct.new(
  :featured_participant_attribute,
  :grid_gap,
  :omit_stopped_video,
  :pip_behavior,
  :pip_height,
  :pip_offset,
  :pip_participant_attribute,
  :pip_position,
  :pip_width,
  :video_fill_mode)
  SENSITIVE = []
  include Aws::Structure
end

#pip_behavior ⇒ String

Defines PiP behavior when all participants have left. Default: STATIC.

Returns:

• (String)

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

class PipConfiguration < Struct.new(
  :featured_participant_attribute,
  :grid_gap,
  :omit_stopped_video,
  :pip_behavior,
  :pip_height,
  :pip_offset,
  :pip_participant_attribute,
  :pip_position,
  :pip_width,
  :video_fill_mode)
  SENSITIVE = []
  include Aws::Structure
end

#pip_height ⇒ Integer

Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

Returns:

• (Integer)

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

class PipConfiguration < Struct.new(
  :featured_participant_attribute,
  :grid_gap,
  :omit_stopped_video,
  :pip_behavior,
  :pip_height,
  :pip_offset,
  :pip_participant_attribute,
  :pip_position,
  :pip_width,
  :video_fill_mode)
  SENSITIVE = []
  include Aws::Structure
end

#pip_offset ⇒ Integer

Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.

Returns:

• (Integer)

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

class PipConfiguration < Struct.new(
  :featured_participant_attribute,
  :grid_gap,
  :omit_stopped_video,
  :pip_behavior,
  :pip_height,
  :pip_offset,
  :pip_participant_attribute,
  :pip_position,
  :pip_width,
  :video_fill_mode)
  SENSITIVE = []
  include Aws::Structure
end

#pip_participant_attribute ⇒ String

Identifies the PiP slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot.

Returns:

• (String)

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

class PipConfiguration < Struct.new(
  :featured_participant_attribute,
  :grid_gap,
  :omit_stopped_video,
  :pip_behavior,
  :pip_height,
  :pip_offset,
  :pip_participant_attribute,
  :pip_position,
  :pip_width,
  :video_fill_mode)
  SENSITIVE = []
  include Aws::Structure
end

#pip_position ⇒ String

Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.

Returns:

• (String)

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

class PipConfiguration < Struct.new(
  :featured_participant_attribute,
  :grid_gap,
  :omit_stopped_video,
  :pip_behavior,
  :pip_height,
  :pip_offset,
  :pip_participant_attribute,
  :pip_position,
  :pip_width,
  :video_fill_mode)
  SENSITIVE = []
  include Aws::Structure
end

#pip_width ⇒ Integer

Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

Returns:

• (Integer)

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

class PipConfiguration < Struct.new(
  :featured_participant_attribute,
  :grid_gap,
  :omit_stopped_video,
  :pip_behavior,
  :pip_height,
  :pip_offset,
  :pip_participant_attribute,
  :pip_position,
  :pip_width,
  :video_fill_mode)
  SENSITIVE = []
  include Aws::Structure
end

#video_fill_mode ⇒ String

Defines how video fits within the participant tile. Default: COVER.

Returns:

• (String)

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

class PipConfiguration < Struct.new(
  :featured_participant_attribute,
  :grid_gap,
  :omit_stopped_video,
  :pip_behavior,
  :pip_height,
  :pip_offset,
  :pip_participant_attribute,
  :pip_position,
  :pip_width,
  :video_fill_mode)
  SENSITIVE = []
  include Aws::Structure
end