Package | se.videoplaza.kit.api |
Class | public class RequestSettings |
Property | Defined by | ||
---|---|---|---|
cuePoints : Array
Set the cue points for the request.
| RequestSettings | ||
height : Number
The height of the video area for the ad request.
| RequestSettings | ||
initialAdRequestTimeout : int
The initial ad request timeout, in milliseconds.
| RequestSettings | ||
insertionPointTypes : Array
The insertion point types for the request.
| RequestSettings | ||
linearSlotSize : Number
Sets the linearSlotSize, i.e the desired slot size of linear ads.
| RequestSettings | ||
maxBitRate : Number
Maximum bit-rate in kbs of the for the ad request.
| RequestSettings | ||
maxLinearBreakDuration : Number
Maximum linear ad break duration, in seconds.
| RequestSettings | ||
referrerUrl : String
Override value for the [request.referrerurl] macro.
| RequestSettings | ||
width : Number
The width of the video area for the ad request.
| RequestSettings |
Method | Defined by | ||
---|---|---|---|
RequestSettings |
cuePoints | property |
cuePoints:Array
[read-write]Set the cue points for the request. A cue point represents a point in time on the content time line.
Cue points are required when insertionPointTypes
contains InsertionPointType.ON_CUE_POINT
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"
RequestSettings.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
height | property |
height:Number
[read-write]The height of the video area for the ad request.
Implementation public function get height():Number
public function set height(value:Number):void
initialAdRequestTimeout | property |
initialAdRequestTimeout:int
[read-write]The initial ad request timeout, in milliseconds.
Implementation public function get initialAdRequestTimeout():int
public function set initialAdRequestTimeout(value:int):void
insertionPointTypes | property |
insertionPointTypes:Array
[read-write]
The insertion point types for the request.
Supported types of content forms: InsertionPointType.ON_CUE_POINT
and InsertionPointType.ON_CONTENT_END
.
public function get insertionPointTypes():Array
public function set insertionPointTypes(value:Array):void
See also
linearSlotSize | property |
linearSlotSize:Number
[read-write]Sets the linearSlotSize, i.e the desired slot size of linear ads.
NOTE! Using this will affect the predictibility of the Pulse forecast functionality. Use with caution.
Implementation public function get linearSlotSize():Number
public function set linearSlotSize(value:Number):void
maxBitRate | property |
maxBitRate:Number
[read-write]Maximum bit-rate in kbs of the for the ad request. The bit-rate will be used to determine what creative files are needed
Implementation public function get maxBitRate():Number
public function set maxBitRate(value:Number):void
maxLinearBreakDuration | property |
maxLinearBreakDuration:Number
[read-write]Maximum linear ad break duration, in seconds.
Implementation public function get maxLinearBreakDuration():Number
public function set maxLinearBreakDuration(value:Number):void
referrerUrl | property |
referrerUrl:String
[read-write]Override value for the [request.referrerurl] macro.
Implementation public function get referrerUrl():String
public function set referrerUrl(value:String):void
width | property |
width:Number
[read-write]The width of the video area for the ad request.
Implementation public function get width():Number
public function set width(value:Number):void
RequestSettings | () | constructor |
public function RequestSettings()