Microsoft Rich Media Actions Overview
This section describes, in detail, how the Microsoft Rich Media actions function and how they are used in the creation of rich media ads.
Primary Microsoft Rich Media Actions
1.) movie() – is used in place of Flash’s standard loadMovie() function to load external child SWFs and/or FLV files into a parent/base movie. The movies to be loaded are defined in the “Links and Descriptions” layer of the main timeline of the parent/base movie.
Implementation:
This function can be added to the buttons, frames or symbols that you would like to use to call the loading of external movies.
Usage Example:
If you wanted to load childmovie1.swf into your parent/base flash file you would use the movie() function like so:
_root.conduit.movie(1);
- “(1)” in the above example, corresponds to the movie1 variable defined in the “Links and Descriptions” layer of your movie's main timeline. The movie is loaded into the movie clip with the instance name of movie1_mc.
2.) exit() – is used in place of Flash’s standard getUrl() function to execute exit (clickthrough) URLs. Exit URLs are defined in the “Links and Descriptions” layer of the main timeline of your parent/base movie.
Implementation:
This function can be added to the buttons, frames or symbols that you would like to use to
send users to a clickthrough destination(s).
Usage Example:
To send a user to a website when they click on the ad you would use the exit() function like so:
on(release){
_root.conduit.exit(1);
}
- “(1)” corresponds to the exit1 variable defined in the “Links and Descriptions” layer.
3.) event() – is used for reporting events that occur within the ad. Events are defined in the “Links and Descriptions” layer of the main timeline of your parent/base movie.
Implementation:
This function can be added to the buttons, frames or symbols that you would like to use to track events on.
Usage Example:
If you wanted to track when a user rolls over and expands an ad you would call the event() function like this:
on (rollover) {
_root.conduit.event(1);
}
-“(1)” corresponds to the event1desc variable defined in the “Links and Descriptions” layer.
Secondary Microsoft Rich Media Actions
1.) close() – This a custom Microsoft Rich Media function that is used to close a Floating Toplayer ad and completely remove it from the page it is on.
Implementation:
This function can be added to any buttons, frames or symbols that you would like to use for closing your ad.
Usage Example:
The code below is an example of what you would add to the “Close” button of a floating ad. When the button is clicked it will close/remove the ad from the page it is on.
on (release) {
_root.conduit.close();
}
2.) mouseRolledOff() –This is a custom Microsoft Rich Media function that’s automatically called when a user has rolled off the “footprint” of an ad. Use this to trigger actions such as closing animations.
Implementation:
mouseRolledOff() is usually implemented by adding it to frame 1 of a layer on a movie's main timeline.
Usage Example:
The example below sends the play head of a movie to the frame labeled 'banner' on the movie's main timeline, which collapses the ad when the mouse rolls out of the ad.
function mouseRolledOff(){
//collapse ad
_root.gotoAndPlay(“banner”);
}
Notes:
- To avoid problems (i.e. with button layering, conflicting scripts etc.) we highly recommend using the mouseRolledOff() function as opposed to creating your own.
Phase Labels
Ads created for Microsoft Rich Media require the use of what we call “Phase Labels”. A phase label is a mechanism used by the system to keep track of an ad's current position/state on the page.
Important: All ads must have at least a “banner” phase (if floating ad, must have “teaser” phase).
Phase Labels By Ad Type
Expanding Banner Phase Labels (Both labels are required if the ad expands)1.) Banner (required)
2.) Expand (required if expanding)
Floating Banner Phase Labels
(Teaser required and at least one of the other two phases are optional)
1.) Teaser (required)
2.) Reminder (optional)
3.) Main (optional)
Implementation:
Phase Labels are implemented in Flash as frame labels on the parent movie's main timeline.Expanding Banner
Floating Banner
Example:
When the movie's play head passes the frame labeled “expand”, the system knows the ad is expanded and will perform any publishing options set in the system (Like hiding dropdown menus and iFrames while expanded).
Ad Phase Actions:
If your ad is not timeline based, or if you prefer not to use frame labels, you can use the Phase Actions below to set phases in your ad. Phase Actions are implemented just like any other function in Flash/Actionscript.
Expanding Banner Phase Actions:
1.) _root.conduit.banner() ; // Sets Ad to banner phase
2.) _root.conduit.expand() ; // Sets Ad to expand phase
Floating Banner Phase Actions
1.) _root.conduit.teaser(); // Sets Ad to teaser phase
2.) _root.conduit.reminder(); // Sets Ad to reminder phase
3.) _root.conduit.main(); // Sets Ad to main phase
IMPORTANT CHANGE: Setting Rich Media Ad phases with fscommands is NO longer supported. Please use frame labels or the ad Phase Actions described above instead. |
Testing Ads Locally
In order to test your ads locally you will need to get a copy of the Microsoft Rich Media conduit.swf file and place it into the directory where you are creating your ad. The conduit.swf file simulates the functionality of the Microsoft Rich Media system allowing you to see whether or not your Microsoft Rich Media commands are working properly via Flash’s output window. The conduit.swf file can be downloaded at http://resources.atlasrichmedia.com/downloads/conduit.zip
