[−][src]Struct gdnative_bindings::AudioEffectRecord
core class AudioEffectRecord
inherits AudioEffect
(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
AudioEffectRecord 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 AudioEffectRecord
[src]
pub fn new() -> Ref<Self, 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 format(&self) -> Format
[src]
Specifies the format in which the sample will be recorded. See [enum AudioStreamSample.Format] for available formats.
pub fn get_recording(&self) -> Option<Ref<AudioStreamSample, Shared>>
[src]
Returns the recorded sample.
pub fn is_recording_active(&self) -> bool
[src]
Returns whether the recording is active or not.
pub fn set_format(&self, format: i64)
[src]
Specifies the format in which the sample will be recorded. See [enum AudioStreamSample.Format] for available formats.
pub fn set_recording_active(&self, record: bool)
[src]
If [code]true[/code], the sound will be recorded. Note that restarting the recording will remove the previously recorded sample.
Trait Implementations
impl Debug for AudioEffectRecord
[src]
impl Deref for AudioEffectRecord
[src]
type Target = AudioEffect
The resulting type after dereferencing.
fn deref(&self) -> &AudioEffect
[src]
impl DerefMut for AudioEffectRecord
[src]
fn deref_mut(&mut self) -> &mut AudioEffect
[src]
impl GodotObject for AudioEffectRecord
[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 AudioEffectRecord
[src]
impl Sealed for AudioEffectRecord
[src]
impl SubClass<AudioEffect> for AudioEffectRecord
[src]
impl SubClass<Object> for AudioEffectRecord
[src]
impl SubClass<Reference> for AudioEffectRecord
[src]
impl SubClass<Resource> for AudioEffectRecord
[src]
Auto Trait Implementations
impl RefUnwindSafe for AudioEffectRecord
impl !Send for AudioEffectRecord
impl !Sync for AudioEffectRecord
impl Unpin for AudioEffectRecord
impl UnwindSafe for AudioEffectRecord
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>,