Skip to main content

NowPlaying

Struct NowPlaying 

Source
pub struct NowPlaying { /* private fields */ }
Expand description

A struct for managing and interacting with the “Now Playing” media session.

The NowPlaying struct allows access to the currently playing media information, and provides functionality to control playback (e.g., play, pause, skip).

§Example

use media_remote::{Controller, NowPlaying};

let now_playing = NowPlaying::new();
now_playing.play();

Implementations§

Source§

impl NowPlaying

Source

pub fn new() -> Self

Creates a new instance of NowPlaying and registers for playback notifications.

This function initializes a new NowPlaying object, sets up necessary observers, and ensures that media metadata is updated upon creation.

§Returns
  • NowPlaying: A new instance of the NowPlaying struct.
§Example
use media_remote::NowPlaying;

let now_playing = NowPlaying::new();
Source

pub fn get_info(&self) -> RwLockReadGuard<'_, Option<NowPlayingInfo>>

Retrieves the latest now playing information.

This function provides a read-locked view of the current playing media metadata.

§Note
  • The lock should be released as soon as possible to minimize blocking time.
§Returns
  • RwLockReadGuard<'_, Option<NowPlayingInfo>>: A guard to the now playing metadata.
§Example
use media_remote::NowPlaying;

let now_playing = NowPlaying::new();
let guard = now_playing.get_info();
let info = guard.as_ref();

if let Some(info) = info {
    println!("Currently playing: {:?}", info.title);
}

drop(guard);

Trait Implementations§

Source§

impl Controller for NowPlaying

Source§

fn is_info_some(&self) -> bool

Source§

fn toggle(&self) -> bool

Toggles between play and pause states. Read more
Source§

fn play(&self) -> bool

Play the currently playing media. Read more
Source§

fn pause(&self) -> bool

Pauses the currently playing media. Read more
Source§

fn next(&self) -> bool

Skips to the next track in the playback queue. Read more
Source§

fn previous(&self) -> bool

Returns to the previous track in the playback queue. Read more
Source§

impl Drop for NowPlaying

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Subscription for NowPlaying

Source§

fn get_info(&self) -> RwLockReadGuard<'_, Option<NowPlayingInfo>>

Source§

fn get_token_counter(&self) -> Arc<AtomicU64>

Source§

fn get_listeners( &self, ) -> Arc<Mutex<HashMap<ListenerToken, Box<dyn Fn(RwLockReadGuard<'_, Option<NowPlayingInfo>>) + Send + Sync>>>>

Source§

fn subscribe<F: Fn(RwLockReadGuard<'_, Option<NowPlayingInfo>>) + Send + Sync + 'static>( &self, listener: F, ) -> ListenerToken

Subscribes a listener to receive updates when the “Now Playing” information changes. Read more
Source§

fn unsubscribe(&self, token: ListenerToken)

Unsubscribes a previously registered listener using the provided ListenerToken. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where 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 T
where 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

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 T
where U: TryFrom<T>,

Source§

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.
Source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,