Struct TrackPatchEvent

pub struct TrackPatchEvent {
    pub id: TrackId,
    pub media_direction: Option<MediaDirection>,
    pub receivers: Option<Vec<MemberId>>,
    pub muted: Option<bool>,
    pub encoding_parameters: Option<Vec<EncodingParameters>>,
}

Patch of a Track which Media Server can send with an Event::PeerUpdated.

Fields

id: TrackId

ID of the Track which should be patched.

media_direction: Option<MediaDirection>

General media exchange direction of the Track.

receivers: Option<Vec<MemberId>>

IDs of the Members who should receive this outgoing Track.

If Some, then it means there are some changes in this outgoing Track’s receivers (or we just want to sync this outgoing Track’s receivers). It describes not changes, but the actual Vec<MemberId> of this outgoing Track, that have to be reached once this TrackPatchEvent applied.

If None, then it means there is no need to check and recalculate this outgoing Track’s receivers.

muted: Option<bool>

Track’s mute state.

Muting and unmuting can be performed without adding/removing tracks from transceivers, hence renegotiation is not required.

encoding_parameters: Option<Vec<EncodingParameters>>

EncodingParameters for the Track which should be patched.

Implementations

impl TrackPatchEvent

pub const fn new(id: TrackId) -> Self

Returns a new empty TrackPatchEvent with the provided TrackId.

pub fn merge(&mut self, another: &Self)

Merges this TrackPatchEvent with the provided one.

Does nothing if TrackId of this TrackPatchEvent and the provided TrackPatchEvent are different.

Trait Implementations

impl Clone for TrackPatchEvent

fn clone(&self) -> TrackPatchEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrackPatchEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TrackPatchEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TrackPatchCommand> for TrackPatchEvent

fn from(from: TrackPatchCommand) -> Self

Converts to this type from the input type.

impl PartialEq for TrackPatchEvent

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for TrackPatchEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TrackPatchEvent

impl StructuralPartialEq for TrackPatchEvent