#[non_exhaustive]pub struct AudioNormalizationSettings {
pub algorithm: Option<AudioNormalizationAlgorithm>,
pub algorithm_control: Option<AudioNormalizationAlgorithmControl>,
pub correction_gate_level: Option<i32>,
pub loudness_logging: Option<AudioNormalizationLoudnessLogging>,
pub peak_calculation: Option<AudioNormalizationPeakCalculation>,
pub target_lkfs: Option<f64>,
pub true_peak_limiter_threshold: Option<f64>,
}Expand description
Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.
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.algorithm: Option<AudioNormalizationAlgorithm>Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.
algorithm_control: Option<AudioNormalizationAlgorithmControl>When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.
correction_gate_level: Option<i32>Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected.
loudness_logging: Option<AudioNormalizationLoudnessLogging>If set to LOG, log each output’s audio track loudness to a CSV file.
peak_calculation: Option<AudioNormalizationPeakCalculation>If set to TRUE_PEAK, calculate and log the TruePeak for each output’s audio track loudness.
target_lkfs: Option<f64>When you use Audio normalization, optionally use this setting to specify a target loudness. If you don’t specify a value here, the encoder chooses a value for you, based on the algorithm that you choose for Algorithm. If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the encoder will choose -23 LKFS.
true_peak_limiter_threshold: Option<f64>Specify the True-peak limiter threshold in decibels relative to full scale (dBFS). The peak inter-audio sample loudness in your output will be limited to the value that you specify, without affecting the overall target LKFS. Enter a value from 0 to -8. Leave blank to use the default value 0.
Implementations§
Source§impl AudioNormalizationSettings
impl AudioNormalizationSettings
Sourcepub fn algorithm(&self) -> Option<&AudioNormalizationAlgorithm>
pub fn algorithm(&self) -> Option<&AudioNormalizationAlgorithm>
Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.
Sourcepub fn algorithm_control(&self) -> Option<&AudioNormalizationAlgorithmControl>
pub fn algorithm_control(&self) -> Option<&AudioNormalizationAlgorithmControl>
When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.
Sourcepub fn correction_gate_level(&self) -> Option<i32>
pub fn correction_gate_level(&self) -> Option<i32>
Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected.
Sourcepub fn loudness_logging(&self) -> Option<&AudioNormalizationLoudnessLogging>
pub fn loudness_logging(&self) -> Option<&AudioNormalizationLoudnessLogging>
If set to LOG, log each output’s audio track loudness to a CSV file.
Sourcepub fn peak_calculation(&self) -> Option<&AudioNormalizationPeakCalculation>
pub fn peak_calculation(&self) -> Option<&AudioNormalizationPeakCalculation>
If set to TRUE_PEAK, calculate and log the TruePeak for each output’s audio track loudness.
Sourcepub fn target_lkfs(&self) -> Option<f64>
pub fn target_lkfs(&self) -> Option<f64>
When you use Audio normalization, optionally use this setting to specify a target loudness. If you don’t specify a value here, the encoder chooses a value for you, based on the algorithm that you choose for Algorithm. If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the encoder will choose -23 LKFS.
Sourcepub fn true_peak_limiter_threshold(&self) -> Option<f64>
pub fn true_peak_limiter_threshold(&self) -> Option<f64>
Specify the True-peak limiter threshold in decibels relative to full scale (dBFS). The peak inter-audio sample loudness in your output will be limited to the value that you specify, without affecting the overall target LKFS. Enter a value from 0 to -8. Leave blank to use the default value 0.
Source§impl AudioNormalizationSettings
impl AudioNormalizationSettings
Sourcepub fn builder() -> AudioNormalizationSettingsBuilder
pub fn builder() -> AudioNormalizationSettingsBuilder
Creates a new builder-style object to manufacture AudioNormalizationSettings.
Trait Implementations§
Source§impl Clone for AudioNormalizationSettings
impl Clone for AudioNormalizationSettings
Source§fn clone(&self) -> AudioNormalizationSettings
fn clone(&self) -> AudioNormalizationSettings
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for AudioNormalizationSettings
impl Debug for AudioNormalizationSettings
Source§impl PartialEq for AudioNormalizationSettings
impl PartialEq for AudioNormalizationSettings
Source§fn eq(&self, other: &AudioNormalizationSettings) -> bool
fn eq(&self, other: &AudioNormalizationSettings) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for AudioNormalizationSettings
Auto Trait Implementations§
impl Freeze for AudioNormalizationSettings
impl RefUnwindSafe for AudioNormalizationSettings
impl Send for AudioNormalizationSettings
impl Sync for AudioNormalizationSettings
impl Unpin for AudioNormalizationSettings
impl UnsafeUnpin for AudioNormalizationSettings
impl UnwindSafe for AudioNormalizationSettings
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>
renamed to 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);