Packagecom.adobe.mediacore
Classpublic class MediaPlayerItem
InheritanceMediaPlayerItem Inheritance flash.events.EventDispatcher

Media Player item is an abstract class to represent audio-video media.



Public Properties
 PropertyDefined By
  activeCCServices : Vector.<String>
[read-only] Returns the active CC services.
MediaPlayerItem
  adSignalingMode : String
[read-only] Returns the ad signaling mode to be used for this item
MediaPlayerItem
  audioTracks : TrackCollection
[read-only] The available audio tracks from the stream.
MediaPlayerItem
  bitrateRange : Range
The bitrate interval allowed for playback (expressed in bits per second). This range enforcement does not apply to the first downloaded fragment.
MediaPlayerItem
  currentAudioTrack : Track
[read-only] Retrieve the current audio track, that will be played during playback. This is not necessarily the track currently being played by the media player.
MediaPlayerItem
  currentVideoRendition : Rendition
[read-only] Retrieve the current video rendition, that is currently in playback by the media player.
MediaPlayerItem
  desiredInitialBitrate : Number
The desired bitrate (in bits per second) at which playback should start.
MediaPlayerItem
  drmMetadataInfos : Vector.<DRMMetadataInfo>
[read-only] DRM metadata for all licenses associated to this item
MediaPlayerItem
  duration : Number
[read-only] Duration of the media item calculated based only on the main resource information (ads not included).
MediaPlayerItem
  dvrInfo : DVRInfo
[read-only] DVR information, if the stream is DVR-enabled
MediaPlayerItem
  isProtected : Boolean
[read-only] Indicates that the stream is protected using FAXS library.
MediaPlayerItem
  mediaId : String
[read-only] Media identifier.
MediaPlayerItem
  metadata : Metadata
[read-only] Returns the configuration associated with this item.
MediaPlayerItem
  notificationHistory : NotificationHistory
[read-only]
MediaPlayerItem
  resource : MediaResource
[read-only] Returns the resource associated with this item.
MediaPlayerItem
  type : String
[read-only] Returns the MediaPlayerItemType
MediaPlayerItem
  videoRenditions : Vector.<Rendition>
[read-only] The available video renditions from the stream representing all the qualities available for playback.
MediaPlayerItem
  videoSize : Size
[read-only] Size of the video.
MediaPlayerItem
Public Methods
 MethodDefined By
  
MediaPlayerItem(resource:MediaResource, mediaId:String, metadata:Metadata)
Constructor.
MediaPlayerItem
Events
 Event Summary Defined By
  Dispatched when a new audio track has started playbackMediaPlayerItem
  Dispatched when an audio track has been selectedMediaPlayerItem
  Dispatched to notify that the duration of the asset has changedMediaPlayerItem
  Dispatched to notify that the isProtected property has changedMediaPlayerItem
  Dispatched to notify that the tracks are availableMediaPlayerItem
  Dispatched to notify that different video renditions are available for this itemMediaPlayerItem
  Dispatched to notify that the size the video has changedMediaPlayerItem
Public Constants
 ConstantDefined By
  DEFAULT_NOTIFICATION_HISTORY_CAPACITY : uint = 1000
MediaPlayerItem
Property Detail
activeCCServicesproperty
activeCCServices:Vector.<String>  [read-only]

Returns the active CC services.


Implementation
    public function get activeCCServices():Vector.<String>
adSignalingModeproperty 
adSignalingMode:String  [read-only]

Returns the ad signaling mode to be used for this item


Implementation
    public function get adSignalingMode():String
audioTracksproperty 
audioTracks:TrackCollection  [read-only]

The available audio tracks from the stream.


Implementation
    public function get audioTracks():TrackCollection
bitrateRangeproperty 
bitrateRange:Range

The bitrate interval allowed for playback (expressed in bits per second).

This range enforcement does not apply to the first downloaded fragment. The desired initial bitrate will be honoured even if it is outside the range specified here.


Implementation
    public function get bitrateRange():Range
    public function set bitrateRange(value:Range):void

See also

currentAudioTrackproperty 
currentAudioTrack:Track  [read-only]

Retrieve the current audio track, that will be played during playback.

This is not necessarily the track currently being played by the media player.


Implementation
    public function get currentAudioTrack():Track
currentVideoRenditionproperty 
currentVideoRendition:Rendition  [read-only]

Retrieve the current video rendition, that is currently in playback by the media player.


Implementation
    public function get currentVideoRendition():Rendition
desiredInitialBitrateproperty 
desiredInitialBitrate:Number

The desired bitrate (in bits per second) at which playback should start. A best-match will be performed in order to pick one of the available quality levels of the content.

You should set this value prior to assigning the item to a MediaPlayer to ensure that it is considered.

This setting only applies to the first fragment downloaded. After that the quality may be changed due to the adaptive streaming algorithm or due to the bitrateRange setting.


Implementation
    public function get desiredInitialBitrate():Number
    public function set desiredInitialBitrate(value:Number):void

See also

drmMetadataInfosproperty 
drmMetadataInfos:Vector.<DRMMetadataInfo>  [read-only]

DRM metadata for all licenses associated to this item


Implementation
    public function get drmMetadataInfos():Vector.<DRMMetadataInfo>
durationproperty 
duration:Number  [read-only]

Duration of the media item calculated based only on the main resource information (ads not included).


Implementation
    public function get duration():Number
dvrInfoproperty 
dvrInfo:DVRInfo  [read-only]

DVR information, if the stream is DVR-enabled


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

Indicates that the stream is protected using FAXS library.


Implementation
    public function get isProtected():Boolean
mediaIdproperty 
mediaId:String  [read-only]

Media identifier. External services (ad resolving, ad and content tracking, custom CMS) might use this identifier to retrieve and store information related to this media.


Implementation
    public function get mediaId():String
metadataproperty 
metadata:Metadata  [read-only]

Returns the configuration associated with this item.


Implementation
    public function get metadata():Metadata
notificationHistoryproperty 
notificationHistory:NotificationHistory  [read-only]


Implementation
    public function get notificationHistory():NotificationHistory
resourceproperty 
resource:MediaResource  [read-only]

Returns the resource associated with this item.


Implementation
    public function get resource():MediaResource
typeproperty 
type:String  [read-only]

Returns the MediaPlayerItemType


Implementation
    public function get type():String
videoRenditionsproperty 
videoRenditions:Vector.<Rendition>  [read-only]

The available video renditions from the stream representing all the qualities available for playback.


Implementation
    public function get videoRenditions():Vector.<Rendition>
videoSizeproperty 
videoSize:Size  [read-only]

Size of the video. Once the playback starts, the actual size of the media will be retrieved. The client can use this property to detect when the video must be scale down or up to match the desired presentation size.


Implementation
    public function get videoSize():Size
Constructor Detail
MediaPlayerItem()Constructor
public function MediaPlayerItem(resource:MediaResource, mediaId:String, metadata:Metadata)

Constructor.

Parameters
resource:MediaResource
 
mediaId:String
 
metadata:Metadata
Event Detail
audioTrackPlaying Event
Event Object Type: com.adobe.mediacore.events.AudioTrackEvent

Dispatched when a new audio track has started playback

audioTrackSelect Event  
Event Object Type: com.adobe.mediacore.events.AudioTrackEvent

Dispatched when an audio track has been selected

itemDurationChange Event  
Event Object Type: com.adobe.mediacore.events.MediaPlayerItemEvent

Dispatched to notify that the duration of the asset has changed

itemIsProtectedChange Event  
Event Object Type: com.adobe.mediacore.events.MediaPlayerItemEvent

Dispatched to notify that the isProtected property has changed

itemTracksAvailable Event  
Event Object Type: com.adobe.mediacore.events.MediaPlayerItemEvent

Dispatched to notify that the tracks are available

itemVideoRenditionsAvailable Event  
Event Object Type: com.adobe.mediacore.events.MediaPlayerItemEvent

Dispatched to notify that different video renditions are available for this item

itemVideoSizeChange Event  
Event Object Type: com.adobe.mediacore.events.MediaPlayerItemEvent

Dispatched to notify that the size the video has changed

Constant Detail
DEFAULT_NOTIFICATION_HISTORY_CAPACITYConstant
public const DEFAULT_NOTIFICATION_HISTORY_CAPACITY:uint = 1000