pub struct AudioData(/* private fields */);Expand description
A wrapper around web_sys::AudioData that closes on Drop.
Implementations§
Source§impl AudioData
impl AudioData
Sourcepub fn new<'a>(
channels: impl ExactSizeIterator<Item = &'a [f32]>,
sample_rate: u32,
timestamp: Timestamp,
) -> Result<Self>
pub fn new<'a>( channels: impl ExactSizeIterator<Item = &'a [f32]>, sample_rate: u32, timestamp: Timestamp, ) -> Result<Self>
A helper to construct AudioData in a more type-safe way. This currently only supports F32.
pub fn timestamp(&self) -> Timestamp
pub fn duration(&self) -> Duration
pub fn sample_rate(&self) -> u32
pub fn append_to<T: AudioAppend>( &self, dst: &mut T, channel: usize, options: AudioCopyOptions, ) -> Result<()>
pub fn copy_to<T: AudioCopy>( &self, dst: &mut T, channel: usize, options: AudioCopyOptions, ) -> Result<()>
pub fn leak(self) -> AudioData
Methods from Deref<Target = AudioData>§
Sourcepub fn format(&self) -> Option<AudioSampleFormat>
pub fn format(&self) -> Option<AudioSampleFormat>
Getter for the format field of this object.
This API requires the following crate features to be activated: AudioData, AudioSampleFormat
This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as
described in the wasm-bindgen guide
Sourcepub fn sample_rate(&self) -> f32
pub fn sample_rate(&self) -> f32
Getter for the sampleRate field of this object.
This API requires the following crate features to be activated: AudioData
This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as
described in the wasm-bindgen guide
Sourcepub fn number_of_frames(&self) -> u32
pub fn number_of_frames(&self) -> u32
Getter for the numberOfFrames field of this object.
This API requires the following crate features to be activated: AudioData
This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as
described in the wasm-bindgen guide
Sourcepub fn number_of_channels(&self) -> u32
pub fn number_of_channels(&self) -> u32
Getter for the numberOfChannels field of this object.
This API requires the following crate features to be activated: AudioData
This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as
described in the wasm-bindgen guide
Sourcepub fn duration(&self) -> f64
pub fn duration(&self) -> f64
Getter for the duration field of this object.
This API requires the following crate features to be activated: AudioData
This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as
described in the wasm-bindgen guide
Sourcepub fn timestamp(&self) -> f64
pub fn timestamp(&self) -> f64
Getter for the timestamp field of this object.
This API requires the following crate features to be activated: AudioData
This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as
described in the wasm-bindgen guide
Sourcepub fn allocation_size(
&self,
options: &AudioDataCopyToOptions,
) -> Result<u32, JsValue>
pub fn allocation_size( &self, options: &AudioDataCopyToOptions, ) -> Result<u32, JsValue>
The allocationSize() method.
This API requires the following crate features to be activated: AudioData, AudioDataCopyToOptions
This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as
described in the wasm-bindgen guide
Sourcepub fn clone(&self) -> Result<AudioData, JsValue>
pub fn clone(&self) -> Result<AudioData, JsValue>
The clone() method.
This API requires the following crate features to be activated: AudioData
This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as
described in the wasm-bindgen guide
Sourcepub fn close(&self)
pub fn close(&self)
The close() method.
This API requires the following crate features to be activated: AudioData
This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as
described in the wasm-bindgen guide
Sourcepub fn copy_to_with_buffer_source(
&self,
destination: &Object,
options: &AudioDataCopyToOptions,
) -> Result<(), JsValue>
pub fn copy_to_with_buffer_source( &self, destination: &Object, options: &AudioDataCopyToOptions, ) -> Result<(), JsValue>
The copyTo() method.
This API requires the following crate features to be activated: AudioData, AudioDataCopyToOptions
This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as
described in the wasm-bindgen guide
Sourcepub fn copy_to_with_u8_slice(
&self,
destination: &mut [u8],
options: &AudioDataCopyToOptions,
) -> Result<(), JsValue>
pub fn copy_to_with_u8_slice( &self, destination: &mut [u8], options: &AudioDataCopyToOptions, ) -> Result<(), JsValue>
The copyTo() method.
This API requires the following crate features to be activated: AudioData, AudioDataCopyToOptions
This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as
described in the wasm-bindgen guide
Sourcepub fn copy_to_with_u8_array(
&self,
destination: &Uint8Array,
options: &AudioDataCopyToOptions,
) -> Result<(), JsValue>
pub fn copy_to_with_u8_array( &self, destination: &Uint8Array, options: &AudioDataCopyToOptions, ) -> Result<(), JsValue>
The copyTo() method.
This API requires the following crate features to be activated: AudioData, AudioDataCopyToOptions
This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as
described in the wasm-bindgen guide
Methods from Deref<Target = Object>§
Sourcepub fn constructor(&self) -> Function
pub fn constructor(&self) -> Function
The constructor property returns a reference to the Object constructor
function that created the instance object.
Sourcepub fn has_own_property(&self, property: &JsValue) -> bool
pub fn has_own_property(&self, property: &JsValue) -> bool
The hasOwnProperty() method returns a boolean indicating whether the
object has the specified property as its own property (as opposed to
inheriting it).
Sourcepub fn is_prototype_of(&self, value: &JsValue) -> bool
pub fn is_prototype_of(&self, value: &JsValue) -> bool
The isPrototypeOf() method checks if an object exists in another
object’s prototype chain.
Sourcepub fn property_is_enumerable(&self, property: &JsValue) -> bool
pub fn property_is_enumerable(&self, property: &JsValue) -> bool
The propertyIsEnumerable() method returns a Boolean indicating
whether the specified property is enumerable.
Sourcepub fn to_locale_string(&self) -> JsString
pub fn to_locale_string(&self) -> JsString
The toLocaleString() method returns a string representing the object.
This method is meant to be overridden by derived objects for
locale-specific purposes.
Sourcepub fn to_string(&self) -> JsString
pub fn to_string(&self) -> JsString
The toString() method returns a string representing the object.
Methods from Deref<Target = JsValue>§
pub const NULL: JsValue
pub const UNDEFINED: JsValue
pub const TRUE: JsValue
pub const FALSE: JsValue
Sourcepub fn as_f64(&self) -> Option<f64>
pub fn as_f64(&self) -> Option<f64>
Returns the f64 value of this JS value if it’s an instance of a
number.
If this JS value is not an instance of a number then this returns
None.
Sourcepub fn as_string(&self) -> Option<String>
pub fn as_string(&self) -> Option<String>
If this JS value is a string value, this function copies the JS string
value into Wasm linear memory, encoded as UTF-8, and returns it as a
Rust String.
To avoid the copying and re-encoding, consider the
JsString::try_from() function from js-sys
instead.
If this JS value is not an instance of a string or if it’s not valid
utf-8 then this returns None.
§UTF-16 vs UTF-8
JavaScript strings in general are encoded as UTF-16, but Rust strings
are encoded as UTF-8. This can cause the Rust string to look a bit
different than the JS string sometimes. For more details see the
documentation about the str type which contains a few
caveats about the encodings.
Sourcepub fn as_bool(&self) -> Option<bool>
pub fn as_bool(&self) -> Option<bool>
Returns the bool value of this JS value if it’s an instance of a
boolean.
If this JS value is not an instance of a boolean then this returns
None.
Sourcepub fn is_undefined(&self) -> bool
pub fn is_undefined(&self) -> bool
Tests whether this JS value is undefined
Sourcepub fn is_function(&self) -> bool
pub fn is_function(&self) -> bool
Tests whether the type of this JS value is function.
Sourcepub fn js_in(&self, obj: &JsValue) -> bool
pub fn js_in(&self, obj: &JsValue) -> bool
Applies the binary in JS operator on the two JsValues.
Sourcepub fn loose_eq(&self, other: &JsValue) -> bool
pub fn loose_eq(&self, other: &JsValue) -> bool
Compare two JsValues for equality, using the == operator in JS.
Sourcepub fn unsigned_shr(&self, rhs: &JsValue) -> u32
pub fn unsigned_shr(&self, rhs: &JsValue) -> u32
Applies the binary >>> JS operator on the two JsValues.
Sourcepub fn checked_div(&self, rhs: &JsValue) -> JsValue
pub fn checked_div(&self, rhs: &JsValue) -> JsValue
Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.
Sourcepub fn pow(&self, rhs: &JsValue) -> JsValue
pub fn pow(&self, rhs: &JsValue) -> JsValue
Applies the binary ** JS operator on the two JsValues.
Sourcepub fn lt(&self, other: &JsValue) -> bool
pub fn lt(&self, other: &JsValue) -> bool
Applies the binary < JS operator on the two JsValues.
Sourcepub fn le(&self, other: &JsValue) -> bool
pub fn le(&self, other: &JsValue) -> bool
Applies the binary <= JS operator on the two JsValues.
Sourcepub fn ge(&self, other: &JsValue) -> bool
pub fn ge(&self, other: &JsValue) -> bool
Applies the binary >= JS operator on the two JsValues.
Sourcepub fn gt(&self, other: &JsValue) -> bool
pub fn gt(&self, other: &JsValue) -> bool
Applies the binary > JS operator on the two JsValues.
Sourcepub fn unchecked_into_f64(&self) -> f64
pub fn unchecked_into_f64(&self) -> f64
Applies the unary + JS operator on a JsValue. Can throw.