Struct ark_api::world::AudioClip

pub struct AudioClip { /* private fields */ }

Represents an audio clip

Used with the AudioSource component to play audio

Implementations

impl AudioClip

pub fn new_ogg(data: &[u8]) -> Self

Creates a new AudioClip. This creates a data object in the host that can be shared for multiple entities. Expects the data to be of ‘ogg’ type, otherwise invalid.

pub fn new_wav(data: &[u8]) -> Self

Creates a new AudioClip. This creates a data object in the host that can be shared for multiple entities. Expects the data to be of ‘wav’ type, otherwise invalid.

pub fn new(data: &[u8]) -> Option<Self>

Creates a new AudioClip. This creates a data object in the host that can be shared for multiple entities. Will try to autodetect file format from the 4 first bytes in the data.

pub fn from_resource(resource: AudioClipResource) -> Self

Creates a new AudioClip from a resource downloaded through the Resource Ark API

This creates a data object in the host that can be shared for multiple entities.

The provided resource must point to a loaded resource

pub fn from_audio_module(
    module_dependency_name: &'static str,
    data: &[u8]
) -> Self

Creates the AudioClip from an audio module name and data.

module_dependency_name is the module name, same as specified in module-dependencies in the Cargo.toml.

pub fn from_audio_module_dynamic(
    module_dependency_name: &str,
    data: &[u8]
) -> Self

Creates the AudioClip from an audio module name and data in a unsafe manner.

module_dependency_name is the module name, same as specified in module-dependencies in the Cargo.toml. Takes a non-’static str as parameter. AudioClip::from_audio_module should be preferred over this.

pub fn info(&self) -> AudioClipInfo

Returns information about this AudioClip.

pub fn set_debug_name(&self, name: &str)

Sets a debug name of this data object. Useful for debugging memory usage and leaks.

Trait Implementations

impl Clone for AudioClip

fn clone(&self) -> AudioClip

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioClip

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

Formats the value using the given formatter.

impl PartialEq<AudioClip> for AudioClip

fn eq(&self, other: &AudioClip) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ValueConverterTrait<AudioClip> for ValueConverter

fn into_value(v: AudioClip) -> Value

Wraps the passed-in value in a Value enum.

fn from_value(v: &Value) -> AudioClip

Extracts the value from a Value enum.

impl StructuralPartialEq for AudioClip