Struct AVMediaSelectionGroup

Source

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

Available on crate feature AVMediaSelectionGroup only.

Expand description

Apple’s documentation

Implementations§

Source §

impl AVMediaSelectionGroup

Source

pub unsafe fn options(&self) -> Retained<NSArray<AVMediaSelectionOption>>

A collection of mutually exclusive media selection options.

An NSArray of AVMediaSelectionOption*.

Source

pub unsafe fn defaultOption(&self) -> Option<Retained<AVMediaSelectionOption>>

Indicates the default option in the group, i.e. the option that’s intended for use in the absence of a specific end-user selection or preference.

Can be nil, indicating that without a specific end-user selection or preference, no option in the group is intended to be selected.

Source

pub unsafe fn allowsEmptySelection(&self) -> bool

Indicates whether it’s possible to present none of the options in the group when an associated AVPlayerItem is played.

If allowsEmptySelection is YES, all of the available media options in the group can be deselected by passing nil as the specified AVMediaSelectionOption to -[AVPlayerItem selectMediaOption:inMediaSelectionGroup:].

Source

pub unsafe fn mediaSelectionOptionWithPropertyList( &self, plist: &AnyObject, ) -> Option<Retained<AVMediaSelectionOption>>

Returns the instance of AVMediaSelectionOption with properties that match the specified property list.

Parameter plist: A property list previously obtained from an option in the group via -[AVMediaSelectionOption propertyList].

Returns: If the specified properties match those of an option in the group, an instance of AVMediaSelectionOption. Otherwise nil.

Source §

impl AVMediaSelectionGroup

Methods declared on superclass NSObject.

Source

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

Source

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

Source §

impl AVMediaSelectionGroup

AVMediaSelectionOptionFiltering. Filtering of media selection options.

The AVMediaSelectionOptionFiltering category is provided for convenience in filtering the media selection options in a group according to playability, locale, and media characteristics. Note that it’s possible to implement additional filtering behaviors by using -[NSArray indexesOfObjectsPassingTest:].

Source

pub unsafe fn playableMediaSelectionOptionsFromArray( media_selection_options: &NSArray<AVMediaSelectionOption>, ) -> Retained<NSArray<AVMediaSelectionOption>>

Filters an array of AVMediaSelectionOptions according to whether they are playable.

Parameter mediaSelectionOptions: An array of AVMediaSelectionOption to be filtered according to whether they are playable.

Returns: An instance of NSArray containing the media selection options of the specified NSArray that are playable.

Source

pub unsafe fn mediaSelectionOptionsFromArray_filteredAndSortedAccordingToPreferredLanguages( media_selection_options: &NSArray<AVMediaSelectionOption>, preferred_languages: &NSArray<NSString>, ) -> Retained<NSArray<AVMediaSelectionOption>>

Filters an array of AVMediaSelectionOptions according to whether their locales match any language identifier in the specified array of preferred languages. The returned array is sorted according to the order of preference of the language each matches.

Parameter mediaSelectionOptions: An array of AVMediaSelectionOptions to be filtered and sorted.

Parameter preferredLanguages: An array of language identifiers in order of preference, each of which is an IETF BCP 47 (RFC 4646) language identifier. Use +[NSLocale preferredLanguages] to obtain the user’s list of preferred languages.

Returns: An instance of NSArray containing media selection options of the specified NSArray that match a preferred language, sorted according to the order of preference of the language each matches.

Source

pub unsafe fn mediaSelectionOptionsFromArray_withLocale( media_selection_options: &NSArray<AVMediaSelectionOption>, locale: &NSLocale, ) -> Retained<NSArray<AVMediaSelectionOption>>

Filters an array of AVMediaSelectionOptions according to locale.

Parameter mediaSelectionOptions: An array of AVMediaSelectionOption to be filtered by locale.

Parameter locale: The NSLocale that must be matched for a media selection option to be copied to the output array.

Returns: An instance of NSArray containing the media selection options of the specified NSArray that match the specified locale.

Source

pub unsafe fn mediaSelectionOptionsFromArray_withMediaCharacteristics( media_selection_options: &NSArray<AVMediaSelectionOption>, media_characteristics: &NSArray<AVMediaCharacteristic>, ) -> Retained<NSArray<AVMediaSelectionOption>>

Available on crate feature AVMediaFormat only.

Filters an array of AVMediaSelectionOptions according to one or more media characteristics.

Parameter mediaSelectionOptions: An array of AVMediaSelectionOptions to be filtered by media characteristic.

Parameter mediaCharacteristics: The media characteristics that must be matched for a media selection option to be copied to the output array.

Returns: An instance of NSArray containing the media selection options of the specified NSArray that match the specified media characteristics.

Source

pub unsafe fn mediaSelectionOptionsFromArray_withoutMediaCharacteristics( media_selection_options: &NSArray<AVMediaSelectionOption>, media_characteristics: &NSArray<AVMediaCharacteristic>, ) -> Retained<NSArray<AVMediaSelectionOption>>

Available on crate feature AVMediaFormat only.

Filters an array of AVMediaSelectionOptions according to whether they lack one or more media characteristics.

Parameter mediaSelectionOptions: An array of AVMediaSelectionOptions to be filtered by media characteristic.

Parameter mediaCharacteristics: The media characteristics that must not be present for a media selection option to be copied to the output array.

Returns: An instance of NSArray containing the media selection options of the specified NSArray that lack the specified media characteristics.

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