Struct AVPlayerLooper

Source

pub struct AVPlayerLooper { /* private fields */ }

Available on crate feature AVPlayerLooper only.

Expand description

Apple’s documentation

Implementations§

Source §

pub unsafe fn playerLooperWithPlayer_templateItem_timeRange( player: &AVQueuePlayer, item_to_loop: &AVPlayerItem, loop_range: CMTimeRange, ) -> Retained<Self>

Available on crate features AVPlayer and AVPlayerItem and objc2-core-media only.

Returns an instance of AVPlayerLooper to loop specified AVPlayerItem within the specified time range with specified AVQueuePlayer.

Parameter player: Must not be nil

Parameter itemToLoop: Must not be nil

Parameter loopRange: Playback time range in [0, itemToLoop’s duration]. kCMTimeRangeInvalid means [0, itemToLoop’s duration].

Returns: An instance of AVPlayerLooper.

The specified AVPlayerItem will be used as a template to generate at least 3 AVPlayerItem replicas and the replicas will be inserted into specified AVQueuePlayer’s play queue to accomplish the looping playback. The specified AVPlayerItem should have its asset’s duration property loaded beforehand so looping setup work would not be blocked until the duration value is known. Otherwise, AVPlayerLooper’s status property is AVPlayerLooperStatusUnknown until the duration property is loaded. The specified AVPlayerItem will not be used in the actual looping playback. Furthermore, AVPlayerItem replicas will be generated at initialization time so any changes made to the specified AVPlayerItem’s property afterwards will not be reflected in the replicas used for looping playback. Specified CMTimeRange will limit each item loop iteration to playing within the specified time range. To play from beginning and the whole duration of the item, specify kCMTimeRangeInvalid for the range parameter. Time range will be accomplished by seeking to range start time and setting AVPlayerItem’s forwardPlaybackEndTime property on the looping item replicas. Client should not modify AVQueuePlayer’s play queue while AVPlayerLooper is performing the looping. AVPlayerLooper will insert the replica items before any existing items in the specified AVQueuePlayer’s play queue and change the actionAtItemEnd to AVPlayerActionAtItemEndAdvance if required. AVQueuePlayer’s play queue and actionAtItemEnd will be restored when -disableLooping method is called and then current looping item replicas completes playback or when AVPlayerLooper is destroyed. While AVPlayerLooper is being initialized, the specified AVQueuePlayer will be paused (rate of 0.0) if necessary and the original player rate will be restored after initialization completes. The client shall set the specified AVQueuePlayer’s rate to 0 beforehand if additional set-up work needs to be performed after AVPlayerLooper initialization and before starting looping playback. An NSInvalidArgumentException will be raised if the player and template item are not specified or the template item has a 0 duration. An NSInvalidArgumentException will be raised if a valid time range has a duration of 0 or is not contained within time 0 and duration of the templateItem.

Source

pub unsafe fn playerLooperWithPlayer_templateItem( player: &AVQueuePlayer, item_to_loop: &AVPlayerItem, ) -> Retained<Self>

Available on crate features AVPlayer and AVPlayerItem only.

Returns an instance of AVPlayerLooper to loop specified AVPlayerItem with specified AVQueuePlayer.

Parameter player: Must not be nil

Parameter itemToLoop: Must not be nil

Returns: An instance of AVPlayerLooper.

Equivalent to +playerLooperWithPlayer:templateItem:timeRange: and passing in kCMTimeRangeInvalid for timeRange parameter.

Source

pub unsafe fn initWithPlayer_templateItem_timeRange( this: Allocated<Self>, player: &AVQueuePlayer, item_to_loop: &AVPlayerItem, loop_range: CMTimeRange, ) -> Retained<Self>

Available on crate features AVPlayer and AVPlayerItem and objc2-core-media only.

Initializes an instance of AVPlayerLooper to loop specified AVPlayerItem within specified time range with specified AVQueuePlayer.

Parameter player: Must not be nil

Parameter itemToLoop: Must not be nil

Parameter loopRange: Playback time range in [0, itemToLoop’s duration]. kCMTimeRangeInvalid means [0, itemToLoop’s duration].

Returns: An initialized AVPlayerLooper.

Equivalent to -initWithPlayer:templateItem:timeRange:existingItemsOrdering: and passing AVPlayerLooperItemOrderingLoopingItemsPrecedeExistingItems as the beforeOrAfter parameter.

Source

pub unsafe fn initWithPlayer_templateItem_timeRange_existingItemsOrdering( this: Allocated<Self>, player: &AVQueuePlayer, item_to_loop: &AVPlayerItem, loop_range: CMTimeRange, item_ordering: AVPlayerLooperItemOrdering, ) -> Retained<Self>

Available on crate features AVPlayer and AVPlayerItem and objc2-core-media only.

Initializes an instance of AVPlayerLooper to loop specified AVPlayerItem within specified time range with specified AVQueuePlayer and adhering to specified ordering of existing items in the play queue.

Parameter player: Must not be nil

Parameter itemToLoop: Must not be nil

Parameter loopRange: Playback time range in [0, itemToLoop’s duration]. kCMTimeRangeInvalid means [0, itemToLoop’s duration].

Parameter itemOrdering: Specifes if replica items are to be inserted before or after existing items in the specified AVQueuePlayer.

Returns: An initialized AVPlayerLooper.

The specified AVPlayerItem will be used as a template to generate at least 3 AVPlayerItem replicas and the replicas will be inserted into specified AVQueuePlayer’s play queue to accomplish the looping playback. The specified AVPlayerItem should have its asset’s duration property loaded beforehand so looping setup work would not be blocked until the duration value is known. Otherwise, AVPlayerLooper’s status property is AVPlayerLooperStatusUnknown until the duration property is loaded. The specified AVPlayerItem will not be used in the actual looping playback. Furthermore, AVPlayerItem replicas will be generated at initialization time so any changes made to the specified AVPlayerItem’s property afterwards will not be reflected in the replicas used for looping playback. Specified CMTimeRange will limit each item loop iteration to playing within the specified time range. To play from beginning and the whole duration of the item, specify kCMTimeRangeInvalid for the range parameter. Time range will be accomplished by seeking to range start time and setting AVPlayerItem’s forwardPlaybackEndTime property on the looping item replicas. Client should not modify AVQueuePlayer’s play queue while AVPlayerLooper is performing the looping. AVPlayerLooper will insert the replica items in the specified AVQueuePlayer’s play queue before or after existing equeued items according to the specified AVPlayerLooperItemOrdering. The looper will change the actionAtItemEnd to AVPlayerActionAtItemEndAdvance if required. AVQueuePlayer’s play queue and actionAtItemEnd will be restored when -disableLooping method is called and then current looping item replicas completes playback or when AVPlayerLooper is destroyed. While AVPlayerLooper is being initialized, the specified AVQueuePlayer will be paused (rate of 0.0) if necessary and the original player rate will be restored after initialization completes. The client shall set the specified AVQueuePlayer’s rate to 0 beforehand if additional set-up work needs to be performed after AVPlayerLooper initialization and before starting looping playback. An NSInvalidArgumentException will be raised if the player and template item are not specified or the template item has a 0 duration. An NSInvalidArgumentException will be raised if a valid time range has a duration of 0 or is not contained within time 0 and duration of the templateItem.

Source

pub unsafe fn status(&self) -> AVPlayerLooperStatus

The ability of the receiver to be used for looping playback.

The value of this property is an AVPlayerLooperStatus that indicates whether the receiver is ready for looping playback. When the value of this property is AVPlayerStatusFailed, the receiver can no longer be used for playback and a new instance needs to be created in its place. When this happens, clients can check the value of the error property to determine the nature of the failure. This property is key value observable.

Source

pub unsafe fn error(&self) -> Option<Retained<NSError>>

If the receiver’s status is AVPlayerLooperStatusFailed, this describes the error that caused the failure.

The value of this property is a NSError that describes what caused the receiver to not be able to perform looping playback. If the receiver’s status is not AVPlayerLooperStatusFailed, the value of this property is nil.

Source

pub unsafe fn disableLooping(&self)

Disables the item looping

AVPlayerLooper will stop performing player queue operations for looping and let the current looping item replica play to the end. The player’s original actionAtItemEnd property will be restored afterwards. After this method is called, the value of the receiver’s status property will be AVPlayerLooperStatusCancelled.

Source

pub unsafe fn loopCount(&self) -> NSInteger

Number of times the specified AVPlayerItem has been played

Starts at 0 and increments when the player starts playback of the AVPlayerItem again. This property is key value observable.

Source

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

Available on crate feature AVPlayerItem only.

Returns an array containing replicas of specified AVPlayerItem used to accomplish the looping

AVPlayerLooper creates replicas of the template AVPlayerItem using -copyWithZone: and inserts the replicas in the specified AVQueuePlayer to accomplish the looping. The AVPlayerItem replicas are for informational purposes and to allow the client to apply properties that are not transferred from the template AVPlayerItem to the replicas. The client can determine the number of replicas created and can listen for notifications and property changes from the replicas if desired. AVPlayerItemOutputs and AVPlayerItemMediaDataCollectors are not transferred to the replicas so the client should add them to each replica if desired. The client shall not modify the properties on the replicas that would disrupt looping playback. Examples of such properties are playhead time/date, selected media option, and forward playback end time. This property is key value observable.

Returns: Array containing replicas of specified AVPlayerItem

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