Packagecom.adobe.mediacore
Interfacepublic interface MediaPlayerItem

Media player item is an interface to represent audio-video media. Once a media resource is processed by the media player, its characteristics become available through media player item. The developer can select the desired alternate audio or closed captioning track.



Public Properties
 PropertyDefined By
  audioTracks : Vector.<AudioTrack>
[read-only] Provides the list of currently available audio tracks.
MediaPlayerItem
  availablePlaybackRates : Vector.<Number>
[read-only] Provides the list of available playback rates in the context of the "trick-play" feature.
MediaPlayerItem
  closedCaptionsTracks : Vector.<ClosedCaptionsTrack>
[read-only] Provides the list of currently available closed captions tracks.
MediaPlayerItem
  config : MediaPlayerItemConfig
Media player item configuration.
MediaPlayerItem
  drmMetadataInfos : Vector.<DRMMetadataInfo>
[read-only] Provides the list of currently drm metadata information associated with the current item.
MediaPlayerItem
  hasAlternateAudio : Boolean
[read-only] Flag indicating that the media has alternate audio tracks.
MediaPlayerItem
  hasClosedCaptions : Boolean
[read-only] Flag indicating that the media has alternate audio tracks.
MediaPlayerItem
  hasTimedMetadata : Boolean
[read-only] Flag indicating that the media has timed metadata.
MediaPlayerItem
  isDynamic : Boolean
[read-only] Flag indicating that the media has multiple bit-rate profiles.
MediaPlayerItem
  isLive : Boolean
[read-only] Flag indicating if the stream is live or not.
MediaPlayerItem
  isProtected : Boolean
[read-only] Flag indicating that the media is protected through the DRM module.
MediaPlayerItem
  isTrickPlaySupported : Boolean
[read-only] Flag indicating that whether the "trick-play" feature is supported.
MediaPlayerItem
  player : MediaPlayer
[read-only] Provides the media player currently associated with this player.
MediaPlayerItem
  profiles : Vector.<Profile>
[read-only] Provides the list of currently available bit-rates profiles for the current playback window.
MediaPlayerItem
  resource : MediaResource
[read-only] Returns the media resource associated with this item.
MediaPlayerItem
  resourceId : int
[read-only] Returns the media identifier associated with this item.
MediaPlayerItem
  selectedAudioTrack : AudioTrack
[read-only] Returns the currently selected alternate audio track.
MediaPlayerItem
  selectedClosedCaptionsTrack : ClosedCaptionsTrack
[read-only] Returns the currently selected closed caption track.
MediaPlayerItem
  timedMetadata : Vector.<TimedMetadata>
[read-only] Provides the list of currently available timed metadata for the current playback window.
MediaPlayerItem
Public Methods
 MethodDefined By
  
selectAudioTrack(audioTrack:AudioTrack):Boolean
Selects an alternate audio track to play.
MediaPlayerItem
  
selectClosedCaptionsTrack(closedCaptionsTrack:ClosedCaptionsTrack):Boolean
Selects a close captions track to display.
MediaPlayerItem
Property Detail
audioTracksproperty
audioTracks:Vector.<AudioTrack>  [read-only]

Provides the list of currently available audio tracks.


Implementation
    public function get audioTracks():Vector.<AudioTrack>
availablePlaybackRatesproperty 
availablePlaybackRates:Vector.<Number>  [read-only]

Provides the list of available playback rates in the context of the "trick-play" feature.


Implementation
    public function get availablePlaybackRates():Vector.<Number>
closedCaptionsTracksproperty 
closedCaptionsTracks:Vector.<ClosedCaptionsTrack>  [read-only]

Provides the list of currently available closed captions tracks.


Implementation
    public function get closedCaptionsTracks():Vector.<ClosedCaptionsTrack>
configproperty 
config:MediaPlayerItemConfig

Media player item configuration. Allows for configuration and customization of various PSDK components like content resolving or analytics service.


Implementation
    public function get config():MediaPlayerItemConfig
    public function set config(value:MediaPlayerItemConfig):void
drmMetadataInfosproperty 
drmMetadataInfos:Vector.<DRMMetadataInfo>  [read-only]

Provides the list of currently drm metadata information associated with the current item.


Implementation
    public function get drmMetadataInfos():Vector.<DRMMetadataInfo>
hasAlternateAudioproperty 
hasAlternateAudio:Boolean  [read-only]

Flag indicating that the media has alternate audio tracks.


Implementation
    public function get hasAlternateAudio():Boolean
hasClosedCaptionsproperty 
hasClosedCaptions:Boolean  [read-only]

Flag indicating that the media has alternate audio tracks.


Implementation
    public function get hasClosedCaptions():Boolean
hasTimedMetadataproperty 
hasTimedMetadata:Boolean  [read-only]

Flag indicating that the media has timed metadata.


Implementation
    public function get hasTimedMetadata():Boolean
isDynamicproperty 
isDynamic:Boolean  [read-only]

Flag indicating that the media has multiple bit-rate profiles.


Implementation
    public function get isDynamic():Boolean
isLiveproperty 
isLive:Boolean  [read-only]

Flag indicating if the stream is live or not.


Implementation
    public function get isLive():Boolean
isProtectedproperty 
isProtected:Boolean  [read-only]

Flag indicating that the media is protected through the DRM module.


Implementation
    public function get isProtected():Boolean
isTrickPlaySupportedproperty 
isTrickPlaySupported:Boolean  [read-only]

Flag indicating that whether the "trick-play" feature is supported.


Implementation
    public function get isTrickPlaySupported():Boolean
playerproperty 
player:MediaPlayer  [read-only]

Provides the media player currently associated with this player.


Implementation
    public function get player():MediaPlayer
profilesproperty 
profiles:Vector.<Profile>  [read-only]

Provides the list of currently available bit-rates profiles for the current playback window.


Implementation
    public function get profiles():Vector.<Profile>
resourceproperty 
resource:MediaResource  [read-only]

Returns the media resource associated with this item.


Implementation
    public function get resource():MediaResource
resourceIdproperty 
resourceId:int  [read-only]

Returns the media identifier associated with this item.


Implementation
    public function get resourceId():int
selectedAudioTrackproperty 
selectedAudioTrack:AudioTrack  [read-only]

Returns the currently selected alternate audio track.


Implementation
    public function get selectedAudioTrack():AudioTrack
selectedClosedCaptionsTrackproperty 
selectedClosedCaptionsTrack:ClosedCaptionsTrack  [read-only]

Returns the currently selected closed caption track.


Implementation
    public function get selectedClosedCaptionsTrack():ClosedCaptionsTrack
timedMetadataproperty 
timedMetadata:Vector.<TimedMetadata>  [read-only]

Provides the list of currently available timed metadata for the current playback window.


Implementation
    public function get timedMetadata():Vector.<TimedMetadata>
Method Detail
selectAudioTrack()method
public function selectAudioTrack(audioTrack:AudioTrack):Boolean

Selects an alternate audio track to play.

Parameters

audioTrack:AudioTrack — the audio track to be selected

Returns
Boolean — whether the operation was successful or not
selectClosedCaptionsTrack()method 
public function selectClosedCaptionsTrack(closedCaptionsTrack:ClosedCaptionsTrack):Boolean

Selects a close captions track to display.

Parameters

closedCaptionsTrack:ClosedCaptionsTrack — the audio track to be selected

Returns
Boolean — whether the operation was successful or not