Struct synthizer::Context

pub struct Context(_);

The Context represents an audio device.

Implementations

impl Context

pub fn new() -> Result<Context>

pub fn enable_events(&self) -> Result<()>

pub fn get_events<'a>(&'a self) -> impl Iterator<Item = Result<Event>> + 'a

Get any pending events. The returned iterator will not block, and iterates over any pending events until the first error. This is lazy: to limit the number of events received, use .take.

pub fn config_route(
    &self,
    output: &dyn RouteOutput,
    input: &dyn RouteInput,
    config: &RouteConfig
) -> Result<()>

pub fn config_route_simple(
    &self,
    output: &dyn RouteOutput,
    input: &dyn RouteInput
) -> Result<()>

Configure a route with the default settings.

pub fn remove_route(
    &self,
    output: &dyn RouteOutput,
    input: &dyn RouteInput,
    fade_out: f64
) -> Result<()>

pub fn get_gain(&self) -> Result<f64>

pub fn set_gain(&self, value: f64) -> Result<()>

pub fn get_default_panner_strategy(&self) -> Result<PannerStrategy>

pub fn set_default_panner_strategy(&self, value: PannerStrategy) -> Result<()>

pub fn get_default_distance_model(&self) -> Result<DistanceModel>

pub fn set_default_distance_model(&self, value: DistanceModel) -> Result<()>

pub fn get_default_distance_ref(&self) -> Result<f64>

pub fn set_default_distance_ref(&self, value: f64) -> Result<()>

pub fn get_default_distance_max(&self) -> Result<f64>

pub fn set_default_distance_max(&self, value: f64) -> Result<()>

pub fn get_default_rolloff(&self) -> Result<f64>

pub fn set_default_rolloff(&self, value: f64) -> Result<()>

pub fn get_default_closeness_boost(&self) -> Result<f64>

pub fn set_default_closeness_boost(&self, value: f64) -> Result<()>

pub fn get_default_closeness_boost_distance(&self) -> Result<f64>

pub fn set_default_closeness_boost_distance(&self, value: f64) -> Result<()>

pub fn get_position(&self) -> Result<(f64, f64, f64)>

pub fn set_position(&self, values: (f64, f64, f64)) -> Result<()>

pub fn get_orientation(&self) -> Result<(f64, f64, f64, f64, f64, f64)>

pub fn set_orientation(
    &self,
    values: (f64, f64, f64, f64, f64, f64)
) -> Result<()>

pub fn handle(&self) -> &Handle

pub fn into_handle(self) -> Handle

pub fn get_type(&self) -> Result<ObjectType>

pub fn cast_to<T: CastTarget>(&self) -> Result<Option<T>>

Try to cast this object to another object type. Will return Ok(None) if this is because of a type mismatch, otherwise Err. Clones self on success in order to prevent throwing the object away on error.

pub fn get_userdata(&self) -> Result<Option<Arc<dyn Any + Send + Sync>>>

pub fn set_userdata(
    &self,
    userdata: Option<impl Any + Send + Sync>
) -> Result<()>

pub fn config_delete_behavior(
    &self,
    config: &DeleteBehaviorConfig
) -> Result<()>

pub fn pause(&self) -> Result<()>

pub fn play(&self) -> Result<()>

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.