Package | com.brightcove.fl.advertising.adSwf |
Class | public class AdSwfConfig |
Inheritance | AdSwfConfig ![]() |
See also
Property | Defined 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 |
completeOnVideoChange | property |
public var completeOnVideoChange:Boolean = true
Determines whether adComplete() is automatically called when the current video has changed.
completeOnVideoComplete | property |
public var completeOnVideoComplete:Boolean = true
Determines whether adComplete() is automatically called when the current video is completed.
customStartStopEvents | property |
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.
keepVisibleAfterComplete | property |
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.
pauseVideoPlayer | property |
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.
resizeOnFullScreen | property |
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.
resizeOnMenuOpen | property |
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.