Trait godot::engine::IWebRtcPeerConnectionExtension

pub trait IWebRtcPeerConnectionExtension: GodotClass + You_forgot_the_attribute__godot_api {
Show 16 methods // Provided methods fn init(base: Base<Self::Base>) -> Self { ... } fn to_string(&self) -> GString { ... } fn on_notification(&mut self, what: ObjectNotification) { ... } fn get_property(&self, property: StringName) -> Option<Variant> { ... } fn set_property(&mut self, property: StringName, value: Variant) -> bool { ... } fn get_connection_state(&self) -> ConnectionState { ... } fn get_gathering_state(&self) -> GatheringState { ... } fn get_signaling_state(&self) -> SignalingState { ... } fn initialize(&mut self, p_config: Dictionary) -> Error { ... } fn create_data_channel( &mut self, p_label: GString, p_config: Dictionary ) -> Option<Gd<WebRtcDataChannel>> { ... } fn create_offer(&mut self) -> Error { ... } fn set_remote_description( &mut self, p_type: GString, p_sdp: GString ) -> Error { ... } fn set_local_description( &mut self, p_type: GString, p_sdp: GString ) -> Error { ... } fn add_ice_candidate( &mut self, p_sdp_mid_name: GString, p_sdp_mline_index: i32, p_sdp_name: GString ) -> Error { ... } fn poll(&mut self) -> Error { ... } fn close(&mut self) { ... }
}
Expand description

Virtual methods for class WebRtcPeerConnectionExtension.

These methods represent constructors (init) or callbacks invoked by the engine.

See also Godot docs for WebRTCPeerConnectionExtension methods.

Provided Methods§

fn init(base: Base<Self::Base>) -> Self

Godot constructor, accepting an injected base object.

base refers to the base instance of the class, which can either be stored in a Base<T> field or discarded. This method returns a fully-constructed instance, which will then be moved into a Gd<T> pointer.

If the class has a #[class(init)] attribute, this method will be auto-generated and must not be overridden.

fn to_string(&self) -> GString

String representation of the Godot instance.

Override this method to define how the instance is represented as a string. Used by impl Display for Gd<T>, as well as str() and print() in GDScript.

fn on_notification(&mut self, what: ObjectNotification)

Called when the object receives a Godot notification.

The type of notification can be identified through what. The enum is designed to hold all possible NOTIFICATION_* constants that the current class can handle. However, this is not validated in Godot, so an enum variant Unknown exists to represent integers out of known constants (mistakes or future additions).

This method is named _notification in Godot, but on_notification in Rust. To send notifications, use the Object::notify method.

See also in Godot docs:

fn get_property(&self, property: StringName) -> Option<Variant>

Called whenever get() is called or Godot gets the value of a property.

Should return the given property’s value as Some(value), or None if the property should be handled normally.

See also in Godot docs:

fn set_property(&mut self, property: StringName, value: Variant) -> bool

Called whenever Godot set() is called or Godot sets the value of a property.

Should set property to the given value and return true, or return false to indicate the property should be handled normally.

See also in Godot docs:

fn get_connection_state(&self) -> ConnectionState

fn get_gathering_state(&self) -> GatheringState

fn get_signaling_state(&self) -> SignalingState

fn initialize(&mut self, p_config: Dictionary) -> Error

fn create_data_channel( &mut self, p_label: GString, p_config: Dictionary ) -> Option<Gd<WebRtcDataChannel>>

fn create_offer(&mut self) -> Error

fn set_remote_description(&mut self, p_type: GString, p_sdp: GString) -> Error

fn set_local_description(&mut self, p_type: GString, p_sdp: GString) -> Error

fn add_ice_candidate( &mut self, p_sdp_mid_name: GString, p_sdp_mline_index: i32, p_sdp_name: GString ) -> Error

fn poll(&mut self) -> Error

fn close(&mut self)

Object Safety§

This trait is not object safe.

Implementors§