Home > Articles > Web Development > Dreamweaver & Flash

  • Print
  • + Share This
This chapter is from the book

Project: Channeling Cue Points to the Caption Display

Now we’ll pull things together. Namely, we’ll play the the_children_must_learn.flv video file we generated earlier while sending the captions gathered using the gathering_tool.swf to the captionText1.swf file we just built.

Steps

  1. Creating the main.fla file
  2. Creating the CaptionHolder symbol
  3. Assembling support class files
  4. Implementing the final code
  5. Alternative 1: making the video play automatically
  6. Alternative 2: adding a second captionText1.swf that supports navigation cue points

Step 1: Creating the main.fla File

For this project, we need to create a simple movie file that contains an FLVPlayback component that points to our .flv file.

Create a new Flash file and save it as main.fla in the same directory in which you’ve been working—the one that contains the video file the_children_must_learn.flv.

Select Window, Components and drag onto the stage an FLVPlayback component (from the FLVPlayback - Flash 8 category). Use the Properties panel to give the component an instance name of playback.

Step 2: Creating the CaptionHolder Symbol

Select Insert, New Symbol. Click Advanced to expand the dialog box if isn’t already expanded. Make sure the Type is set to Movie Clip and name it CaptionHolder. Next, enable the Export for ActionScript check box, which automatically enables the Export in First Frame check box. Then fill in both fields (Identifier and AS 2.0 Class) with the name CaptionHolder so your dialog box looks like the one in Figure 3.13. Click OK.

Now this empty symbol will be associated with the class file CaptionHolder.as.

Figure 3.13

Figure 3.13 When you create the empty CaptionHolder movie clip, you can associate it with an ActionScript class file (CaptionHolder.as—but you don’t type the .as).

After you click OK, you are taken inside this new clip. Although you don’t have to put anything here (the captionText1.swf file is loaded at runtime), draw a rectangle that’s exactly 320 x 50 pixels (the space your captions need). Use the Info panel to ensure the rectangle’s upper-left corner is aligned with the center of the clip (the plus sign), as shown in Figure 3.14.

Figure 3.14

Figure 3.14 The rectangle you draw inside the CaptionHolder symbol should have its upper-left corner aligned with the symbol’s center (where the plus sign is shown).

Select your drawn rectangle and then select Modify, Convert to Symbol. Make sure the Movie Clip option is selected and name it Rectangle. After you click OK, use the Properties panel to give the Rectangle symbol an instance name of preview. Finally, click the first keyframe—still inside the CaptionHolder symbol—and type this code:

preview._visible = false;

This way, the preview instance is visible only while authoring.

Return to the main timeline of main.fla and drag an instance of CaptionHolder onto the stage. Because it contains the rectangle shape, you can position it below the playback instance or right on top—wherever you want. Use the Properties panel to give the CaptionHolder symbol on stage an instance name of captions_clip.

Step 3: Assembling Support Class Files

You’ll need to add two class files for the code to work. Copy the two homemade class files I created, named CaptionHolder.as and EventChannel.as, from the starter_files folder to your working directory. The following is a list of the minimum set of files that need to be in the same folder as main.fla:

  • the_children_must_learn.flv
  • video_captions.xml
  • captionType1.swf
  • CaptionHolder.as
  • EventChannel.as

The FLVPlayback skin you selected, such as MojaveOverNoVol.swf, must also be adjacent to main.fla. (You’re welcome to move the video, the XML, and the captionType1.swf files into a subfolder—just remember to add the path to that subfolder when specifying filenames in the next step.)

The CaptionHolder.as class file is needed by the CaptionHolder symbol you created in step 2. It handles loading the captionType1.swf file (or whatever template you specify). The EventChannel.as class does a lot of work, as detailed at the end of this chapter. It has three primary features:

  • It takes all the events broadcast by the different cue point types in an FLVPlayback and channels them through a single, consistent event broadcast. That is, the cue point types all fire off different events (with different parameters and such), and the EventChannel.as class makes them all consistent.
  • It handles the task of loading an optional XML file full of cue point information and injecting that information (as ActionScript cue points) at runtime.
  • It supports the Sound object. This means that nearly everything you do with the FLVPlayback component and video you can do with an audio clip. (And you will in the next project.)

In doing all this work, the EventChannel.as class insulates you from the tedious code and keeps the code you have to write for each new project to a minimum.

Step 4: Implementing the Final Code

Inside main.fla, select the first keyframe and open the Actions panel. Type the code in Listing 3.2.

There’s very little code here, but it’s worth digging into. The first three lines simply set up the FLVPlayback instance (playback), the same as using the Parameters panel but with script instead. Notice that you must set autoPlay to false because you need to wait for video_captions.xml to fully load. (I’ll show you alternative code that makes the video start playing automatically in the next step.)

Line 5 creates an instance of the EventChannel class (saved in the variable myEventChannel). Next, we pass three parameters when triggering the init() method on the captions_clip instance (the CaptionHolder symbol you put on the stage—and therefore an instance of the CaptionHolder class). Those parameters are the path to the captionType1.swf template file we created earlier, a reference to the myEventChannel instance, and an array (eventList) that specifies which event types you want sent to the captionType1.swf template. (This array can include any of the following caption types: "event", "navigation", "actionscript", "caption", or "marker". In this example, though, because the array contains just "actionscript", we want to display only the cue points from the XML file.)

Listing 3.2 This Code Associates theEventChannel Class with YourcaptionType1.swf File

1  var playback:mx.video.FLVPlayback;
2  playback.autoPlay = false;
3  playback.contentPath = "the_children_must_learn.flv";
4  
5  var myEventChannel:EventChannel = new EventChannel();
6  
7  //send init() function to the CaptionHolder instance 
   //on stage (captions_clip)
8  var url = "captionType1.swf";
9  var eventList = ["actionscript"];
10  captions_clip.init(url, myEventChannel, eventList);
11  
12  myEventChannel.init(playback, "video_captions.xml");

Finally, in the last line, we initialize myEventChannel by specifying the media source—in this case, it’s the playback, which is an FLVPlayback component, but it could also be a Sound instance—and the XML file where ActionScript cue points can be found. The second parameter is optional, meaning you don’t have to load cue points from the file if you don’t want to.

Select Control Test Movie and then click the Play button on the FLVPlayback component to view the video. Figure 3.15 shows what mine looks like: The captions are on top of the video as if they were there the whole time.

Figure 3.15

Figure 3.15 The finished video with overlaying captions.

Step 5: Alternative 1: Making the Video Play Automatically

There are two quick variations to this project worth examining. First, you might not like the fact that the video didn’t automatically start playing. Add the following code before the last line, which triggers init() on myEventChannel:

function ready(){
  playback.play();
}
myEventChannel.addEventListener("ready",
                 this);

If this code looks familiar, that’s because the myEventChannel instance supports every event supported by the FLVPlayback component (that is, our playback instance). Here, when the ready event fires, you tell the playback instance to play(). The myEventChannel class’s ready event fires only after the XML has safely loaded and the playback instance has fired its ready event.

Select Control, Test Movie to confirm that the video begins playing automatically.

Step 6: Alternative 2: Adding a Second captionText1.swf That Supports Navigation Cue Points

Just to see how versatile this application is, let’s view those Navigation cue points you injected into the video back in the first project. One way you could do this is by simply passing ["navigation", "actionscript"] (instead of just ["actionscript"]) for the third parameter when invoking init() on the captions_clip (lines 9–10 of Listing 3.2). But seeing both cue point types in the sole captionsType1.swf would get messy.

Do this instead: Create a duplicate of the captions_clip instance on stage and give it an instance name of captions_clip2. Move it to another area, such as above the video. Add the following code directly below where you call init() on captions_clip (line 10 of Listing 3.2):

var url = "captionType1.swf";
var eventList = ["navigation"];
captions_clip2.init( url,
           myEventChannel, 
           eventList );

It’s the same as the original call, except you’re calling init() on captions_clip2 (not on captions_clip) and passing a different list of event types to support. (Well, just one type, but notice that it’s an array, so you can specify more types. In fact, if you omit this parameter all cue point types are sent to the clip.)

Now when you test the movie, you’ll see both ActionScript cue points (the captions in the XML file) and the names of the Navigation cue points embedded in the video.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020