Click or drag to resize
VastAdBreak Class
An VASTAdBreak object defines an ad break for which the builder plugin will try to generate MediaUnits and insert them into the playlist.
Inheritance Hierarchy

Namespace: Veeplay.media.events
Assembly: Veeplay (in Veeplay.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class VastAdBreak : MediaEvent

The VastAdBreak type exposes the following members.

Constructors
  NameDescription
Public methodVastAdBreak
Initializes a new instance of the VastAdBreak class
Top
Methods
  NameDescription
Public methodadBreakTrackErrorWithCodeEvent
Public methodaddSource(String)
Public methodaddSource(VASTXMLNode)
Public methodadjustForAbsoluteDuration (Inherited from MediaEvent.)
Public methodadjustRelativeToDuration
Translates percentual values set via setStartPoint to actual time intervals in seconds, relative to a specified total duration.
(Inherited from MediaEvent.)
Public methodadsForDatawithWrappers
Public methodadsForRootWithWrappers
Public methodadsForURLWithWrappers
Public methodconfigureFromDictionary
Public methodStatic membercopyAdBreak
Public methodendPoint
The time interval (in seconds) when the player needs to remove the overlay.

Warning: If percentual values were set via setStartPoint, this value will change immediately after the current clip's duration is available.

(Inherited from MediaEvent.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodStatic membergenerateAdBreaks
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodgetState
Get the current event state
(Inherited from MediaEvent.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodincrementStartAndEndPointsWithInterval
Shifts air-time for an overlay by a defined amount of time.
(Inherited from MediaEvent.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodneedsToBeAdjustedRelativeToDuration
Determines if an overlay has start points, end points or duration relative to the unit duration.
(Inherited from MediaEvent.)
Public methodonPreload (Overrides MediaEventonPreload.)
Public methodonTrigger (Overrides MediaEventonTrigger.)
Public methodonUnload (Overrides MediaEventonUnload.)
Public methodonUpdate (Overrides MediaEventonUpdate.)
Public methodoverlaysForNonlinearsInInlineNodes
Public methodStatic memberparseAdBreaksDictionary
Public methodpreload (Inherited from MediaEvent.)
Public methodremoveSource(String)
Public methodremoveSource(VASTXMLNode)
Public methodsetAdBreakTrackingForList
Public methodsetEndPoint
Sets the ending time point of the overlay.
(Inherited from MediaEvent.)
Public methodsetPointsForOverlayForAdBreak
Public methodsetStartPoint
Sets the starting time point of the overlay.
(Inherited from MediaEvent.)
Public methodstartPoint
The time interval (in seconds) when the player needs to display the overlay.

Warning: If percentual values were set via setStartPoint, this value will change immediately after the current clip's duration is available.

(Inherited from MediaEvent.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodtrackErrorWithCode
Public methodtrigger (Inherited from MediaEvent.)
Public methodunitsForLinearsInInlineNodesWithBuffet
Public methodunload (Inherited from MediaEvent.)
Public methodupdateState
Update the event state
(Inherited from MediaEvent.)
Top
Fields
  NameDescription
Protected field_absoluteDuration (Inherited from MediaEvent.)
Protected field_endPoint (Inherited from MediaEvent.)
Protected field_relativeEndPoint (Inherited from MediaEvent.)
Protected field_relativeStartPoint (Inherited from MediaEvent.)
Protected field_startPoint (Inherited from MediaEvent.)
Public fieldadOffset
Public fieldadPodFallbackStrategy
Public fieldafterBannerTapped
Defines the behavior of the player after a banner ad is tapped and the built-in web browser is dismissed.
Public fieldafterVideoAdTapped
Defines the behavior of the player after a video ad is tapped and the built-in web browser is dismissed.
Public fieldallowMultipleAds
Public fieldbannerCloseButtonBackgroundColor
Public fieldbannerCloseButtonFinalAlpha
Public fieldbannerCloseButtonImage
Public fieldbannerCloseButtonInitialAlpha
Public fieldbannerCloseButtonOffsetX
Public fieldbannerCloseButtonOffsetY
Public fieldbannerCloseButtonProgressColor
Public fieldbannerCloseButtonSize
Public fieldbannerCloseButtonTrackColor
Public fieldbannerCloseButtonXColor
Public fieldbannerFadeInDuration
Public fieldbannerMaxSizeHeight
Public fieldbannerMaxSizeWidth
Public fieldbannerPosition
Public fieldbannerSkipOffset
Public fieldcontrolsDisplayForAds
Public fieldcontrolsParametersForAds
Public fieldcountdownColor
Public fieldcountdownFont
Public fieldcountdownHeight
Public fieldcountdownPosition
Public fieldcountdownSize
Public fieldcountdownText
Public fieldcountdownWidth
Public fielddebugMode
Public fielddefaultAdBreakPositions
Public fielddefaultBannerAdBreakDuration
Public fielddefaultIconHeightPercentage
Public fielddefaultSkipOffset
Public fielddynamicPosition (Inherited from MediaEvent.)
Public fieldfollowWrappers
Public fieldiconFadeInDuration
Public fieldisDynamicAdBreak
Protected fieldloaded (Inherited from MediaEvent.)
Public fieldmetadata
Public fieldStatic memberMetadataCurrentAdBreakIndex
Public fieldStatic memberMetadataCurrentAdBreakOffset
Public fieldStatic memberMetadataTotalAdBreakAds
Public fieldmultipleAdsConflictsPolicy
Public fieldnextMediaCountdownPosition
Public fieldprefferedVideoMimeTypes
Public fieldpreloadInterval
Defines the number of seconds before the scheduled start point when the event should receive the preload call.
(Inherited from MediaEvent.)
Public fieldpreloadPoint
Set by the player to the current playback time in seconds, after the current event begins preloading. Defaults to -1 if the event did not start preloading.
(Inherited from MediaEvent.)
Public fieldrepeatAfter
If this parameter is greater than 0, then the event will be retriggered by the MediaPlayer after the specific time interval (in seconds).
(Inherited from MediaEvent.)
Public fieldshowBannerCloseButton
Public fieldshowCountdown
Public fieldskipButtonBackgroundColor
Public fieldskipButtonBorderColor
Public fieldskipButtonBorderRadius
Public fieldskipButtonHeight
Public fieldskipButtonPadding
Public fieldskipButtonPosition
Public fieldskipButtonProgressCircleColor
Public fieldskipButtonProgressCircleTextColor
Public fieldskipButtonProgressCircleTrackColor
Public fieldskipButtonProgressPosition
Public fieldskipButtonText
Public fieldskipButtonTextColor
Public fieldskipButtonWidth
Public fieldsources
Public fieldstretchBannersToMaxSize
Public fieldtimeout
Defines the maximum number of seconds the event is allowed to live once it has been pretriggered, without setting the loaded property to true.
(Inherited from MediaEvent.)
Public fieldtrackingURLs
This dictionary defines all URLs that need to be notified of specific events from the object's lifecycle. The keys are event constants, as defined in MediaPlayer
(Inherited from MediaTrackableObject.)
Public fieldtype
Public fielduserAgent
Public fieldStatic memberVastMidrollUnit
Public fieldStatic memberVastPostrollUnit
Public fieldStatic memberVastPrerollUnit
Top
Events
  NameDescription
Public eventStateChanged (Inherited from MediaEvent.)
Public eventTimeoutEvent (Inherited from MediaEvent.)
Top
See Also