Struct godot::classes::AudioStreamInteractive

#[repr(C)]
pub struct AudioStreamInteractive { /* private fields */ }

Godot class AudioStreamInteractive.

Inherits AudioStream.

Related symbols:

• audio_stream_interactive: sidecar module with related enum/flag types
• IAudioStreamInteractive: virtual methods

See also Godot docs for AudioStreamInteractive.

Construction

This class is reference-counted. You can create a new instance using AudioStreamInteractive::new_gd().

Implementations

impl AudioStreamInteractive

pub fn set_clip_count(&mut self, clip_count: i32)

pub fn get_clip_count(&self) -> i32

pub fn set_initial_clip(&mut self, clip_index: i32)

pub fn get_initial_clip(&self) -> i32

pub fn set_clip_name(&mut self, clip_index: i32, name: StringName)

pub fn get_clip_name(&self, clip_index: i32) -> StringName

pub fn set_clip_stream(&mut self, clip_index: i32, stream: Gd<AudioStream>)

pub fn get_clip_stream(&self, clip_index: i32) -> Option<Gd<AudioStream>>

pub fn set_clip_auto_advance(&mut self, clip_index: i32, mode: AutoAdvanceMode)

pub fn get_clip_auto_advance(&self, clip_index: i32) -> AutoAdvanceMode

pub fn set_clip_auto_advance_next_clip( &mut self, clip_index: i32, auto_advance_next_clip: i32, )

pub fn get_clip_auto_advance_next_clip(&self, clip_index: i32) -> i32

pub fn add_transition( &mut self, from_clip: i32, to_clip: i32, from_time: TransitionFromTime, to_time: TransitionToTime, fade_mode: FadeMode, fade_beats: f32, )

pub fn add_transition_ex( &mut self, from_clip: i32, to_clip: i32, from_time: TransitionFromTime, to_time: TransitionToTime, fade_mode: FadeMode, fade_beats: f32, ) -> ExAddTransition<'_>

pub fn has_transition(&self, from_clip: i32, to_clip: i32) -> bool

pub fn erase_transition(&mut self, from_clip: i32, to_clip: i32)

pub fn get_transition_list(&self) -> PackedInt32Array

pub fn get_transition_from_time( &self, from_clip: i32, to_clip: i32, ) -> TransitionFromTime

pub fn get_transition_to_time( &self, from_clip: i32, to_clip: i32, ) -> TransitionToTime

pub fn get_transition_fade_mode(&self, from_clip: i32, to_clip: i32) -> FadeMode

pub fn get_transition_fade_beats(&self, from_clip: i32, to_clip: i32) -> f32

pub fn is_transition_using_filler_clip( &self, from_clip: i32, to_clip: i32, ) -> bool

pub fn get_transition_filler_clip(&self, from_clip: i32, to_clip: i32) -> i32

pub fn is_transition_holding_previous( &self, from_clip: i32, to_clip: i32, ) -> bool

pub const CLIP_ANY: i32 = -1i32

Methods from Deref<Target = AudioStream>

pub fn get_length(&self) -> f64

pub fn is_monophonic(&self) -> bool

pub fn instantiate_playback(&mut self) -> Option<Gd<AudioStreamPlayback>>

pub fn can_be_sampled(&self) -> bool

pub fn generate_sample(&self) -> Option<Gd<AudioSample>>

pub fn is_meta_stream(&self) -> bool

Methods from Deref<Target = Resource>

pub fn set_path(&mut self, path: GString)

pub fn take_over_path(&mut self, path: GString)

pub fn get_path(&self) -> GString

pub fn set_name(&mut self, name: GString)

pub fn get_name(&self) -> GString

pub fn get_rid(&self) -> Rid

pub fn set_local_to_scene(&mut self, enable: bool)

pub fn is_local_to_scene(&self) -> bool

pub fn get_local_scene(&self) -> Option<Gd<Node>>

pub fn setup_local_to_scene(&mut self)

pub fn set_scene_unique_id(&mut self, id: GString)

pub fn get_scene_unique_id(&self) -> GString

pub fn emit_changed(&mut self)

pub fn duplicate(&self) -> Option<Gd<Resource>>

pub fn duplicate_ex(&self) -> ExDuplicate<'_>

Methods from Deref<Target = RefCounted>

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: GString) -> bool

pub fn set(&mut self, property: StringName, value: Variant)

pub fn get(&self, property: StringName) -> Variant

pub fn set_indexed(&mut self, property_path: NodePath, value: Variant)

pub fn get_indexed(&self, property_path: NodePath) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: StringName) -> bool

pub fn property_get_revert(&self, property: StringName) -> Variant

pub fn set_script(&mut self, script: Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: StringName, value: Variant)

pub fn remove_meta(&mut self, name: StringName)

pub fn get_meta(&self, name: StringName) -> Variant

pub fn get_meta_ex(&self, name: StringName) -> ExGetMeta<'_>

pub fn has_meta(&self, name: StringName) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: GString)

pub fn add_user_signal_ex(&mut self, signal: GString) -> ExAddUserSignal<'_>

pub fn has_user_signal(&self, signal: StringName) -> bool

pub fn remove_user_signal(&mut self, signal: StringName)

pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: StringName, varargs: &[Variant], ) -> Result<Error, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred(&mut self, property: StringName, value: Variant)

pub fn callv(&mut self, method: StringName, arg_array: OutArray) -> Variant

pub fn has_method(&self, method: StringName) -> bool

pub fn get_method_argument_count(&self, method: StringName) -> i32

pub fn has_signal(&self, signal: StringName) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: StringName, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error

pub fn connect_ex( &mut self, signal: StringName, callable: Callable, ) -> ExConnect<'_>

pub fn disconnect(&mut self, signal: StringName, callable: Callable)

pub fn is_connected(&self, signal: StringName, callable: Callable) -> bool

pub fn set_block_signals(&mut self, enable: bool)

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

pub fn set_message_translation(&mut self, enable: bool)

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: StringName) -> GString

pub fn tr_ex(&self, message: StringName) -> ExTr<'_>

pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32, ) -> GString

pub fn tr_n_ex( &self, message: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'_>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.

pub fn notify_reversed(&mut self, what: ObjectNotification)

⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.

See docs of that method, including the panics.

Trait Implementations

impl Bounds for AudioStreamInteractive

type Memory = MemRefCounted

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for AudioStreamInteractive

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

Formats the value using the given formatter.

impl Deref for AudioStreamInteractive

type Target = AudioStream

The resulting type after dereferencing.

fn deref(&self) -> &<AudioStreamInteractive as Deref>::Target

Dereferences the value.

impl DerefMut for AudioStreamInteractive

fn deref_mut(&mut self) -> &mut <AudioStreamInteractive as Deref>::Target

Mutably dereferences the value.

impl GodotClass for AudioStreamInteractive

type Base = AudioStream

The immediate superclass of T. This is always a Godot engine class.

fn class_name() -> ClassName

The name of the class, under which it is registered in Godot.

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

fn inherits<U>() -> bool

where U: GodotClass,

Returns whether Self inherits from U.

impl GodotDefault for AudioStreamInteractive

impl Inherits<AudioStream> for AudioStreamInteractive

impl Inherits<Object> for AudioStreamInteractive

impl Inherits<RefCounted> for AudioStreamInteractive

impl Inherits<Resource> for AudioStreamInteractive