[−][src]Struct gdnative::api::AudioStreamSample
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:
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
[src]
Constants
pub const FORMAT_16_BITS: i64
[src]
pub const FORMAT_8_BITS: i64
[src]
pub const FORMAT_IMA_ADPCM: i64
[src]
pub const LOOP_BACKWARD: i64
[src]
pub const LOOP_DISABLED: i64
[src]
pub const LOOP_FORWARD: i64
[src]
pub const LOOP_PING_PONG: i64
[src]
impl AudioStreamSample
[src]
pub fn new() -> Ref<AudioStreamSample, Unique>
[src]
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) -> TypedArray<u8>
[src]
pub fn format(&self) -> Format
[src]
pub fn loop_begin(&self) -> i64
[src]
pub fn loop_end(&self) -> i64
[src]
pub fn loop_mode(&self) -> LoopMode
[src]
pub fn mix_rate(&self) -> i64
[src]
pub fn is_stereo(&self) -> bool
[src]
pub fn save_to_wav(
&self,
path: impl Into<GodotString>
) -> Result<(), GodotError>
[src]
&self,
path: impl Into<GodotString>
) -> Result<(), GodotError>
pub fn set_data(&self, data: TypedArray<u8>)
[src]
pub fn set_format(&self, format: i64)
[src]
pub fn set_loop_begin(&self, loop_begin: i64)
[src]
pub fn set_loop_end(&self, loop_end: i64)
[src]
pub fn set_loop_mode(&self, loop_mode: i64)
[src]
pub fn set_mix_rate(&self, mix_rate: i64)
[src]
pub fn set_stereo(&self, stereo: bool)
[src]
Methods from Deref<Target = AudioStream>
pub fn get_length(&self) -> f64
[src]
Trait Implementations
impl Debug for AudioStreamSample
[src]
impl Deref for AudioStreamSample
[src]
type Target = AudioStream
The resulting type after dereferencing.
fn deref(&self) -> &AudioStream
[src]
impl DerefMut for AudioStreamSample
[src]
fn deref_mut(&mut self) -> &mut AudioStream
[src]
impl GodotObject for AudioStreamSample
[src]
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. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for AudioStreamSample
[src]
fn construct() -> Ref<AudioStreamSample, Unique>
[src]
impl SubClass<AudioStream> for AudioStreamSample
[src]
impl SubClass<Object> for AudioStreamSample
[src]
impl SubClass<Reference> for AudioStreamSample
[src]
impl SubClass<Resource> for AudioStreamSample
[src]
Auto Trait Implementations
impl RefUnwindSafe for AudioStreamSample
impl !Send for AudioStreamSample
impl !Sync for AudioStreamSample
impl Unpin for AudioStreamSample
impl UnwindSafe for AudioStreamSample
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,