Inherits from NSObject
Declared in PTMediaSelectionOption.h

Overview

PTMediaSelectionOption class represents an audiovisual media resource to accommodate different language preferences, accessibility requirements or custom application configurations There are 2 possible types of PTMediaSelectionOption: Subtitles and Alternate Audio.

Tasks

Properties

  •   optionId

    Returns the id of the option

         property
  •   title

    Title of the media option.

         property
  •   locale

    Indicates the locale of the media option.

         property
  •   forced

    Returns YES if the option is of type forced. Forced atribute only applies to PTMediaSelectionOption of type PTMediaSelectionOptionTypeSubtitle Forced options are automatically selected by the player if the locale is the current language.

         property
  •   selected

    Returns YES if the option is currently selected.

         property
  •   isDefault

    Returns YES if the option is the default for the current item.

         property
  •   type

    Returns the type of the media option.

         property

Constant media option

  • + defaultOption

    Returns a constant that the PTMediaPlayerItem understands for selecting its current default option. THIS IS NOT THE DEFAULT OPTION ITESELF.
  • + emptyOption

    Returns a constant that the PTMediaPlayerItem understands for selecting none option. For type PTMediaSelectionOptionTypeSubtitle the empty option is no subtitles track at all (not even forced). For type PTMediaSelectionOptionTypeAudio the empty option is the audio stream embeded in the video stream.

Properties

forced

Returns YES if the option is of type forced. Forced atribute only applies to PTMediaSelectionOption of type PTMediaSelectionOptionTypeSubtitle Forced options are automatically selected by the player if the locale is the current language.

@property (readonly, assign) BOOL forced

Discussion

Returns YES if the option is of type forced. Forced atribute only applies to PTMediaSelectionOption of type PTMediaSelectionOptionTypeSubtitle Forced options are automatically selected by the player if the locale is the current language.

Declared In

PTMediaSelectionOption.h

isDefault

Returns YES if the option is the default for the current item.

@property (readonly, assign) BOOL isDefault

Discussion

Returns YES if the option is the default for the current item.

Declared In

PTMediaSelectionOption.h

locale

Indicates the locale of the media option.

@property (readonly, retain) NSLocale *locale

Discussion

Indicates the locale of the media option.

Declared In

PTMediaSelectionOption.h

optionId

Returns the id of the option

@property (readonly, retain) NSString *optionId

Discussion

Returns the id of the option

Declared In

PTMediaSelectionOption.h

selected

Returns YES if the option is currently selected.

@property (readonly, assign) BOOL selected

Discussion

Returns YES if the option is currently selected.

Declared In

PTMediaSelectionOption.h

title

Title of the media option.

@property (readonly, retain) NSString *title

Discussion

Title of the media option.

Declared In

PTMediaSelectionOption.h

type

Returns the type of the media option.

@property (readonly, assign) PTMediaSelectionOptionType type

Discussion

Returns the type of the media option.

Declared In

PTMediaSelectionOption.h

Class Methods

defaultOption

Returns a constant that the PTMediaPlayerItem understands for selecting its current default option. THIS IS NOT THE DEFAULT OPTION ITESELF.

+ (PTMediaSelectionOption *)defaultOption

Discussion

Returns a constant that the PTMediaPlayerItem understands for selecting its current default option. THIS IS NOT THE DEFAULT OPTION ITESELF.

Declared In

PTMediaSelectionOption.h

emptyOption

Returns a constant that the PTMediaPlayerItem understands for selecting none option. For type PTMediaSelectionOptionTypeSubtitle the empty option is no subtitles track at all (not even forced). For type PTMediaSelectionOptionTypeAudio the empty option is the audio stream embeded in the video stream.

+ (PTMediaSelectionOption *)emptyOption

Discussion

Returns a constant that the PTMediaPlayerItem understands for selecting none option. For type PTMediaSelectionOptionTypeSubtitle the empty option is no subtitles track at all (not even forced). For type PTMediaSelectionOptionTypeAudio the empty option is the audio stream embeded in the video stream.

Declared In

PTMediaSelectionOption.h