Struct Introspector

pub struct Introspector { /* private fields */ }

A wrapper object providing introspection routines to a context.

Implementations

impl Introspector

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

where F: FnMut(ListResult<&SinkInfo<'_>>) + 'static,

Gets information about a sink by its name.

Panics on error, i.e. invalid arguments or state.

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

where F: FnMut(ListResult<&SinkInfo<'_>>) + 'static,

Gets information about a sink by its index.

Panics on error, i.e. invalid arguments or state.

pub fn get_sink_info_list<F>( &self, callback: F, ) -> Operation<dyn FnMut(ListResult<&SinkInfo<'_>>)>

where F: FnMut(ListResult<&SinkInfo<'_>>) + 'static,

Gets the complete sink list.

Panics on error, i.e. invalid arguments or state.

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

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

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

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

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

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

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

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

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Suspends/Resumes a sink.

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Suspends/Resumes a sink.

If index is def::INVALID_INDEX all sinks will be suspended. Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Changes the profile of a sink.

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Changes the profile of a sink.

Panics 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<dyn FnMut(ListResult<&SourceInfo<'_>>)>

where F: FnMut(ListResult<&SourceInfo<'_>>) + 'static,

Gets information about a source by its name.

Panics on error, i.e. invalid arguments or state.

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

where F: FnMut(ListResult<&SourceInfo<'_>>) + 'static,

Gets information about a source by its index.

Panics on error, i.e. invalid arguments or state.

pub fn get_source_info_list<F>( &self, callback: F, ) -> Operation<dyn FnMut(ListResult<&SourceInfo<'_>>)>

where F: FnMut(ListResult<&SourceInfo<'_>>) + 'static,

Gets the complete source list.

Panics on error, i.e. invalid arguments or state.

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

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

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

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

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

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

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

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

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Suspends/Resumes a source.

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Suspends/Resumes a source.

If index is def::INVALID_INDEX, all sources will be suspended. Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Changes the profile of a source.

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Changes the profile of a source.

Panics 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<dyn FnMut(&ServerInfo<'_>)>

where F: FnMut(&ServerInfo<'_>) + 'static,

Gets some information about the server.

Panics on error, i.e. invalid arguments or state.

impl Introspector

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

where F: FnMut(ListResult<&ModuleInfo<'_>>) + 'static,

Gets some information about a module by its index.

Panics on error, i.e. invalid arguments or state.

pub fn get_module_info_list<F>( &self, callback: F, ) -> Operation<dyn FnMut(ListResult<&ModuleInfo<'_>>)>

where F: FnMut(ListResult<&ModuleInfo<'_>>) + 'static,

Gets the complete list of currently loaded modules.

Panics on error, i.e. invalid arguments or state.

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

where F: FnMut(u32) + 'static,

Loads a module.

Panics 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<dyn FnMut(bool)>

where F: FnMut(bool) + 'static,

Unloads a module.

Panics on error, i.e. invalid arguments or state.

The callback must accept a bool, which indicates success.

impl Introspector

pub fn send_message_to_object<F>( &mut self, recipient_name: &str, message: &str, message_parameters: &str, callback: F, ) -> Operation<dyn FnMut(bool, Option<String>)>

where F: FnMut(bool, Option<String>) + 'static,

Available on crate feature pa_v15 only.

Send a message to an object that registered a message handler.

The callback must accept two params, firstly a boolean indicating success if true, and secondly, the response string. The response string may possibly not be given if unsuccessful.

For more information see the messaging_api.txt documentation in the PulseAudio repository.

impl Introspector

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

where F: FnMut(ListResult<&ClientInfo<'_>>) + 'static,

Gets information about a client by its index.

Panics on error, i.e. invalid arguments or state.

pub fn get_client_info_list<F>( &self, callback: F, ) -> Operation<dyn FnMut(ListResult<&ClientInfo<'_>>)>

where F: FnMut(ListResult<&ClientInfo<'_>>) + 'static,

Gets the complete client list.

Panics on error, i.e. invalid arguments or state.

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

where F: FnMut(bool) + 'static,

Kills a client.

Panics 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<dyn FnMut(ListResult<&CardInfo<'_>>)>

where F: FnMut(ListResult<&CardInfo<'_>>) + 'static,

Gets information about a card by its index.

Panics on error, i.e. invalid arguments or state.

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

where F: FnMut(ListResult<&CardInfo<'_>>) + 'static,

Gets information about a card by its name.

Panics on error, i.e. invalid arguments or state.

pub fn get_card_info_list<F>( &self, callback: F, ) -> Operation<dyn FnMut(ListResult<&CardInfo<'_>>)>

where F: FnMut(ListResult<&CardInfo<'_>>) + 'static,

Gets the complete card list.

Panics on error, i.e. invalid arguments or state.

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

Changes the profile of a card.

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Changes the profile of a card.

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Sets the latency offset of a port.

Panics 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<dyn FnMut(ListResult<&SinkInputInfo<'_>>)>

where F: FnMut(ListResult<&SinkInputInfo<'_>>) + 'static,

Gets some information about a sink input by its index.

Panics on error, i.e. invalid arguments or state.

pub fn get_sink_input_info_list<F>( &self, callback: F, ) -> Operation<dyn FnMut(ListResult<&SinkInputInfo<'_>>)>

where F: FnMut(ListResult<&SinkInputInfo<'_>>) + 'static,

Gets the complete sink input list.

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Moves the specified sink input to a different sink.

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Moves the specified sink input to a different sink.

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Sets the volume of a sink input stream.

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Sets the mute switch of a sink input stream.

Panics 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<dyn FnMut(bool)>

where F: FnMut(bool) + 'static,

Kills a sink input.

Panics 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<dyn FnMut(ListResult<&SourceOutputInfo<'_>>)>

where F: FnMut(ListResult<&SourceOutputInfo<'_>>) + 'static,

Gets information about a source output by its index.

Panics on error, i.e. invalid arguments or state.

pub fn get_source_output_info_list<F>( &self, callback: F, ) -> Operation<dyn FnMut(ListResult<&SourceOutputInfo<'_>>)>

where F: FnMut(ListResult<&SourceOutputInfo<'_>>) + 'static,

Gets the complete list of source outputs.

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Moves the specified source output to a different source.

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Moves the specified source output to a different source.

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Sets the volume of a source output stream.

Panics 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<dyn FnMut(bool) + 'static>>, ) -> Operation<dyn FnMut(bool)>

Sets the mute switch of a source output stream.

Panics 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<dyn FnMut(bool)>

where F: FnMut(bool) + 'static,

Kills a source output.

Panics 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<dyn FnMut(&StatInfo)>

where F: FnMut(&StatInfo) + 'static,

Gets daemon memory block statistics.

Panics on error, i.e. invalid arguments or state.

impl Introspector

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

where F: FnMut(ListResult<&SampleInfo<'_>>) + 'static,

Gets information about a sample by its name.

Panics on error, i.e. invalid arguments or state.

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

where F: FnMut(ListResult<&SampleInfo<'_>>) + 'static,

Gets information about a sample by its index.

Panics on error, i.e. invalid arguments or state.

pub fn get_sample_info_list<F>( &self, callback: F, ) -> Operation<dyn FnMut(ListResult<&SampleInfo<'_>>)>

where F: FnMut(ListResult<&SampleInfo<'_>>) + 'static,

Gets the complete list of samples stored in the daemon.

Panics on error, i.e. invalid arguments or state.

Trait Implementations

impl Drop for Introspector

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Introspector

impl Sync for Introspector