| Package | se.videoplaza.kit.api.utils |
| Class | public dynamic class ItemInfo |
ItemInfo class carries vital item information to the AdPlayer.
The ItemInfo object is dynamic, allowing you to add methods and properties
dynamically. This allows for customization of this object, thereby providing the AdPlayer
with information unique to a certain client implementation. Observe that for this customization
to have effect, both parties must have agreed on this custom implementation.
| Property | Defined by | ||
|---|---|---|---|
| category : String
Gets/Sets Category
| ItemInfo | ||
| contentForm : String
Gets/Sets contentForm
| ItemInfo | ||
| contentId : String
Get/Set ContentId
| ItemInfo | ||
| contentPartner : String
Gets/Sets contentPartner
| ItemInfo | ||
| cuePoints : Array
Gets / sets an array of cue points.
| ItemInfo | ||
| customParameters : Dictionary | ItemInfo | ||
| duration : Number
Gets / sets the item duration.
| ItemInfo | ||
| flags : Array
Gets / sets an array of Pulse specific flags related to the item.
| ItemInfo | ||
| initialAdRequestTimeout : int
Get/set the timeout of the initial ad request.
| ItemInfo | ||
| referrerUrl : String
Gets the override value for the [request.referrerurl] macro
| ItemInfo | ||
| tags : Array
Gets / sets an array of tags related to the item.
| ItemInfo | ||
| timeReference : ITimeReference
Gets / sets an ITimeReferenceObject for this item.
| ItemInfo | ||
| uri : String | ItemInfo | ||
| Method | Defined by | ||
|---|---|---|---|
|
ItemInfo()
| ItemInfo | ||
| category | property |
category:String [read-write]Gets/Sets Category
Implementation public function get category():String
public function set category(value:String):void
| contentForm | property |
contentForm:String [read-write]Gets/Sets contentForm
Implementation public function get contentForm():String
public function set contentForm(value:String):void
| contentId | property |
contentId:String [read-write]Get/Set ContentId
Implementation public function get contentId():String
public function set contentId(value:String):void
| contentPartner | property |
contentPartner:String [read-write]Gets/Sets contentPartner
Implementation public function get contentPartner():String
public function set contentPartner(value:String):void
| cuePoints | property |
cuePoints:Array [read-write]Gets / sets an array of cue points. A cue point represents a point in time on the content time line.
Note! The cuePoints array should contain objects with name and time properties.
Linear ads like standard spots will be inserted at cue points name : "vpLinear", Nonlinear ads like overlays will start at cue points name : "vpNonlinear"
cuePoints = [{name:"vpLinear", time:65}, {name:"vpLinear", time:320}, {name:"vpNonlinear", time:120}];
Implementation
public function get cuePoints():Array
public function set cuePoints(value:Array):void
| customParameters | property |
customParameters:Dictionary [read-write]Implementation
public function get customParameters():Dictionary
public function set customParameters(value:Dictionary):void
| duration | property |
duration:Number [read-write]Gets / sets the item duration.
Implementation public function get duration():Number
public function set duration(value:Number):void
| flags | property |
flags:Array [read-write]Gets / sets an array of Pulse specific flags related to the item.
Flags are Pulse specific rules that decide whether or not to display
certain or all ads / ad formats in during the session created for this item.
Flags are string values, and available flags are defined as constants in the
VpFlag object.
public function get flags():Array
public function set flags(value:Array):void
See also
| initialAdRequestTimeout | property |
initialAdRequestTimeout:int [read-write]Get/set the timeout of the initial ad request.
Implementation public function get initialAdRequestTimeout():int
public function set initialAdRequestTimeout(value:int):void
| referrerUrl | property |
referrerUrl:String [read-write]Gets the override value for the [request.referrerurl] macro
Implementation public function get referrerUrl():String
public function set referrerUrl(value:String):void
| tags | property |
tags:Array [read-write]Gets / sets an array of tags related to the item.
Implementation public function get tags():Array
public function set tags(value:Array):void
| timeReference | property |
timeReference:ITimeReference [read-write]Gets / sets an ITimeReferenceObject for this item. This object is the time engine, from which the AdPlayer can access the current playhead position for this item. If no timeReference is set, the AdPlayer cannot evaluate the correct timing for time-based events.
Implementation public function get timeReference():ITimeReference
public function set timeReference(value:ITimeReference):void
| uri | property |
uri:String [read-write]Implementation
public function get uri():String
public function set uri(value:String):void
| ItemInfo | () | constructor |
public function ItemInfo()