com.adobe.mediacore
Interface MediaPlayerItem

public 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.

Method Summary

List<String>	getAdTags() Provides the list of ad tags, used for the ad placement process.
List<AudioTrack>	getAudioTracks() Provides the list of currently available audio tracks.
List<Integer>	getAvailableSpeeds() Provides the list of available "speeds" in the context of the "trick-play" feature.
List<ClosedCaptionsTrack>	getClosedCaptionsTracks() Provides the list of currently available closed captions tracks.
List<DRMMetadataInfo>	getDRMMetadataInfos() A list of all the DRM metadata objects discovered in the manifest.
List<Profile>	getProfiles() Provides the list of currently available bit-rates profiles for the current playback window.
MediaResource	getResource() Returns the media resource associated with this item.
AudioTrack	getSelectedAudioTrack() Returns the currently selected alternate audio track.
ClosedCaptionsTrack	getSelectedClosedCaptionsTrack() Returns the currently selected closed caption track.
List<TimedMetadata>	getTimedMetadata() Provides the list of currently available timed metadata for the current playback window.
boolean	hasAlternateAudio() Flag indicating that the media has alternate audio tracks.
boolean	hasClosedCaptions() Flag indicating that the media has alternate closed captions tracks.
boolean	hasTimedMetadata() Flag indicating that the media has timed metadata.
boolean	isDynamic() Flag indicating that the media has multiple bit-rate profiles.
boolean	isLive() Flag indicating if the stream is live or not.
boolean	isProtected() Flag indicating that the media is protected through the DRM module.
boolean	isTrickPlaySupported() Flag indicating that whether the "trick-play" feature is supported.
boolean	selectAudioTrack(AudioTrack audioTrack) Selects an alternate audio track to play.
boolean	selectClosedCaptionsTrack(ClosedCaptionsTrack closedCaptionsTrack) Selects a close captions track to display.

Method Detail

getResource

MediaResource getResource()

Returns the media resource associated with this item.

isLive

boolean isLive()

Flag indicating if the stream is live or not.

Returns:

true if the stream is a live stream, false otherwise.

hasAlternateAudio

boolean hasAlternateAudio()

Flag indicating that the media has alternate audio tracks.

Returns:

true if alternate audio tracks are available, false otherwise.

getAudioTracks

List<AudioTrack> getAudioTracks()

Provides the list of currently available audio tracks.

Returns:

the list of currently available audio tracks.

getSelectedAudioTrack

AudioTrack getSelectedAudioTrack()

Returns the currently selected alternate audio track.

Returns:

the currently selected audio track

selectAudioTrack

boolean selectAudioTrack(AudioTrack audioTrack)

Selects an alternate audio track to play. Selection to the same audio track will results in keeping the alternate audio configuration. If an audio track cannot be loaded, a selection to another alternate audio track must be made.

Parameters:

audioTrack - the audio track to be selected

Returns:

whether the operation was successful or not

hasClosedCaptions

boolean hasClosedCaptions()

Flag indicating that the media has alternate closed captions tracks.

Returns:

true if closed captions tracks are available, false otherwise.

getClosedCaptionsTracks

List<ClosedCaptionsTrack> getClosedCaptionsTracks()

Provides the list of currently available closed captions tracks.

Returns:

the list of currently available closed captions tracks.

getSelectedClosedCaptionsTrack

ClosedCaptionsTrack getSelectedClosedCaptionsTrack()

Returns the currently selected closed caption track.

Returns:

the currently selected closed caption track

selectClosedCaptionsTrack

boolean selectClosedCaptionsTrack(ClosedCaptionsTrack closedCaptionsTrack)

Selects a close captions track to display.

Parameters:

closedCaptionsTrack - the CC track to be selected

Returns:

whether the operation was successful or not

hasTimedMetadata

boolean hasTimedMetadata()

Flag indicating that the media has timed metadata.

Returns:

true if the media has timed metadata, false otherwise.

getTimedMetadata

List<TimedMetadata> getTimedMetadata()

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

Returns:

the list of currently available timed metadata.

isDynamic

boolean isDynamic()

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

Returns:

true if multiple profiles are available, false otherwise.

isProtected

boolean isProtected()

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

Returns:

true if the media is DRM protected, false otherwise.

getDRMMetadataInfos

List<DRMMetadataInfo> getDRMMetadataInfos()

A list of all the DRM metadata objects discovered in the manifest.

Returns:

a list containing these DRMMetadataInfo objects.

getProfiles

List<Profile> getProfiles()

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

Returns:

the list of currently available bit-rate profiles.

isTrickPlaySupported

boolean isTrickPlaySupported()

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

Returns:

true if the the "trick-play" feature is supported, false otherwise.

getAvailableSpeeds

List<Integer> getAvailableSpeeds()

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

Returns:

the list of currently available "speeds".

getAdTags

List<String> getAdTags()

Provides the list of ad tags, used for the ad placement process.

Returns:

the list of ad tags.