Skip to main content

TrackPublishOptions

Struct TrackPublishOptions 

Source
pub struct TrackPublishOptions {
Show 14 fields pub video_encoding: Option<VideoEncoding>, pub audio_encoding: Option<AudioEncoding>, pub video_codec: VideoCodec, pub dtx: bool, pub red: bool, pub simulcast: bool, pub simulcast_layers: Option<Vec<VideoPreset>>, pub source: TrackSource, pub stream: String, pub preconnect_buffer: bool, pub frame_metadata_features: FrameMetadataFeatures, pub video_encoder: VideoEncoderBackend, pub scalability_mode: Option<String>, pub degradation_preference: Option<DegradationPreference>,
}

Fields§

§video_encoding: Option<VideoEncoding>§audio_encoding: Option<AudioEncoding>§video_codec: VideoCodec§dtx: bool§red: bool§simulcast: bool§simulcast_layers: Option<Vec<VideoPreset>>

Custom simulcast layer presets (low, mid). When set, these override the SDK’s built-in defaults which reduce fps on lower layers.

§source: TrackSource§stream: String§preconnect_buffer: bool§frame_metadata_features: FrameMetadataFeatures§video_encoder: VideoEncoderBackend

Preferred encoder backend for video tracks published with these options.

If the requested backend is unavailable, the SDK logs a warning and falls back to another compatible encoder.

§scalability_mode: Option<String>

RTP scalability mode (e.g. “L3T3_KEY”). When set, a single RTP encoding is produced and that mode is forwarded to libwebrtc to enable true SVC for VP9/AV1. Has no effect for VP8/H264.

§degradation_preference: Option<DegradationPreference>

Controls how the encoder trades off between resolution and framerate when bandwidth is constrained.

  • MaintainFramerate: Prioritizes framerate, reduces resolution if needed
  • MaintainResolution: Prioritizes resolution, drops frames if needed
  • Balanced: Balances between both

If not set, the SDK uses defaults based on track source:

  • Camera: MaintainFramerate (smoother video for real-time communication)
  • Screen share: MaintainResolution (clarity is critical for text/UI)
  • Other/unknown: Balanced

Trait Implementations§

Source§

impl Clone for TrackPublishOptions

Source§

fn clone(&self) -> TrackPublishOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for TrackPublishOptions

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for TrackPublishOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more