Packagese.videoplaza.kit.api
Classpublic class RequestSettings

RequestSettings contains integration specific information for the ad request.



Public Properties
 PropertyDefined 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
Public Methods
 MethodDefined by
  
RequestSettings
Property detail
cuePointsproperty
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"

Example:
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
heightproperty 
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
initialAdRequestTimeoutproperty 
initialAdRequestTimeout:int  [read-write]

The initial ad request timeout, in milliseconds.

Implementation
    public function get initialAdRequestTimeout():int
    public function set initialAdRequestTimeout(value:int):void
insertionPointTypesproperty 
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.

Implementation
    public function get insertionPointTypes():Array
    public function set insertionPointTypes(value:Array):void

See also

linearSlotSizeproperty 
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 Ooyala Pulse forecast functionality. Use with caution.

Implementation
    public function get linearSlotSize():Number
    public function set linearSlotSize(value:Number):void
maxBitRateproperty 
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
maxLinearBreakDurationproperty 
maxLinearBreakDuration:Number  [read-write]

Maximum linear ad break duration, in seconds.

Implementation
    public function get maxLinearBreakDuration():Number
    public function set maxLinearBreakDuration(value:Number):void
referrerUrlproperty 
referrerUrl:String  [read-write]

Override value for the [request.referrerurl] macro.

Implementation
    public function get referrerUrl():String
    public function set referrerUrl(value:String):void
widthproperty 
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
Constructor detail
RequestSettings()constructor
public function RequestSettings()