pub struct Composition {
pub layout: Option<CompositionLayout>,
pub priority: Option<LayoutPriority>,
pub grid_size: Option<u32>,
pub orientation: Option<Orientation>,
pub theme: Option<Theme>,
pub quality: Option<CompositionQuality>,
}Expand description
The composition options shared by every egress: layout, priority, grid size, orientation, theme and quality.
If layout is omitted while quality, theme or orientation are set, the
layout defaults to CompositionLayout::Grid — the API requires a layout
whenever any other composition option is present.
Fields§
§layout: Option<CompositionLayout>A named layout, or a custom template.
priority: Option<LayoutPriority>The speaker priority. HLS and RTMP require it when a layout is present,
so the SDK defaults it to LayoutPriority::Speaker for those.
grid_size: Option<u32>The number of tiles in a grid layout: 0-25, defaulting to 25.
orientation: Option<Orientation>The composition’s orientation.
theme: Option<Theme>The composition’s theme.
quality: Option<CompositionQuality>The recorder quality tier.
Trait Implementations§
Source§impl Clone for Composition
impl Clone for Composition
Source§fn clone(&self) -> Composition
fn clone(&self) -> Composition
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for Composition
impl Debug for Composition
Source§impl Default for Composition
impl Default for Composition
Source§fn default() -> Composition
fn default() -> Composition
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for Composition
impl RefUnwindSafe for Composition
impl Send for Composition
impl Sync for Composition
impl Unpin for Composition
impl UnsafeUnpin for Composition
impl UnwindSafe for Composition
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
Mutably borrows from an owned value. Read more