Packagecom.adobe.mediacore.timeline.advertising
Classpublic final class AdBreak
InheritanceAdBreak Inheritance Object

Represents a group of ads. While an ad break can contain both linear and non-linear ads, it is recommended to keep them separated as some undefined placement behaviors can occur if they are mixed.



Public Properties
 PropertyDefined By
  ads : Vector.<Ad>
[read-only] The ads contained in this ad break.
AdBreak
  duration : Number
[read-only] The total duration of the ad break.
AdBreak
  tracker : ContentTracker
[read-only] Analytics provider for this ad break.
AdBreak
  type : String
[read-only]
AdBreak
Public Methods
 MethodDefined By
  
AdBreak(ads:Vector.<Ad>, tracker:ContentTracker = null, type:String = null)
Default constructor.
AdBreak
  
create(ads:Vector.<Ad>, tracker:ContentTracker = null, type:String = null):AdBreak
[static] Helper method for creating ad breaks.
AdBreak
Property Detail
adsproperty
ads:Vector.<Ad>  [read-only]

The ads contained in this ad break. This method returns a copy of the internal vector - so it is recommended to save the return value in a local variable and use that instead. We do so for preventing accidental/unwanted modifications of the ad vector.


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

The total duration of the ad break. Is is calculated by adding the duration of all linear ads contained within the ad break.


Implementation
    public function get duration():Number
trackerproperty 
tracker:ContentTracker  [read-only]

Analytics provider for this ad break.


Implementation
    public function get tracker():ContentTracker
typeproperty 
type:String  [read-only]


Implementation
    public function get type():String
Constructor Detail
AdBreak()Constructor
public function AdBreak(ads:Vector.<Ad>, tracker:ContentTracker = null, type:String = null)

Default constructor.

Parameters
ads:Vector.<Ad> — the ads which are grouped together.
 
tracker:ContentTracker (default = null) — The analytics provider for this ad break.
 
type:String (default = null)
Method Detail
create()method
public static function create(ads:Vector.<Ad>, tracker:ContentTracker = null, type:String = null):AdBreak

Helper method for creating ad breaks.

Parameters

ads:Vector.<Ad> — the ads which will be contained in this ad break.
 
tracker:ContentTracker (default = null) — The analytics provider for this ad break.
 
type:String (default = null)

Returns
AdBreak — a valid ad break