Struct gdnative_bindings::AudioStreamSample

pub struct AudioStreamSample { /* fields omitted */ }

core class AudioStreamSample inherits AudioStream (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

AudioStreamSample inherits methods from:

• AudioStream
• Resource
• Reference
• Object

Methods

impl AudioStreamSample

Constants

pub const LOOP_BACKWARD: i64

pub const FORMAT_16_BITS: i64

pub const LOOP_FORWARD: i64

pub const LOOP_DISABLED: i64

pub const LOOP_PING_PONG: i64

pub const FORMAT_8_BITS: i64

pub const FORMAT_IMA_ADPCM: i64

impl AudioStreamSample

pub fn new() -> Self

pub fn new_ref(&self) -> Self

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

pub fn get_data(&self) -> ByteArray

pub fn get_format(&self) -> AudioStreamSampleFormat

pub fn get_loop_begin(&self) -> i64

pub fn get_loop_end(&self) -> i64

pub fn get_loop_mode(&self) -> AudioStreamSampleLoopMode

pub fn get_mix_rate(&self) -> i64

pub fn is_stereo(&self) -> bool

pub fn save_to_wav(&mut self, path: GodotString) -> GodotResult

pub fn set_data(&mut self, data: ByteArray)

pub fn set_format(&mut self, format: i64)

pub fn set_loop_begin(&mut self, loop_begin: i64)

pub fn set_loop_end(&mut self, loop_end: i64)

pub fn set_loop_mode(&mut self, loop_mode: i64)

pub fn set_mix_rate(&mut self, mix_rate: i64)

pub fn set_stereo(&mut self, stereo: bool)

pub fn to_audio_stream(&self) -> AudioStream

Up-cast.

pub fn to_resource(&self) -> Resource

Up-cast.

pub fn to_reference(&self) -> Reference

Up-cast.

pub fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Methods from Deref<Target = AudioStream>

pub fn new_ref(&self) -> Self

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

pub fn get_length(&self) -> f64

pub fn to_resource(&self) -> Resource

Up-cast.

pub fn to_reference(&self) -> Reference

Up-cast.

pub fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Trait Implementations

impl Clone for AudioStreamSample

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioStreamSample

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

Formats the value using the given formatter.

impl Deref for AudioStreamSample

type Target = AudioStream

The resulting type after dereferencing.

fn deref(&self) -> &AudioStream

Dereferences the value.

impl DerefMut for AudioStreamSample

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

Mutably dereferences the value.

impl Drop for AudioStreamSample

fn drop(&mut self)

Executes the destructor for this type.

impl FromVariant for AudioStreamSample

fn from_variant(variant: &Variant) -> Option<Self>

impl GodotObject for AudioStreamSample

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

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

impl Instanciable for AudioStreamSample

fn construct() -> Self

impl ToVariant for AudioStreamSample

fn to_variant(&self) -> Variant