Struct MPNowPlayingSession

Source

#[repr(C)]
pub struct MPNowPlayingSession { /* private fields */ }

Available on crate feature MPNowPlayingSession only.

Expand description

Apple’s documentation

Implementations§

Source §

impl MPNowPlayingSession

Source

pub unsafe fn initWithPlayers( this: Allocated<Self>, players: &NSArray<AVPlayer>, ) -> Retained<Self>

Available on crate feature objc2-av-foundation only.

Creates a session associated with a given AVPlayer instance. This will assert if players is nil or empty.

Source

pub unsafe fn new() -> Retained<Self>

Source

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Source

pub unsafe fn players( &self, mtm: MainThreadMarker, ) -> Retained<NSArray<AVPlayer>>

Available on crate feature objc2-av-foundation only.

AVPlayer instances associated with this session.

Source

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn MPNowPlayingSessionDelegate>>>

Source

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn MPNowPlayingSessionDelegate>>, )

This is a weak property. Setter for delegate.

Source

pub unsafe fn automaticallyPublishesNowPlayingInfo(&self) -> bool

When YES, now playing info will be automatically published, and nowPlayingInfoCenter must not be used. Now playing info keys to be incorporated by automatic publishing can be set on the AVPlayerItem’s nowPlayingInfo property.

Source

pub unsafe fn setAutomaticallyPublishesNowPlayingInfo( &self, automatically_publishes_now_playing_info: bool, )

Setter for automaticallyPublishesNowPlayingInfo.

Source

pub unsafe fn nowPlayingInfoCenter(&self) -> Retained<MPNowPlayingInfoCenter>

Available on crate feature MPNowPlayingInfoCenter only.

The now playing info center that is associated with this session.

Source

pub unsafe fn remoteCommandCenter(&self) -> Retained<MPRemoteCommandCenter>

Available on crate feature MPRemoteCommandCenter only.

The remote command center that is associated with this session.

Source

pub unsafe fn canBecomeActive(&self) -> bool

Returns a Boolean value indicating whether this session can become the App’s active now playing session.

Source

pub unsafe fn isActive(&self) -> bool

Returns a Boolean value indicating whether this session is the App’s active now playing session.

Source

pub unsafe fn becomeActiveIfPossibleWithCompletion( &self, completion: Option<&DynBlock<dyn Fn(Bool)>>, )

Available on crate feature block2 only.

Asks the system to make this session the active now playing sessin for the App.

Source

pub unsafe fn addPlayer(&self, player: &AVPlayer)

Available on crate feature objc2-av-foundation only.

Add AVPlayer instance to this session.

Source

pub unsafe fn removePlayer(&self, player: &AVPlayer)

Available on crate feature objc2-av-foundation only.

Remove AVPlayer instance from this session.

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}