Skip to main content

QualityController

Struct QualityController 

Source
pub struct QualityController { /* private fields */ }
Expand description

Tracks interaction state and determines encoding parameters each frame.

Implementations§

Source§

impl QualityController

Source

pub fn new(config: QualityConfig) -> Self

Source

pub fn on_input(&mut self)

Call when any input event is received.

Source

pub fn on_transport_rtt(&mut self, rtt: Duration)

Feed a transport RTT sample into the adaptive quality controller.

Source

pub fn on_network_metrics(&mut self, metrics: NetworkMetrics)

Feed a full network metrics sample into the adaptive quality controller.

The controller treats requested_tier as the application’s preferred maximum quality, and network_cap_tier as the highest quality the current transport conditions can safely sustain.

Source

pub fn requested_tier(&self) -> QualityTier

The currently requested application tier.

Source

pub fn network_cap_tier(&self) -> QualityTier

The highest tier currently allowed by recent network samples.

Source

pub fn current_tier(&self) -> QualityTier

The effective encode tier after combining app preference and network cap.

Source

pub fn last_network_metrics(&self) -> Option<NetworkMetrics>

The most recent network metrics sample, if one has been provided.

Source

pub fn frame_params(&mut self) -> EncodeParams

Get the encode parameters for the current frame.

Source

pub fn set_tier(&mut self, tier: QualityTier)

Set the application’s preferred maximum tier.

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.