Struct RtcPeerConnection 

pub struct RtcPeerConnection { /* private fields */ }

Representation of RTCPeerConnection.

Implementations

impl RtcPeerConnection

pub async fn new<I>( ice_servers: I, is_force_relayed: bool, ) -> Result<Self, Traced<RtcPeerConnectionError>>

where I: IntoIterator<Item = IceServer>,

Instantiates a new RtcPeerConnection.

Errors

Errors with RtcPeerConnectionError::PeerCreationError if RtcPeerConnection creation fails.

pub async fn get_stats( &self, ) -> Result<RtcStats, Traced<RtcPeerConnectionError>>

Returns RtcStats of this RtcPeerConnection.

pub fn on_track<F>(&self, handler: Option<F>)

where F: 'static + FnMut(MediaStreamTrack, Transceiver),

Sets handler for a RTCTrackEvent (see ontrack callback).

pub fn on_ice_candidate<F>(&self, handler: Option<F>)

where F: 'static + FnMut(IceCandidate),

Sets handler for a RTCPeerConnectionIceEvent (see onicecandidate callback).

pub fn on_ice_candidate_error<F>(&self, handler: Option<F>)

where F: 'static + FnMut(IceCandidateError),

Sets handler for an RTCPeerConnectionIceEvent (see the onicecandidateerror callback).

pub fn ice_connection_state(&self) -> IceConnectionState

Returns IceConnectionState of this RtcPeerConnection.

pub fn connection_state(&self) -> PeerConnectionState

Returns PeerConnectionState of this RtcPeerConnection.

pub fn on_ice_connection_state_change<F>(&self, handler: Option<F>)

where F: 'static + FnMut(IceConnectionState),

Sets handler for an iceconnectionstatechange event.

pub fn on_connection_state_change<F>(&self, handler: Option<F>)

where F: 'static + FnMut(PeerConnectionState),

Sets handler for a connectionstatechange event.

pub async fn add_ice_candidate( &self, candidate: &str, sdp_m_line_index: Option<u16>, sdp_mid: &Option<String>, ) -> Result<(), Traced<RtcPeerConnectionError>>

Adds remote RTCPeerConnection’s ICE candidate to this RtcPeerConnection.

Errors

With RtcPeerConnectionError::AddIceCandidateFailed if RtcPeerConnection.addIceCandidate() fails.

pub fn restart_ice(&self)

Marks RtcPeerConnection to trigger ICE restart.

After this function returns, the offer returned by the next call to RtcPeerConnection::create_offer is automatically configured to trigger ICE restart.

pub async fn set_offer( &self, offer: &str, ) -> Result<(), Traced<RtcPeerConnectionError>>

Sets provided SDP offer as local description.

Errors

With RtcPeerConnectionError::SetLocalDescriptionFailed if RtcPeerConnection.setLocalDescription() fails.

pub async fn set_answer( &self, answer: &str, ) -> Result<(), Traced<RtcPeerConnectionError>>

Sets the provided SDP answer as local description.

Errors

With RtcPeerConnectionError::SetLocalDescriptionFailed if RtcPeerConnection.setLocalDescription() fails.

pub async fn create_answer( &self, ) -> Result<String, Traced<RtcPeerConnectionError>>

Obtains SDP answer from the RtcPeerConnection.

Should be called whenever remote description has been changed.

Errors

With RtcPeerConnectionError::CreateAnswerFailed if RtcPeerConnection.createAnswer() fails.

pub async fn rollback(&self) -> Result<(), Traced<RtcPeerConnectionError>>

Rollbacks the RtcPeerConnection to the previous stable state.

Errors

With RtcPeerConnectionError::SetLocalDescriptionFailed if RtcPeerConnection.setLocalDescription() fails.

pub async fn create_offer( &self, ) -> Result<String, Traced<RtcPeerConnectionError>>

Obtains SDP offer from the RtcPeerConnection.

Should be called after local tracks changes, which require (re)negotiation.

Errors

With RtcPeerConnectionError::CreateOfferFailed if RtcPeerConnection.createOffer() fails.

pub async fn set_remote_description( &self, sdp: SdpType, ) -> Result<(), Traced<RtcPeerConnectionError>>

Instructs the RtcPeerConnection to apply the supplied SDP as the remote offer or answer.

Changes the local media state.

Errors

With RtcPeerConnectionError::SetRemoteDescriptionFailed if RTCPeerConnection.setRemoteDescription() fails.

pub async fn add_transceiver( &self, kind: MediaKind, init: TransceiverInit, ) -> Transceiver

Creates a new Transceiver (see RTCRtpTransceiver) and adds it to the set of this RTCPeerConnection’s transceivers.

pub fn get_transceiver_by_mid( &self, mid: String, ) -> impl Future<Output = Option<Transceiver>> + 'static + use<>

Returns Transceiver (see RTCRtpTransceiver) from a set of this RTCPeerConnection’s transceivers by provided mid.

Trait Implementations

impl Clone for RtcPeerConnection

fn clone(&self) -> RtcPeerConnection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RtcPeerConnection

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

Formats the value using the given formatter.

impl Drop for RtcPeerConnection

fn drop(&mut self)

Executes the destructor for this type.