Packagecom.brightcove.fl.advertising.adSwf
Classpublic class AdSwfConfig
InheritanceAdSwfConfig Inheritance Object

Configuration for an ad display SWF. This class should not be instantiated directly- use AdSwf.config.

See also

AdSwf.config


Public Properties
 PropertyDefined By
  completeOnVideoChange : Boolean = true
Determines whether adComplete() is automatically called when the current video has changed.
AdSwfConfig
  completeOnVideoComplete : Boolean = true
Determines whether adComplete() is automatically called when the current video is completed.
AdSwfConfig
  customStartStopEvents : Boolean = false
Setting this to true will make sure that the player does not dispatch any AdEvent start or stop events for the ad display SWF.
AdSwfConfig
  keepVisibleAfterComplete : Boolean = false
Allows the AdSwf to be visible after adComplete() is called.
AdSwfConfig
  pauseVideoPlayer : Boolean = false
Allows for a linear or non-linear mode for the ad.
AdSwfConfig
  resizeOnFullScreen : Boolean = true
Determines whether or not the player takes control of resizing an ad when the player switches in and out of full screen.
AdSwfConfig
  resizeOnMenuOpen : Boolean = true
Determines whether or not the player takes control of resizing an ad to fit within the video window when the Brightcove menu opens.
AdSwfConfig
Property Detail
completeOnVideoChangeproperty
public var completeOnVideoChange:Boolean = true

Determines whether adComplete() is automatically called when the current video has changed.

completeOnVideoCompleteproperty 
public var completeOnVideoComplete:Boolean = true

Determines whether adComplete() is automatically called when the current video is completed.

customStartStopEventsproperty 
public var customStartStopEvents:Boolean = false

Setting this to true will make sure that the player does not dispatch any AdEvent start or stop events for the ad display SWF. Instead, all start and stop events are expected to be dispatched through AdSwf.dispatchAdEvent(). This only affects the AdEvent start and stop events that are surfaced in the API in the AdvertisingModule. It has no other effect on playback.

keepVisibleAfterCompleteproperty 
public var keepVisibleAfterComplete:Boolean = false

Allows the AdSwf to be visible after adComplete() is called. This can be used for ads that aren't timed, like banners. It can also be used to display different ads at different times in the playback of a video, but there are drawbacks to this approach. It is recommended that an ad rules SWF is used along with an ad display SWF for this.

pauseVideoPlayerproperty 
public var pauseVideoPlayer:Boolean = false

Allows for a linear or non-linear mode for the ad. If set to true, the ad will be in linear mode with the video player paused until adComplete() is called. If set to false, which is the default, the ad will be in non-linear mode with the video player continuing to play the main video. This property should be set instead of calling pause on the video player module in the player API, as timing issues can cause problems with that approach. The video player module should also not be used to display a linear ad, and instead a video ad should be displayed in its own video container in the AdSwf. Various functions in the video player module in the player API will work or return information when pauseVideoPlayer is true: for more information see AdSwf in this documentation and VideoPlayerModule in the player API documentation.

resizeOnFullScreenproperty 
public var resizeOnFullScreen:Boolean = true

Determines whether or not the player takes control of resizing an ad when the player switches in and out of full screen. When set to true, make sure to set the x, y, width, and height of the ad within the displayAd() function so that the resizing can happen properly.

resizeOnMenuOpenproperty 
public var resizeOnMenuOpen:Boolean = true

Determines whether or not the player takes control of resizing an ad to fit within the video window when the Brightcove menu opens. When set to true, make sure to set the x, y, width, and height of the ad within the displayAd() function so that the resizing can happen properly.