Struct script::dom::baseaudiocontext::BaseAudioContext

#[repr(C)]
pub struct BaseAudioContext {
    eventtarget: EventTarget,
    audio_context_impl: Arc<Mutex<AudioContext>>,
    destination: MutNullableDom<AudioDestinationNode>,
    listener: MutNullableDom<AudioListener>,
    in_flight_resume_promises_queue: DomRefCell<VecDeque<(Box<[Rc<Promise>]>, Result<(), Error>)>>,
    pending_resume_promises: DomRefCell<Vec<Rc<Promise>>>,
    decode_resolvers: DomRefCell<HashMap<String, DecodeResolver>>,
    sample_rate: f32,
    state: Cell<AudioContextState>,
    channel_count: u32,
}

Fields

eventtarget: EventTarget

audio_context_impl: Arc<Mutex<AudioContext>>

destination: MutNullableDom<AudioDestinationNode>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-destination

listener: MutNullableDom<AudioListener>

in_flight_resume_promises_queue: DomRefCell<VecDeque<(Box<[Rc<Promise>]>, Result<(), Error>)>>

Resume promises which are soon to be fulfilled by a queued task.

pending_resume_promises: DomRefCell<Vec<Rc<Promise>>>

https://webaudio.github.io/web-audio-api/#pendingresumepromises

decode_resolvers: DomRefCell<HashMap<String, DecodeResolver>>

sample_rate: f32

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

state: Cell<AudioContextState>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-state Although servo-media already keeps track of the control thread state, we keep a state flag here as well. This is so that we can synchronously throw when trying to do things on the context when the context has just been “closed()”.

channel_count: u32

Implementations

impl BaseAudioContext

pub fn new_inherited( options: BaseAudioContextOptions, pipeline_id: PipelineId, ) -> Result<BaseAudioContext, Error>

pub fn is_offline(&self) -> bool

Tells whether this is an OfflineAudioContext or not.

pub fn audio_context_impl(&self) -> Arc<Mutex<AudioContext>>

pub fn destination_node(&self) -> NodeId

pub fn listener(&self) -> NodeId

pub fn is_allowed_to_start(&self) -> bool

fn push_pending_resume_promise(&self, promise: &Rc<Promise>)

fn take_pending_resume_promises(&self, result: Result<(), Error>)

Takes the pending resume promises.

The result with which these promises will be fulfilled is passed here and this method returns nothing because we actually just move the current list of pending resume promises to the in_flight_resume_promises_queue field.

Each call to this method must be followed by a call to fulfill_in_flight_resume_promises, to actually fulfill the promises which were taken and moved to the in-flight queue.

fn fulfill_in_flight_resume_promises<F>(&self, f: F)

where F: FnOnce(),

Fulfills the next in-flight resume promises queue after running a closure.

See the comment on take_pending_resume_promises for why this method does not take a list of promises to fulfill. Callers cannot just pop the front list off of in_flight_resume_promises_queue and later fulfill the promises because that would mean putting #[allow(crown::unrooted_must_root)] on even more functions, potentially hiding actual safety bugs.

pub fn control_thread_state(&self) -> ProcessingState

Control thread processing state

pub fn set_state_attribute(&self, state: AudioContextState)

Set audio context state

pub fn resume(&self)

pub fn channel_count(&self) -> u32

impl BaseAudioContext

fn __assert_parent_type(&self)

Trait Implementations

impl BaseAudioContextMethods for BaseAudioContext

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

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

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

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-currenttime

fn State(&self) -> AudioContextState

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-state

fn Resume(&self, comp: InRealm<'_>, can_gc: CanGc) -> Rc<Promise>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-resume

fn Destination(&self) -> Root<Dom<AudioDestinationNode>>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-destination

fn Listener(&self) -> Root<Dom<AudioListener>>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-listener

fn CreateOscillator( &self, can_gc: CanGc, ) -> Result<Root<Dom<OscillatorNode>>, Error>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-createoscillator

fn CreateGain(&self, can_gc: CanGc) -> Result<Root<Dom<GainNode>>, Error>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-creategain

fn CreatePanner(&self, can_gc: CanGc) -> Result<Root<Dom<PannerNode>>, Error>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-createpanner

fn CreateAnalyser( &self, can_gc: CanGc, ) -> Result<Root<Dom<AnalyserNode>>, Error>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-createanalyser

fn CreateBiquadFilter( &self, can_gc: CanGc, ) -> Result<Root<Dom<BiquadFilterNode>>, Error>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-createbiquadfilter

fn CreateStereoPanner( &self, can_gc: CanGc, ) -> Result<Root<Dom<StereoPannerNode>>, Error>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-createstereopanner

fn CreateConstantSource( &self, can_gc: CanGc, ) -> Result<Root<Dom<ConstantSourceNode>>, Error>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-createconstantsource

fn CreateChannelMerger( &self, count: u32, can_gc: CanGc, ) -> Result<Root<Dom<ChannelMergerNode>>, Error>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-createchannelmerger

fn CreateChannelSplitter( &self, count: u32, can_gc: CanGc, ) -> Result<Root<Dom<ChannelSplitterNode>>, Error>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-createchannelsplitter

fn CreateBuffer( &self, number_of_channels: u32, length: u32, sample_rate: Finite<f32>, can_gc: CanGc, ) -> Result<Root<Dom<AudioBuffer>>, Error>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-createbuffer

fn CreateIIRFilter( &self, feedforward: Vec<Finite<f64>>, feedback: Vec<Finite<f64>>, can_gc: CanGc, ) -> Result<Root<Dom<IIRFilterNode>>, Error>

https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-createiirfilter

fn GetOnstatechange(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnstatechange(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn CreateBufferSource( &self, can_gc: CanGc, ) -> Result<Root<Dom<AudioBufferSourceNode>>, Error>

fn DecodeAudioData( &self, audio_data: CustomAutoRooterGuard<'_, ArrayBuffer>, decode_success_callback: Option<Rc<DecodeSuccessCallback>>, decode_error_callback: Option<Rc<DecodeErrorCallback>>, comp: InRealm<'_>, can_gc: CanGc, ) -> Rc<Promise>

impl Castable for BaseAudioContext

fn is<T>(&self) -> bool

where T: DerivedFrom<Self>,

Check whether a DOM object implements one of its deriving interfaces.

fn upcast<T>(&self) -> &T

where T: Castable, Self: DerivedFrom<T>,

Cast a DOM object upwards to one of the interfaces it derives from.

fn downcast<T>(&self) -> Option<&T>

where T: DerivedFrom<Self>,

Cast a DOM object downwards to one of the interfaces it might implement.

impl DomObject for BaseAudioContext

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 BaseAudioContext

const WRAP: unsafe fn(_: SafeJSContext, _: &GlobalScope, _: Option<HandleObject<'_>>, _: Box<Self>, _: CanGc) -> Root<Dom<Self>> = {dom::bindings::codegen::Bindings::BaseAudioContextBinding::BaseAudioContext_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::baseaudiocontext::BaseAudioContext>, script_runtime::CanGc) -> dom::bindings::root::Root<dom::bindings::root::Dom<dom::baseaudiocontext::BaseAudioContext>>}

Function pointer to the general wrap function type

impl HasParent for BaseAudioContext

fn as_parent(&self) -> &EventTarget

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

type Parent = EventTarget

impl IDLInterface for BaseAudioContext

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

Returns whether the given DOM class derives that interface.

impl MallocSizeOf for BaseAudioContext

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 BaseAudioContext

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

Initializes the Reflector

impl PartialEq for BaseAudioContext

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 BaseAudioContext

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

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

impl Traceable for BaseAudioContext

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

Trace self.

impl DerivedFrom<BaseAudioContext> for AudioContext

impl DerivedFrom<BaseAudioContext> for BaseAudioContext

impl DerivedFrom<BaseAudioContext> for OfflineAudioContext

impl DerivedFrom<EventTarget> for BaseAudioContext

impl Eq for BaseAudioContext