Skip to main content

API

Struct API 

Source
pub struct API { /* private fields */ }
Expand description

API bundles the global functions of the WebRTC and ORTC API. Some of these functions are also exported globally using the defaultAPI object. Note that the global version of the API may be phased out in the future.

Implementations§

Source§

impl API

Source

pub async fn new_peer_connection( &self, configuration: RTCConfiguration, ) -> Result<RTCPeerConnection>

new_peer_connection creates a new PeerConnection with the provided configuration against the received API object

Source

pub fn new_ice_gatherer( &self, opts: RTCIceGatherOptions, ) -> Result<RTCIceGatherer>

new_ice_gatherer creates a new ice gatherer. This constructor is part of the ORTC API. It is not meant to be used together with the basic WebRTC API.

Source

pub fn new_ice_transport( &self, gatherer: Arc<RTCIceGatherer>, ) -> RTCIceTransport

new_ice_transport creates a new ice transport. This constructor is part of the ORTC API. It is not meant to be used together with the basic WebRTC API.

Source

pub fn new_dtls_transport( &self, ice_transport: Arc<RTCIceTransport>, certificates: Vec<RTCCertificate>, ) -> Result<RTCDtlsTransport>

new_dtls_transport creates a new dtls_transport transport. This constructor is part of the ORTC API. It is not meant to be used together with the basic WebRTC API.

Source

pub fn new_sctp_transport( &self, dtls_transport: Arc<RTCDtlsTransport>, ) -> Result<RTCSctpTransport>

new_sctp_transport creates a new SCTPTransport. This constructor is part of the ORTC API. It is not meant to be used together with the basic WebRTC API.

Source

pub async fn new_data_channel( &self, sctp_transport: Arc<RTCSctpTransport>, params: DataChannelParameters, ) -> Result<RTCDataChannel>

new_data_channel creates a new DataChannel. This constructor is part of the ORTC API. It is not meant to be used together with the basic WebRTC API.

Source

pub fn new_rtp_receiver( &self, kind: RTPCodecType, transport: Arc<RTCDtlsTransport>, interceptor: Arc<dyn Interceptor + Send + Sync>, ) -> RTCRtpReceiver

new_rtp_receiver constructs a new RTPReceiver

Source

pub async fn new_rtp_sender( &self, track: Option<Arc<dyn TrackLocal + Send + Sync>>, transport: Arc<RTCDtlsTransport>, interceptor: Arc<dyn Interceptor + Send + Sync>, ) -> RTCRtpSender

new_rtp_sender constructs a new RTPSender

Source

pub fn setting_engine(&self) -> Arc<SettingEngine>

Returns the internal SettingEngine.

Source

pub fn media_engine(&self) -> Arc<MediaEngine>

Returns the internal MediaEngine.

Auto Trait Implementations§

§

impl Freeze for API

§

impl !RefUnwindSafe for API

§

impl Send for API

§

impl Sync for API

§

impl Unpin for API

§

impl !UnwindSafe for API

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> ErasedDestructor for T
where T: 'static,