Follow

You can use Sizmek Flash API, when you want to add additional functionality to your ads that cannot be added through the Ad Builder for Flash. For example, if your ad contains video and you want to add more functions, such as load and play the video, or start and stop loop (which are not available in the VideoLoader component), you can call these functions through code.

You should only use the Sizmek Flash API if you are familiar with Flash, ActionScript programming, and object-oriented programming concepts.

The following classes are available:

Class

Package

Description

CreativeState

eyeblaster.targeting

Creative State ads let you create ads that behave differently each time a user views them based on previous interactions by the user (states).

DataCapture

eyeblaster.data

The DataCapture class lets you capture user input in an ad and store it on Sizmek servers.

DynamicContentManager

eyeblaster.data

The DynamicContentManager class lets your Flash movie access dynamic data on a remote server.

EB

Top Level

The EB class combines API from several classes into a single API.

You can also call the EBBase classes which are smaller and contain more functions, when you want to call each class separately.

EBAudioStateEvent

eyeblaster.events

The EBAudioStateEvent event is dispatched by the video component whenever there is a change in the audio stream of a video.

EBBandwidthEvent

eyeblaster.events

The EBBandwidthEvent event is dispatched by the video component when the ad has detected the user's bandwidth.

EBBase

Top Level

The EBBase class contains the most commonly used functions in online advertising.

EBContentMgr

Top Level

The EBContentMgr class provides methods for the develop to load external content into the creative.

EBErrorEvent

eyeblaster.events

The EBErrorEvent class dispatches events when an error causes a network operation to fail.

EBMetadataEvent

eyeblaster.events

The EBMetadataEvent class creates a listener to respond when the Flash Player receives descriptive information embedded in the video being played.

EBNotificationEvent

eyeblaster.events

The EBNotificationEvent class dispatches various component events to other components and to In-Stream VPAID-compliant video players.

EBPageEvent

eyeblaster.events

The EBPageEvent class dispatches events when the page is loaded or when the user moves the mouse on the page.

EBPanel

Top Level

The EBPanel class provides methods that allow you to manipulate ad panels.

EBSingleExandableEvent

eyeblaster.events

The EBSingleExpandableEvent class dispatches events when a Single Expandable ad expands or collapses.

EBSmartVersioningEvent

eyeblaster.events

The EBSmartVersioningEvent class dispatches events when Smart Item data is updated or loaded.

EBStd

Top Level

The EBStd class is a specific class for Standard Banner ads.

EBSyncEvent

eyeblaster.events

The EBSyncEvent class dispatches events when a connection is found or not found after a predefined timeout.

EBVideoEvent

eyeblaster.events

The EBVideoEvent class dispatches events through the video component whenever there is a change in the video playback status, for example: load, buffer, start, stop, end, etc.

EBVideoMgr

Top Level

The EBVideoMgr class manages video and video playback.

EBVideoStateEvent

eyeblaster.events

The EBVideoState event object is dispatched by the video component whenever there is a change in the video state, for example: pause/play, and enter/exit full-screen mode.

SingleExpandable

eyeblaster.adFormats

The SingleExpandable class is used by the Single Expandable format, an expandable that uses only one Flash file.

SmartVersioning

eyeblaster.data

The SmartVersioning class gives you access to Smart Versioning, a feature that lets you create ads containing dynamic elements that can change the ad's content during runtime.

SWFVideoLoader

eyeblaster.media

The SWFVideoLoader class lets you download videos embedded within a separate Flash movie and add them to your own Flash movie as a movie clip.

SyncAds

eyeblaster.utilities.syncAds

The SyncAds class is a communication layer that lets Sizmek ads on the same page interact with each other at either the campaign or ad level.

Tracer

eyeblaster.core

The Tracer class is a static class used for debugging.

VideoLoader

eyeblaster.media

The VideoLoader class lets you define video settings, such as loading method, looping, streaming, sound, etc.

VideoPlayBack

eyeblaster.media

The VideoPlayback class lets you define video settings, such as loading method, looping, streaming, sound, etc.

VideoScreen

eyeblaster.videoPlayer

The VideoScreen class uses Sizmek’s VideoScreen component.

VideoScreenPlayer

eyeblaster.videoPlayer

The VideoScreenPlayer class uses the VideoScreenPlayer component, which allows you to create a pre-built video player for your videos.

With this new release of the Ad Builder for Flash, we have enhanced the EB class and have provided you with two options:

  • EB class contains all Sizmek supported methods and events (in one class).
  • EBBase class contains more functions, allows you to lower the size of your ad (in separate classes)

If you want to reduce your ad's file size and are not sure how, you can use the following table to see which option is better for you.

  • Previous API version (Eyeblaster Workshop 4.3.2.1 old API).
  • Latest API Version (Ad Builder for Flash + new API)

The following table explains the differences between the two classes:

EB.Init() – AS2 only

EBBase.Init()

EB.Init(this) – AS3 only

EBBase.Init(this)

EB.CloseAd("User")

EBBase.CloseAd("User")

EB.UserActionCounter("InteractionName")

EBBase.UserActionCounter("InteractionName")

EB.Clickthrough()

EBBase.Clickthrough()

EB.CollapsePanel("panel1")

EBPanel.CollapsePanel("panel1")

EB.ExpandPanel("panel1")

EBPanel.ExpandPanel

The Sizmek Flash API is available in AS2 and AS3 and are divided into classes and packages.

  • To view the AS2 Sizmek Flash API help, click here
  • To view the AS3 Sizmek Flash API help, click here.
Was this article helpful?
0 out of 2 found this helpful
Have more questions? Submit a request

Comments