#[non_exhaustive]pub struct PipConfigurationBuilder { /* private fields */ }Expand description
A builder for PipConfiguration.
Implementations§
Source§impl PipConfigurationBuilder
impl PipConfigurationBuilder
Sourcepub fn featured_participant_attribute(self, input: impl Into<String>) -> Self
pub fn featured_participant_attribute(self, input: impl Into<String>) -> Self
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).
Sourcepub fn set_featured_participant_attribute(self, input: Option<String>) -> Self
pub fn set_featured_participant_attribute(self, input: Option<String>) -> Self
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).
Sourcepub fn get_featured_participant_attribute(&self) -> &Option<String>
pub fn get_featured_participant_attribute(&self) -> &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).
Sourcepub fn omit_stopped_video(self, input: bool) -> Self
pub fn omit_stopped_video(self, input: bool) -> Self
Determines whether to omit participants with stopped video in the composition. Default: false.
Sourcepub fn set_omit_stopped_video(self, input: Option<bool>) -> Self
pub fn set_omit_stopped_video(self, input: Option<bool>) -> Self
Determines whether to omit participants with stopped video in the composition. Default: false.
Sourcepub fn get_omit_stopped_video(&self) -> &Option<bool>
pub fn get_omit_stopped_video(&self) -> &Option<bool>
Determines whether to omit participants with stopped video in the composition. Default: false.
Sourcepub fn video_fill_mode(self, input: VideoFillMode) -> Self
pub fn video_fill_mode(self, input: VideoFillMode) -> Self
Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.
Sourcepub fn set_video_fill_mode(self, input: Option<VideoFillMode>) -> Self
pub fn set_video_fill_mode(self, input: Option<VideoFillMode>) -> Self
Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.
Sourcepub fn get_video_fill_mode(&self) -> &Option<VideoFillMode>
pub fn get_video_fill_mode(&self) -> &Option<VideoFillMode>
Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.
Sourcepub fn grid_gap(self, input: i32) -> Self
pub fn grid_gap(self, input: i32) -> Self
Specifies the spacing between participant tiles in pixels. Default: 0.
Sourcepub fn set_grid_gap(self, input: Option<i32>) -> Self
pub fn set_grid_gap(self, input: Option<i32>) -> Self
Specifies the spacing between participant tiles in pixels. Default: 0.
Sourcepub fn get_grid_gap(&self) -> &Option<i32>
pub fn get_grid_gap(&self) -> &Option<i32>
Specifies the spacing between participant tiles in pixels. Default: 0.
Sourcepub fn pip_participant_attribute(self, input: impl Into<String>) -> Self
pub fn pip_participant_attribute(self, input: impl Into<String>) -> Self
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).
Sourcepub fn set_pip_participant_attribute(self, input: Option<String>) -> Self
pub fn set_pip_participant_attribute(self, input: Option<String>) -> Self
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).
Sourcepub fn get_pip_participant_attribute(&self) -> &Option<String>
pub fn get_pip_participant_attribute(&self) -> &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).
Sourcepub fn pip_behavior(self, input: PipBehavior) -> Self
pub fn pip_behavior(self, input: PipBehavior) -> Self
Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.
Sourcepub fn set_pip_behavior(self, input: Option<PipBehavior>) -> Self
pub fn set_pip_behavior(self, input: Option<PipBehavior>) -> Self
Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.
Sourcepub fn get_pip_behavior(&self) -> &Option<PipBehavior>
pub fn get_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.
Sourcepub fn pip_offset(self, input: i32) -> Self
pub fn pip_offset(self, input: i32) -> Self
Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.
Sourcepub fn set_pip_offset(self, input: Option<i32>) -> Self
pub fn set_pip_offset(self, input: Option<i32>) -> Self
Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.
Sourcepub fn get_pip_offset(&self) -> &Option<i32>
pub fn get_pip_offset(&self) -> &Option<i32>
Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.
Sourcepub fn pip_position(self, input: PipPosition) -> Self
pub fn pip_position(self, input: PipPosition) -> Self
Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.
Sourcepub fn set_pip_position(self, input: Option<PipPosition>) -> Self
pub fn set_pip_position(self, input: Option<PipPosition>) -> Self
Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.
Sourcepub fn get_pip_position(&self) -> &Option<PipPosition>
pub fn get_pip_position(&self) -> &Option<PipPosition>
Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.
Sourcepub fn pip_width(self, input: i32) -> Self
pub fn pip_width(self, input: i32) -> Self
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.
Sourcepub fn set_pip_width(self, input: Option<i32>) -> Self
pub fn set_pip_width(self, input: Option<i32>) -> Self
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.
Sourcepub fn get_pip_width(&self) -> &Option<i32>
pub fn get_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.
Sourcepub fn pip_height(self, input: i32) -> Self
pub fn pip_height(self, input: i32) -> Self
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.
Sourcepub fn set_pip_height(self, input: Option<i32>) -> Self
pub fn set_pip_height(self, input: Option<i32>) -> Self
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.
Sourcepub fn get_pip_height(&self) -> &Option<i32>
pub fn get_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.
Sourcepub fn participant_order_attribute(self, input: impl Into<String>) -> Self
pub fn participant_order_attribute(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_participant_order_attribute(self, input: Option<String>) -> Self
pub fn set_participant_order_attribute(self, input: Option<String>) -> Self
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.
Sourcepub fn get_participant_order_attribute(&self) -> &Option<String>
pub fn get_participant_order_attribute(&self) -> &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.
Sourcepub fn build(self) -> PipConfiguration
pub fn build(self) -> PipConfiguration
Consumes the builder and constructs a PipConfiguration.
Trait Implementations§
Source§impl Clone for PipConfigurationBuilder
impl Clone for PipConfigurationBuilder
Source§fn clone(&self) -> PipConfigurationBuilder
fn clone(&self) -> PipConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for PipConfigurationBuilder
impl Debug for PipConfigurationBuilder
Source§impl Default for PipConfigurationBuilder
impl Default for PipConfigurationBuilder
Source§fn default() -> PipConfigurationBuilder
fn default() -> PipConfigurationBuilder
Source§impl PartialEq for PipConfigurationBuilder
impl PartialEq for PipConfigurationBuilder
impl StructuralPartialEq for PipConfigurationBuilder
Auto Trait Implementations§
impl Freeze for PipConfigurationBuilder
impl RefUnwindSafe for PipConfigurationBuilder
impl Send for PipConfigurationBuilder
impl Sync for PipConfigurationBuilder
impl Unpin for PipConfigurationBuilder
impl UnwindSafe for PipConfigurationBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);