iOS Developer Library

Developer

AVFoundation Framework Reference AVPlayerMediaSelectionCriteria Class Reference

Options
Deployment Target:

On This Page
Language:

AVPlayerMediaSelectionCriteria

The AVPlayerMediaSelectionCriteria class specifies the preferred languages and media characteristics for an AVPlayer instance.

The languages and media characteristics of assets containing media selection options that an AVPlayer instance should attempt to select automatically when preparing and playing items. The languages and media characteristics are specified in the preferred order.

Inheritance


  • NSObject
  • AVPlayerMediaSelectionCriteria
  • NSObject
  • AVPlayerMediaSelectionCriteria

Conforms To


Import Statement


Swift

import AVFoundation

Objective-C

@import AVFoundation;

Availability


Available in iOS 7.0 and later.
  • Returns an initialized media selection criteria instance with the specified settings.

    Declaration

    Swift

    init!(preferredLanguages preferredLanguages: [AnyObject]!, preferredMediaCharacteristics preferredMediaCharacteristics: [AnyObject]!)

    Objective-C

    - (instancetype)initWithPreferredLanguages:(NSArray *)preferredLanguages preferredMediaCharacteristics:(NSArray *)preferredMediaCharacteristics

    Parameters

    preferredLanguages

    An array of strings containing language identifiers, in the preferred order. Can be nil.

    preferredMediaCharacteristics

    An array of strings indicating additional media characteristics, the preferred order. Can be nil.

    Supported media characteristics are defined in AVMediaSelectionOption Constants and Media Characteristics.

    Return Value

    An initialized AVPlayerMediaSelectionCriteria instance.

    Discussion

    When making selections, AVPlayer treats the preferredLanguages as the paramount criterion and the preference for preferredMediaCharacteristics as secondary.

    The objects in the preferredLanguages array are indicated using BCP 47 language identifiers or ISO 639-2/T language codes.

    If no option with any of the preferredLanguages is available, a selection is made according to the default enabling and disabling of media options as stored in the asset.

    The preferredMediaCharacteristics are used when selecting media for the AVPlayer.

    For example, desirable characteristics of legible media may include AVMediaCharacteristicTranscribesSpokenDialogForAccessibility and AVMediaCharacteristicDescribesMusicAndSoundForAccessibility.

    Similarly, desirable characteristics of audible media may include AVMediaCharacteristicDescribesVideoForAccessibility.

    If no option is found that possesses all of the desired characteristics, the option that best matches the desired characteristics will be selected.

    Import Statement

    Objective-C

    @import AVFoundation;

    Swift

    import AVFoundation

    Availability

    Available in iOS 7.0 and later.