Crate pipewire_wrapper

Overview

The crate structure is close to the PipeWire API structure, so PipeWire Documentation can be used to clarify some aspects of the bindings.

Examples

use pipewire_wrapper::core_api::main_loop::MainLoop;
use std::time::Duration;
let main_loop = MainLoop::default();

let callback = |_expirations| {
    main_loop.quit().unwrap();
};
let timer = main_loop.get_loop().add_timer(Box::new(callback)).unwrap();
main_loop
    .get_loop()
    .update_timer(&timer, Duration::from_secs(1), Duration::ZERO, false)
    .unwrap();
main_loop.run().unwrap();

More examples can be found in examples folder.

Modules

• core_api
  Bindings for PipeWire Core API
• derive_raw_wrapper
• derive_wrapper
• error
  Common Error types used across the library.
• filter
  PipeWire Filter bindings
• impl_api
  PipeWire Implementation API bindings.
• interface
• listeners
  Listeners storage
• macro_rules
  Macro rules
• object_type_impl
• proxy_wrapper
• spa
  PipeWire Simple Plugin API bindings.
• spa_interface
• stream
  PipeWire Stream bindings.
• wrapper
  Wrappers for the external types

Macros

• enum_wrapper
  Wrap the given key: value pairs to struct with constants.
• events_builder_build
  Implement build method for Events struct builder.
• events_channel_builder
  Implement build method for Events struct channel builder.
• interface_type
  Create const TypeInfo with the TypeKind::Interface and given short name
• properties_new
• spa_interface_call
  Call the method on SPA Interface.

Constants

• SPA_ID_INVALID
  Invalid ID value

Type Definitions

• Result
  Result type used in the library

Attribute Macros

• interface
  Implement SpaInterface and Proxied traits.
• object_type_impl
  Add an *Info and *Builder structures after the enum definition. For each enum variant will be added optional struct fields with value and flags.
• proxy_wrapper
  Implement Wrapper trait for structure with the ref_: Proxy<'c> field. Macros parameter will be used as target type to cast underlying proxy.
• spa_interface
  Implement SpaInterface

Derive Macros

• RawWrapper
  Implement RawWrapper trait. #[raw] attribute must be added before field with wrapped raw value.
• Wrapper
  Implement Wrapper trait. #[raw_wrapper] attribute must be added before field with NonNull<impl RawWrapper> pointer to *Ref struct, that implements RawWrapper