Struct PipConfiguration 

#[non_exhaustive]
pub struct PipConfiguration {
    pub featured_participant_attribute: Option<String>,
    pub omit_stopped_video: bool,
    pub video_fill_mode: Option<VideoFillMode>,
    pub grid_gap: i32,
    pub pip_participant_attribute: Option<String>,
    pub pip_behavior: Option<PipBehavior>,
    pub pip_offset: i32,
    pub pip_position: Option<PipPosition>,
    pub pip_width: Option<i32>,
    pub pip_height: Option<i32>,
    pub participant_order_attribute: Option<String>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

featured_participant_attribute: Option<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).

omit_stopped_video: bool

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

video_fill_mode: Option<VideoFillMode>

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

grid_gap: i32

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

pip_participant_attribute: Option<String>

Specifies the participant for the PiP window. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot. Default: "" (no PiP participant).

pip_behavior: Option<PipBehavior>

Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.

pip_offset: i32

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

pip_position: Option<PipPosition>

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

pip_width: Option<i32>

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.

pip_height: Option<i32>

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.

participant_order_attribute: Option<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.

Implementations

impl PipConfiguration

pub fn featured_participant_attribute(&self) -> Option<&str>

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).

pub fn omit_stopped_video(&self) -> bool

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

pub fn video_fill_mode(&self) -> Option<&VideoFillMode>

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

pub fn grid_gap(&self) -> i32

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

pub fn pip_participant_attribute(&self) -> Option<&str>

Specifies the participant for the PiP window. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot. Default: "" (no PiP participant).

pub fn pip_behavior(&self) -> Option<&PipBehavior>

Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.

pub fn pip_offset(&self) -> i32

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

pub fn pip_position(&self) -> Option<&PipPosition>

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

pub fn pip_width(&self) -> Option<i32>

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.

pub fn pip_height(&self) -> Option<i32>

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.

pub fn participant_order_attribute(&self) -> Option<&str>

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.

impl PipConfiguration

pub fn builder() -> PipConfigurationBuilder

Creates a new builder-style object to manufacture PipConfiguration.

Trait Implementations

impl Clone for PipConfiguration

fn clone(&self) -> PipConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PipConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PipConfiguration

fn eq(&self, other: &PipConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PipConfiguration