Struct script::dom::rtcpeerconnection::RTCPeerConnection

#[repr(C)]
pub struct RTCPeerConnection {
    eventtarget: EventTarget,
    controller: DomRefCell<Option<WebRtcController>>,
    closed: Cell<bool>,
    offer_answer_generation: Cell<u32>,
    offer_promises: DomRefCell<Vec<Rc<Promise>>>,
    answer_promises: DomRefCell<Vec<Rc<Promise>>>,
    local_description: MutNullableDom<RTCSessionDescription>,
    remote_description: MutNullableDom<RTCSessionDescription>,
    gathering_state: Cell<RTCIceGatheringState>,
    ice_connection_state: Cell<RTCIceConnectionState>,
    signaling_state: Cell<RTCSignalingState>,
    data_channels: DomRefCell<HashMap<DataChannelId, Dom<RTCDataChannel>>>,
}

Fields

eventtarget: EventTarget

controller: DomRefCell<Option<WebRtcController>>

closed: Cell<bool>

offer_answer_generation: Cell<u32>

offer_promises: DomRefCell<Vec<Rc<Promise>>>

answer_promises: DomRefCell<Vec<Rc<Promise>>>

local_description: MutNullableDom<RTCSessionDescription>

remote_description: MutNullableDom<RTCSessionDescription>

gathering_state: Cell<RTCIceGatheringState>

ice_connection_state: Cell<RTCIceConnectionState>

signaling_state: Cell<RTCSignalingState>

data_channels: DomRefCell<HashMap<DataChannelId, Dom<RTCDataChannel>>>

Implementations

impl RTCPeerConnection

fn __assert_parent_type(&self)

impl RTCPeerConnection

pub fn new_inherited() -> RTCPeerConnection

fn new( global: &GlobalScope, proto: Option<HandleObject<'_>>, config: &RTCConfiguration, can_gc: CanGc, ) -> Root<Dom<RTCPeerConnection>>

pub fn get_webrtc_controller(&self) -> &DomRefCell<Option<WebRtcController>>

fn make_signaller(&self) -> Box<dyn WebRtcSignaller>

fn on_ice_candidate(&self, candidate: IceCandidate, can_gc: CanGc)

fn on_negotiation_needed(&self, can_gc: CanGc)

fn on_add_stream(&self, id: MediaStreamId, ty: MediaStreamType, can_gc: CanGc)

fn on_data_channel_event( &self, channel_id: DataChannelId, event: DataChannelEvent, can_gc: CanGc, )

pub fn register_data_channel(&self, id: DataChannelId, channel: &RTCDataChannel)

pub fn unregister_data_channel(&self, id: &DataChannelId)

fn update_gathering_state(&self, state: GatheringState, can_gc: CanGc)

https://www.w3.org/TR/webrtc/#update-ice-gathering-state

fn update_ice_connection_state(&self, state: IceConnectionState, can_gc: CanGc)

https://www.w3.org/TR/webrtc/#update-ice-connection-state

fn update_signaling_state(&self, state: SignalingState, can_gc: CanGc)

fn create_offer(&self)

fn create_answer(&self)

Trait Implementations

impl Castable for RTCPeerConnection

fn is<T>(&self) -> bool

where T: DerivedFrom<Self>,

Check whether a DOM object implements one of its deriving interfaces.

fn upcast<T>(&self) -> &T

where T: Castable, Self: DerivedFrom<T>,

Cast a DOM object upwards to one of the interfaces it derives from.

fn downcast<T>(&self) -> Option<&T>

where T: DerivedFrom<Self>,

Cast a DOM object downwards to one of the interfaces it might implement.

impl DomObject for RTCPeerConnection

fn reflector(&self) -> &Reflector

Returns the receiver’s reflector.

fn global(&self) -> Root<Dom<GlobalScope>>

where Self: Sized,

Returns the global scope of the realm that the DomObject was created in.

impl DomObjectWrap for RTCPeerConnection

const WRAP: unsafe fn(_: SafeJSContext, _: &GlobalScope, _: Option<HandleObject<'_>>, _: Box<Self>, _: CanGc) -> Root<Dom<Self>> = {dom::bindings::codegen::Bindings::RTCPeerConnectionBinding::RTCPeerConnection_Binding::Wrap as for<'a, 'b> unsafe fn(script_runtime::JSContext, &'a dom::globalscope::GlobalScope, std::option::Option<js::rust::Handle<'b, *mut js::jsapi::JSObject>>, std::boxed::Box<dom::rtcpeerconnection::RTCPeerConnection>, script_runtime::CanGc) -> dom::bindings::root::Root<dom::bindings::root::Dom<dom::rtcpeerconnection::RTCPeerConnection>>}

Function pointer to the general wrap function type

impl HasParent for RTCPeerConnection

fn as_parent(&self) -> &EventTarget

This is used in a type assertion to ensure that the source and webidls agree as to what the parent type is

type Parent = EventTarget

impl IDLInterface for RTCPeerConnection

fn derives(class: &'static DOMClass) -> bool

Returns whether the given DOM class derives that interface.

impl MallocSizeOf for RTCPeerConnection

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl MutDomObject for RTCPeerConnection

unsafe fn init_reflector(&self, obj: *mut JSObject)

Initializes the Reflector

impl PartialEq for RTCPeerConnection

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RTCPeerConnectionMethods<DomTypeHolder> for RTCPeerConnection

fn AddIceCandidate( &self, candidate: &RTCIceCandidateInit, comp: InRealm<'_>, can_gc: CanGc, ) -> Rc<Promise>

https://w3c.github.io/webrtc-pc/#dom-rtcpeerconnection-addicecandidate

fn CreateOffer( &self, _options: &RTCOfferOptions, comp: InRealm<'_>, can_gc: CanGc, ) -> Rc<Promise>

https://w3c.github.io/webrtc-pc/#dom-rtcpeerconnection-createoffer

fn CreateAnswer( &self, _options: &RTCAnswerOptions, comp: InRealm<'_>, can_gc: CanGc, ) -> Rc<Promise>

https://w3c.github.io/webrtc-pc/#dom-rtcpeerconnection-createoffer

fn GetLocalDescription(&self) -> Option<Root<Dom<RTCSessionDescription>>>

https://w3c.github.io/webrtc-pc/#dom-rtcpeerconnection-localdescription

fn GetRemoteDescription(&self) -> Option<Root<Dom<RTCSessionDescription>>>

https://w3c.github.io/webrtc-pc/#dom-rtcpeerconnection-remotedescription

fn SetLocalDescription( &self, desc: &RTCSessionDescriptionInit, comp: InRealm<'_>, can_gc: CanGc, ) -> Rc<Promise>

https://w3c.github.io/webrtc-pc/#dom-rtcpeerconnection-setlocaldescription

fn SetRemoteDescription( &self, desc: &RTCSessionDescriptionInit, comp: InRealm<'_>, can_gc: CanGc, ) -> Rc<Promise>

https://w3c.github.io/webrtc-pc/#dom-rtcpeerconnection-setremotedescription

fn IceGatheringState(&self) -> RTCIceGatheringState

https://www.w3.org/TR/webrtc/#dom-rtcpeerconnection-icegatheringstate

fn IceConnectionState(&self) -> RTCIceConnectionState

https://www.w3.org/TR/webrtc/#dom-rtcpeerconnection-iceconnectionstate

fn SignalingState(&self) -> RTCSignalingState

https://www.w3.org/TR/webrtc/#dom-rtcpeerconnection-signalingstate

fn Close(&self, can_gc: CanGc)

https://www.w3.org/TR/webrtc/#dom-rtcpeerconnection-close

fn CreateDataChannel( &self, label: USVString, init: &RTCDataChannelInit, ) -> Root<Dom<RTCDataChannel>>

https://www.w3.org/TR/webrtc/#dom-peerconnection-createdatachannel

fn AddTransceiver( &self, _track_or_kind: MediaStreamTrackOrString, init: &RTCRtpTransceiverInit, ) -> Root<Dom<RTCRtpTransceiver>>

https://w3c.github.io/webrtc-pc/#dom-rtcpeerconnection-addtransceiver

fn Constructor( window: &Window, proto: Option<HandleObject<'_>>, can_gc: CanGc, config: &RTCConfiguration, ) -> Result<Root<Dom<RTCPeerConnection>>, Error>

fn GetOnicecandidate(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnicecandidate(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOntrack(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOntrack(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOniceconnectionstatechange(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOniceconnectionstatechange( &self, listener: Option<Rc<EventHandlerNonNull>>, )

fn GetOnicegatheringstatechange(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnicegatheringstatechange( &self, listener: Option<Rc<EventHandlerNonNull>>, )

fn GetOnnegotiationneeded(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnnegotiationneeded(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOnsignalingstatechange(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnsignalingstatechange(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOndatachannel(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOndatachannel(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn AddStream(&self, stream: &MediaStream)

impl ToJSValConvertible for RTCPeerConnection

unsafe fn to_jsval(&self, cx: *mut JSContext, rval: MutableHandleValue<'_>)

Convert self to a JSVal. JSAPI failure causes a panic.

impl Traceable for RTCPeerConnection

unsafe fn trace(&self, tracer: *mut JSTracer)

Trace self.

impl DerivedFrom<EventTarget> for RTCPeerConnection

impl Eq for RTCPeerConnection