Struct AVPlayerItemLegibleOutput

Source

pub struct AVPlayerItemLegibleOutput { /* private fields */ }

Available on crate feature AVPlayerItemOutput only.

Expand description

A subclass of AVPlayerItemOutput that can vend media with a legible characteristic as NSAttributedStrings.

An instance of AVPlayerItemLegibleOutput is typically initialized using the -init method.

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

Implementations§

Source §

impl AVPlayerItemLegibleOutput

Source

pub unsafe fn setDelegate_queue( &self, delegate: Option<&ProtocolObject<dyn AVPlayerItemLegibleOutputPushDelegate>>, delegate_queue: Option<&DispatchQueue>, )

Available on crate feature dispatch2 only.

Sets the receiver’s delegate and a dispatch queue on which the delegate will be called.

Parameter delegate: An object conforming to AVPlayerItemLegibleOutputPushDelegate protocol.

Parameter delegateQueue: A dispatch queue on which all delegate methods will be called.

The delegate is held using a zeroing-weak reference, so it is safe to deallocate the delegate while the receiver still has a reference to it.

§Safety

delegate_queue possibly has additional threading requirements.

Source

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

The receiver’s delegate.

The delegate is held using a zeroing-weak reference, so this property will have a value of nil after a delegate that was previously set has been deallocated. This property is not key-value observable.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn delegateQueue(&self) -> Option<Retained<DispatchQueue>>

Available on crate feature dispatch2 only.

The dispatch queue where the delegate is messaged.

This property is not key-value observable.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn advanceIntervalForDelegateInvocation(&self) -> NSTimeInterval

Permits advance invocation of the associated delegate, if any.

If it is possible, an AVPlayerItemLegibleOutput will message its delegate advanceIntervalForDelegateInvocation seconds earlier than otherwise. If the value you provide is large, effectively requesting provision of samples earlier than the AVPlayerItemLegibleOutput is prepared to act on them, the delegate will be invoked as soon as possible.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn setAdvanceIntervalForDelegateInvocation( &self, advance_interval_for_delegate_invocation: NSTimeInterval, )

Setter for advanceIntervalForDelegateInvocation.

§Safety

This might not be thread-safe.

Source §

impl AVPlayerItemLegibleOutput

Methods declared on superclass NSObject.

Source

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

Source

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

Source §

impl AVPlayerItemLegibleOutput

AVPlayerItemLegibleOutput_NativeRepresentation.

Source

pub unsafe fn initWithMediaSubtypesForNativeRepresentation( this: Allocated<Self>, subtypes: &NSArray<NSNumber>, ) -> Retained<Self>

Returns an instance of AVPlayerItemLegibleOutput with filtering enabled for AVPlayerItemLegibleOutputPushDelegate’s legibleOutput:didOutputAttributedStrings:nativeSampleBuffers:forItemTime:.

Parameter subtypes: NSArray of NSNumber FourCC codes, e.g. @ [ [NSNumber numberWithUnsignedInt:‘tx3g’] ]

Returns: An instance of AVPlayerItemLegibleOutput.

Add media subtype FourCC number objects to the subtypes array to elect to receive that type as a CMSampleBuffer instead of an NSAttributedString. Initializing an AVPlayerItemLegibleOutput using the -init method is equivalent to calling -initWithMediaSubtypesForNativeRepresentation: with an empty array, which means that all legible data, regardless of media subtype, will be delivered using NSAttributedString in a common format.

If a media subtype for which there is no legible data in the current player item is included in the media subtypes array, no error will occur. AVPlayerItemLegibleOutput will not vend closed caption data as CMSampleBuffers, so it is an error to include ‘c608’ in the media subtypes array.

This method throws an exception if any media subtype is kCMClosedCaptionFormatType_CEA608 (native representation is not available for media subtype).

Source §

impl AVPlayerItemLegibleOutput

AVPlayerItemLegibleOutput_TextStylingResolution.

Source

pub unsafe fn textStylingResolution( &self, ) -> Retained<AVPlayerItemLegibleOutputTextStylingResolution>

A string identifier indicating the degree of text styling to be applied to attributed strings vended by the receiver

Valid values are AVPlayerItemLegibleOutputTextStylingResolutionDefault and AVPlayerItemLegibleOutputTextStylingResolutionSourceAndRulesOnly. An NSInvalidArgumentException is raised if this property is set to any other value. The default value is AVPlayerItemLegibleOutputTextStylingResolutionDefault, which indicates that attributed strings vended by the receiver will include the same level of styling information that would be used if AVFoundation were rendering the text via AVPlayerLayer.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn setTextStylingResolution( &self, text_styling_resolution: &AVPlayerItemLegibleOutputTextStylingResolution, )

Setter for textStylingResolution.

This is copied when set.

§Safety

This might not be thread-safe.

Methods from Deref<Target = AVPlayerItemOutput>§

Source

pub unsafe fn itemTimeForHostTime( &self, host_time_in_seconds: CFTimeInterval, ) -> CMTime

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

Convert a host time, expressed in seconds, to item time.

Converts a host time value (for example a CADisplayLink timestamp, or the value returned by CACurrentMediaTime()) to the equivalent time on the item’s timebase.

Note: The Core Animation CADisplayLink timestamp property expresses the most recent, or previous, screen refresh time. You need to increment this timestamp by the CADisplayLink’s duration property to find the next appropriate item time.

Parameter hostTimeInSeconds: The timestamp value to convert to item time.

Returns: The equivalent item time.

Source

pub unsafe fn itemTimeForMachAbsoluteTime( &self, mach_absolute_time: i64, ) -> CMTime

Available on crate feature objc2-core-media only.

Convenience method to convert a Mach host time to item time.

Converts Mach host time to the equivalent time on the item’s timebase. mach_absolute_time() returns time awake since boot in system-specific rational units that can be queried by calling mach_timebase_info().

Parameter machAbsoluteTime: The Mach host time to convert to item time.

Returns: The equivalent item time.

Source

pub unsafe fn itemTimeForCVTimeStamp(&self, timestamp: CVTimeStamp) -> CMTime

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

Convenience method to convert a CoreVideo timestamp to the equivalent time on the item’s timebase.

Note: A CVDisplayLink provides a parameter inOutputTimestamp that expresses a future screen refresh time. You can use this value directly to find the next appropriate item time. Use itemTimeForHostTime if you were using this method previously to find the item time and have to switch over due to CVDisplayLink deprecation.

Parameter timestamp: The CoreVideo timestamp value to convert to item time.

Returns: The equivalent item time.

Source

pub unsafe fn suppressesPlayerRendering(&self) -> bool

Indicates whether the output, when added to an AVPlayerItem, will be used in addition to normal rendering of media data by the player or instead of normal rendering.

The default value is NO, indicating that the output will be used in addition to normal rendering. If you want to render the media data provided by the output yourself instead of allowing it to be rendered as in normally would be by AVPlayer, set suppressesPlayerRendering to YES.

Whenever any output is added to an AVPlayerItem that has suppressesPlayerRendering set to YES, the media data supplied to the output will not be rendered by AVPlayer. Other media data associated with the item but not provided to such an output is not affected. For example, if an output of class AVPlayerItemVideoOutput with a value of YES for suppressesPlayerRendering is added to an AVPlayerItem, video media for that item will not be rendered by the AVPlayer, while audio media, subtitle media, and other kinds of media, if present, will be rendered.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn setSuppressesPlayerRendering( &self, suppresses_player_rendering: bool, )

Setter for suppressesPlayerRendering.

§Safety

This might not be thread-safe.

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