[−][src]Struct gdnative_bindings::WebRTCPeerConnection
core class WebRTCPeerConnection
inherits Reference
(reference counted).
Official documentation
See the documentation of this class in the Godot engine's official documentation.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
WebRTCPeerConnection inherits methods from:
Safety
All types in the Godot API have "interior mutability" in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
impl WebRTCPeerConnection
[src]
Constants
pub const STATE_CLOSED: i64
[src]
pub const STATE_CONNECTED: i64
[src]
pub const STATE_CONNECTING: i64
[src]
pub const STATE_DISCONNECTED: i64
[src]
pub const STATE_FAILED: i64
[src]
pub const STATE_NEW: i64
[src]
impl WebRTCPeerConnection
[src]
pub fn new() -> Ref<Self, Unique>
[src]
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
pub fn add_ice_candidate(
&self,
media: impl Into<GodotString>,
index: i64,
name: impl Into<GodotString>
) -> GodotResult
[src]
&self,
media: impl Into<GodotString>,
index: i64,
name: impl Into<GodotString>
) -> GodotResult
pub fn close(&self)
[src]
pub fn create_data_channel(
&self,
label: impl Into<GodotString>,
options: Dictionary
) -> Option<Ref<WebRTCDataChannel, Shared>>
[src]
&self,
label: impl Into<GodotString>,
options: Dictionary
) -> Option<Ref<WebRTCDataChannel, Shared>>
pub fn create_offer(&self) -> GodotResult
[src]
pub fn get_connection_state(&self) -> ConnectionState
[src]
pub fn initialize(&self, configuration: Dictionary) -> GodotResult
[src]
pub fn poll(&self) -> GodotResult
[src]
pub fn set_local_description(
&self,
_type: impl Into<GodotString>,
sdp: impl Into<GodotString>
) -> GodotResult
[src]
&self,
_type: impl Into<GodotString>,
sdp: impl Into<GodotString>
) -> GodotResult
pub fn set_remote_description(
&self,
_type: impl Into<GodotString>,
sdp: impl Into<GodotString>
) -> GodotResult
[src]
&self,
_type: impl Into<GodotString>,
sdp: impl Into<GodotString>
) -> GodotResult
Methods from Deref<Target = Reference>
pub fn init_ref(&self) -> bool
[src]
Initializes the internal reference counter. Use this only if you really know what you are doing.
Returns whether the initialization was successful.
Trait Implementations
impl Debug for WebRTCPeerConnection
[src]
impl Deref for WebRTCPeerConnection
[src]
impl DerefMut for WebRTCPeerConnection
[src]
impl GodotObject for WebRTCPeerConnection
[src]
type RefKind = RefCounted
The memory management kind of this type. This modifies the behavior of the
Ref
smart pointer. See its type-level documentation for more
information. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for WebRTCPeerConnection
[src]
impl Sealed for WebRTCPeerConnection
[src]
impl SubClass<Object> for WebRTCPeerConnection
[src]
impl SubClass<Reference> for WebRTCPeerConnection
[src]
impl SubClass<WebRTCPeerConnection> for WebRTCPeerConnectionGDNative
[src]
Auto Trait Implementations
impl RefUnwindSafe for WebRTCPeerConnection
impl !Send for WebRTCPeerConnection
impl !Sync for WebRTCPeerConnection
impl Unpin for WebRTCPeerConnection
impl UnwindSafe for WebRTCPeerConnection
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,