Struct script::dom::audiobuffer::AudioBuffer

#[repr(C)]
pub struct AudioBuffer {
    reflector_: Reflector,
    js_channels: DomRefCell<Vec<HeapBufferSource<Float32>>>,
    shared_channels: DomRefCell<Option<AudioBuffer>>,
    sample_rate: f32,
    length: u32,
    duration: f64,
    number_of_channels: u32,
}

The AudioBuffer keeps its data either in js_channels or in shared_channels if js_channels buffers are detached.

js_channels buffers are (re)attached right before calling GetChannelData and remain attached until its contents are needed by some other API implementation. Follow https://webaudio.github.io/web-audio-api/#acquire-the-content to know in which situations js_channels buffers must be detached.

Fields

reflector_: Reflector

js_channels: DomRefCell<Vec<HeapBufferSource<Float32>>>

Float32Arrays returned by calls to GetChannelData.

shared_channels: DomRefCell<Option<AudioBuffer>>

Aggregates the data from js_channels. This is Some<T> iff the buffers in js_channels are detached.

sample_rate: f32

https://webaudio.github.io/web-audio-api/#dom-audiobuffer-samplerate

length: u32

https://webaudio.github.io/web-audio-api/#dom-audiobuffer-length

duration: f64

https://webaudio.github.io/web-audio-api/#dom-audiobuffer-duration

number_of_channels: u32

https://webaudio.github.io/web-audio-api/#dom-audiobuffer-numberofchannels

Implementations

impl AudioBuffer

pub fn new_inherited( number_of_channels: u32, length: u32, sample_rate: f32, ) -> AudioBuffer

pub fn new( global: &Window, number_of_channels: u32, length: u32, sample_rate: f32, initial_data: Option<&[Vec<f32>]>, can_gc: CanGc, ) -> Root<Dom<AudioBuffer>>

fn new_with_proto( global: &Window, proto: Option<HandleObject<'_>>, number_of_channels: u32, length: u32, sample_rate: f32, initial_data: Option<&[Vec<f32>]>, can_gc: CanGc, ) -> Root<Dom<AudioBuffer>>

fn set_initial_data(&self, initial_data: Option<&[Vec<f32>]>)

fn restore_js_channel_data(&self, cx: JSContext) -> bool

fn acquire_contents(&self) -> Option<ServoMediaAudioBuffer>

pub fn get_channels(&self) -> Ref<'_, Option<ServoMediaAudioBuffer>>

impl AudioBuffer

fn __assert_parent_type(&self)

Trait Implementations

impl AudioBufferMethods for AudioBuffer

fn Constructor( window: &Window, proto: Option<HandleObject<'_>>, can_gc: CanGc, options: &AudioBufferOptions, ) -> Result<Root<Dom<AudioBuffer>>, Error>

fn SampleRate(&self) -> Finite<f32>

fn Length(&self) -> u32

fn Duration(&self) -> Finite<f64>

fn NumberOfChannels(&self) -> u32

fn GetChannelData( &self, cx: JSContext, channel: u32, ) -> Result<Float32Array, Error>

fn CopyFromChannel( &self, destination: CustomAutoRooterGuard<'_, Float32Array>, channel_number: u32, start_in_channel: u32, ) -> Result<(), Error>

fn CopyToChannel( &self, source: CustomAutoRooterGuard<'_, Float32Array>, channel_number: u32, start_in_channel: u32, ) -> Result<(), Error>

impl DomObject for AudioBuffer

fn reflector(&self) -> &Reflector

Returns the receiver’s reflector.

fn global(&self) -> Root<Dom<GlobalScope>>

where Self: Sized,

Returns the global scope of the realm that the DomObject was created in.

impl DomObjectWrap for AudioBuffer

const WRAP: unsafe fn(_: SafeJSContext, _: &GlobalScope, _: Option<HandleObject<'_>>, _: Box<Self>, _: CanGc) -> Root<Dom<Self>> = {dom::bindings::codegen::Bindings::AudioBufferBinding::AudioBuffer_Binding::Wrap as for<'a, 'b> unsafe fn(script_runtime::JSContext, &'a dom::globalscope::GlobalScope, std::option::Option<js::rust::Handle<'b, *mut js::jsapi::JSObject>>, std::boxed::Box<dom::audiobuffer::AudioBuffer>, script_runtime::CanGc) -> dom::bindings::root::Root<dom::bindings::root::Dom<dom::audiobuffer::AudioBuffer>>}

Function pointer to the general wrap function type

impl HasParent for AudioBuffer

fn as_parent(&self) -> &Reflector

This is used in a type assertion to ensure that the source and webidls agree as to what the parent type is

type Parent = Reflector

impl IDLInterface for AudioBuffer

fn derives(class: &'static DOMClass) -> bool

Returns whether the given DOM class derives that interface.

impl MallocSizeOf for AudioBuffer

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl MutDomObject for AudioBuffer

unsafe fn init_reflector(&self, obj: *mut JSObject)

Initializes the Reflector

impl PartialEq for AudioBuffer

fn eq(&self, other: &Self) -> 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 ToJSValConvertible for AudioBuffer

unsafe fn to_jsval(&self, cx: *mut JSContext, rval: MutableHandleValue<'_>)

Convert self to a JSVal. JSAPI failure causes a panic.

impl Traceable for AudioBuffer

unsafe fn trace(&self, tracer: *mut JSTracer)

Trace self.

impl Eq for AudioBuffer