Struct AVPictureInPictureController

Source

pub struct AVPictureInPictureController { /* private fields */ }

Available on crate feature AVPictureInPictureController only.

Expand description

AVPictureInPictureController is a subclass of NSObject that can be used to present the contents of an AVPlayerLayer or AVPlayerView floating on top of applications.

Implementations§

Source §

impl AVPictureInPictureController

Source

pub unsafe fn isPictureInPictureSupported() -> bool

Whether or not Picture in Picture is supported on the current device.

When NO, all initializers will return nil.

Source

pub unsafe fn pictureInPictureButtonStartImage() -> Retained<NSImage>

Available on crate feature objc2-app-kit and macOS only.

System default Picture in Picture start template image for use in client’s Picture in Picture button.

Source

pub unsafe fn pictureInPictureButtonStopImage() -> Retained<NSImage>

Available on crate feature objc2-app-kit and macOS only.

System default Picture in Picture stop template image for use in client’s Picture in Picture button.

Source

pub unsafe fn initWithContentSource( this: Allocated<Self>, content_source: &AVPictureInPictureControllerContentSource, ) -> Retained<Self>

Parameter contentSource: The content source to be shown in Picture in Picture.

Use this initializer for content that may be a sample buffer display layer or a player layer.

Source

pub unsafe fn initWithPlayerLayer( this: Allocated<Self>, player_layer: &AVPlayerLayer, ) -> Option<Retained<Self>>

Available on crate feature objc2-av-foundation and non-watchOS only.

Parameter playerLayer: The player layer from which to source the media content for the Picture in Picture controller.

Initialize the picture in picture controller with a player layer.

Source

pub unsafe fn contentSource( &self, ) -> Option<Retained<AVPictureInPictureControllerContentSource>>

The receiver’s content source. Can be changed while Picture in Picture is active, but the new content source must be ready for display (in the case of AVPlayerLayer, that means AVPlayerLayer.isReadyForDisplay must return YES), otherwise Picture in Picture will stop.

Source

pub unsafe fn setContentSource( &self, content_source: Option<&AVPictureInPictureControllerContentSource>, )

Setter for contentSource.

Source

pub unsafe fn playerLayer(&self) -> Retained<AVPlayerLayer>

Available on crate feature objc2-av-foundation and non-watchOS only.

The receiver’s player layer.

Source

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

The receiver’s delegate.

Source

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

Setter for delegate.

This is a weak property.

Source

pub unsafe fn startPictureInPicture(&self)

Start Picture in Picture for the provided AVPlayerLayer if possible.

Receiver will call -pictureInPictureControllerWillStartPictureInPicture: if Picture in Picture is currently possible and -pictureInPictureControllerDidStartPictureInPicture: after a successful start. If starting Picture in Picture fails, -pictureInPictureControllerFailedToStartPictureInPicture:withError: is called on the delegate instead. Client can stop Picture in Picture by calling -stopPictureInPicture. In addition the user can stop Picture in Picture through user interaction. It is also possible that Picture in Picture is stopped by the Picture in Picture controller at any time. In all these cases receiver calls -pictureInPictureControllerWillStopPictureInPicture: on the delegate and -pictureInPictureControllerDidStopPictureInPicture:after the stop animation completed.

Source

pub unsafe fn stopPictureInPicture(&self)

Stop the local Picture in Picture if currently active. On tvOS, this can also stop Picture in Picture sessions for other applications.

See startPictureInPicture for details.

Source

pub unsafe fn isPictureInPicturePossible(&self) -> bool

Whether or not Picture in Picture is currently possible.

Source

pub unsafe fn isPictureInPictureActive(&self) -> bool

Whether or not Picture in Picture is currently active.

Source

pub unsafe fn isPictureInPictureSuspended(&self) -> bool

Whether or not Picture in Picture is currently suspended.

Source

pub unsafe fn canStopPictureInPicture(&self) -> bool

Whether or not any Picture in Picture is active, and can be stopped.

When true, stopPictureInPicture will stop the active Picture in Picture session. Apps should re-inspect the system-provided picture in picture start button image when this property changes. Observable.

Source

pub unsafe fn requiresLinearPlayback(&self) -> bool

Disables certain user operations (fast forward, forward skip, and scrubbing).

This can be used to temporarily enforce playback of mandatory content (such as legalese or advertisements).

Source

pub unsafe fn setRequiresLinearPlayback(&self, requires_linear_playback: bool)

Setter for requiresLinearPlayback.

Source

pub unsafe fn canStartPictureInPictureAutomaticallyFromInline(&self) -> bool

Indicates whether Picture in Picture should be allowed to start automatically when transitioning to background when the receiver’s content is embedded inline. Default is NO.

This property must only be set to YES for content intended to be the user’s primary focus.

Source

pub unsafe fn setCanStartPictureInPictureAutomaticallyFromInline( &self, can_start_picture_in_picture_automatically_from_inline: bool, )

Setter for canStartPictureInPictureAutomaticallyFromInline.

Source §

impl AVPictureInPictureController

Methods declared on superclass NSObject.

Source

pub unsafe fn invalidatePlaybackState(&self)

Available on crate feature AVPictureInPictureController_AVSampleBufferDisplayLayerSupport only.

Informs Picture in Picture controller that it should request an updated playback state from its sampleBufferPlaybackDelegate.

This should always be called whenever playback is paused or unpaused, or the underlying content duration changes.

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`
    }
}