Struct libpulse_binding::context::introspect::Introspector

pub struct Introspector {
    pub context: *mut ContextInternal,
    // some fields omitted
}

A wrapper object providing introspection routines to a context.

Fields

context: *mut ContextInternal

Methods

impl Introspector

fn from_raw(context: *mut ContextInternal) -> Self

Create a new Introspector from an existing ContextInternal pointer.

fn from_raw_weak(context: *mut ContextInternal) -> Self

Create a new Introspector from an existing ContextInternal pointer. This is the 'weak' version, for use in callbacks, which avoids destroying the internal object when dropped.

impl Introspector

fn get_sink_info_by_name(
    &self,
    name: &str,
    cb: (SinkInfoCb, *mut c_void)
) -> Option<Operation>

Get information about a sink by its name.

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

fn get_sink_info_by_index(
    &self,
    idx: u32,
    cb: (SinkInfoCb, *mut c_void)
) -> Option<Operation>

Get information about a sink by its index.

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

fn get_sink_info_list(&self, cb: (SinkInfoCb, *mut c_void)) -> Option<Operation>

Get the complete sink list.

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

fn set_sink_volume_by_index(
    &self,
    idx: u32,
    volume: &CVolume,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

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

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

fn set_sink_volume_by_name(
    &self,
    name: &str,
    volume: &CVolume,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

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

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

fn set_sink_mute_by_index(
    &self,
    idx: u32,
    mute: bool,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

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

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

fn set_sink_mute_by_name(
    &self,
    name: &str,
    mute: bool,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

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

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

fn suspend_sink_by_name(
    &self,
    sink_name: &str,
    suspend: bool,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Suspend/Resume a sink.

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

fn suspend_sink_by_index(
    &self,
    idx: u32,
    suspend: bool,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Suspend/Resume a sink.

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

fn set_sink_port_by_index(
    &self,
    idx: u32,
    port: &str,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Change the profile of a sink.

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

fn set_sink_port_by_name(
    &self,
    name: &str,
    port: &str,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Change the profile of a sink.

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

impl Introspector

fn get_source_info_by_name(
    &self,
    name: &str,
    cb: (SourceInfoCb, *mut c_void)
) -> Option<Operation>

Get information about a source by its name.

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

fn get_source_info_by_index(
    &self,
    idx: u32,
    cb: (SourceInfoCb, *mut c_void)
) -> Option<Operation>

Get information about a source by its index.

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

fn get_source_info_list(
    &self,
    cb: (SourceInfoCb, *mut c_void)
) -> Option<Operation>

Get the complete source list.

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

fn set_source_volume_by_index(
    &self,
    idx: u32,
    volume: &CVolume,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

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

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

fn set_source_volume_by_name(
    &self,
    name: &str,
    volume: &CVolume,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

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

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

fn set_source_mute_by_index(
    &self,
    idx: u32,
    mute: bool,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

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

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

fn set_source_mute_by_name(
    &self,
    name: &str,
    mute: bool,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

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

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

fn suspend_source_by_name(
    &self,
    name: &str,
    suspend: bool,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Suspend/Resume a source.

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

fn suspend_source_by_index(
    &self,
    idx: u32,
    suspend: bool,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Suspend/Resume a source.

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

fn set_source_port_by_index(
    &self,
    idx: u32,
    port: &str,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Change the profile of a source.

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

fn set_source_port_by_name(
    &self,
    name: &str,
    port: &str,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Change the profile of a source.

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

impl Introspector

fn get_server_info(&self, cb: (ServerInfoCb, *mut c_void)) -> Option<Operation>

Get some information about the server.

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

impl Introspector

fn get_module_info(
    &self,
    idx: u32,
    cb: (ModuleInfoCb, *mut c_void)
) -> Option<Operation>

Get some information about a module by its index.

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

fn get_module_info_list(
    &self,
    cb: (ModuleInfoCb, *mut c_void)
) -> Option<Operation>

Get the complete list of currently loaded modules.

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

fn load_module(
    &self,
    name: &str,
    argument: &str,
    cb: (ContextIndexCb, *mut c_void)
) -> Option<Operation>

Load a module.

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

fn unload_module(
    &self,
    idx: u32,
    cb: (ContextSuccessCb, *mut c_void)
) -> Option<Operation>

Unload a module.

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

impl Introspector

fn get_client_info(
    &self,
    idx: u32,
    cb: (ClientInfoCb, *mut c_void)
) -> Option<Operation>

Get information about a client by its index.

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

fn get_client_info_list(
    &self,
    cb: (ClientInfoCb, *mut c_void)
) -> Option<Operation>

Get the complete client list.

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

fn kill_client(
    &self,
    idx: u32,
    cb: (ContextSuccessCb, *mut c_void)
) -> Option<Operation>

Kill a client.

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

impl Introspector

fn get_card_info_by_index(
    &self,
    idx: u32,
    cb: (CardInfoCb, *mut c_void)
) -> Option<Operation>

Get information about a card by its index.

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

fn get_card_info_by_name(
    &self,
    name: &str,
    cb: (CardInfoCb, *mut c_void)
) -> Option<Operation>

Get information about a card by its name.

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

fn get_card_info_list(&self, cb: (CardInfoCb, *mut c_void)) -> Option<Operation>

Get the complete card list.

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

fn set_card_profile_by_index(
    &self,
    idx: u32,
    profile: &str,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Change the profile of a card.

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

fn set_card_profile_by_name(
    &self,
    name: &str,
    profile: &str,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Change the profile of a card.

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

fn set_port_latency_offset(
    &self,
    card_name: &str,
    port_name: &str,
    offset: i64,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Set the latency offset of a port.

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

impl Introspector

fn get_sink_input_info(
    &self,
    idx: u32,
    cb: (SinkInputInfoCb, *mut c_void)
) -> Option<Operation>

Get some information about a sink input by its index.

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

fn get_sink_input_info_list(
    &self,
    cb: (SinkInputInfoCb, *mut c_void)
) -> Option<Operation>

Get the complete sink input list. Returns None on error, i.e. invalid arguments or state.

fn move_sink_input_by_name(
    &self,
    idx: u32,
    sink_name: &str,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Move the specified sink input to a different sink.

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

fn move_sink_input_by_index(
    &self,
    idx: u32,
    sink_idx: u32,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Move the specified sink input to a different sink.

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

fn set_sink_input_volume(
    &self,
    idx: u32,
    volume: &CVolume,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Set the volume of a sink input stream.

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

fn set_sink_input_mute(
    &self,
    idx: u32,
    mute: bool,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Set the mute switch of a sink input stream.

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

fn kill_sink_input(
    &self,
    idx: u32,
    cb: (ContextSuccessCb, *mut c_void)
) -> Option<Operation>

Kill a sink input.

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

impl Introspector

fn get_source_output_info(
    &self,
    idx: u32,
    cb: (SourceOutputInfoCb, *mut c_void)
) -> Option<Operation>

Get information about a source output by its index.

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

fn get_source_output_info_list(
    &self,
    cb: (SourceOutputInfoCb, *mut c_void)
) -> Option<Operation>

Get the complete list of source outputs.

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

fn move_source_output_by_name(
    &self,
    idx: u32,
    source_name: &str,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Move the specified source output to a different source.

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

fn move_source_output_by_index(
    &self,
    idx: u32,
    source_idx: u32,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Move the specified source output to a different source.

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

fn set_source_output_volume(
    &self,
    idx: u32,
    volume: &CVolume,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Set the volume of a source output stream.

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

fn set_source_output_mute(
    &self,
    idx: u32,
    mute: bool,
    cb: Option<(ContextSuccessCb, *mut c_void)>
) -> Option<Operation>

Set the mute switch of a source output stream.

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

fn kill_source_output(
    &self,
    idx: u32,
    cb: (ContextSuccessCb, *mut c_void)
) -> Option<Operation>

Kill a source output.

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

impl Introspector

fn stat(&self, cb: (StatInfoCb, *mut c_void)) -> Option<Operation>

Get daemon memory block statistics.

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

impl Introspector

fn get_sample_info_by_name(
    &self,
    name: &str,
    cb: (SampleInfoCb, *mut c_void)
) -> Option<Operation>

Get information about a sample by its name.

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

fn get_sample_info_by_index(
    &self,
    idx: u32,
    cb: (SampleInfoCb, *mut c_void)
) -> Option<Operation>

Get information about a sample by its index.

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

fn get_sample_info_list(
    &self,
    cb: (SampleInfoCb, *mut c_void)
) -> Option<Operation>

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.