Struct web_thread::web::audio_worklet::AudioWorkletHandle

pub struct AudioWorkletHandle(/* private fields */);

Available on Web and crate feature audio-worklet only.

Handle to the audio worklet. See BaseAudioContextExt::register_thread().

Implementations

impl AudioWorkletHandle

pub const fn thread(&self) -> &Thread

Extracts a handle to the underlying thread.

Example

use web_sys::{AudioContext, console};
use web_thread::web::audio_worklet::BaseAudioContextExt;

let context = AudioContext::new().unwrap();
let handle = context.clone().register_thread(
	None,
	|| {
		// Do work.
	},
).await.unwrap();

console::log_1(&format!("thread id: {:?}", handle.thread().id()).into());

pub unsafe fn release(self) -> Result<(), ReleaseError>

This releases memory allocated for the corresponding audio worklet thread.

Safety

The corresponding thread must not currently or in the future access this Wasm module.

Errors

If called from its corresponding audio worklet thread.

Example

use wasm_bindgen_futures::JsFuture;
use web_sys::AudioContext;
use web_thread::web::audio_worklet::BaseAudioContextExt;

let context = AudioContext::new().unwrap();
let (sender, receiver) = async_channel::bounded(1);
let handle = context.clone().register_thread(
	None,
	move || {
		// Do work.
		sender.try_send(()).unwrap();
	},
).await.unwrap();

// Wait until audio worklet is finished.
receiver.recv().await.unwrap();
JsFuture::from(context.close().unwrap()).await.unwrap();
// SAFETY: We are sure we are done with the audio worklet and didn't register any
// events or promises that could call into the Wasm module later.
unsafe { handle.release() }.unwrap();

Trait Implementations

impl Debug for AudioWorkletHandle

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

Formats the value using the given formatter.