Skip to end of metadata
Go to start of metadata

 Overview

This document captures a high level requirements and architecture for client side DAI Implementation in the AAMP Native Engine

1.Product and Technical Requirements

Req   No.

Product   Requirements

Status

1.0



2.0




2. Architecture

This section provides a high level architecture



2.1.Component Overview  


Process view


3.0.Integrated AAMP-FOG 

Detaching the AAMP from browser & merging with the FOG's executable gives us the flexibility in caching the dynamic Ads in the local storage. It provides many other advantages and few disadvantages too.

3.1.Pros

    1. AAMP Player can be used by other apps too.
    2. FOG & AAMP can be kept running silently in the background . Hence, coming back from an app will quickly play the linear video with TSB available. 
    3. Eliminates the requirement of AAMP plugins from the browser. It provides better load time while boot up and app launching/exiting would be faster too.
    4. Can isolate the AAMP bugs from the browser; hence debugging will be easy.
    5. Browser crash won’t affect the playback and AAMP crash doesn't need browser reloading too; hence crash recovery will be faster.
    6. No redundant codes for FOG and AAMP; saves development effort, memory and performance.
    7. FOG refreshes the manifest in the memory, which will be readily available to AAMP; No need of explicit refreshing the manifest in the AAMP side.
    8. Overlapping streams (eg: client side DAI) can be cached and played easily.
    9. It eliminates extra operations to send the fragments from FOG to AAMP.
    10. Will be able to run the unified executable in the desktop environment without any code changes.

3.2.Cons

    1. Extra effort needed for integrating AAMP & FOG.
    2. Complexity and number of threads increases; hence maintenance effort too.
    3. Player platform needs an IPC mechanism to communicate with AAMP - but avoids IPC between AAMP & FOG.
    4. Integrated binary will be heavier than the individual modules of FOG & AAMP; it takes more memory footprint and load time.
    5. Can’t unload the AAMP and freeup memory, while it is not in use. Eg: launching an App may not need AAMP.
    6. Can't support the HTML5 video tag directly. (It needs another plugin to interact with the AAMP process; which would result in unnecessary complexities.)

Integration activity suspended due to the difficulty in supporting the HTML5 video tag.

4.0.AAMP Player APIs 

4.1.Properties

Name

Data Type

Read or Write

Description

urlStringr/wvideo content URL
contentOptionsObjectr/whash of k/v pairs required for content playback
autoPlayBooleanr/wwhen true, video starts playing immediately; when false, playback must be manually started.
audioLanguageStringr/wprimary audio language. If set to a value that does not exist for the content, value will not be changed.
secondaryAudioLanguageStringr/wsecondary audio language. If set to a value that does not exist for the content, value will not be changed.
closedCaptionsLanguageStringr/wclosed captions language. If set to a value that does not exist for the content, value will not be changed.
closedCaptionsEnabledBooleanr/wwhen true, closed captioning is enabled; when false, closed captioning is disabled
closedCaptionsOptionsObjectr/wcaption options
positionNumberr/wposition of video
speedNumberr/wplayback speed
volumeNumberr/wa value from 0 to 100. Defaults to 100.
zoomStringr/w"FULL" or "NONE". When FULL, content is stretched to width and height of player. When NONE, content is best fit to width or height of player without distorting the video's aspect ratio.
durationNumberrduration of video in milliseconds
availableAudioLanguagesString [ ]rarray of the available audio languages for this video
availableClosedCaptionsLanguagesString [ ]rarray of the available captions languages for this video
availableSpeedsString [ ]rarray of the available playback speeds for this video
tsbEnabledBooleanr/w

when false, TSB will not be available. when true, TSB may be available if video and device support it.

timelineObjectr

Timeline object used for DAI support (see section 5.0).


4.2.Functions

Name

Return Value

Arguments

Description

playvoidnonestarts video playback
pausevoidnonepauses video playback. Equivalent to speed = 1
stopvoidnonestops video playback. Video is not expected to resume.
setSpeedvoid

speed - Number

overshootCorrection - Number (milliseconds)

sets the speed and adjusts the position of the video by the number of milliseconds specified by overshootCorrection
setPositionRelativevoidseconds - NumberSets the position of the video by adding the given number of seconds. seconds may be positive or negative, but should not cause the position to be less than zero or greater than the duration.
requestStatusvoidnoneRequests the onStatus event to be fired
setAdditionalAuthvoidparams - Objectprovides a set of k/v pairs required for additional authentication and authorization


4.3.Events

Name

Payload

Description

onMediaOpened

mediaType - String - has one of the following values: live, liveTSB, recorded

width - Number

height - Number

availableSpeeds - Number

availableAudioLanguages - String [ ]

availableClosedCaptionsLanguages - String [ ]

customProperties - Object

mediaSegments - Object

Fired when video content has been opened
onClosednonefired when the video stream is closed
onPlayerInitializednonefired when the video player is initialized
onBufferingnonefired when video starts buffering. playback is not possible at this time.
onPlayingnonefired when video starts playing for the first time.
onPausednonefired when video is paused (or speed is set to 0)
onCompletenonefired when video is reaches its end, VOD or cDVR for example.
onIndividualizingnonefired when player is individualizing. Playback is not possible. Not all instances will fire this event.
onAcquiringLicensenonefired when player is acquiring a license. Playback is not yet possible. Not all instances will fire this event.
onProgress

position - Number - current position in milliseconds

duration - Number - length of content in milliseconds (recorded video only)

speed - Number - current playback speed

start - Number - start position of the TSB buffer, -1 when no buffer available

end - Number - end position of the TSB buffer, -1 when no buffer available

fired periodically when player progresses
onWarning

code - Number

description - String

fired when a warning occurs. video playback will likely continue.
onError

code - Number

description - String

fired when an error occurs. video playback will terminate.
onSpeedChangespeed - Numberfired when playback speed changes
onDRMMetadataprops - Objectfired when DRM metadata is acquired. Contains DRM related properties.
onSegmentStarted

segmentType - String

duration - Number

segmentId - String

segment - Object

fired when a new segment is started.
onSegmentCompleted

segmentType - String

duration - Number

segmentId - String

segment - Object

fired when a segment is has completed
onSegmentWatched

segmentType - String

duration - Number

segmentId - String

segment - Object

fired when a segment has been started and completed.
onBufferWarning

warningType - String - one of BUFFER_UNDERFLOW or BUFFER_OVERFLOW

bufferSize - Number - total size of buffer

bufferFillSize - Number - current filled size of buffer


onPlaybackSpeedsChangedavailableSpeeds - String [ ]fired when playback speeds have changed. This may happen when the video switches from one segment to the next.
onAdditionalAuthRequired

locator - String

eventId - String

fired when video needs additional auth to continue playback

5.0.AAMP Timeline APIs

5.1.DAI support:  Timeline, AdBreak, Ad

Based on the timedMeata events, AAMP will construct a Timeline object that contains a list of AdBreak and Ad.

AAMP.timeline;

-- Get a reference (read-only) to the current Timeline object.

interface Timeline {

readonly attribute AdBreak adBreaks[];

readonly attribute AdOpportunity adOpportunities[];

readonly attribute Number start;
readonly attribute Number duration;
readonly attribute Number position;

readonly attribute TrickModeRestrictions restrictions;

addEventListener(eventType, listener);
removeEventListener(eventType, listener);

};

interface AdBreak {

const unsigned short ADBREAK_TYPE_INSERT = 0;
const unsigned short ADBREAK_TYPE_REPLACE = 1;

readonly attribute unsigned short type;
readonly attribute String id;
readonly attribute Number start;
readonly attribute Number duration;

readonly attribute Ad ads[];

};

 interface Ad {

readonly attribute String id;
readonly attribute String url;
readonly attribute Number duration;
readonly attribute Object metadata;
readonly attribute TrickModeRestrictions restrictions;

};

interface TrickModeRestrictions {

readonly attribute Number pause;
readonly attribute Number rewind;
readonly attribute Number fastForward;

};

interface AdOpportunity {

const unsigned short AD_PLACEMENT_TYPE_PREROLL = 0;
const unsigned short AD_PLACEMENT_TYPE_MIDROLL = 1;
const unsigned short AD_PLACEMENT_TYPE_POSTROLL = 2;

const unsigned short AD_PLACEMENT_MODE_INSERT = 0;
const unsigned short AD_PLACEMENT_MODE_REPLACE = 1;

readonly attribute unsigned short placement;
readonly attribute unsigned short mode;
readonly attribute String id;
readonly attribute Number start;
readonly attribute Number duration;

readonly attribute Object metadata;

};

5.2.Timeline Properties

Name

Data Type

Read or Write

Description

adBreaksObject[]r

Array of AdBreak objects (sorted by time).

Contains replaced and inserted Ad placed into the timeline.

adOpportunitiesObject[]r

Array of AdOpportunity objects (sorted by time).

Contains replaced and inserted Ad opportunities available for client-side Ad insertion.

durationNumberrDuration of the entire timeline in milliseconds (includes content and placed Ads).
positionNumberrCurrent playback position in milliseconds.
startNumberrEarliest seekable position in milliseconds
timedMetadataObject[]r

Array of TimedMetadata objects (sorted by time).

Contains metadata associated with HLS subscribed tags and embedded SCTE35 data.

5.3.Timeline Functions

Name

Return Value

Arguments

Description

addEventListenervoid

eventType - String,

listener - Function

Register an event listener for the specified eventType.

removeEventListenervoid

eventType - String,

listener - Function

De-register the specifiend event listener for the specified eventType.
placeAdBreakbooladBreak - Object

Places the specified AdBreak into the timeline.

Return true if successful.

subscribedTimedMetadatavoidtags - String []

Sets collection of HLS tags to monitor during parsing, or embedded data.

Fire "timedMetadata" event when subscribed tags are parsed.

5.4.Timeline Events

Name

Payload

Description

timelineUpdated

seekableRangeChanged - bool

adBreaks - Object[] - array of modified AdBreaks

adOpportunities - Object[] - array of inserted AdOpportunities

duration - Number - duration of entire timeline (milliseconds)

position - Number - current position in the timeline (milliseconds)

start - Number - earliest seekable position in the timeline (milliseconds)

Fired timeline is updated.

An update occurs when the timeline start/duration changes, or new AdOpportunity has been inserted, or an AdBreak / Ad has been placed.

timedMetadatatimedMetadata - ObjectFired when new TimedMetadata has been parsed.
adBreakStart

adBreak - Object - the AdBreak being started

speed - Number - current playback rate

seenCount - Number - number of times Ad break was played (in full).

Fired when player starts playing an AdBreak.
adBreakComplete

adBreak - Object - the Adbreak being finished

progress - Number - percentage of Ads played

ads - Object[] - array of Ad including played progress of each Ad.

Fired when player finishes playing an AdBreak.
adBreakSkipped

adBreak - Object - the Adbreak being skipped or exited

progress - Number - percentage of Ads played

Fired when player skips over an AdBreak.
adStart

ad - Object - the Ad being started

speed - Number - current playback rate

seenCount - Number - number of times Ad was played (in full).

Fired when player start playing an Ad.
adProgress

ad - Object - the Ad being played

progress - Number - percentage of Ad played

Reports the player's progress as it plays an Ad.
adComplete

ad - Object - the Ad that finished begin played

progress - Number - percentage of Ad played

Fired when player finishes playing an Ad.

5.5.AdBreak Properties

Name

Data Type

Read or Write

Description

ADBREAK_TYPE_INSERT0static const

Indicates adBreak was inserted.

ADBREAK_TYPE_REPLACED1static const

Indicates adBreak was replaced.

typeNumberrSpecified the abBreak type, and indicates if adds are inserted or replace existing content.
idStringrUnique identifier associated with the ad break.
startNumberrStarting position (milliseconds) of the ad break in the timeline.
durationNumberrDuration (milliseconds) of the ad break.
adsObject[]r

Array of Ad objects (sorted by time).

Contains the ads that will be played during the ad break.

5.6.AdBreak Functions

Name

Return Value

Arguments

Description

placeAdsbool

position - Number,

ads - Object[]

Place the specified Ad objects in the AdBreak.

Return true if successful.

5.7.Ad Properties

Name

Data Type

Read or Write

Description

idStringr

Unique identifier associated with the ad.

urlStringr

URL specifying the location of the ad's manifest.

durationNumberrDuration (milliseconds) of the ad.
metadataObjectrAdditional metadata associated with the ad.

5.8.AdOpportunity Properties

Name

Data Type

Read or Write

Description

AD_PLACEMENT_TYPE_PREROLL0static const

Indicates opportunity places ad before the main content.

AD_PLACEMENT_TYPE_MIDROLL1static const

Indicates opportunity places ad in the main content.

AD_PLACEMENT_TYPE_POSTROLL2static const

Indicates opportunity places ad after the main content.

AD_PLACEMENT_MODE_INSERT0static const

Indicates opportunity inserts ad inside content.

AD_PLACEMENT_MODE_REPLACE1static const

Indicates opportunity replaces content.

idStringr

Unique identifier associated with the ad opportunity.

placementNumberrIndicates placement type: preroll vs. midroll vs. postroll.
modeNumberrIndicates placement mode: insertion vs. replacement.
startNumberrStarting position (milliseconds) of the ad opportunity.
durationNumberrDuration (milliseconds) of the ad.
metadataObjectrAdditional metadata associated with the ad opportunity.

5.9.TimedMetadata Properties

Name

Data Type

Read or Write

Description

METADATA_TYPE_TAG0static const

Indicates metadata is from the manifest.

METADATA_TYPE_ID31static const

Indicates metadata was embedded in the content.

typeNumberr

Specified the metadata type: manifest vs. embedded.

timeNumberr

Time (in milliseconds) of the metadata.

nameStringr

Name of the metadata. E.g., #EXT-X-CUE, #EXT-X-SCTE35.

contentStringrValue of the metadata.
idStringr

Unique identifier associated with the metadata.

metadataObjectrAdditional name / value pairs obtained from the metadata content string.

5.10.TrickModeRestrictions Properties

Name

Data Type

Read or Write

Description

pauseNumberr

Specifies if pause is restricted during Ad playback.

rewindNumberr

Specifies if rewind is restricted during Ad playback.

fastForwardNumberr

Specified if fastForward is restricted during Ad playback.

  • No labels