Struct gdnative_bindings::WebRTCPeerConnectionGDNative

pub struct WebRTCPeerConnectionGDNative { /* fields omitted */ }

core class WebRTCPeerConnectionGDNative inherits WebRTCPeerConnection (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

WebRTCPeerConnectionGDNative inherits methods from:

• WebRTCPeerConnection
• Reference
• Object

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 WebRTCPeerConnectionGDNative

pub fn new() -> Ref<Self, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

Methods from Deref<Target = WebRTCPeerConnection>

pub const STATE_CLOSED: i64

pub const STATE_CONNECTED: i64

pub const STATE_CONNECTING: i64

pub const STATE_DISCONNECTED: i64

pub const STATE_FAILED: i64

pub const STATE_NEW: i64

pub fn add_ice_candidate(
    &self,
    media: impl Into<GodotString>,
    index: i64,
    name: impl Into<GodotString>
) -> GodotResult

pub fn close(&self)

pub fn create_data_channel(
    &self,
    label: impl Into<GodotString>,
    options: Dictionary
) -> Option<Ref<WebRTCDataChannel, Shared>>

pub fn create_offer(&self) -> GodotResult

pub fn get_connection_state(&self) -> ConnectionState

pub fn initialize(&self, configuration: Dictionary) -> GodotResult

pub fn poll(&self) -> GodotResult

pub fn set_local_description(
    &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

Trait Implementations

impl Debug for WebRTCPeerConnectionGDNative

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

Formats the value using the given formatter.

impl Deref for WebRTCPeerConnectionGDNative

type Target = WebRTCPeerConnection

The resulting type after dereferencing.

fn deref(&self) -> &WebRTCPeerConnection

Dereferences the value.

impl DerefMut for WebRTCPeerConnectionGDNative

fn deref_mut(&mut self) -> &mut WebRTCPeerConnection

Mutably dereferences the value.

impl GodotObject for WebRTCPeerConnectionGDNative

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.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for WebRTCPeerConnectionGDNative

fn construct() -> Ref<Self, Unique>

impl Sealed for WebRTCPeerConnectionGDNative

impl SubClass<Object> for WebRTCPeerConnectionGDNative

impl SubClass<Reference> for WebRTCPeerConnectionGDNative

impl SubClass<WebRTCPeerConnection> for WebRTCPeerConnectionGDNative