Struct Core 

pub struct Core { /* private fields */ }

A singleton object representing the connection between the client and the PipeWire server.

Implementations

impl Core

pub fn disconnect(&self)

Disconnect connection with the PipeWire server. This will immediately trigger the removed and destroy events on all tracked proxies. Callers should ensure that this will not result in deadlocks with their own synchronisation primitives (for example, taking a lock before disconnecting that is also taken in either of those callbacks).

pub fn add_listener(&self, events: CoreEvents) -> HookId

Listen for events on the core object.

pub fn remove_listener(&self, hook_id: HookId)

Remove a set of event listeners.

pub fn sync(&self) -> Result<u32>

Trigger a sync message to the server, flushing all pending messages.

pub fn registry(&self) -> Result<Registry>

Retrieve a Registry. This can be used to query and track objects exposed by the server.

pub fn create_object( &self, factory_name: &str, type_: &str, version: u32, props: &Properties, ) -> Result<Box<dyn HasProxy>>

Create an object of the given factory type on the server.

pub fn destroy(&self, object: &dyn HasProxy) -> Result<()>

Destroy a proxy.

Trait Implementations

impl Clone for Core

fn clone(&self) -> Core

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl HasProxy for Core

fn type_(&self) -> ObjectType

The interface type of the proxy object.

fn version(&self) -> u32

The interface version of the proxy object.

fn proxy(&self) -> Proxy<Core>

Get a Proxy<T> for this object.

impl Refcounted for Core

type WeakRef = WeakCore

The type of a weak reference to the object

fn upgrade(this: &Self::WeakRef) -> Option<Self>

Try to convert a weak reference to a strong reference. If the underlying object isstill alive, returns a Some continaing the value. If the underlying object’s strong reference count dropped to zero, and was thus freed, this returns None.

fn downgrade(&self) -> Self::WeakRef

Create a weak reference to the object. This reference does not impact the object’s lifecycle, and merely allows us the option to try to retrieve the object using Self::upgrade().

impl Send for Core

impl Sync for Core