Struct AVPlayerInterstitialEventController

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

Available on crate feature AVPlayerInterstitialEventController only.

An AVPlayerInterstitialEventController allows you to specify a schedule of interstitial events for items played by a primary player. By creating an instance of AVPlayerInterstitialEventController and setting a schedule of interstitial events, you pre-empt directives the are intrinsic to the items played by the primary player, if any exist, causing them to be ignored.

The schedule of interstitial events is specified as an array of AVPlayerInterstitialEvents. For each AVPlayerInterstitialEvent, when the primary player’s current item is the primary item of the interstitial event and its currentDate reaches the date of the event, playback of the primary item by the primary player is temporarily suspended, i.e. its timeControlStatus changes to AVPlayerTimeControlStatusWaitingToPlayAtSpecifiedRate and its reasonForWaitingToPlay will change to AVPlayerWaitingDuringInterstitialEventReason. During this suspension, playback of items that replicate the interstitial template items of the event are played by the interstitial player, which temporarily assumes the output configuration of the primary player; for example, its visual content will be routed to AVPlayerLayers that reference the primary player. Once the interstitial player has advanced through playback of the interstitial items specified by the event or its current item otherwise becomes nil, playback of the primary content will resume, at an offset from the time at which it was suspended as specified by the event.

Subclasses of this type that are used from Swift must fulfill the requirements of a Sendable type.

See also Apple’s documentation

Implementations

impl AVPlayerInterstitialEventController

pub unsafe fn interstitialEventControllerWithPrimaryPlayer( primary_player: &AVPlayer, ) -> Retained<Self>

Available on crate feature AVPlayer only.

Returns an instance of AVPlayerInterstitialEvent for use in observing and scheduling interstitial playback.

Parameter primaryPlayer: The AVPlayer that will play the primaryItems of the receiver’s interstitial events.

Returns: An instance of AVPlayerInterstitialEventController.

This method throws an exception if the primary player is an interstitial player.

pub unsafe fn initWithPrimaryPlayer( this: Allocated<Self>, primary_player: &AVPlayer, ) -> Retained<Self>

Available on crate feature AVPlayer only.

This method throws an exception if the primary player is an interstitial player.

pub unsafe fn events(&self) -> Retained<NSArray<AVPlayerInterstitialEvent>>

Specifies the current schedule of interstitial events.

Setting this property to a non-nil value cancels and overrides all previously scheduled future interstitial events, including those that are intrinsically specified by the content of primary items, such as directives carried by HLS media playlists. Setting it to nil causes its value to be reset in accordance with the content of the current primary item.

If you change the value of events during an interstitial event and the current event is not included in the new value of events, the current event is nevertheless allowed to continue until completion. If you wish to cancel the current event, use -cancelCurrentEventWithResumptionOffset:.

If interstitial events are scheduled with dates that coincide either with the date of another scheduled interstitial event or with the date range of the primary content that’s omitted according to the resumption offset of another scheduled interstitial event, the primary content will remain suspended until all coinciding interstitial events have been completed. The effective resumption offset will be the sum of the resumption offsets of the coinciding interstitial events. (Note that the sum of a numeric CMTime and kCMTimeIndefinite is kCMTimeIndefinite.)

If interstitial events are scheduled for the same date, they are ordered according to their position in the events array.

The receiver will make a copy of the events that are set on it. Subsequent mutations on the original events will have no effect on the copy.

An NSInvalidArgumentException will be raised if an under-specified AVPlayerInterstitialEvent is set, such as one with a nil primaryItem, or with neither a time nor a date.

pub unsafe fn setEvents( &self, events: Option<&NSArray<AVPlayerInterstitialEvent>>, )

Setter for events.

pub unsafe fn cancelCurrentEventWithResumptionOffset( &self, resumption_offset: CMTime, )

Available on crate feature objc2-core-media only.

Causes the playback of any and all interstitial content currently in progress to be abandoned and the playback of primary content to be resumed.

Parameter resumptionOffset: Specifies the offset in time at which playback of the primary player’s current item should resume after interstitial playback has finished. To specify that the effective resumption time offset should accord with the wallclock time elapsed during interstitial playback, pass a value of kCMTimeIndefinite.

If invoked during the handling of coinciding interstitial events, they will all be canceled. When you cancel interstitial events via the use of this method, the value of resumptionOffset that you pass overrides the events’ resumptionOffset. Has no effect while currentEvent is nil.

impl AVPlayerInterstitialEventController

Methods declared on superclass AVPlayerInterstitialEventMonitor.

pub unsafe fn interstitialEventMonitorWithPrimaryPlayer( primary_player: &AVPlayer, ) -> Retained<Self>

Available on crate feature AVPlayer only.

Returns an instance of AVPlayerInterstitialEvent for use in observing and scheduling interstitial playback.

Parameter primaryPlayer: The AVPlayer that will play the primaryItems of the receiver’s interstitial events.

Returns: An instance of AVPlayerInterstitialEventMonitor.

impl AVPlayerInterstitialEventController

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = AVPlayerInterstitialEventMonitor>

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

Available on crate feature AVPlayer only.

The AVPlayer that will play the primaryItems of the receiver’s interstitial events.

pub unsafe fn interstitialPlayer( &self, mtm: MainThreadMarker, ) -> Retained<AVQueuePlayer>

Available on crate feature AVPlayer only.

The AVQueuePlayer that will play interstitial items during suspension of playback of primary items.

pub unsafe fn events(&self) -> Retained<NSArray<AVPlayerInterstitialEvent>>

Provides the current schedule of interstitial events, specified either intrinsically within the content of primary items, such as via use of directives carried by HLS media playlists, or via use of an AVPlayerInterstitialEventController.

When interstitial events follow a schedule specified intrinsically within the content of primary items, the value of this property will typically change whenever the currentItem of the primaryPlayer changes. For HLS content that specifies interstitials via the use of DATERANGE tags, the value of this property may also change whenever the set of DATERANGE tags in the currentItem’s media playlist changes. When interstitial events follow a schedule specified via use of an AVPlayerInterstitialEventController, the value of this property changes only when a new schedule is set on the AVPlayerInterstitialEventController. The events returned in this array are immutable. Attempting to mutate them will trigger an exception. To alter an event, make a copy and mutate the copy.

pub unsafe fn currentEvent(&self) -> Option<Retained<AVPlayerInterstitialEvent>>

The current interstitial event. Has a value of nil during playback of primary content by the primary player.

Methods from Deref<Target = NSObject>

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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

Dynamically find the class of this object.

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());

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.

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

Trait Implementations

impl AsRef<AVPlayerInterstitialEventController> for AVPlayerInterstitialEventController

fn as_ref(&self) -> &Self

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

impl AsRef<AVPlayerInterstitialEventMonitor> for AVPlayerInterstitialEventController

fn as_ref(&self) -> &AVPlayerInterstitialEventMonitor

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

impl AsRef<AnyObject> for AVPlayerInterstitialEventController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for AVPlayerInterstitialEventController

fn as_ref(&self) -> &NSObject

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

impl Borrow<AVPlayerInterstitialEventMonitor> for AVPlayerInterstitialEventController

fn borrow(&self) -> &AVPlayerInterstitialEventMonitor

Immutably borrows from an owned value.

impl Borrow<AnyObject> for AVPlayerInterstitialEventController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for AVPlayerInterstitialEventController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for AVPlayerInterstitialEventController

const NAME: &'static str = "AVPlayerInterstitialEventController"

The name of the Objective-C class that this type represents.

type Super = AVPlayerInterstitialEventMonitor

The superclass of this class.

type ThreadKind = <<AVPlayerInterstitialEventController as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for AVPlayerInterstitialEventController

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

Formats the value using the given formatter.

impl Deref for AVPlayerInterstitialEventController

type Target = AVPlayerInterstitialEventMonitor

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for AVPlayerInterstitialEventController

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for AVPlayerInterstitialEventController

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for AVPlayerInterstitialEventController

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for AVPlayerInterstitialEventController

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for AVPlayerInterstitialEventController

const ENCODING_REF: Encoding = <AVPlayerInterstitialEventMonitor as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for AVPlayerInterstitialEventController

impl Eq for AVPlayerInterstitialEventController