Struct libpulse_binding::context::introspect::Introspector

pub struct Introspector { /* fields omitted */ }

A wrapper object providing introspection routines to a context.

Methods

impl Introspector

pub fn get_sink_info_by_name<F>(     &self,     name: &str,     callback: F ) -> Operation<FnMut(ListResult<&SinkInfo>)> where     F: FnMut(ListResult<&SinkInfo>) + 'static,

Get information about a sink by its name.

Returns None on error, i.e. invalid arguments or state.

pub fn get_sink_info_by_index<F>(     &self,     index: u32,     callback: F ) -> Operation<FnMut(ListResult<&SinkInfo>)> where     F: FnMut(ListResult<&SinkInfo>) + 'static,

Get information about a sink by its index.

Returns None on error, i.e. invalid arguments or state.

pub fn get_sink_info_list<F>(     &self,     callback: F ) -> Operation<FnMut(ListResult<&SinkInfo>)> where     F: FnMut(ListResult<&SinkInfo>) + 'static,

Get the complete sink list.

Returns None on error, i.e. invalid arguments or state.

pub fn set_sink_volume_by_index(     &mut self,     index: u32,     volume: &ChannelVolumes,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Set the volume of a sink device specified by its index.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_sink_volume_by_name(     &mut self,     name: &str,     volume: &ChannelVolumes,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Set the volume of a sink device specified by its name.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_sink_mute_by_index(     &mut self,     index: u32,     mute: bool,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Set the mute switch of a sink device specified by its index.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_sink_mute_by_name(     &mut self,     name: &str,     mute: bool,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Set the mute switch of a sink device specified by its name.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn suspend_sink_by_name(     &mut self,     sink_name: &str,     suspend: bool,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Suspend/Resume a sink.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn suspend_sink_by_index(     &mut self,     index: u32,     suspend: bool,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Suspend/Resume a sink.

If index is ::def::INVALID_INDEX all sinks will be suspended. Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_sink_port_by_index(     &mut self,     index: u32,     port: &str,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Change the profile of a sink.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_sink_port_by_name(     &mut self,     name: &str,     port: &str,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Change the profile of a sink.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

impl Introspector

pub fn get_source_info_by_name<F>(     &self,     name: &str,     callback: F ) -> Operation<FnMut(ListResult<&SourceInfo>)> where     F: FnMut(ListResult<&SourceInfo>) + 'static,

Get information about a source by its name.

Returns None on error, i.e. invalid arguments or state.

pub fn get_source_info_by_index<F>(     &self,     index: u32,     callback: F ) -> Operation<FnMut(ListResult<&SourceInfo>)> where     F: FnMut(ListResult<&SourceInfo>) + 'static,

Get information about a source by its index.

Returns None on error, i.e. invalid arguments or state.

pub fn get_source_info_list<F>(     &self,     callback: F ) -> Operation<FnMut(ListResult<&SourceInfo>)> where     F: FnMut(ListResult<&SourceInfo>) + 'static,

Get the complete source list.

Returns None on error, i.e. invalid arguments or state.

pub fn set_source_volume_by_index(     &mut self,     index: u32,     volume: &ChannelVolumes,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Set the volume of a source device specified by its index.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_source_volume_by_name(     &mut self,     name: &str,     volume: &ChannelVolumes,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Set the volume of a source device specified by its name.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_source_mute_by_index(     &mut self,     index: u32,     mute: bool,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Set the mute switch of a source device specified by its index.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_source_mute_by_name(     &mut self,     name: &str,     mute: bool,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Set the mute switch of a source device specified by its name.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn suspend_source_by_name(     &mut self,     name: &str,     suspend: bool,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Suspend/Resume a source.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn suspend_source_by_index(     &mut self,     index: u32,     suspend: bool,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Suspend/Resume a source.

If index is ::def::INVALID_INDEX, all sources will be suspended. Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_source_port_by_index(     &mut self,     index: u32,     port: &str,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Change the profile of a source.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_source_port_by_name(     &mut self,     name: &str,     port: &str,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Change the profile of a source.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

impl Introspector

pub fn get_server_info<F>(&self, callback: F) -> Operation<FnMut(&ServerInfo)> where     F: FnMut(&ServerInfo) + 'static,

Get some information about the server.

Returns None on error, i.e. invalid arguments or state.

impl Introspector

pub fn get_module_info<F>(     &self,     index: u32,     callback: F ) -> Operation<FnMut(ListResult<&ModuleInfo>)> where     F: FnMut(ListResult<&ModuleInfo>) + 'static,

Get some information about a module by its index.

Returns None on error, i.e. invalid arguments or state.

pub fn get_module_info_list<F>(     &self,     callback: F ) -> Operation<FnMut(ListResult<&ModuleInfo>)> where     F: FnMut(ListResult<&ModuleInfo>) + 'static,

Get the complete list of currently loaded modules.

Returns None on error, i.e. invalid arguments or state.

pub fn load_module<F>(     &mut self,     name: &str,     argument: &str,     callback: F ) -> Operation<FnMut(u32)> where     F: FnMut(u32) + 'static,

Load a module.

Returns None on error, i.e. invalid arguments or state. The callback is provided with the index.

pub fn unload_module<F>(     &mut self,     index: u32,     callback: F ) -> Operation<FnMut(bool)> where     F: FnMut(bool) + 'static,

Unload a module.

Returns None on error, i.e. invalid arguments or state.

The callback must accept a bool, which indicates success.

impl Introspector

pub fn get_client_info<F>(     &self,     index: u32,     callback: F ) -> Operation<FnMut(ListResult<&ClientInfo>)> where     F: FnMut(ListResult<&ClientInfo>) + 'static,

Get information about a client by its index.

Returns None on error, i.e. invalid arguments or state.

pub fn get_client_info_list<F>(     &self,     callback: F ) -> Operation<FnMut(ListResult<&ClientInfo>)> where     F: FnMut(ListResult<&ClientInfo>) + 'static,

Get the complete client list.

Returns None on error, i.e. invalid arguments or state.

pub fn kill_client<F>(     &mut self,     index: u32,     callback: F ) -> Operation<FnMut(bool)> where     F: FnMut(bool) + 'static,

Kill a client.

Returns None on error, i.e. invalid arguments or state.

The callback must accept a bool, which indicates success.

impl Introspector

pub fn get_card_info_by_index<F>(     &self,     index: u32,     callback: F ) -> Operation<FnMut(ListResult<&CardInfo>)> where     F: FnMut(ListResult<&CardInfo>) + 'static,

Get information about a card by its index.

Returns None on error, i.e. invalid arguments or state.

pub fn get_card_info_by_name<F>(     &self,     name: &str,     callback: F ) -> Operation<FnMut(ListResult<&CardInfo>)> where     F: FnMut(ListResult<&CardInfo>) + 'static,

Get information about a card by its name.

Returns None on error, i.e. invalid arguments or state.

pub fn get_card_info_list<F>(     &self,     callback: F ) -> Operation<FnMut(ListResult<&CardInfo>)> where     F: FnMut(ListResult<&CardInfo>) + 'static,

Get the complete card list.

Returns None on error, i.e. invalid arguments or state.

pub fn set_card_profile_by_index(     &mut self,     index: u32,     profile: &str,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Change the profile of a card.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_card_profile_by_name(     &mut self,     name: &str,     profile: &str,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Change the profile of a card.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_port_latency_offset(     &mut self,     card_name: &str,     port_name: &str,     offset: i64,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Set the latency offset of a port.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

impl Introspector

pub fn get_sink_input_info<F>(     &self,     index: u32,     callback: F ) -> Operation<FnMut(ListResult<&SinkInputInfo>)> where     F: FnMut(ListResult<&SinkInputInfo>) + 'static,

Get some information about a sink input by its index.

Returns None on error, i.e. invalid arguments or state.

pub fn get_sink_input_info_list<F>(     &self,     callback: F ) -> Operation<FnMut(ListResult<&SinkInputInfo>)> where     F: FnMut(ListResult<&SinkInputInfo>) + 'static,

Get the complete sink input list.

Returns None on error, i.e. invalid arguments or state.

pub fn move_sink_input_by_name(     &mut self,     index: u32,     sink_name: &str,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Move the specified sink input to a different sink.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn move_sink_input_by_index(     &mut self,     index: u32,     sink_index: u32,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Move the specified sink input to a different sink.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_sink_input_volume(     &mut self,     index: u32,     volume: &ChannelVolumes,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Set the volume of a sink input stream.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_sink_input_mute(     &mut self,     index: u32,     mute: bool,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Set the mute switch of a sink input stream.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn kill_sink_input<F>(     &mut self,     index: u32,     callback: F ) -> Operation<FnMut(bool)> where     F: FnMut(bool) + 'static,

Kill a sink input.

Returns None on error, i.e. invalid arguments or state.

The callback must accept a bool, which indicates success.

impl Introspector

pub fn get_source_output_info<F>(     &self,     index: u32,     callback: F ) -> Operation<FnMut(ListResult<&SourceOutputInfo>)> where     F: FnMut(ListResult<&SourceOutputInfo>) + 'static,

Get information about a source output by its index.

Returns None on error, i.e. invalid arguments or state.

pub fn get_source_output_info_list<F>(     &self,     callback: F ) -> Operation<FnMut(ListResult<&SourceOutputInfo>)> where     F: FnMut(ListResult<&SourceOutputInfo>) + 'static,

Get the complete list of source outputs.

Returns None on error, i.e. invalid arguments or state.

pub fn move_source_output_by_name(     &mut self,     index: u32,     source_name: &str,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Move the specified source output to a different source.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn move_source_output_by_index(     &mut self,     index: u32,     source_index: u32,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Move the specified source output to a different source.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_source_output_volume(     &mut self,     index: u32,     volume: &ChannelVolumes,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Set the volume of a source output stream.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn set_source_output_mute(     &mut self,     index: u32,     mute: bool,     callback: Option<Box<FnMut(bool) + 'static>> ) -> Operation<FnMut(bool)>

Set the mute switch of a source output stream.

Returns None on error, i.e. invalid arguments or state.

The optional callback must accept a bool, which indicates success.

pub fn kill_source_output<F>(     &mut self,     index: u32,     callback: F ) -> Operation<FnMut(bool)> where     F: FnMut(bool) + 'static,

Kill a source output.

Returns None on error, i.e. invalid arguments or state.

The callback must accept a bool, which indicates success.

impl Introspector

pub fn stat<F>(&self, callback: F) -> Operation<FnMut(&StatInfo)> where     F: FnMut(&StatInfo) + 'static,

Get daemon memory block statistics.

Returns None on error, i.e. invalid arguments or state.

impl Introspector

pub fn get_sample_info_by_name<F>(     &self,     name: &str,     callback: F ) -> Operation<FnMut(ListResult<&SampleInfo>)> where     F: FnMut(ListResult<&SampleInfo>) + 'static,

Get information about a sample by its name.

Returns None on error, i.e. invalid arguments or state.

pub fn get_sample_info_by_index<F>(     &self,     index: u32,     callback: F ) -> Operation<FnMut(ListResult<&SampleInfo>)> where     F: FnMut(ListResult<&SampleInfo>) + 'static,

Get information about a sample by its index.

Returns None on error, i.e. invalid arguments or state.

pub fn get_sample_info_list<F>(     &self,     callback: F ) -> Operation<FnMut(ListResult<&SampleInfo>)> where     F: FnMut(ListResult<&SampleInfo>) + 'static,

Get the complete list of samples stored in the daemon.

Returns None on error, i.e. invalid arguments or state.

Trait Implementations

impl Drop for Introspector

fn drop(&mut self)

Executes the destructor for this type.