Skip to Content

Analog + Digital TV Index | Movies | Web + Multimedia

Tools & Guidelines
CCforFlash (AS2) feature list

CCforFlash Features


v3.0.1


New caption source


Version 3.0.1 gives authors the ability to store caption data internally within a text object residing in the same Flash movie as the CCforFlash component. The data is stored as a text string that must be structured in either DFXP or QTtext timed-text format.

New caption source type property


A new property, captSrcType, has been added to identify the type of source where the caption data is being stored. The values for the captSrcType property are:

  • external (default)
  • internal
  • embedded
This property replaces the captEmbed property and appears as "Caption source type" in the Component Inspector. The captEmbed property will continue to be recognized in order for authors to incorporate the new version of the CCforFlash component into older projects. However, the "Captions embedded" property has been removed from the Component Inspector.

Caption source property replaced


With the addition of the internal caption source type, the captFilename property, listed as "Caption filename" in the Component Inspector, has been changed. This property now appears as captSource and has the following values depending on the type of source indicated:

  • external – URL to external caption file
  • internal – name of text object containing caption information
  • embedded – no information needed
The captSource property appears as "Caption source" in the Component Inspector. Please note, the captFilename property will continue to be recognized, along with the captEmbed property until further notice.

Revised startCaptions() method


With the addition of the internal caption source type, the parameters for the startCaptions() method have also been updated. The first value, previously associated with the captEmbed property, now indicates the captSourceType property. The method is constructed as follows:

startCaptions(caption source type, caption source name [optional, if caption source type is embedded], language [optional], override style [optional])

Note: Any startCaptions() methods using the previous captEmbed value will still be recognized as follows:

  • true = embedded
  • false = external

Roll-up caption display options


Captions can now be displayed in either pop-up or roll-up mode. A new property, captDispMode, has been added to identify the selected display option. This appears as "Caption-display mode" in the Component Inspector.

In roll-up mode, the caption display mimics line-21 captions on broadcast television. Each caption row appears near the bottom of the screen and is rolled up one row when the next caption row appears. Pop-on mode was the default method of display in previous versions of CCforFlash, where each caption pops onto the screen as a discrete block of text.

An additional property has been added to indicate how many lines of roll-up captions should appear within the caption display area. (The default is 3.) The property, captDispLns, appears as "Max number of rows (roll-up)" in the Component Inspector.

switchDispMode() method added


A new method has been added which allows authors to switch the display mode between pop-on and roll-up while the captions are being displayed.

switchDispMode(display mode, number of lines [optional])

  • display mode values – pop-on or roll-up
  • number of lines – indicates the number of lines to be displayed when using roll-up mode

stopCaptions() changed to clearCaptions()


The stopCaptions() method has been changed to clearCaptions(). The method itself remains the same, stopping the playback of captions and clearing the caption display area. However, the new name reflects another usage for this method.

In some instances, a Flash-based video player may be opened without a video or caption file loaded. When this happens, CCforFlash will display the sample text that is used in the authoring environment to show the current style settings. To remove this text when the player is initially launched, run the clearCaptions() method on the instance of the CCforFlash component.

DFXP filenames no longer required to end with .xml


While it is good practice to append the proper file-type extension to the filename, CCforFlash no longer uses the extension to indicate the presence of DFXP-formatted captions.

New method for checking the status of loading captions


A new method, checkFileLoad() has been added to check the status of the captions being loaded. This method returns the following:

  • loading – CCforFlash is still in the process of loading and processing the caption information
  • loaded – CCforFlash has completed loading and processing the caption information
  • failed – CCforFlash was unable to load or process the caption information*
*There are a number of reasons a caption file couldn't be loaded or processed, including: the caption URI or text object name was incorrect, the caption source type was incorrect, the caption information was not properly formatted.

New methods for accessing caption content


Three new methods have been added to transfer the content CCforFlash extracts from external or internal caption sources. These methods will not work with the embedded caption source type.

  • getCaptText() – returns an array containing the caption text
  • getCaptStTime() – returns an array containing the caption start times
  • getCaptEndTime() – returns an array containing the caption end times

Captions with missing begin times are not displayed


In previous versions, CCforFlash would use the previous caption's end time in place of a missing begin time. In this version, CCforFlash will not display any caption with a missing begin time.

Bug Fix – caption area background color


Previously, if the background color was changed for an individual caption, that color would remain until a new caption was displayed. With version 3.0.1, when a caption's end time is reached, the background of the caption area returns to the default color.

Bug Fix – search gets stuck in current caption


Previously, if a search was initiated (using findString()) for a term that is currently being displayed, the time returned would be the time for the current caption. In version 3.0.1, the findString() will proceed to the next instance of that term, if one exists.

Bug Fix – captColor return value


The captColor property returns the proper hex format of the current caption color (#rrggbb). In previous versions, the color would be returned missing the prepended hash mark (rrggbb).

Bug Fix – font names are lowercased


Previously, a test condition in CCforFlash altered all font names to lowercase. This caused a conflict with the release of an update to the Flash Player plug-in (9,0,115,0). Users who viewed the captions on a Mac would only see captions in Times New Roman. Since the CCforFlash font test was not needed, the code was removed.

v2.0.2


Bug Fix


Version 2.0.2 fixes a bug which occurred when the CCforFlash component was inserted into a Flash project at run-time using ActionScript. In previous versions, the component would automatically try to load a caption file, even if a filename had not yet been given, resulting in an unnecessary call to the server.

v2.0.1


Display captions synchronized to additional types of objects


CC for Flash is now able to display captions synchronized to sound objects, animated movie clips, or SWFs, in addition to Flash video.

Add CC for Flash at runtime


CC for Flash can be added to Flash movies at runtime using ActionScript. In addition, any of CC for Flash's settings can be changed during runtime using built-in properties and methods.

Recognition of path names


CC for Flash now recognizes video objects and components embedded in movie clips. In order to locate the object, the author provides CC for Flash with either the path relative to the CCforFlash component or the absolute path from the main level of the Flash movie.

Multiple instances of CC for Flash


Multiple instances of the CC for Flash component can reside in the same Flash movie. In addition, a swf containing the CC for Flash component can be loaded into a movie clip in another swf.

Note: If you have loaded an external movie that has a CC for Flash component, you cannot add another CC for Flash component. This is a know problem; NCAM is investigating a solution.

Padding


Padding can be added between the caption area background and caption text. The amount the author indicates is applied to each of the sides. If too much padding is applied, the caption text box may not be able to display multiple lines of the captions.

Override caption file style


Authors can choose to override global style settings found in the start of a QTtext file or in the body and div tags of a DFXP file. This does not override any inline styles found in the DFXP caption files. Settings are:

  • true – override settings found in caption file
  • false – do not override style settings found in caption file

Recognition of brackets in QTtext


In some cases, the brackets in QTtext are used for speaker ids. CC for Flash now determines which brackets are being used to indicate timecodes. All other uses are passed through seamlessly.

Style changes


The default font is Verdana (changed from Arial) and the default font size is 14 (changed from 12).


Return to CC for Flash home page