Struct livekit_protocol::livekit::UpdateTrackSettings

pub struct UpdateTrackSettings {
    pub track_sids: Vec<String>,
    pub disabled: bool,
    pub quality: i32,
    pub width: u32,
    pub height: u32,
    pub fps: u32,
    pub priority: u32,
}

Fields

track_sids: Vec<String>

disabled: bool

when true, the track is placed in a paused state, with no new data returned

quality: i32

deprecated in favor of width & height

width: u32

for video, width to receive

height: u32

for video, height to receive

fps: u32

priority: u32

subscription priority. 1 being the highest (0 is unset) when unset, server sill assign priority based on the order of subscription server will use priority in the following ways:

1. when subscribed tracks exceed per-participant subscription limit, server will pause the lowest priority tracks
2. when the network is congested, server will assign available bandwidth to higher priority tracks first. lowest priority tracks can be paused

Implementations

impl UpdateTrackSettings

pub fn quality(&self) -> VideoQuality

Returns the enum value of quality, or the default if the field is set to an invalid enum value.

pub fn set_quality(&mut self, value: VideoQuality)

Sets quality to the provided enum value.

Trait Implementations

impl Clone for UpdateTrackSettings

fn clone(&self) -> UpdateTrackSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateTrackSettings

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

Formats the value using the given formatter.

impl Default for UpdateTrackSettings

fn default() -> Self

Returns the “default value” for a type.

impl Message for UpdateTrackSettings

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<UpdateTrackSettings> for UpdateTrackSettings

fn eq(&self, other: &UpdateTrackSettings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateTrackSettings