Struct medea_jason::peer::receiver::State

pub struct State { /* fields omitted */ }

State of the Component.

Implementations

impl State

#[must_use]pub fn new(
    id: TrackId,
    mid: Option<String>,
    media_type: MediaType,
    sender: MemberId
) -> Self

Returns State with a provided data.

#[must_use]pub fn id(&self) -> TrackId

Returns TrackId of this State.

#[must_use]pub fn mid(&self) -> Option<&str>

Returns current mid of this State.

#[must_use]pub fn media_type(&self) -> &MediaType

Returns current MediaType of this State.

#[must_use]pub fn sender_id(&self) -> &MemberId

Returns current MemberId of the Member from which this State should receive media data.

#[must_use]pub fn enabled_individual(&self) -> bool

Returns current individual media exchange state of this State.

#[must_use]pub fn enabled_general(&self) -> bool

Returns current general media exchange state of this State.

#[must_use]pub fn muted(&self) -> bool

Returns current mute state of this State.

pub fn update(&self, track_patch: &TrackPatchEvent)

Updates this State with the provided TrackPatchEvent.

Trait Implementations

impl AsProtoState for State

type Output = Receiver

medea_client_api_proto::state into which this state can be transformed.

fn as_proto(&self) -> Self::Output

Converts this state to the medea_client_api_proto::state representation.

impl Debug for State

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

Formats the value using the given formatter.

impl MediaStateControllable for State

fn media_exchange_state_controller(&self) -> Rc<MediaExchangeStateController>

Returns reference to the MediaExchangeStateController.

fn mute_state_controller(&self) -> Rc<MuteStateController>

Returns a reference to the MuteStateController.

#[must_use]fn media_exchange_state(&self) -> MediaExchangeState

Returns MediaExchangeState of this MediaStateControllable.

#[must_use]fn mute_state(&self) -> MuteState

Returns MuteState of this MediaStateControllable.

fn media_state_transition_to(
    &self,
    desired_state: MediaState
) -> Result<(), Traced<MediaConnectionsError>>

Sets current MediaState to TransitableState::Transition.

#[must_use]fn is_subscription_needed(&self, desired_state: MediaState) -> bool

Indicates whether Room should subscribe to the MediaState update when updating MediaStateControllable to the provided MediaState.

#[must_use]fn is_track_patch_needed(&self, desired_state: MediaState) -> bool

Indicates whether Room should send TrackPatchCommand to the server when updating MediaStateControllable to the provided MediaState.

fn when_media_state_stable(
    &self,
    desired_state: MediaState
) -> LocalBoxFuture<'static, Result<(), Traced<MediaConnectionsError>>>

Returns Future which will be resolved when MediaState of this MediaStateControllable will be TransitableState::Stable or it’s dropped.

impl SynchronizableState for State

type Input = Receiver

medea_client_api_proto::state by which this state can be updated.

fn from_proto(input: Self::Input, _: &LocalTracksConstraints) -> Self

Creates a new state from the medea_client_api_proto::state representation.

fn apply(&self, input: Self::Input, _: &LocalTracksConstraints)

Updates this state with a provided medea_client_api_proto::state.

impl TransceiverSide for State

fn track_id(&self) -> TrackId

Returns TrackId of this TransceiverSide.

fn kind(&self) -> MediaKind

Returns MediaKind of this TransceiverSide.

fn source_kind(&self) -> MediaSourceKind

Returns MediaSourceKind of this TransceiverSide.

fn is_transitable(&self) -> bool

Returns true if this TransceiverSide currently can be disabled/enabled without LocalTracksConstraints updating.

impl Updatable for State

fn when_stabilized(&self) -> AllProcessed<'static>

Returns Future resolving once media_exchange_state is stabilized.

fn when_updated(&self) -> AllProcessed<'static>

Returns Future resolving once State update will be applied onto the Receiver.

fn connection_lost(&self)

Notifies State about a RPC connection loss.

fn connection_recovered(&self)

Notifies State about a RPC connection restore.