Struct medea_jason::peer::sender::State

pub struct State { /* private fields */ }

State of the Component.

Implementations

impl State

pub fn new( id: TrackId, mid: Option<String>, media_type: MediaType, media_direction: MediaDirection, muted: bool, receivers: Vec<MemberId>, send_constraints: LocalTracksConstraints, connection_mode: ConnectionMode ) -> Self

Creates new State with the provided data.

pub fn enabled(&self) -> bool

Indicates whether this Sender’s media exchange state is in media_exchange_state::Stable::Enabled.

pub const fn id(&self) -> TrackId

Returns TrackId of this State.

pub fn mid(&self) -> Option<&str>

Returns current mid of this State.

pub const fn media_type(&self) -> MediaType

Returns current MediaType of this State.

pub fn receivers(&self) -> Vec<MemberId>

Returns current MemberIds of the Members that this State should send media data to.

pub fn is_enabled_individual(&self) -> bool

Returns current individual media exchange state of this State.

pub fn is_enabled_general(&self) -> bool

Returns current general media exchange state of this State.

pub fn is_muted(&self) -> bool

Returns current mute state of this State.

pub fn local_stream_update_result( &self ) -> LocalBoxFuture<'static, Result<(), Traced<UpdateLocalStreamError>>>

Returns Future which will be resolved once getUserMedia()/getDisplayMedia() request for this State is resolved.

pub fn update(&self, track_patch: TrackPatchEvent)

Updates this State with the provided TrackPatchEvent.

pub fn is_local_stream_update_needed(&self) -> bool

Indicates whether local MediaStream update needed for this State.

pub fn failed_local_stream_update(&self, error: Traced<UpdateLocalStreamError>)

Marks an inner local_track_state of this State as failed with the provided error.

pub fn local_stream_updated(&self)

Marks an inner local_track_state of this State as stable.

pub const fn media_kind(&self) -> MediaKind

Returns MediaKind of this State.

pub const fn media_source(&self) -> MediaSourceKind

Returns MediaSourceKind of this State.

Trait Implementations

impl AsProtoState for State

type Output = Sender

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 From<&State> for Sender

fn from(state: &State) -> Self

Converts to this type from the input type.

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.

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

Sets current MediaState to TransitableState::Transition.

fn media_exchange_state(&self) -> MediaExchangeState

Returns MediaExchangeState of this MediaStateControllable.

fn mute_state(&self) -> MuteState

Returns MuteState of this MediaStateControllable.

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.

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<(), MediaState>>

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 = Sender

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

fn from_proto( input: Self::Input, send_constraints: &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 and mute_state are stabilized.

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

Returns Future resolving once a State update is applied onto the Sender.

fn connection_lost(&self)

Notifies State about a RPC connection loss.

fn connection_recovered(&self)

Notifies State about a RPC connection restore.