#[repr(transparent)]
pub struct RegistryRef { /* private fields */ }
Expand description

Wrapper for the external pw_sys::pw_registry proxy.

The registry object is a singleton object that keeps track of global objects on the PipeWire instance. When a client creates a registry object, the registry object will emit a global event for each global currently in the registry. Globals come and go as a result of device hotplugs or reconfiguration or other events, and the registry will send out global and global_remove events to keep the client up to date with the changes. To mark the end of the initial burst of events, the client can use the pw_core.sync method immediately after calling pw_core.get_registry.

A client can bind to a global object by using the bind request. This creates a client-side proxy that lets the object emit events to the client and lets the client invoke methods on the object.

Examples

use std::sync::Arc;
use pipewire_wrapper::core_api::core::Core;
use pipewire_wrapper::core_api::device::DeviceRef;
use pipewire_wrapper::core_api::registry::events::RegistryEventsBuilder;
use pipewire_wrapper::listeners::OwnListeners;
use std::time::Duration;

let core = Core::default();
let context = core.context();
 let main_loop = context.main_loop();
 let registry = core.get_registry(0).unwrap();

let _registry_events = registry.add_listener(
     RegistryEventsBuilder::default()
         .global(Box::new(
             |_id, permissions, type_info, version, properties| {
                println!(
                     "Global {:?} {:?} {:?} {:?}",
                     permissions, type_info, version, properties
                );
            },
        ))
        .build(),
 );

let timer_callback = |_| {
    core.context().main_loop().quit().unwrap();
};
let timer = main_loop
     .get_loop()
     .add_timer(Box::new(timer_callback))
    .unwrap();
main_loop
    .get_loop()
    .update_timer(&timer, Duration::from_secs(1), Duration::ZERO, false)
    .unwrap();

main_loop.run().unwrap();

Implementations§

source§

impl RegistryRef

source

pub fn destroy(&self, id: u32) -> Result<()>

Attempt to destroy a global object.

Trait Implementations§

source§

impl<'a> AddListener<'a> for RegistryRef

§

type Events = RegistryEvents<'a>

Events listener struct
source§

fn add_listener(&self, events: Pin<Box<Self::Events>>) -> Pin<Box<Self::Events>>

Register listener and return it. Read more
source§

impl<'c> AsMut<RegistryRef> for Registry<'c>

source§

fn as_mut(&mut self) -> &'c mut RegistryRef

Converts this type into a mutable reference of the (usually inferred) input type.
source§

impl<'c> AsRef<RegistryRef> for Registry<'c>

source§

fn as_ref(&self) -> &'c RegistryRef

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Debug for RegistryRef

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl From<RegistryRef> for pw_registry

source§

fn from(value: RegistryRef) -> Self

Converts to this type from the input type.
source§

impl From<pw_registry> for RegistryRef

source§

fn from(value: pw_registry) -> Self

Converts to this type from the input type.
source§

impl Proxied for RegistryRef

source§

fn type_info() -> TypeInfo<'static>

source§

fn as_proxy(&self) -> &ProxyRef

source§

impl RawWrapper for RegistryRef

§

type CType = pw_registry

External type
source§

fn as_raw_ptr(&self) -> *mut Self::CType

Raw ptr to the external type
source§

fn as_raw(&self) -> &Self::CType

Wrapped external value
source§

fn from_raw(raw: Self::CType) -> Self

Creates wrapper from the external value, can be use when external type has no raw pointers.
source§

unsafe fn mut_from_raw_ptr<'lft>(raw: *mut Self::CType) -> &'lft mut Self

Cast external pointer to the borrowed mutable wrapper. Panic when pointer is null. Lifetime is not reliable and should be guaranteed explicitly. Read more
source§

unsafe fn from_raw_ptr<'a>(raw: *const Self::CType) -> &'a Self

Cast external pointer to the borrowed wrapper. Panic when pointer is null. Lifetime is not reliable and should be guaranteed explicitly. Read more
source§

fn as_ptr(&self) -> *mut Self

Raw mutable pointer to Self
source§

impl SpaInterface for RegistryRef

§

type Methods = pw_registry_methods

spa_sys::spa_interface methods structure
source§

fn spa_interface(&self) -> &InterfaceRef

Interface wrapper
source§

fn version(&self) -> u32

Interface version

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.