Struct rustpotter_wasm::RustpotterJSBuilder

source · [−]

pub struct RustpotterJSBuilder { /* private fields */ }

Implementations

source

impl RustpotterJSBuilder

source

pub fn new() -> Self

source

pub fn setThreshold(&mut self, value: f32)

Configures the detector threshold, is the min score (in range 0. to 1.) that some of the wakeword templates should obtain to trigger a detection.

Defaults to 0.5, wakeword defined value takes prevalence if present.

source

pub fn setAveragedThreshold(&mut self, value: f32)

Configures the detector threshold, is the min score (in range 0. to 1.) that
the averaged wakeword template should obtain to allow to continue with the detection. This way it can prevent to run the comparison of the current frame against each of the wakeword templates. If set to 0. this functionality is disabled.

Defaults to half of the configured threshold, wakeword defined value takes prevalence if present.

source

pub fn setBitsPerSample(&mut self, value: u16)

Configures the detector expected bit per sample for the audio chunks to process.

Defaults to 16; Allowed values: 8, 16, 24, 32

source

pub fn setSampleRate(&mut self, value: usize)

Configures the detector expected sample rate for the audio chunks to process.

Defaults to 16000

source

pub fn setSampleFormat(&mut self, value: SampleFormat)

Configures the detector expected sample format for the audio chunks to process.

Defaults to int

source

pub fn setChannels(&mut self, value: u16)

Configures the detector expected number of channels for the audio chunks to process. Rustpotter will only use data for first channel.

Defaults to 1

source

pub fn setComparatorBandSize(&mut self, value: usize)

Configures the band-size for the comparator used to match the samples.

Defaults to 6

source

pub fn setComparatorRef(&mut self, value: f32)

Configures the reference for the comparator used to match the samples.

Defaults to 0.22

source

pub fn setEagerMode(&mut self, value: bool)

Enables eager mode. Terminate the detection as son as one result is above the score, instead of wait to see if the next frame has a higher score.

Recommended for real usage.

Defaults to false.

source

pub fn setSingleThread(&mut self, value: bool)

Unless enabled the comparison against multiple wakewords run in separate threads.

Defaults to false.

Only applies when more than a wakeword is loaded.

source

pub fn build(&self) -> RustpotterJS

construct the wakeword detector

Trait Implementations

source

impl From<RustpotterJSBuilder> for JsValue

source

fn from(value: RustpotterJSBuilder) -> Self

Converts to this type from the input type.

source

impl FromWasmAbi for RustpotterJSBuilder

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary. Read more

source

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi. Read more

source

impl IntoWasmAbi for RustpotterJSBuilder

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary. Read more

source

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary. Read more

source

impl OptionFromWasmAbi for RustpotterJSBuilder

source

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi. Read more

source

impl OptionIntoWasmAbi for RustpotterJSBuilder

source

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more

source

impl RefFromWasmAbi for RustpotterJSBuilder

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, RustpotterJSBuilder>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous. Read more

source