#[non_exhaustive]pub struct EncoderSettings {Show 14 fields
pub audio_descriptions: Option<Vec<AudioDescription>>,
pub avail_blanking: Option<AvailBlanking>,
pub avail_configuration: Option<AvailConfiguration>,
pub blackout_slate: Option<BlackoutSlate>,
pub caption_descriptions: Option<Vec<CaptionDescription>>,
pub feature_activations: Option<FeatureActivations>,
pub global_configuration: Option<GlobalConfiguration>,
pub motion_graphics_configuration: Option<MotionGraphicsConfiguration>,
pub nielsen_configuration: Option<NielsenConfiguration>,
pub output_groups: Option<Vec<OutputGroup>>,
pub timecode_config: Option<TimecodeConfig>,
pub video_descriptions: Option<Vec<VideoDescription>>,
pub thumbnail_configuration: Option<ThumbnailConfiguration>,
pub color_correction_settings: Option<ColorCorrectionSettings>,
}
Expand description
Encoder Settings
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.audio_descriptions: Option<Vec<AudioDescription>>
Placeholder documentation for __listOfAudioDescription
avail_blanking: Option<AvailBlanking>
Settings for ad avail blanking.
avail_configuration: Option<AvailConfiguration>
Event-wide configuration settings for ad avail insertion.
blackout_slate: Option<BlackoutSlate>
Settings for blackout slate.
caption_descriptions: Option<Vec<CaptionDescription>>
Settings for caption decriptions
feature_activations: Option<FeatureActivations>
Feature Activations
global_configuration: Option<GlobalConfiguration>
Configuration settings that apply to the event as a whole.
motion_graphics_configuration: Option<MotionGraphicsConfiguration>
Settings for motion graphics.
nielsen_configuration: Option<NielsenConfiguration>
Nielsen configuration settings.
output_groups: Option<Vec<OutputGroup>>
Placeholder documentation for __listOfOutputGroup
timecode_config: Option<TimecodeConfig>
Contains settings used to acquire and adjust timecode information from inputs.
video_descriptions: Option<Vec<VideoDescription>>
Placeholder documentation for __listOfVideoDescription
thumbnail_configuration: Option<ThumbnailConfiguration>
Thumbnail configuration settings.
color_correction_settings: Option<ColorCorrectionSettings>
Color Correction Settings
Implementations§
Source§impl EncoderSettings
impl EncoderSettings
Sourcepub fn audio_descriptions(&self) -> &[AudioDescription]
pub fn audio_descriptions(&self) -> &[AudioDescription]
Placeholder documentation for __listOfAudioDescription
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .audio_descriptions.is_none()
.
Sourcepub fn avail_blanking(&self) -> Option<&AvailBlanking>
pub fn avail_blanking(&self) -> Option<&AvailBlanking>
Settings for ad avail blanking.
Sourcepub fn avail_configuration(&self) -> Option<&AvailConfiguration>
pub fn avail_configuration(&self) -> Option<&AvailConfiguration>
Event-wide configuration settings for ad avail insertion.
Sourcepub fn blackout_slate(&self) -> Option<&BlackoutSlate>
pub fn blackout_slate(&self) -> Option<&BlackoutSlate>
Settings for blackout slate.
Sourcepub fn caption_descriptions(&self) -> &[CaptionDescription]
pub fn caption_descriptions(&self) -> &[CaptionDescription]
Settings for caption decriptions
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .caption_descriptions.is_none()
.
Sourcepub fn feature_activations(&self) -> Option<&FeatureActivations>
pub fn feature_activations(&self) -> Option<&FeatureActivations>
Feature Activations
Sourcepub fn global_configuration(&self) -> Option<&GlobalConfiguration>
pub fn global_configuration(&self) -> Option<&GlobalConfiguration>
Configuration settings that apply to the event as a whole.
Sourcepub fn motion_graphics_configuration(
&self,
) -> Option<&MotionGraphicsConfiguration>
pub fn motion_graphics_configuration( &self, ) -> Option<&MotionGraphicsConfiguration>
Settings for motion graphics.
Sourcepub fn nielsen_configuration(&self) -> Option<&NielsenConfiguration>
pub fn nielsen_configuration(&self) -> Option<&NielsenConfiguration>
Nielsen configuration settings.
Sourcepub fn output_groups(&self) -> &[OutputGroup]
pub fn output_groups(&self) -> &[OutputGroup]
Placeholder documentation for __listOfOutputGroup
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .output_groups.is_none()
.
Sourcepub fn timecode_config(&self) -> Option<&TimecodeConfig>
pub fn timecode_config(&self) -> Option<&TimecodeConfig>
Contains settings used to acquire and adjust timecode information from inputs.
Sourcepub fn video_descriptions(&self) -> &[VideoDescription]
pub fn video_descriptions(&self) -> &[VideoDescription]
Placeholder documentation for __listOfVideoDescription
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .video_descriptions.is_none()
.
Sourcepub fn thumbnail_configuration(&self) -> Option<&ThumbnailConfiguration>
pub fn thumbnail_configuration(&self) -> Option<&ThumbnailConfiguration>
Thumbnail configuration settings.
Sourcepub fn color_correction_settings(&self) -> Option<&ColorCorrectionSettings>
pub fn color_correction_settings(&self) -> Option<&ColorCorrectionSettings>
Color Correction Settings
Source§impl EncoderSettings
impl EncoderSettings
Sourcepub fn builder() -> EncoderSettingsBuilder
pub fn builder() -> EncoderSettingsBuilder
Creates a new builder-style object to manufacture EncoderSettings
.
Trait Implementations§
Source§impl Clone for EncoderSettings
impl Clone for EncoderSettings
Source§fn clone(&self) -> EncoderSettings
fn clone(&self) -> EncoderSettings
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for EncoderSettings
impl Debug for EncoderSettings
Source§impl PartialEq for EncoderSettings
impl PartialEq for EncoderSettings
impl StructuralPartialEq for EncoderSettings
Auto Trait Implementations§
impl Freeze for EncoderSettings
impl RefUnwindSafe for EncoderSettings
impl Send for EncoderSettings
impl Sync for EncoderSettings
impl Unpin for EncoderSettings
impl UnwindSafe for EncoderSettings
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);