Struct gdnative_bindings::audio_stream_sample::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

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 AudioStreamSample

Constants

pub const FORMAT_16_BITS: i64

pub const FORMAT_8_BITS: i64

pub const FORMAT_IMA_ADPCM: i64

pub const LOOP_BACKWARD: i64

pub const LOOP_DISABLED: i64

pub const LOOP_FORWARD: i64

pub const LOOP_PING_PONG: i64

impl AudioStreamSample

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.

pub fn data(&self) -> ByteArray

Contains the audio data in bytes.
			[b]Note:[/b] This property expects signed PCM8 data. To convert unsigned PCM8 to signed PCM8, subtract 128 from each byte.

pub fn format(&self) -> Format

Audio format. See [enum Format] constants for values.

pub fn loop_begin(&self) -> i64

The loop start point (in number of samples, relative to the beginning of the sample). This information will be imported automatically from the WAV file if present.

pub fn loop_end(&self) -> i64

The loop end point (in number of samples, relative to the beginning of the sample). This information will be imported automatically from the WAV file if present.

pub fn loop_mode(&self) -> LoopMode

The loop mode. This information will be imported automatically from the WAV file if present. See [enum LoopMode] constants for values.

pub fn mix_rate(&self) -> i64

The sample rate for mixing this audio.

pub fn is_stereo(&self) -> bool

If [code]true[/code], audio is stereo.

pub fn save_to_wav(&self, path: impl Into<GodotString>) -> GodotResult

Saves the AudioStreamSample as a WAV file to [code]path[/code]. Samples with IMA ADPCM format can't be saved.
				[b]Note:[/b] A [code].wav[/code] extension is automatically appended to [code]path[/code] if it is missing.

pub fn set_data(&self, data: ByteArray)

Contains the audio data in bytes.
			[b]Note:[/b] This property expects signed PCM8 data. To convert unsigned PCM8 to signed PCM8, subtract 128 from each byte.

pub fn set_format(&self, format: i64)

Audio format. See [enum Format] constants for values.

pub fn set_loop_begin(&self, loop_begin: i64)

The loop start point (in number of samples, relative to the beginning of the sample). This information will be imported automatically from the WAV file if present.

pub fn set_loop_end(&self, loop_end: i64)

The loop end point (in number of samples, relative to the beginning of the sample). This information will be imported automatically from the WAV file if present.

pub fn set_loop_mode(&self, loop_mode: i64)

The loop mode. This information will be imported automatically from the WAV file if present. See [enum LoopMode] constants for values.

pub fn set_mix_rate(&self, mix_rate: i64)

The sample rate for mixing this audio.

pub fn set_stereo(&self, stereo: bool)

If [code]true[/code], audio is stereo.

Methods from Deref<Target = AudioStream>

pub fn get_length(&self) -> f64

Returns the length of the audio stream in seconds.

Trait Implementations

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 GodotObject for AudioStreamSample

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 AudioStreamSample

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

impl Sealed for AudioStreamSample

impl SubClass<AudioStream> for AudioStreamSample

impl SubClass<Object> for AudioStreamSample

impl SubClass<Reference> for AudioStreamSample

impl SubClass<Resource> for AudioStreamSample