Struct gdnative::WebRTCPeerConnection

pub struct WebRTCPeerConnection { /* fields omitted */ }

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:

• Reference
• Object

Methods

impl WebRTCPeerConnection

Constants

pub const STATE_CLOSED: i64

pub const STATE_CONNECTING: i64

pub const STATE_FAILED: i64

pub const STATE_CONNECTED: i64

pub const STATE_DISCONNECTED: i64

pub const STATE_NEW: i64

impl WebRTCPeerConnection

pub fn new() -> WebRTCPeerConnection

pub fn new_ref(&self) -> WebRTCPeerConnection

Creates a new reference to the same reference-counted object.

pub fn add_ice_candidate(
    &mut self,
    media: GodotString,
    index: i64,
    name: GodotString
) -> Result<(), GodotError>

pub fn close(&mut self)

pub fn create_data_channel(
    &mut self,
    label: GodotString,
    options: Dictionary
) -> Option<WebRTCDataChannel>

pub fn create_offer(&mut self) -> Result<(), GodotError>

pub fn get_connection_state(&self) -> WebRTCPeerConnectionConnectionState

pub fn initialize(
    &mut self,
    configuration: Dictionary
) -> Result<(), GodotError>

pub fn poll(&mut self) -> Result<(), GodotError>

pub fn set_local_description(
    &mut self,
    _type: GodotString,
    sdp: GodotString
) -> Result<(), GodotError>

pub fn set_remote_description(
    &mut self,
    _type: GodotString,
    sdp: GodotString
) -> Result<(), GodotError>

pub fn init_ref(&mut self) -> bool

Inherited from Reference.

pub fn to_reference(&self) -> Reference

Up-cast.

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Methods from Deref<Target = Reference>

pub fn new_ref(&self) -> Reference

Creates a new reference to the same reference-counted object.

pub fn init_ref(&mut self) -> bool

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for WebRTCPeerConnection

fn clone(&self) -> WebRTCPeerConnection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebRTCPeerConnection

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

Formats the value using the given formatter.

impl Deref for WebRTCPeerConnection

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for WebRTCPeerConnection

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

Mutably dereferences the value.

impl Drop for WebRTCPeerConnection

fn drop(&mut self)

Executes the destructor for this type.

impl FromVariant for WebRTCPeerConnection

fn from_variant(
    variant: &Variant
) -> Result<WebRTCPeerConnection, FromVariantError>

impl GodotObject for WebRTCPeerConnection

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> WebRTCPeerConnection

unsafe fn from_return_position_sys(obj: *mut c_void) -> WebRTCPeerConnection

unsafe fn to_sys(&self) -> *mut c_void

impl Instanciable for WebRTCPeerConnection

fn construct() -> WebRTCPeerConnection

impl ToVariant for WebRTCPeerConnection

fn to_variant(&self) -> Variant