Struct pipewire_wrapper::core_api::context::ContextRef

#[repr(transparent)]
pub struct ContextRef { /* private fields */ }

Wrapper for the external pw_sys::pw_context value. The PipeWire context object manages all locally available resources.

It is used by both clients and servers.

The context is used to:

Load modules and extend the functionality. This includes extending the protocol with new object types or creating any of the available objects.

Create implementations of various objects like nodes, devices, factories, modules, etc.. This will usually also create pw_global objects that can then be shared with clients.

Connect to another PipeWire instance (the main daemon, for example) and interact with it (See page_core_api).

Export a local implementation of an object to another instance.

Implementations

impl ContextRef

pub fn get_properties(&self) -> &PropertiesRef

Context properties

pub fn update_properties(&self, properties: &DictRef) -> i32

Update context properties, returns the count of updated properties

pub fn get_support(&self) -> &[SupportRef]

Get SupportRef list, associated with the Context

pub fn get_main_loop(&self) -> &LoopRef

Get MainLoopRef

pub fn get_work_queue(&self) -> &WorkQueueRef

Work queue

pub fn for_each_global<F>(&self, callback: F) -> Result<i32>where F: FnMut(&GlobalRef) -> i32,

Evaluate the callback for each global

Arguments

• callback - callback to evaluate, should return 0 to continue or any other value to return from the cycle.

Return the value from last evaluated callback

pub fn find_global(&self, id: u32) -> Option<&GlobalRef>

Find global by id

Arguments

• id - id of the Global object

Trait Implementations

impl<'a> AddListener<'a> for ContextRef

type Events = ContextEvents<'a>

Events listener struct

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

Register listener and return it.

impl AsMut<ContextRef> for Context

fn as_mut(&mut self) -> &mut <Self as Wrapper>::RawWrapperType

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

impl AsRef<ContextRef> for Context

fn as_ref(&self) -> &<Self as Wrapper>::RawWrapperType

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

impl Debug for ContextRef

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

Formats the value using the given formatter.

impl From<ContextRef> for pw_context

fn from(value: ContextRef) -> Self

Converts to this type from the input type.

impl From<pw_context> for ContextRef

fn from(value: pw_context) -> Self

Converts to this type from the input type.

impl RawWrapper for ContextRef

type CType = pw_context

External type

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

Raw ptr to the external type

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

Wrapped external value

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

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

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.

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.

fn as_ptr(&self) -> *mut Self

Raw mutable pointer to Self