Struct AVPlayerItemIntegratedTimeline 

pub struct AVPlayerItemIntegratedTimeline { /* private fields */ }

Available on crate feature AVPlayerItemIntegratedTimeline only.

An AVPlayerItemIntegratedTimeline provides detailed timing information and control for the sequence of playback of a primary AVPlayerItem and scheduled AVPlayerInterstitialEvents.

An object that models the timeline and sequence of playback of primary AVPlayerItem and scheduled AVPlayerInterstitialEvents. The timeline models all regions expected to be traversed during playback. Notably portions of the primary item may not be presented when exiting an interstitial event with a positive resumption offset. Subclasses of this type that are used from Swift must fulfill the requirements of a Sendable type.

See also Apple’s documentation

Implementations

impl AVPlayerItemIntegratedTimeline

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

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

pub unsafe fn currentSnapshot( &self, ) -> Retained<AVPlayerItemIntegratedTimelineSnapshot>

This property provides an immutable representation of the timeline state at time of request.

Returns an immutable representation of the timeline state at time of request. A timeline snapshot provides accessors for obtaining inspectable details of the timeline. Because a snapshot is immutable, the snapshot’s properties will not update as playback continues.

pub unsafe fn currentTime(&self) -> CMTime

Available on crate feature objc2-core-media only.

Returns the current time on the integrated timeline.

Returns the current time on the integrated timeline. During playback of interstitial events that occupy a single point, currentTime will not change.

pub unsafe fn currentDate(&self) -> Option<Retained<NSDate>>

Returns the date of current playback, or nil if playback is not mapped to any date.

impl AVPlayerItemIntegratedTimeline

AVPlayerItemIntegratedTimelineControl.

pub unsafe fn seekToTime_toleranceBefore_toleranceAfter_completionHandler( &self, time: CMTime, tolerance_before: CMTime, tolerance_after: CMTime, completion_handler: Option<&DynBlock<dyn Fn(Bool)>>, )

Available on crate features block2 and objc2-core-media only.

Seeks to a particular time in the integrated time domain and invokes the completionHandler

Parameter time: Time represented in the integrated time domain.

Parameter toleranceBefore: Tolerance before target time allowed to seek to.

Parameter toleranceAfter: Tolerance after target time allowed to seek to.

Parameter completionHandler: CompletionHandler callback after seek completes. Success will be true if the playhead moved to the new time.

The integrated timeline seeks to the the range of [time-beforeTolerance, time+afterTolerance] will be attributed to a segment and AVPlayerItem that falls in that range. You can request sample accurate seeking by passing a time value of kCMTimeZero for both toleranceBefore and toleranceAfter.

Safety

completion_handler block must be sendable.

pub unsafe fn seekToDate_completionHandler( &self, date: &NSDate, completion_handler: Option<&DynBlock<dyn Fn(Bool)>>, )

Available on crate feature block2 only.

Seeks playhead to corresponding date and invokes the completionHandler.

Parameter date: The new position for the playhead.

Parameter completionHandler: CompletionHandler callback after seek completes. Success will be true if the playhead moved to the new date.

The integrated timeline will seek playhead to the coresponding date.

Safety

completion_handler block must be sendable.

impl AVPlayerItemIntegratedTimeline

AVPlayerItemIntegratedTimelineObserver.

pub unsafe fn addPeriodicTimeObserverForInterval_queue_usingBlock( &self, interval: CMTime, queue: Option<&DispatchQueue>, block: &DynBlock<dyn Fn(CMTime)>, ) -> Retained<ProtocolObject<dyn AVPlayerItemIntegratedTimelineObserver>>

Available on crate features block2 and dispatch2 and objc2-core-media only.

Requests invocation of a block during playback to report changing time.

Parameter interval: The interval of invocation of the block during normal playback, according to progress of the current time in the integrated timeline.

Parameter queue: The serial queue onto which block should be enqueued. If you pass NULL, the main queue (obtained using dispatch_get_main_queue()) will be used. Passing a concurrent queue to this method will result in undefined behavior.

Parameter block: The block to be invoked periodically.

Returns: An object conforming to the AVPlayerItemIntegratedTimelineObserver protocol. You must retain this returned value as long as you want the time observer to be invoked by the timeline. The block is invoked periodically at the interval specified, interpreted according to the integrated timeline. The block is also invoked across AVPlayerItemSegment and AVPlayerItem boundaries, whenever time jumps, and whenever playback starts or stops. Each call to -addPeriodicTimeObserverForInterval:queue:usingBlock: should be paired with a corresponding call to -removeTimeObserver:. Releasing the observer object without a call to -removeTimeObserver: will result in undefined behavior

Safety

• queue possibly has additional threading requirements.
• block block must be sendable.

pub unsafe fn addBoundaryTimeObserverForSegment_offsetsIntoSegment_queue_usingBlock( &self, segment: &AVPlayerItemSegment, offsets_into_segment: &NSArray, queue: Option<&DispatchQueue>, block: &DynBlock<dyn Fn(Bool)>, ) -> Retained<ProtocolObject<dyn AVPlayerItemIntegratedTimelineObserver>>

Available on crate features block2 and dispatch2 only.

Requests invocation of a block when an offset in a segment is traversed during playback.

Parameter segment: AVPlayerItemSegment to monitor playback traversal of.

Parameter offsetsIntoSegment: Offsets in the segment for which the observer requests notification, supplied as an array of NSValues carrying CMTimes.

Parameter queue: The serial queue onto which block should be enqueued. If you pass NULL, the main queue (obtained using dispatch_get_main_queue()) will be used. Passing a concurrent queue to this method will result in undefined behavior.

Parameter block: The block to be invoked when the offset is crossed during playback of a segment.

Returns: An object conforming to the AVPlayerItemIntegratedTimelineObserver protocol. You must retain this returned value as long as you want the time observer to be invoked by the timeline. Pass this object to -removeTimeObserver: to cancel time observation. One can also configure single point segments with segmentTimes to trigger during traversal of the segment’s playback. As the timeline duration and segments change, the installed time observer will be automatically adjusted to fire at the desired offset in the segment. A segment that is removed from the timeline will trigger the invocation of the block immediately with success set as false. Each call to -addBoundaryTimeObserverForSegment:segment:offsetsInSegment:queue:usingBlock: should be paired with a corresponding call to -removeTimeObserver:. Releasing the observer object without a call to -removeTimeObserver: will result in undefined behavior

Safety

• offsets_into_segment generic should be of the correct type.
• queue possibly has additional threading requirements.
• block block must be sendable.

pub unsafe fn removeTimeObserver( &self, observer: &ProtocolObject<dyn AVPlayerItemIntegratedTimelineObserver>, )

Cancels a previously registered time observer.

Parameter observer: An object returned by a previous call to -addPeriodicTimeObserverForInterval or -addBoundaryTimeObserverForSegment.

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.

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

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<AVPlayerItemIntegratedTimeline> for AVPlayerItemIntegratedTimeline

fn as_ref(&self) -> &Self

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

impl AsRef<AnyObject> for AVPlayerItemIntegratedTimeline

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for AVPlayerItemIntegratedTimeline

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for AVPlayerItemIntegratedTimeline

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for AVPlayerItemIntegratedTimeline

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for AVPlayerItemIntegratedTimeline

const NAME: &'static str = "AVPlayerItemIntegratedTimeline"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<AVPlayerItemIntegratedTimeline 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 AVPlayerItemIntegratedTimeline

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

Formats the value using the given formatter.

impl Deref for AVPlayerItemIntegratedTimeline

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for AVPlayerItemIntegratedTimeline

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 AVPlayerItemIntegratedTimeline

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for AVPlayerItemIntegratedTimeline

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 AVPlayerItemIntegratedTimeline

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 AVPlayerItemIntegratedTimeline

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

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

impl DowncastTarget for AVPlayerItemIntegratedTimeline

impl Eq for AVPlayerItemIntegratedTimeline

impl Send for AVPlayerItemIntegratedTimeline

impl Sync for AVPlayerItemIntegratedTimeline