Struct medea_jason::peer::State

pub struct State { /* fields omitted */ }

State of a Component.

Implementations

impl State

#[must_use]pub fn new(
    id: Id,
    ice_servers: Vec<IceServer>,
    force_relay: bool,
    negotiation_role: Option<NegotiationRole>
) -> Self

Creates a new State with the provided data.

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

Returns Id of this State.

#[must_use]pub fn ice_servers(&self) -> &Vec<IceServer>

Returns all IceServers of this State.

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

Indicates whether PeerConnection should be relayed forcibly.

pub fn insert_sender(&self, track_id: TrackId, sender: Rc<State>)

Inserts a new sender::State into this State.

pub fn insert_receiver(&self, track_id: TrackId, receiver: Rc<State>)

Inserts a new receiver::State into this State.

#[must_use]pub fn get_sender(&self, track_id: TrackId) -> Option<Rc<State>>

Returns Rc to the sender::State with the provided TrackId.

#[must_use]pub fn get_receiver(&self, track_id: TrackId) -> Option<Rc<State>>

Returns Rc to the receiver::State with the provided TrackId.

pub async fn set_negotiation_role(&self, negotiation_role: NegotiationRole)

Sets NegotiationRole of this State to the provided one.

pub fn restart_ice(&self)

Sets State::restart_ice to true.

pub fn remove_track(&self, track_id: TrackId)

Removes sender::State or receiver::State with the provided TrackId.

pub fn set_remote_sdp(&self, sdp: String)

Sets remote SDP offer to the provided value.

pub fn add_ice_candidate(&self, ice_candidate: IceCandidate)

Adds IceCandidate for the State.

pub fn apply_local_sdp(&self, sdp: String)

Marks current local SDP as approved by server.

pub fn stop_timeouts(&self)

Stops all timeouts of the State.

Stops local SDP rollback timeout.

pub fn resume_timeouts(&self)

Resumes all timeouts of the State.

Resumes local SDP rollback timeout.

pub fn local_stream_update_result(
    &self,
    tracks_ids: HashSet<TrackId>
) -> LocalBoxFuture<'static, Result<(), Traced<PeerError>>>

Returns Future resolving once getUserMedia()/getDisplayMedia() request for the provided TrackIds is resolved.

Result returned by this Future will be the same as the result of the getUserMedia()/getDisplayMedia() request.

Returns last known getUserMedia()/getDisplayMedia() request’s Result, if currently no such requests are running for the provided TrackIds.

pub fn when_all_updated(&self) -> AllProcessed<'static>

Returns Future resolving when all sender::State’s and receiver::State’s updates will be applied.

pub fn insert_track(
    &self,
    track: &Track,
    send_constraints: LocalTracksConstraints
) -> Result<(), Traced<PeerError>>

Inserts the provided proto::Track to this State.

Errors

Errors with PeerError::MediaConnections if sender::State creation fails.

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

Patches sender::State or receiver::State with the provided proto::TrackPatchEvent.

Schedules a local stream update.

#[must_use]pub fn current_sdp_offer(&self) -> Option<String>

Returns the current SDP offer of this State.

Trait Implementations

impl AsProtoState for State

type Output = Peer

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 SynchronizableState for State

type Input = Peer

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

fn from_proto(from: Self::Input, send_cons: &LocalTracksConstraints) -> Self

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

fn apply(&self, state: Self::Input, send_cons: &LocalTracksConstraints)

Updates this state with a provided medea_client_api_proto::state.

impl Updatable for State

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

Returns Future resolving once this Updatable state resolves its intentions.

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

Returns Future resolving once all the client updates are performed on this state.

fn connection_lost(&self)

Notifies about a RPC connection loss.

fn connection_recovered(&self)

Notifies about a RPC connection recovering.