Struct ConnectionHandle 

pub struct ConnectionHandle(/* private fields */);

External handler to a Connection with a remote Member.

Actually, represents a Weak-based handle to InnerConnection.

Implementations

impl ConnectionHandle

pub fn on_close( &self, f: Function<()>, ) -> Result<(), Traced<HandleDetachedError>>

Sets callback, invoked when this Connection will close.

Errors

See HandleDetachedError for details.

pub fn get_remote_member_id( &self, ) -> Result<String, Traced<HandleDetachedError>>

Returns remote Member ID.

Errors

See HandleDetachedError for details.

pub fn on_remote_track_added( &self, f: Function<RemoteMediaTrack>, ) -> Result<(), Traced<HandleDetachedError>>

Sets callback, invoked when a new remote::Track is added to this Connection.

Errors

See HandleDetachedError for details.

pub fn on_quality_score_update( &self, f: Function<u8>, ) -> Result<(), Traced<HandleDetachedError>>

Sets callback, invoked when a connection quality score is updated by a server.

Errors

See HandleDetachedError for details.

pub fn enable_remote_video( &self, source_kind: Option<MediaSourceKind>, ) -> impl Future<Output = Result<(), Traced<ChangeMediaStateError>>> + 'static + use<>

Enables inbound video in this Connection.

Errors

With ChangeMediaStateError::Detached if an inner Weak pointer upgrade fails.

With ChangeMediaStateError::TransitionIntoOppositeState if ConnectionHandle::disable_remote_video() was called while enabling or a media server didn’t approve this state transition.

pub fn disable_remote_video( &self, source_kind: Option<MediaSourceKind>, ) -> impl Future<Output = Result<(), Traced<ChangeMediaStateError>>> + 'static + use<>

Disables inbound video in this Connection.

Errors

With ChangeMediaStateError::Detached if an inner Weak pointer upgrade fails.

With ChangeMediaStateError::TransitionIntoOppositeState if ConnectionHandle::enable_remote_video() was called while disabling or a media server didn’t approve this state transition.

pub fn enable_remote_audio( &self, ) -> impl Future<Output = Result<(), Traced<ChangeMediaStateError>>> + 'static + use<>

Enables inbound audio in this Connection.

Errors

With ChangeMediaStateError::Detached if an inner Weak pointer upgrade fails.

With ChangeMediaStateError::TransitionIntoOppositeState if ConnectionHandle::disable_remote_audio() was called while enabling or a media server didn’t approve this state transition.

pub fn disable_remote_audio( &self, ) -> impl Future<Output = Result<(), Traced<ChangeMediaStateError>>> + 'static + use<>

Disables inbound audio in this Connection.

Errors

With ChangeMediaStateError::Detached if an inner Weak pointer upgrade fails.

With ChangeMediaStateError::TransitionIntoOppositeState if ConnectionHandle::enable_remote_audio() was called while disabling or a media server didn’t approve this state transition.

Trait Implementations

impl Clone for ConnectionHandle

fn clone(&self) -> ConnectionHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionHandle

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

Formats the value using the given formatter.

impl From<ConnectionHandle> for ConnectionHandle

fn from(value: ConnectionHandle) -> Self

Converts to this type from the input type.