pub struct BurnInDestinationSettings {Show 17 fields
pub alignment: Option<String>,
pub background_color: Option<String>,
pub background_opacity: Option<i64>,
pub font: Option<InputLocation>,
pub font_color: Option<String>,
pub font_opacity: Option<i64>,
pub font_resolution: Option<i64>,
pub font_size: Option<String>,
pub outline_color: Option<String>,
pub outline_size: Option<i64>,
pub shadow_color: Option<String>,
pub shadow_opacity: Option<i64>,
pub shadow_x_offset: Option<i64>,
pub shadow_y_offset: Option<i64>,
pub teletext_grid_control: Option<String>,
pub x_position: Option<i64>,
pub y_position: Option<i64>,
}
Expand description
Burn In Destination Settings
Fields
alignment: Option<String>
If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.
background_color: Option<String>
Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.
background_opacity: Option<i64>
Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
font: Option<InputLocation>
External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
font_color: Option<String>
Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
font_opacity: Option<i64>
Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
font_resolution: Option<i64>
Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
font_size: Option<String>
When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
outline_color: Option<String>
Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
outline_size: Option<i64>
Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
shadow_color: Option<String>
Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
shadow_opacity: Option<i64>
Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
shadow_x_offset: Option<i64>
Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
shadow_y_offset: Option<i64>
Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
teletext_grid_control: Option<String>
Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
x_position: Option<i64>
Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
y_position: Option<i64>
Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
Trait Implementations
sourceimpl Clone for BurnInDestinationSettings
impl Clone for BurnInDestinationSettings
sourcefn clone(&self) -> BurnInDestinationSettings
fn clone(&self) -> BurnInDestinationSettings
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for BurnInDestinationSettings
impl Debug for BurnInDestinationSettings
sourceimpl Default for BurnInDestinationSettings
impl Default for BurnInDestinationSettings
sourcefn default() -> BurnInDestinationSettings
fn default() -> BurnInDestinationSettings
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for BurnInDestinationSettings
impl<'de> Deserialize<'de> for BurnInDestinationSettings
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<BurnInDestinationSettings> for BurnInDestinationSettings
impl PartialEq<BurnInDestinationSettings> for BurnInDestinationSettings
sourcefn eq(&self, other: &BurnInDestinationSettings) -> bool
fn eq(&self, other: &BurnInDestinationSettings) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &BurnInDestinationSettings) -> bool
fn ne(&self, other: &BurnInDestinationSettings) -> bool
This method tests for !=
.
sourceimpl Serialize for BurnInDestinationSettings
impl Serialize for BurnInDestinationSettings
impl StructuralPartialEq for BurnInDestinationSettings
Auto Trait Implementations
impl RefUnwindSafe for BurnInDestinationSettings
impl Send for BurnInDestinationSettings
impl Sync for BurnInDestinationSettings
impl Unpin for BurnInDestinationSettings
impl UnwindSafe for BurnInDestinationSettings
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more