Struct pipewire::loop_::TimerSource

pub struct TimerSource<'l> { /* private fields */ }

A source that can be used to have a callback called on a timer.

This source can be obtained by calling add_timer on a loop, registering a callback to it.

The timer starts out inactive. You can arm or disarm the timer by calling update_timer.

Implementations

impl<'l> TimerSource<'l>

pub fn update_timer( &self, value: Option<Duration>, interval: Option<Duration> ) -> SpaResult

Arm or disarm the timer.

The timer will be called the next time after the provided value duration. After that, the timer will be repeatedly called again at the the specified interval.

If interval is None or zero, the timer will only be called once.
If value is None or zero, the timer will be disabled.

Panics

The provided durations seconds must fit in an i64. Otherwise, this function will panic.

Trait Implementations

impl<'l> Drop for TimerSource<'l>

fn drop(&mut self)

Executes the destructor for this type.

impl<'l> IsSource for TimerSource<'l>

fn as_ptr(&self) -> *mut spa_source

Return a valid pointer to a raw spa_source.