Kinesis SoftwareKineticFusion

[Show Table of Contents]

10 RVML Reference

[Hide Table of Contents]



10.2 RVML Reference Documentation (Printable)

ActionScriptSettings Alter Argument ASProperty Bevel Blur Button ButtonActions ButtonPressSound ButtonReleaseSound ButtonRollOutSound ButtonRollOverSound ButtonSound CArc Circle ClassPath ColorAdjust ColorFill ColorMatrix CommonFillStyles CommonLineStyles Component Components Curve DataSources Definitions Desc DropShadow EArc Edges EditField EmptyFrame ExcludeClass ExportAfter ExportSymbol ExportSymbols FillStylePair FillStyles Filters Font FontDefinition FontMetrics Frame FrameActions FrameLabel FromShape GlobalDataSource Glow Glyph Glyphs GradientBevel GradientGlow Image ImageFill ImageShape ImportSymbol ImportSymbols Include IncludeClass IncludePath InitActions InitClip InitClipActions InitialText InitScript JavaDataSource KerningPair Layer Layers Line LinearGradient LineStyle LineStylePair LineStyles Metadata MorphShape Move Movie MovieAttributes MovieClip MovieClipActions Path Place PlaceSound Polygon Polyline PropertyDataSource RadialGradient Rect Remove Replace Repository RGBAColorTransform Segment SetStyle Shape ShapeTransform Sound SoundEnvelope SoundInfo SoundStream SoundStreams Stop TabIndex Template Text Timeline Title ToShape Transform Variable Video XMLDataSource

ActionScriptSettings

Back to Top

This defines ActionScript settings that should be specifically applied to the current RVML document

Attributes

timeout Optional attribute specifying the maximum timeout in seconds for a script before the player presents a warning message to the user. This can be set to a higher value than the default when a safe script is known to run slow.
Type Integer
From Value 1
To Value 65535
recursionDepth Optional attribute specifying the maximum recursion depth permitted for a script.
Type Integer
From Value 1
To Value 65535

Child Elements

ClassPath
IncludePath
IncludeClass
ExcludeClass
ASProperty

Parent Elements

Movie

Examples

ActionScriptSettings Example

Alter

Back to Top

This element alters the properties of an instance of a symbol on the timeline at the specified display depth. A new ratio can be specified for MorphShape or video symbols and Transform and RGBAColorTransform child elements may also be specified. MovieClipActions cannot be specified. A Replace element must be used to specify new MovieClipActions. Existing Transform and RGBAColorTransform elements are unchanged unless explicitly specified.

Alter elements can also take basic transformation attributes. These, in general, should be used in preference to a nested Transform element in situations where the referenced symbol is already defined and the bounds are known. The location of the referenced symbol can be modified with the x and y attributes, the scale of the symbol can be modified using the width and height attributes, and the rotation of the symbol modified using the rotate attribute. Note that when the width and height attributes are used for compound symbols such as MovieClips and Buttons, their bounds are calculated by summing the bounds of all symbols on their timeline or, in the case of buttons, their hit areas.

If it is necessary to specify skew attributes using differing values for rotateX and rotateY, or if it is preferred to specify an absolute transform independent of the altered symbol, then the nested Transform element can be used

Attributes

name The id of the symbol to alter on the timeline. This attribute is optional from Version 2.0.04 - when supplied, the existing symbol on the specified depth is checked to ensure that it has the specified symbol ID.
Type String
depth The depth of the symbol instance to alter.
Type Integer
From Value 1
To Value 65535
tabIndex Optional attribute specifying a tab index for the symbol. Tab indices are used by screen readers and provide a means to signal that the current symbol has content that is renderable by such a reader.
Type Integer
From Value 0
To Value 65535
ratio Optional attribute used for MorphShapes and Videos. When used for a MorphShape, this refers to the degree of interpolation between the FromShape and the ToShape. A value of 0 displays the FromShape, a value of 65535 displays the ToShape and all values in between result in an interpolation between the two in direct proportion to the ratio.

For Video symbols this moves the video playhead to the frame number specified by the ratio value.

Type Integer
From Value 0
To Value 65535
x X position for specified symbol. Moves the origin of the symbol to the specified X coordinate.
Type Float
Default Value 0
y Y position for specified symbol. Moves the origin of the symbol to the specified Y coordinate.
Type Float
Default Value 0
width The new width of the symbol. The symbol width is independent of the coordinate system of the symbol being altered. In order for this attribute to be specified, the symbol must already be defined in RVML, and it cannot have a width of zero.
Type Float
Default Value Width of existing symbol
height The new height of the symbol. The symbol height is independent of the coordinate system of the symbol being altered. In order for this attribute to be specified, the symbol must already be defined in RVML, and it cannot have a height of zero.
Type Float
Default Value Height of existing symbol
rotate Rotation in degrees about the origin of the shape, applied before the application of the x and y attribute definitions, if specified.
Type Float
Default Value 0
blend Flash 8 introduced blending of multiple overlapping symbols on a stage. There are 14 different blend types supported. Blends remain applied to a symbol instance until explicitly reset. To remove a previously applied blend mode, the blend value should be set to 'normal'.
Values normal
layer
multiply
screen
lighten
darken
difference
add
subtract
invert
alpha
erase
overlay
hardlight
cacheAsBitmap Flash 8 introduced a new setting for indicating that a MovieClip or Button placed on the timeline should be converted to a bitmap for faster rendering. This enables the Flash player to optimize the rendering of display objects that are frequently redrawn on the stage.
Values
yes
The displayed symbol should be converted to a bitmap
no
The displayed symbol should not be converted to a bitmap
Default Value no

Child Elements

Transform
RGBAColorTransform
Filters

Parent Elements

Frame

Examples

MorphShape Example
Square to Circle Morph Example
Video Example
Animate simple symbols on timeline

Argument

Back to Top

This is a text element that specifies a String argument to be passed to the initialize() method of a JavaDataSource object. The Object must implement the com.kinesis.interfaces.datasource.JavaDataSourceType interface otherwise processing is aborted. Arguments are passed to the initialize() method in the order in which they are declared..

Attributes

None

Child Elements

None

Parent Elements

None

Examples

None

ASProperty

Back to Top

Allows this document to override default ActionScript processing properties.

Attributes

name The name of the ActionScript property to override. Check the detailed configuration documentation here for more information on each of these settings.
Values
logCachedClasses
Alter the logging status for accesses to precompiled classes. When true, all classes retrieved from class class are logged. When false, retrieving a class from the class cache is done silently.
logLoadedClasses
Alter the logging status for all classes loaded into the output SWF and their load order. When true, the names and output order of all classes are logged on SWF output. When false, no logging of loaded classes is done.
logParsedClasses
Alter the logging status for all accesses to parsed classes. When true, each class that is parsed is logged. When false, no notification is given when reading a class.
enableWarningMessages
Alter the default logging for warning messages. When 'true', all warning messages are logged. When false, only error messages are reported.
optimizeFunctions
Change the behavior of the ActionScript function optimizer. When true, functions will be optimized. When false, functions will not be optimized.
setterReturnsValue
Change the behavior of the implementation of the 'set' property method. When true, extra code is inserted into AS2.0 'setter' methods to call the 'getter' value. When false, the setter does not return a value.
analyzeScriptsAsAS2
Change the behavior on how KineticFusion handles embedded scripts. When true, all scripts will be analyzed as AS2.0 scripts. When false, AS2.0 syntax is accepted but no semantic analysis or class retrieval will be carried out.
useCachedClasses
Change the behavior on whether precompiled classes are used when available. When true, classes will only be compiled if unavailable or invalid. When false, required classes will always be recompiled.
value This attributes defines the value for the specified property
Values true
false

Child Elements

None

Parent Elements

ActionScriptSettings

Examples

ActionScriptSettings Example

Bevel

Back to Top

Defines a single bevel filter on the display object.

Attributes

blurX This defines the extent of the blur effect of the filter in the X-axis. A value of zero disables blurring and a value of 100 is the maximum blur value permitted.
From Value 0
To Value 100
Default Value 5
blurY This defines the extent of the blur effect of the filter in the Y-axis. A value of zero disables blurring and a value of 100 is the maximum blur value permitted.
From Value 0
To Value 100
Default Value 5
strength This defines the darkness of the filter. A value of zero disables the filter and a value of 1000 is the maximum strength value permitted.
From Value 0
To Value 1000
Default Value 100
quality This defines the rendering quality of the filter. The higher the quality, the greater the processing power required to render the filter.
Values
low
This is the default lowest quality of the filter and is best for optimal playback performance
medium
This is the medium quality level
high
This is the highest quality level and renders the optimal blur
Default Value low
shadow The color of the shadow specified as an RGB/RGBA tuple, a hex string or a color name. The first number of the tuple represents the red intensity, the second green, and the third blue. A minimum value of 0 for each color results in black and a max value of 255 for each color results in white. For RGBA the first three attributes are the same as above and the fourth is the degree of opacity of the color with 0 being totally transparent and 255 totally opaque. Alternatively the color can be specified as in SVG either in hexadecimal with a '#' leading character or by name using the color names defined in the SVG specification. Since these do not specify opacity, an additional shadowOpacity attribute can be defined.
Value Template rgb(Color, Color, Color)
Value Template rgba(Color, Color, Color, Color)
From Value 0
To Value 255
Value Template #Color Color Color
From Value 00
To Value ff
Value Range Any SVG color name supported in the SVG1.1 specification.
Default Value black
shadowOpacity Optional attribute specifying the opacity of the shadow color with 0 being totally transparent and 1.0 totally opaque. This will override any opacity channel value specified as part of the shadowColor attribute.
From Value 0.0
To Value 1.0
Default Value 1.0
highlight The color of the bevel highlight specified as an RGB/RGBA tuple, a hex string or a color name. The first number of the tuple represents the red intensity, the second green, and the third blue. A minimum value of 0 for each color results in black and a max value of 255 for each color results in white. For RGBA the first three attributes are the same as above and the fourth is the degree of opacity of the color with 0 being totally transparent and 255 totally opaque. Alternatively the color can be specified as in SVG either in hexadecimal with a '#' leading character or by name using the color names defined in the SVG specification. Since these do not specify opacity, an additional highlightOpacity attribute can be defined.
Value Template rgb(Color, Color, Color)
Value Template rgba(Color, Color, Color, Color)
From Value 0
To Value 255
Value Template #Color Color Color
From Value 00
To Value ff
Value Range Any SVG color name supported in the SVG1.1 specification.
Default Value white
highlightOpacity Optional attribute specifying the opacity of the highlight color with 0 being totally transparent and 1.0 totally opaque. This will override any opacity channel value specified as part of the highlightColor attribute.
From Value 0.0
To Value 1.0
Default Value 1.0
angle This defines the angle of the filter. Angles are expressed in degrees and range from 0 to 360. Filter effects rotate in a clockwise direction as the value increases.
From Value 0
To Value 360
Default Value 45
distance This defines the distance of the filter effect from the object. Distances are expressed in pixels and range from -32 to + 32.
From Value -32
To Value 32
Default Value 5
knockout This boolean attributes defines whether the filtered object is visible in the output. When true, both the filtered object, and any underlying filter effects are not rendered.
Values
false
The source object is displayed on the stage
true
The source object and any underlying filter effect is hidden
Default Value false
type Defines the type of bevel displayed.
Values
inner
The rendered bevel is an inner bevel
outer
The rendered bevel is an outer bevel
full
The rendered bevel is a full bevel
Default Value inner

Parent Elements

Filters

Examples

None

Blur

Back to Top

Defines a single blur filter on the display object.

Attributes

blurX This defines the extent of the blur effect of the filter in the X-axis. A value of zero disables blurring and a value of 100 is the maximum blur value permitted.
From Value 0
To Value 100
Default Value 5
blurY This defines the extent of the blur effect of the filter in the Y-axis. A value of zero disables blurring and a value of 100 is the maximum blur value permitted.
From Value 0
To Value 100
Default Value 5
quality This defines the rendering quality of the filter. The higher the quality, the greater the processing power required to render the filter.
Values
low
This is the default lowest quality of the filter and is best for optimal playback performance
medium
This is the medium quality level
high
This is the highest quality level and renders the optimal blur
Default Value low

Parent Elements

Filters

Examples

None

Button

Back to Top

This defines a button symbol that can be placed on a movie stage. A button has a number of button layers which specify the bounds and symbols used in the button. Each layer is associated with one or more button states (over, down, release, hit). Actions can be associated with a button using the optional ButtonActions element. Sounds can be associated with button events using the optional ButtonSound element.

Attributes

id A unique name for the symbol within the movie.
Type String
dragTarget Determines the behavior of the button in relation to mouse press events.
Values
no
Normal button behavior. The button will not react when the mouse enters the button hit area while pressed and no events will be generated. However if the mouse is subsequently released over the button a 'rollOver' event will be generated. When the button is pressed and the mouse is moved outside the hit area the button state changes to the 'over' state and the cursor does not change from a button cursor.
yes
Behaves like a drag target or sub-menu button. When the mouse enters the button hit area while pressed the button's state changes to the 'down' state and 'dragOver' button events are generated. If the mouse is release over the button then a 'release' event is generated otherwise 'dragOut' events are generated when mouse dragged out. When the button is pressed and the mouse is moved outside the button will reset itself to the 'up' state and the cursor will reset to the normal cursor. A 'dragOutside' event will be generated but no 'releaseOutside' button events will be generated if mouse is released.
Default Value no
bounds Optional attribute specifying the bounding rectangle of the Button specified as 'bounds( minX, minY, maxX, maxY)'. This attribute can be produced on decompilation as a guide to the actual runtime bounds of the symbol but it is not referenced by the RVML compiler. This is useful for the timeline elements (Place, Alter, Replace) to specify new scaling attributes for the Button symbol.
Value Template bounds(Coord, Coord, Coord, Coord)
Type Float

Child Elements

Desc
Metadata
Layers
ButtonSound
ButtonActions

Parent Elements

Definitions

Examples

Button Example
Button DragTarget Example
Button Sound Example

ButtonActions

Back to Top

Text element detailing action script associated with the button. Best presented in a CDATA section so that all punctuation can be specified without escaping. All ActionScript must be inside on() event handlers.
By default the script is expected as element content however the use of the optional 'src' attribute permits an external script to be identified using a URL. If this is specified then all element content is ignored.
Consult documentation on ActionScript for more information on scripting.

Attributes

src Optional attribute indicating the URL from which to read the script.
Type String

Child Elements

None

Parent Elements

Button

Examples

Button Example
Button Sound Example

ButtonPressSound

Back to Top

This sound will play on button press events. A SoundInfo element must be specified for this element.

Attributes

soundName The name of a sound.
Type String

Child Elements

SoundInfo

Parent Elements

ButtonSound

Examples

Button Sound Example

ButtonReleaseSound

Back to Top

This sound will play on button release events. A SoundInfo element must be specified for this element.

Attributes

soundName The name of a sound.
Type String

Child Elements

SoundInfo

Parent Elements

ButtonSound

Examples

Button Sound Example

ButtonRollOutSound

Back to Top

When the parent button's 'dragTarget' attribute is 'no' this sound will play on rollOut and releaseOutside events. When the parent button's 'dragTarget' attribute is 'yes' this sound will play on rollOut and dragOut events. A SoundInfo element must be specified for this element.

Attributes

soundName The name of a sound.
Type String

Child Elements

SoundInfo

Parent Elements

ButtonSound

Examples

Button Sound Example

ButtonRollOverSound

Back to Top

When the parent button's 'dragTarget' attribute is 'no' this sound will play on rollOver events. When the parent button's 'dragTarget' attribute is 'yes' this sound will play on rollOver and dragOver events. A SoundInfo element must be specified for this element.

Attributes

soundName The name of a sound.
Type String

Child Elements

SoundInfo

Parent Elements

ButtonSound

Examples

Button Sound Example

ButtonSound

Back to Top

This element acts a container for elements specifying sounds that are played during button events.

Attributes

None

Child Elements

ButtonRollOverSound
ButtonRollOutSound
ButtonPressSound
ButtonReleaseSound

Parent Elements

Button

Examples

Button Sound Example

CArc

Back to Top

Draw an circular arc in the current line style. If the start point is not specified then the current drawing position is used as the start position, otherwise a Move is executed to the new start position before drawing. The center of the Arc and the direction of the arc must always be specified. Either an angle or a destination point can be specified. If a destination point is specified, at least one dimension of the end point must be specified and the user must ensure that a valid arc can be drawn from the start to the end point given the specified center point. If not, the application will terminate the arc as close as possible to the specified endpoint.

Attributes

isRelative When set, coordinates are relative to last drawing position, otherwise coordinates are absolute.
Values yes
no
Default Value no
sx Optional X coordinate for the start position. If not specified then a prior path component must exist in the shape.
Type Float
Default Value Current X position
sy Optional Y coordinate for the start position. If not specified then a prior path component must exist in the shape.
Type Float
Default Value Current Y position
cx X coordinate for the center point of the arc.
Type Float
Default Value None
cy Y coordinate for the center point of the arc.
Type Float
Default Value None
ex X coordinate for the destination position. Specified when an angle is not being used. Ignored if an angle is specified.
Type Float
Default Value Current X position if ey specified
ey Y coordinate for the destination position. Specified when endpoint and direction specified. Ignored if an angle is specified.
Type Float
Default Value Current Y position if ex specified
angle Optional angle of the arc in degrees.
Type Float
Default Value None
clockwise Indicates which of the two possible arc candidates is drawn. When set, the arc is drawn in a clockwise direction.
Values yes
no
Default Value no

Child Elements

None

Parent Elements

Edges
Glyph
ShapeTransform

Examples

Examples of Elliptical Arcs and Circular Arcs
CArcs Example
Line Style and Scaling

Circle

Back to Top

Draw a circle of the specified radius around the specified center. The start and final drawing position is (cx+r, cy). Circles are a derived type and rendered using 8 quadratic Bezier curves. As a result of this, small circles should not be scaled up to levels where imperfections due to coordinate resolution and unnoticeable at smaller scales become obvious. Instead, define the larger circle and scale down. When used in MorphShapes it must be noted that the Circle is implemented using 8 Curve elements.

Attributes

cx X coordinate for the center position.
Type Float
Default Value 0
cy Y coordinate for the center position.
Type Float
Default Value 0
r Radius of the circle.
Type Float
Value Range >0
Default Value None

Child Elements

None

Parent Elements

Edges
Glyph
ShapeTransform

Examples

Quadratic Curve Example
Shape Origin Example
Circle Examples
Color Specification Example
Square to Circle Morph Example
Defines simple symbol for export
Clipping and Text Clipping Example

ClassPath

Back to Top

This is a text element defining a single class path that should be used for locating AS 2.0 classes for the current RVML document. Multiple ClassPath elements can be specified if classes reside in multiple locations. All ClassPath locations take priority over the system-wide AS 2.0 class path definitions, however these paths will always be referenced if classes cannot be found in any ClassPath locations.

Attributes

None

Child Elements

None

Parent Elements

ActionScriptSettings

Examples

ActionScriptSettings Example

ColorAdjust

Back to Top

Defines color adjustment filter to apply to the source object.

Attributes

brightness Adjusts the brightness of the symbol.
From Value -100
To Value 100
Default Value 0
contrast Adjusts the contrast of the symbol.
From Value -100
To Value 100
Default Value 0
saturation Adjusts the saturation of the symbol.
From Value -100
To Value 100
Default Value 0
hue Adjusts the hue of the symbol. Hue adjustments are specified as a rotation in degrees in the range of -180 to +180
From Value -180
To Value 180
Default Value 0

Parent Elements

Filters

Examples

None

ColorFill

Back to Top

This defines a solid color fill for an enclosed area. The color can be expressed using a tuple of color channels or can be represented by a text name and an optional opacity channel value.

Attributes

color The color specified as an RGB/RGBA tuple, a hex string or a color name. The first number of the tuple represents the red intensity, the second green, and the third blue. A minimum value of 0 for each color results in black and a max value of 255 for each color results in white. For RGBA the first three attributes are the same as above and the fourth is the degree of opacity of the color with 0 being totally transparent and 255 totally opaque. Alternatively the color can be specified as in SVG either in hexadecimal with a '#' leading character or by name using the color names defined in the SVG specification. Since these do not specify opacity, an additional opacity attribute can be defined.
Value Template rgb(Color, Color, Color)
Value Template rgba(Color, Color, Color, Color)
From Value 0
To Value 255
Value Template #Color Color Color
From Value 00
To Value ff
Value Range Any SVG color name supported in the SVG1.1 specification.
opacity Optional attribute specifying the opacity of the color with 0 being totally transparent and 1.0 totally opaque. This will override any opacity channel value specified as part of the color attribute.
From Value 0.0
To Value 1.0
Default Value 1.0
index Optionally specifies the index of the current entry in the table. Informational attribute produced on RVML output and not used on input.
Type Integer

Child Elements

None

Parent Elements

FillStylePair
FillStyles

Examples

Shape Fill Examples
CArcs Example
Timeline Replace Examples
Shape Origin Example
Square to Circle Morph Example
Animate simple symbols on timeline
Circle Examples
Color Specification Example
Quadratic Curve Example
SVG Arc Example in RVML
Dynamic MovieClip Clipping
Shape Transform Examples
Button Example
Button DragTarget Example
Button Sound Example
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Timeline Color Transformations
Elliptical Arcs Example
Examples of Elliptical Arcs and Circular Arcs
Defines simple symbol for export
Polygon Example
Rectangle Example
Clipping and Text Clipping Example

ColorMatrix

Back to Top

A color matrix represents a composite matrix of color adjustment values that are applied uniformly to the source display object. A Color matrix is a 5x5 matrix that is the product of adjustments made to brightness, contrast, saturation, and hue of the displayed symbol. In general, it is not possible to separate out the individual transformations once a color matrix is created. To specify individual color transformations, the ColorAdjust element should be used. For more information on the general characteristics of the Color Matrix, please see the feColorMatrix element in the SVG specification.

Attributes

values This is a list of 20 floating point values, separated by whitespace. Only the first four rows of the 5x5 color matrix are specified as the last row is always constant.
Type List of numbers

Parent Elements

Filters

Examples

None

CommonFillStyles

Back to Top

This is a container element for StylePair elements defining the fill styles used in a MorphShape.

Attributes

None

Child Elements

FillStylePair

Parent Elements

MorphShape

Examples

Timeline Replace Examples
Square to Circle Morph Example
MorphShape Example

CommonLineStyles

Back to Top

This is a container element for StylePair elements defining the line styles used in a MorphShape.

Attributes

None

Child Elements

LineStylePair

Parent Elements

MorphShape

Examples

Square to Circle Morph Example
MorphShape Example

Component

Back to Top

This specifies a single component to be included in the RVML document. The component must be locatable on the component path. The class definitions for the component are immediately available to the KineticFusion compiler.

Attributes

id A mandatory attribute specifying the name of the component. This is the name of the component on the component path and also used as the symbol ID to identify the component within the RVML document.
Type String
type The type of component. Currently only SWC components are supported.
Type String
Values swc
Default Value swc
name The file name of the component. By default, KineticFusion looks for components that have the same file name as the component ID e.g. It will assume that the DataGrid component resides in a component file called DataGrid.swc. This is only a naming convention however - this attribute is used to explicitly specify the name of the component file in which the desired component resides. It can be used to to specify a different version of a component, or for components whose component IDs do not match the name of the SWC files in which they are stored.
Type String
Default Value {Component ID}.swc

Child Elements

None

Parent Elements

Components

Examples

None

Components

Back to Top

This a container element for one or more Component elements that specify external components to be added to the output SWF. Components are located on the component path specified by the kinesis.components.componentPath property.

Attributes

exportFrame An optional attribute that allows users to explicitly specific the greatest frame number at which the commponents should be made available publicly. This attribute is only necessary if the components are referenced implicitly within ActionScript 1.0 scripts where dependencies are not automatically resolved. A value of -1 will output the components on the last possible frame the component is referenced.
Type Integer
Default Value -1

Child Elements

Component

Parent Elements

Movie

Examples

None

Curve

Back to Top

Draw a curve in the current line style from the current drawing position to the destination location. The curve drawn is a quadratic Bezier curve that uses a single control point to specify the weighting of the curve. A control point close to the line made by the current position and the destination position means a gentle curve in the direction of the control point. As the control point moves from the line the curve will get more exaggerated and acute. Most authoring packages use cubic Bezier curves which allows greater control over the curves but these can all be approximated by quadratic curves. As an alternative to specifying a control point the reflection of a control point used in a previous curve can be used to allow for continuous smooth curves.

Attributes

isRelative When set, coordinates are relative to last drawing position, otherwise coordinates are absolute.
Values yes
no
Default Value no
x X coordinate for the destination position.
Type Float
Default Value 0
y Y coordinate for the destination position.
Type Float
Default Value 0
smooth Use the reflection of the control point of the previous curve through the current drawing position. If previous drawing operation was not a curve then this will generate an error. When 'yes', attributes for control point are ignored.
Values yes
no
Default Value no
cx X coordinate for the control position. Not used if 'smooth' is set.
Type Float
Default Value 0
cy Y coordinate for the control position. Not used if 'smooth' is set.
Type Float
Default Value 0

Child Elements

None

Parent Elements

Edges
Glyph
ShapeTransform

Examples

User-Defined Font Example
Quadratic Curve Example

DataSources

Back to Top

This a container element for one or more data source elements that specify external data documents to be added to the internal data model for this RVML document

Attributes

None

Child Elements

PropertyDataSource
XMLDataSource
JavaDataSource
GlobalDataSource

Parent Elements

Movie

Examples

None

Definitions

Back to Top

This is a container element for explicit symbol definitions that can be placed on a movie stage.

Attributes

None

Child Elements

Shape
ImageShape
MovieClip
Button
EditField
Text
MorphShape
FontDefinition

Parent Elements

Movie

Examples

ADPCM Sound Example
Simple MP3 Sound Example
ActionScriptSettings Example
Animate simple symbols on timeline
Button Example
Button DragTarget Example
Button Sound Example
CArcs Example
Circle Examples
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Color Specification Example
Timeline Color Transformations
Quadratic Curve Example
Elliptical Arcs Example
Examples of Elliptical Arcs and Circular Arcs
SVG Arc Example in RVML
EditField Examples
EditField Transformations
Defines simple symbol for export
Raw MP3 Example
Font Manipulation Examples
HTML Support in EditFields
Font Range Examples
ActionScript on the Timeline
Color Gradient Examples
ImageFill Examples
ImageShape Example
Import and Export a Symbol
Importing symbols at runtime
Line Style Z-Ordering
Line Style and Scaling
MorphShape Example
Dynamic MovieClip Clipping
Polygon Example
Simple Polyline Example
Rectangle Example
Timeline Replace Examples
Text Segments Example
Shape Fill Examples
Shape Origin Example
Shape Transform Examples
Sound Envelope Example
Square to Circle Morph Example
Clipping and Text Clipping Example
Simple MP3 Sound From URL Example
User-Defined Font Example
Video Example

Desc

Back to Top

Text element defines an optional description for both a Movie element and all symbol elements. This text can be optionally stored when the document is translated to SWF.

Attributes

None

Child Elements

None

Parent Elements

Button
EditField
Font
FontDefinition
Image
ImportSymbol
MorphShape
Movie
MovieClip
Shape
Sound
Text
Video

Examples

ADPCM Sound Example
Simple MP3 Sound Example
ActionScriptSettings Example
Animate simple symbols on timeline
Button Example
Button DragTarget Example
Button Sound Example
CArcs Example
Circle Examples
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Color Specification Example
Timeline Color Transformations
Quadratic Curve Example
Elliptical Arcs Example
Examples of Elliptical Arcs and Circular Arcs
SVG Arc Example in RVML
EditField Examples
EditField Transformations
Defines simple symbol for export
Raw MP3 Example
Font Manipulation Examples
HTML Support in EditFields
Font Range Examples
ActionScript on the Timeline
Color Gradient Examples
ImageFill Examples
ImageShape Example
Import and Export a Symbol
Importing symbols at runtime
Line Style Z-Ordering
Line Style and Scaling
MorphShape Example
Dynamic MovieClip Clipping
Polygon Example
Simple Polyline Example
Rectangle Example
Timeline Replace Examples
Text Segments Example
Shape Fill Examples
Shape Origin Example
Shape Transform Examples
Sound Envelope Example
Square to Circle Morph Example
Clipping and Text Clipping Example
Simple MP3 Sound From URL Example
User-Defined Font Example
Video Example

DropShadow

Back to Top

Defines a single drop shadow filter on the display object.

Attributes

blurX This defines the extent of the blur effect of the filter in the X-axis. A value of zero disables blurring and a value of 100 is the maximum blur value permitted.
From Value 0
To Value 100
Default Value 5
blurY This defines the extent of the blur effect of the filter in the Y-axis. A value of zero disables blurring and a value of 100 is the maximum blur value permitted.
From Value 0
To Value 100
Default Value 5
strength This defines the darkness of the filter. A value of zero disables the filter and a value of 1000 is the maximum strength value permitted.
From Value 0
To Value 1000
Default Value 100
quality This defines the rendering quality of the filter. The higher the quality, the greater the processing power required to render the filter.
Values
low
This is the default lowest quality of the filter and is best for optimal playback performance
medium
This is the medium quality level
high
This is the highest quality level and renders the optimal blur
Default Value low
color The color of the drop shadow specified as an RGB/RGBA tuple, a hex string or a color name. The first number of the tuple represents the red intensity, the second green, and the third blue. A minimum value of 0 for each color results in black and a max value of 255 for each color results in white. For RGBA the first three attributes are the same as above and the fourth is the degree of opacity of the color with 0 being totally transparent and 255 totally opaque. Alternatively the color can be specified as in SVG either in hexadecimal with a '#' leading character or by name using the color names defined in the SVG specification. Since these do not specify opacity, an additional opacity attribute can be defined.
Value Template rgb(Color, Color, Color)
Value Template rgba(Color, Color, Color, Color)
From Value 0
To Value 255
Value Template #Color Color Color
From Value 00
To Value ff
Value Range Any SVG color name supported in the SVG1.1 specification.
Default Value black
angle This defines the angle of the filter. Angles are expressed in degrees and range from 0 to 360. Filter effects rotate in a clockwise direction as the value increases.
From Value 0
To Value 360
Default Value 45
distance This defines the distance of the filter effect from the object. Distances are expressed in pixels and range from -32 to + 32.
From Value -32
To Value 32
Default Value 5
knockout This boolean attributes defines whether the filtered object is visible in the output. When true, both the filtered object, and any underlying filter effects are not rendered.
Values
false
The source object is displayed on the stage
true
The source object and any underlying filter effect is hidden
Default Value false
hideObject This boolean attributes defines whether the filtered object is visible in the output. When true, the filtered object is not rendered but the underlying filter effects are still rendered.
Values
false
The source object is displayed on the stage
true
The source object is hidden but underlying filter effects are visible
Default Value false
inner This boolean attributes defines whether the filter effect is applied tinside the boundaries of the shape or outside the boundaries of the shape
Values
false
The filter is rendered outside the boundaries of the shape
true
The filter is rendered inside the boundaries of the shape
Default Value false

Parent Elements

Filters

Examples

None

EArc

Back to Top

Draw an elliptical arc in the current line style following same conventions as described in SVG1.1 specification. If the start point is not specified then the current drawing position is used as the start position, otherwise a Move is executed to the new start position before drawing. The size and orientation of the arc is defined using the radius attributes and the xRotation attribute and the large and clockwise attribute flags select which of the maximum of 4 possible arcs is rendered. The center of the arc is implicitly derived from the other attribute.

Attributes

isRelative When set, coordinates are relative to last drawing position, otherwise coordinates are absolute.
Values yes
no
Default Value no
sx Optional X coordinate for the start position.
Type Float
Default Value None
sy Optional Y coordinate for the start position.
Type Float
Default Value None
ex X coordinate for the destination position.
Type Float
Default Value 0
ey Y coordinate for the destination position.
Type Float
Default Value 0
rx X axis radius of the ellipse.
Type Float
Default Value 0
ry Y axis radius of the ellipse.
Type Float
Default Value 0
xRotation Clockwise rotation of the ellipse in the X plane in degrees.
Type Float
Default Value 0
large There is always a minimum of two arcs and a maximum of 4 arcs between two points. When set, this flag reduces the set of renderable arcs to those with sweep-angles greater than or equal to 180 degrees. In combination with the clockwise flag this will reduce the set of renderable arcs to 1.
Values yes
no
Default Value yes
clockwise There is always a minimum of two arcs and a maximum of 4 arcs between two points. When set, this flag reduces the set of renderable arcs to those that can be rendered from startpoint to endpoint in a clockwise or positive-angle direction.
Values yes
no
Default Value yes

Child Elements

None

Parent Elements

Edges
Glyph
ShapeTransform

Examples

Elliptical Arcs Example
Examples of Elliptical Arcs and Circular Arcs

Edges

Back to Top

This is a container element for drawing operations and style change tables used in the Shape symbol. When one or more new styles are defined all existing style definitions are replaced. All coordinate locations are relative to the origin of the shape which has an independent local coordinate system.

Attributes

None

Child Elements

ShapeTransform
Move
Line
Curve
CArc
EArc
Circle
Rect
Path
Polyline
Polygon
SetStyle
LineStyles
FillStyles

Parent Elements

FromShape
Shape
ToShape

Examples

CArcs Example
Timeline Replace Examples
Shape Fill Examples
Shape Origin Example
Square to Circle Morph Example
Circle Examples
Dynamic MovieClip Clipping
Animate simple symbols on timeline
Color Specification Example
Timeline Color Transformations
Quadratic Curve Example
Color Gradient Examples
ImageFill Examples
Line Style and Scaling
MorphShape Example
Shape Transform Examples
Clipping and Text Clipping Example
Button Example
Button DragTarget Example
Button Sound Example
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Elliptical Arcs Example
Examples of Elliptical Arcs and Circular Arcs
SVG Arc Example in RVML
Defines simple symbol for export
Line Style Z-Ordering
Polygon Example
Simple Polyline Example
Rectangle Example

EditField

Back to Top

This defines a powerful text symbol with many properties including editability, selectable text, html support. Flash 8 also introduces a new antialias attribute.

Attributes

id A unique name for the symbol within the movie.
Type String
bounds The bounding rectangle of the text symbol specified as 'bounds( minX, minY, maxX, maxY)'. This should be large enough to display any necessary text. A good rule of thumb for calculating this manually is to allow lineSpacing + fontSize +2 in height for each line displayed and to allow 2 + fontSize * length for the width of the field. The field should be anchored at ( -2, -2) relative to the actual relative location you wish the text to be displayed at. This attribute is ignored if the autosize property is enabled and should be set to 'bounds(0, 0, 0, 0)'.
Value Template bounds(Coord, Coord, Coord, Coord)
Type Float
fieldName Optional name for the symbol. When set, this field can be referenced in ActionScript using the specified name. All placed instances of the symbol are updated together. If different EditField symbols have the same fieldName then the initial text will be the first field placed in the movie. If no fieldName is specified the contents of the field can still be accessed using the 'text' property of the placed object provided the EditField is given a name when placed on the timeline.
Type String
fontID The name of the Font symbol or FontDefinition symbol used to render the text.
Type String
fontSize The size of the font used to render the text.
Type Float
Default Value 8
lineSpacing Optional number of pixels from bottom of one line of text to top of next. Can be either positive or negative. This vertical size of each line of text is modified by this attribute. On input, if this value is too small then no text may be displayed at all until a newline is added.
Type Float
Default Value 2
leftMargin Optional left margin for the text, in pixels. Value can be positive or negative.
Type Float
Default Value 0
rightMargin Optional right margin for the text, in pixels. Value can be positive or negative..
Type Float
Default Value 0
indentation Optional indentation for first line of text. If this is negative then text is outdented to left of defined left margin.
Type Float
Default Value 0
alignment Optional alignment for text
Values left
right
center
fill
Default Value left
charLimit Optional maximum number of characters allowed in field on input. If the initial text length is greater that that specified here then no input is allowed until the length of the string is reduced below the charLimit value. A charLimit value of 0 disables all restrictions on input length.
Type Integer
Default Value 0
color The color specified as an RGB/RGBA tuple, a hex string or a color name. The first number of the tuple represents the red intensity, the second green, and the third blue. A minimum value of 0 for each color results in black and a max value of 255 for each color results in white. For RGBA the first three attributes are the same as above and the fourth is the degree of opacity of the color with 0 being totally transparent and 255 totally opaque. Alternatively the color can be specified as in SVG either in hexadecimal with a '#' leading character or by name using the color names defined in the SVG specification. Since these do not specify opacity, an additional opacity attribute can be defined.
Value Template rgb(Color, Color, Color)
Value Template rgba(Color, Color, Color, Color)
From Value 0
To Value 255
Value Template #Color Color Color
From Value 00
To Value ff
Value Range Any SVG color name supported in the SVG1.1 specification.
opacity Optional attribute specifying the opacity of the color with 0 being totally transparent and 1.0 totally opaque. This will override any opacity channel value specified as part of the color attribute.
From Value 0.0
To Value 1.0
Default Value 1.0
properties Additional set of properties governing the behavior of an EditField:
Value Template (Property,...)
Values
selectable
The text is selectable using the mouse.
editable
The EditField is selectable and accepts user input.
systemFont
Specifies that the font used for the EditField should be loaded from the System where possible and font glyphs do not need to be included as part of the movie. The Font symbol still needs to be defined within the document but does not need associated glyphs. This property can not be applied to EditField symbols that need to be rotated as they are rendered using the native platform renderer. In addition, all scaling transforms applied to systemFont symbols on a timeline are applied uniformly in both axes.
multiLine
On input a new display line is created on Enter or Carriage Return
html
Allows the initial text of the edit field to be specified as a HTML String. Permitted block attributes include font, color, alignment and size and can include bold and italic attributes. This is useful when using combination of plain, bold and italic fonts within a single field. Note: it may be necessary to force the inclusion of font glyphs in output using the forceOutput font flag if non-device fonts are used.
border
Places a black rectangular border around the text with a white background.
wordWrap
Will automatically split the text into multiple lines when the field border is reached. It will attempt to break on whitespace, if available.
password
The display and input text will be represented by asterisks. These asterisks inherit the styles specified for the Edit Field.
autosize
Only applicable for Versions 6 or higher. Setting this property will ignore the specified bounding rectangle and will ensure that all specified text is visible. This is particularly useful when the rendering font is unknown or for I18N purposes where text field sizes will vary with translation. For dynamic fields with borders, the border will grow with input. This will only autosize in the positive axis, however, so text with negative margins will be partially truncated.
fontRange Optionally specifies the characters in the specified font that should be included for this edit field. This is used to specific valid characters when an embedded Font has a 'Defined' font range and the EditField is dynamic. When specified, it will override the defined content in the field for display purposes e.g. if an EditField has the text "test" and the fontRange is "['A'-'Z']", then no characters will be displayed. The specified characters are still in the field however.
Values
All
Include all known font characters
Defined
Include only font characters used in defined symbols
User-defined range string.
A font range string consists of a comma separated set of ranges. Each range can be a single character constant enclosed in single quotes, an integer character code, a unicode character code, or a range of characters enclosed in square brackets with a '-' range character e.g. ['a'-'z'], '+', 34, \u0025
Default Value Defined
antialias Flash 8 introduces a new antialias attribute that allows the use to specify the degree of antialiasing to be applied to a text element. Antialias values can be specified as 'reading', which is the default setting for maximum legibility, or as a pair of values indicating the thickness and sharpness of the antialiasing. When not specified, antialias behaviour defaults to that used in Flash player 7 and below. Thickness and sharpness, when specified should be in the following ranges:
Thickness: -200 -> +200
Sharpness: -400 -> + 400.
The default 'reading' setting is equivalent to setting both thickness and sharpness to 0.
Values reading
custom( thickness, sharpness)
Default Value Not specified

Child Elements

Desc
Metadata
InitialText

Parent Elements

Definitions

Examples

EditField Examples
Elliptical Arcs Example
Font Manipulation Examples
HTML Support in EditFields
Button Example
Button DragTarget Example
CArcs Example
Circle Examples
Color Specification Example
EditField Transformations
Defines simple symbol for export
Importing symbols at runtime
ADPCM Sound Example
Simple MP3 Sound Example
ActionScriptSettings Example
Animate simple symbols on timeline
Quadratic Curve Example
SVG Arc Example in RVML
Raw MP3 Example
Font Range Examples
ActionScript on the Timeline
Color Gradient Examples
Import and Export a Symbol
MorphShape Example
Sound Envelope Example
Square to Circle Morph Example
Clipping and Text Clipping Example
Simple MP3 Sound From URL Example
User-Defined Font Example

EmptyFrame

Back to Top

A place holder for more than one empty frame with no content.

Attributes

numBlank Attribute that specifies that a number of blank frames should be inserted into the Timeline. This is useful to provide non-programmatic delays during animation. Values less than 1 are ignored.
Default Value 1
Type Integer
Value Range > 1

Child Elements

None

Parent Elements

Timeline

Examples

None

ExcludeClass

Back to Top

This defines a class or package that must not be included in an output SWF movie. A class cannot be specified as both an IncludeClass and an ExcludeClass. The first declaration will always be used in this situation. When a package is excluded then it will override all IncludeClass declarations. All excluded classes can be verified by enabling the ASProperty 'logLoadedClasses' option.

Attributes

name The name of the ActionScript class or package to be excluded from the output movie. This uses the same syntax as the import directive in ActionScript 2.0. To exclude a class, the name should be specified as a fully qualified class name. To exclude a package, only the package name should be specified followed by a '.*' e.g. 'mx.core.*'
Type String

Child Elements

None

Parent Elements

ActionScriptSettings

Examples

None

ExportAfter

Back to Top

Specifies the name of a single MovieClip symbol whose initialization script must be executed before the parent MovieClip symbol of this element. This is normally used for specifying ActionScript class MovieClips that are instantiated in the current InitScript code.

Attributes

name The id for the required Movie Clip symbol.
Type String

Child Elements

None

Parent Elements

InitActions

Examples

None

ExportSymbol

Back to Top

This defines a single symbol definition that is exported from the movie. Once exported, the symbol can be imported by any other movie that can reference the exporting movie using a URL. Any symbol can be exported from a movie including those imported from a different movie. Symbols are exported, by default on the first frame of a Movie. TO change this, the exportFrame attribute should be specified.

Attributes

name The id of the symbol to export.
Type String
exportName The published name of the symbol by which it is referred when importing.
Type String
exportFrame The main timeline frame in which the symbol should be exported. If the symbol is referenced before the specified frame, the symbol is exported automatically in the earlier frame.
Type Number
Default Value 1

Child Elements

None

Parent Elements

ExportSymbols

Examples

Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Defines simple symbol for export
ImageShape Example
Import and Export a Symbol

ExportSymbols

Back to Top

This is a container element for definitions that are exported from this movie and available for import into other movies. This is only available when the movie version is 5 or greater.

Attributes

None

Child Elements

ExportSymbol

Parent Elements

Movie

Examples

Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Defines simple symbol for export
ImageShape Example
Import and Export a Symbol

FillStylePair

Back to Top

This is a container element for defining a pair of fill styles in a MorphShape. The first style defined in a pair is the style associated with the FromShape element. The second style defined in the pair is the style associated with the ToShape element. The player will interpolate between these two styles for all intermediate shapes. Gradient fill elements must have the same number of gradient points. Image fills must both refer to the same Image symbol.

Attributes

index Specifies the index of the current entry in the table. Informational attribute produced on decompilation. Not used on input.
Type Integer

Child Elements

ColorFill
ImageFill
LinearGradient
RadialGradient

Parent Elements

CommonFillStyles

Examples

Timeline Replace Examples
Square to Circle Morph Example
MorphShape Example

FillStyles

Back to Top

This is a container element for fill styles used in the graphic symbol. The fill style table can be overridden by later definitions in the edges group. Styles are indexed by their location in this table, the first element being index 1. Fill styles earlier in the table have a lower display depth than those later in the table so those fills defined with an higher style index will obscure those with lower indices. All line styles will appear on top of all Fill styles defined in the same style table. In order to show a fill over a line, the fill must be defined in a later table or the shape redrawn so the overlapping boundary does not occur.

Attributes

None

Child Elements

ColorFill
ImageFill
LinearGradient
RadialGradient

Parent Elements

Edges
Shape
ShapeTransform

Examples

Shape Fill Examples
CArcs Example
Shape Origin Example
Animate simple symbols on timeline
Circle Examples
Color Specification Example
Quadratic Curve Example
Color Gradient Examples
ImageFill Examples
Dynamic MovieClip Clipping
Timeline Replace Examples
Shape Transform Examples
Clipping and Text Clipping Example
Button Example
Button DragTarget Example
Button Sound Example
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Timeline Color Transformations
Elliptical Arcs Example
Examples of Elliptical Arcs and Circular Arcs
SVG Arc Example in RVML
Defines simple symbol for export
Polygon Example
Rectangle Example

Filters

Back to Top

This is a container element for filters to be applied to an object on the display list to provide complex graphical effects. This is a new feature in Flash 8 and filter definitions are not rendered for RVML documents with a version less than 8. Once defined, filters persist on a display list instance until the instance is removed, new filters are defined, or an empty Filters element is defined.

Attributes

None

Child Elements

DropShadow
Glow
Blur
Bevel
GradientGlow
GradientBevel
ColorMatrix
ColorAdjust

Parent Elements

Alter
Place
Replace

Examples

None

Font

Back to Top

This defines a font symbol that can be used within the movie, loaded from an external resource. Font symbols are associated with both EditField and TextField symbols. Glyphs from each defined font are embedded in the movie for each character in a Text symbol and for all EditField text that does not have the systemFont property. A Font symbol is output when referenced but can be forced to be output even if no symbol references it.
All Font symbols with the same fontName and fontStyle are combined prior to output.

Attributes

id A unique name for the symbol within the movie.
Type String
fontName The standard name of the font. The fontName and fontStyle combination should be unique within a movie. If the name does not agree with the stored name of the font this name will take precedence.
Type String
resourceType The type of file used to store the font. An SWF format is an SWF file in which the font is already pre-processed and stored as SWF. Most commonly, this is as a result of a previous SWF decompilation. The first Font symbol found in the SWF is used.
Values External
SWF
Default Value SWF
resourceLocation Identifier for this resource within the repository. For the default 'File' repository this indicated the file storing the font within the fonts directory. If the resource is not found the application will create the font symbol however all referencing symbols must be EditFields with the systemFont property, indicating that the font will be provided by the device on which the SWF will be played. Fonts to be used purely as device fonts should be specified with the FontDefinition element which is not explicitly associated with any repository. If this attribute is omitted, the font is assumed to be a system font and the font is automatically retrieved from the system font folder, if it exists.
Default Value No default
fontStyle Optionally specifies the bold and italic properties of the font as a comma-separated string, presented in parentheses.
Values bold
italic
Default Value None
codeClass Optional attribute to indicate the code page associated with the font.
Values Default
Latin
Japan
Korea
SimpChinese
TradChinese
Default Value Default
fontRange Specifies the minimum character set in this font that should be included in the output movie. The specified range is added to the specified range or content of all referencing symbols. This is best used for the purposes of space optimization rather than the restriction of input characters for an EditField.
Values
All
Include all known font characters
Defined
Include only font characters used in defined symbols
User-defined range string.
A font range string consists of a comma separated set of ranges. Each range can be a single character constant enclosed in single quotes, an integer character code, a Unicode character code, or a range of characters enclosed in square brackets with a '-' range character e.g. ['a'-'z'], '+', 34, \u0025.
Default Value Defined
forceOutput Specify that the font must be output in the movie though no symbol directly references it. This is set to true when decompiling SWF if the font is used in a HTML EditField.
Values
no
Include characters in output movie only if directly referenced by symbol.
yes
Include characters from this font in output when not referenced by symbol.
Default Value no
knownCodes Informational attribute for fonts produced on decompilation. Details the character codes of all known characters stored in the font resource. Not used on input.
includeKerning In order to correctly render dynamic text that uses embedded fonts, the Flash 8 player can now use embedded kerning information in the font to adjust the gaps between different pairs of characters to enhance legibility. While such kerning information can become quite large in size, KineticFusion will only output the kerning information for those characters embedded in the font symbol.
Values no
yes
Default Value no
bitmapFont The Flash 8 authoring tool can convert font definitions so that they render using full pixels at a single specified font size. Pixel fonts are normally expensive in terms of storage space (as each pixel is square is emulated with a vector outline) and must be included for each font size used. This attribute is an information attribute indicating that a decompiled font is a bitmapFont and is not used on input.
Values no
yes

Child Elements

Desc
Metadata

Parent Elements

Repository

Examples

Font Manipulation Examples
HTML Support in EditFields
Font Range Examples
EditField Transformations
Timeline Replace Examples
Text Segments Example
Clipping and Text Clipping Example

FontDefinition

Back to Top

This defines an inline font symbol that can be used within the movie. Font symbols are associated with both EditField and TextField symbols. Glyphs from each defined font are embedded in the movie for each character in a Text symbol and for all EditField text that does not have the systemFont property. A Font symbol is output when referenced but can be forced to be output even if no symbol references it.

All Font and FontDefinition symbols with the same fontName and fontStyle are combined prior to output.

Attributes

id A unique name for the symbol within the movie.
Type String
fontName The standard name of the font. The fontName and fontStyle combination should be unique within a movie.
Type String
fontStyle Optionally specifies the bold and italic properties of the font as a comma-separated string, presented in parentheses.
Values bold
italic
Default Value None
codeClass Optional attribute to indicate the code page associated with the font.
Values Default
Latin
Japan
Korea
SimpChinese
TradChinese
Default Value Default
fontRange Specifies the minimum character set in this font that should be included in the output movie. The specified range is added to the specified range or content of all referencing symbols.This is best used for the purposes of space optimization rather than the restriction of input characters for an EditField.
Values
All
Include all known font characters
Defined
Include only font characters used in defined symbols
User-defined range string.
A font range string consists of a comma separated set of ranges. Each range can be a single character constant enclosed in single quotes, an integer character code, a Unicode character code, or a range of characters enclosed in square brackets with a '-' range character e.g. ['a'-'z'], '+', 34, \u0025.
Default Value Defined
forceOutput Specify that the font must be output in the movie though no symbol directly references it. This is set to true when decompiling SWF if the font is used in a HTML EditField.
Values
no
Include characters in output movie only if directly referenced by symbol.
yes
Include characters from this font in output when not referenced by symbol.
Default Value no
includeKerning In order to correctly render dynamic text that uses embedded fonts, the Flash 8 player can now use embedded kerning information in the font to adjust the gaps between different pairs of characters to enhance legibility. While such kerning information can become quite large in size, KineticFusion will only output the kerning information for those characters embedded in the font symbol.
Values no
yes
Default Value no
bitmapFont The Flash 8 authoring tool can convert font definitions so that they render using full pixels at a single specified font size. Pixel fonts are normally expensive in terms of storage space (as each pixel is square is emulated with a vector outline) and must be included for each font size used. This attribute is an information attribute indicating that a decompiled font is a bitmapFont and is not used on input.
Values no
yes

Child Elements

Desc
Metadata
Glyphs
FontMetrics

Parent Elements

Definitions

Examples

ADPCM Sound Example
Simple MP3 Sound Example
ActionScriptSettings Example
Animate simple symbols on timeline
Button Example
Button DragTarget Example
CArcs Example
Circle Examples
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Color Specification Example
Quadratic Curve Example
Elliptical Arcs Example
SVG Arc Example in RVML
EditField Examples
EditField Transformations
Defines simple symbol for export
Raw MP3 Example
ActionScript on the Timeline
Color Gradient Examples
Import and Export a Symbol
Importing symbols at runtime
MorphShape Example
Sound Envelope Example
Square to Circle Morph Example
Simple MP3 Sound From URL Example
User-Defined Font Example

FontMetrics

Back to Top

This defines general parameters relating to the FontDefinition which must be specified if the font is to be used for dynamic text.

Attributes

ascent The maximum height of any glyph of this font above the baseline.
Type Float
descent The maximum height of any glyph of this font below the baseline.
Type Float
leading The maximum offset of any glyph of this font from the orgin on the x-axis.
Type Float

Child Elements

KerningPair

Parent Elements

FontDefinition

Examples

User-Defined Font Example

Frame

Back to Top

A Frame is the container for all operations that position or alter graphical or sound symbols on a stage over a single time instance and is evaluated at the rate specified by the movie's rate attribute. Frames can occur under two different Timeline elements: the main movie timeline, and the timeline of a MovieClip. The visual and audio contents of a frame is dependent on all operations that took place in all frames preceding the frame on the same timeline and the operations defined on the frame itself. In additional the contents of a frame can be affected by scripts executed within any timeline in the movie providing a named reference exist to current timeline.

Attributes

frameNo Optional attribute indicating the position of the frame in timeline. Output when decompiling but not used on input.
Type Integer
frameLabel Optional attribute that defines a label for the frame. This label can be used in ActionScript operations to move the play head. A label must be specified if the anchorFrame attribute is set to 'yes'.
Type String containing only characters valid for a URI path part.
anchorFrame Optional attribute that, when set, specifies that the frame can be bookmarked by an external browser. Only frames in the main timeline can be anchor frames. In order to use anchor frames the anchors are specified after the SWF Object tag in the HTML file using the NAME attribute. The frameLabel attribute defines the fragment identifier within the parent document identifying the frame.
Values no
yes
Default Value no

Child Elements

FrameLabel
FrameActions
Place
Alter
Replace
Remove
TabIndex
PlaceSound

Parent Elements

Timeline

Examples

MorphShape Example
Square to Circle Morph Example
Video Example
Animate simple symbols on timeline
ActionScript on the Timeline
Color Gradient Examples
Dynamic MovieClip Clipping
Button Example
Button Sound Example
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Defines simple symbol for export
Timeline Replace Examples
ADPCM Sound Example
Simple MP3 Sound Example
ActionScriptSettings Example
Button DragTarget Example
CArcs Example
Circle Examples
Color Specification Example
Timeline Color Transformations
Quadratic Curve Example
Elliptical Arcs Example
Examples of Elliptical Arcs and Circular Arcs
SVG Arc Example in RVML
EditField Examples
EditField Transformations
Raw MP3 Example
Font Manipulation Examples
HTML Support in EditFields
Font Range Examples
ImageFill Examples
ImageShape Example
Import and Export a Symbol
Importing symbols at runtime
Line Style Z-Ordering
Line Style and Scaling
Polygon Example
Simple Polyline Example
Rectangle Example
Text Segments Example
Shape Fill Examples
Shape Origin Example
Shape Transform Examples
Sound Envelope Example
Clipping and Text Clipping Example
Simple MP3 Sound From URL Example
User-Defined Font Example

FrameActions

Back to Top

This text element specifies ActionScript to be executed after all other frame commands have been executed but before the frame is displayed. FrameActions are executed when the frame is entered from another frame (unlike the enterFrame MovieClip event which triggers every frame regardless whether the frame head moves or not) so for single-frame timelines the actions are executed just once. All ActionScript except event handlers can be used here. ActionScript functions should not be referenced before they are defined however once defined they are accessible from any frame.
By default the script is expected as element content however the use of the optional 'src' attribute permits an external script to be identified using a URL. If this is specified then all element content is ignored.

Consult documentation on ActionScript for more information on scripting.

Attributes

src Optional attribute indicating the URL from which to read the script.
Type String

Child Elements

None

Parent Elements

Frame

Examples

Animate simple symbols on timeline
ActionScript on the Timeline
Color Gradient Examples
ActionScriptSettings Example
Button Example
Button Sound Example
EditField Examples
Font Manipulation Examples
HTML Support in EditFields

FrameLabel

Back to Top

Attributes

frameLabel Attribute that defines a label for the frame. This label can be used in ActionScript operations to move the play head.
Type String containing only characters valid for a URI path part.
anchorFrame Optional attribute that, when set, specifies that the frame can be bookmarked by an external browser. Only frames in the main timeline can be anchor frames. In order to use anchor frames the anchors are specified after the SWF Object tag in the HTML file using the NAME attribute. The frameLabel attribute defines the fragment identifier within the parent document identifying the frame.
Values no
yes
Default Value no

Child Elements

None

Parent Elements

Frame

Examples

None

FromShape

Back to Top

Specifies the definition of edge elements for the source shape used in a MorphShape object. All standard path elements and SetStyle elements are allowed here. The ToShape will implicitly inherit all style element settings. It is possible to use derived elements such as Rect, CArc and EArc elements provided the user can guarantee that the number of edges in the FromShape and ToShape are the same (e.g by using the same elements in both). These are included in the list of valid child elements however care should be taken with their use.

Attributes

None

Child Elements

Edges

Parent Elements

MorphShape

Examples

Timeline Replace Examples
Square to Circle Morph Example
MorphShape Example

GlobalDataSource

Back to Top

This permits a document to specify default values for global data source variables and to override specified values. Only variables at the top-level of the model can be defined. The initial global data source is populated from a combination of the an external model location (specified by the kinesis.datasources.globalLocation configuration property) and command-line property definitions.

Attributes

None

Child Elements

None

Parent Elements

DataSources

Examples

None

Glow

Back to Top

Defines a single glow filter on the display object.

Attributes

blurX This defines the extent of the blur effect of the filter in the X-axis. A value of zero disables blurring and a value of 100 is the maximum blur value permitted.
From Value 0
To Value 100
Default Value 5
blurY This defines the extent of the blur effect of the filter in the Y-axis. A value of zero disables blurring and a value of 100 is the maximum blur value permitted.
From Value 0
To Value 100
Default Value 5
strength This defines the darkness of the filter. A value of zero disables the filter and a value of 1000 is the maximum strength value permitted.
From Value 0
To Value 1000
Default Value 100
quality This defines the rendering quality of the filter. The higher the quality, the greater the processing power required to render the filter.
Values
low
This is the default lowest quality of the filter and is best for optimal playback performance
medium
This is the medium quality level
high
This is the highest quality level and renders the optimal blur
Default Value low
color The color of the drop shadow specified as an RGB/RGBA tuple, a hex string or a color name. The first number of the tuple represents the red intensity, the second green, and the third blue. A minimum value of 0 for each color results in black and a max value of 255 for each color results in white. For RGBA the first three attributes are the same as above and the fourth is the degree of opacity of the color with 0 being totally transparent and 255 totally opaque. Alternatively the color can be specified as in SVG either in hexadecimal with a '#' leading character or by name using the color names defined in the SVG specification. Since these do not specify opacity, an additional opacity attribute can be defined.
Value Template rgb(Color, Color, Color)
Value Template rgba(Color, Color, Color, Color)
From Value 0
To Value 255
Value Template #Color Color Color
From Value 00
To Value ff
Value Range Any SVG color name supported in the SVG1.1 specification.
Default Value black
knockout This boolean attributes defines whether the filtered object is visible in the output. When true, both the filtered object, and any underlying filter effects are not rendered.
Values
false
The source object is displayed on the stage
true
The source object and any underlying filter effect is hidden
Default Value false
inner This boolean attributes defines whether the filter effect is applied tinside the boundaries of the shape or outside the boundaries of the shape
Values
false
The filter is rendered outside the boundaries of the shape
true
The filter is rendered inside the boundaries of the shape
Default Value false

Parent Elements

Filters

Examples

None

Glyph

Back to Top

This defines a glyph used as part of a FontDefinition element. Glyphs are composed solely of vector drawing elements. Ann enclosed areas will be rendered using the specified font color using an even-odd fill style. All glyphs are defined in a square of width 51.2 and height of 51.2. The ascent of the glyph is specified using negative y-axis coordinates and the descent of the glyph is specified using positive y-axis coordinates. Positive coordinates on the x-axis are rendered to the right of the current drawing position and negative coordinates are drawn to the left. When rendering, all coordinate positions and advances are scaled by 1/51.2 * TextSize. All inner glyph boundaries must be specified in the opposite direction to the outer boundary otherwise the entire glyph will be filled.

Attributes

code The character code represented by this glyph.
Type Integer
From Value 1
To Value 65535
char Optional informational attribute illustrating the ASCII character represented by the code. Only output if the code is in the range [32 - 126].
Type String
advance The distance along the x-axis to move the current drawing position when this glyph has been rendered. This is normally equal to the width of the glyph + 2* minimum x-axis coordinate.
Type String
bounds The bounding rectangle of the glyph specified as 'bounds( minX, minY, maxX, maxY)'. If the bounding rectangle is unknown, a value of 'auto' can be specified and the glyph bounds will be calculated automatically. Incorrect specification of this may result in parts of the glyph being occluded.
Value Template bounds(Coord, Coord, Coord, Coord)
Type Float
Default Value auto

Child Elements

ShapeTransform
Move
Line
Curve
CArc
EArc
Circle
Rect
Path
Polyline

Parent Elements

Glyphs

Examples

User-Defined Font Example

Glyphs

Back to Top

This a container element for one or more Glyph elements used in a a font definition.

Attributes

None

Child Elements

Glyph

Parent Elements

FontDefinition

Examples

User-Defined Font Example

GradientBevel

Back to Top

Defines a bevel filter on the display object that uses a user-defined gradient. Gradient stops are defined using child Stop elements to define the location and color of the gradient. All Stop elements should be ordered by offset and a gradient bevel should have at least 3 stops defined: one at offset 0, one at offset 50 with an opacity of 0, and one at offset 100.

Attributes

blurX This defines the extent of the blur effect of the filter in the X-axis. A value of zero disables blurring and a value of 100 is the maximum blur value permitted.
From Value 0
To Value 100
Default Value 5
blurY This defines the extent of the blur effect of the filter in the Y-axis. A value of zero disables blurring and a value of 100 is the maximum blur value permitted.
From Value 0
To Value 100
Default Value 5
strength This defines the darkness of the filter. A value of zero disables the filter and a value of 1000 is the maximum strength value permitted.
From Value 0
To Value 1000
Default Value 100
quality This defines the rendering quality of the filter. The higher the quality, the greater the processing power required to render the filter.
Values
low
This is the default lowest quality of the filter and is best for optimal playback performance
medium
This is the medium quality level
high
This is the highest quality level and renders the optimal blur
Default Value low
angle This defines the angle of the filter. Angles are expressed in degrees and range from 0 to 360. Filter effects rotate in a clockwise direction as the value increases.
From Value 0
To Value 360
Default Value 45
distance This defines the distance of the filter effect from the object. Distances are expressed in pixels and range from -32 to + 32.
From Value -32
To Value 32
Default Value 5
knockout This boolean attributes defines whether the filtered object is visible in the output. When true, both the filtered object, and any underlying filter effects are not rendered.
Values
false
The source object is displayed on the stage
true
The source object and any underlying filter effect is hidden
Default Value false
type Defines the type of bevel displayed.
Values
inner
The rendered bevel is an inner bevel
outer
The rendered bevel is an outer bevel
full
The rendered bevel is a full bevel
Default Value inner

Child Elements

Stop

Parent Elements

Filters

Examples

None

GradientGlow

Back to Top

Defines a glow filter on the display object that is uses a user-defined gradient. Gradient stops are defined using child Stop elements to define the location and color of the gradient. All Stop elements should be ordered by offset and a gradient glow should have at least 2 stops defined: one at offset 0, with an opacity of 0, and one at offset 100.

Attributes

blurX This defines the extent of the blur effect of the filter in the X-axis. A value of zero disables blurring and a value of 100 is the maximum blur value permitted.
From Value 0
To Value 100
Default Value 5
blurY This defines the extent of the blur effect of the filter in the Y-axis. A value of zero disables blurring and a value of 100 is the maximum blur value permitted.
From Value 0
To Value 100
Default Value 5
strength This defines the darkness of the filter. A value of zero disables the filter and a value of 1000 is the maximum strength value permitted.
From Value 0
To Value 1000
Default Value 100
quality This defines the rendering quality of the filter. The higher the quality, the greater the processing power required to render the filter.
Values
low
This is the default lowest quality of the filter and is best for optimal playback performance
medium
This is the medium quality level
high
This is the highest quality level and renders the optimal blur
Default Value low
angle This defines the angle of the filter. Angles are expressed in degrees and range from 0 to 360. Filter effects rotate in a clockwise direction as the value increases.
From Value 0
To Value 360
Default Value 45
distance This defines the distance of the filter effect from the object. Distances are expressed in pixels and range from -32 to + 32.
From Value -32
To Value 32
Default Value 5
knockout This boolean attributes defines whether the filtered object is visible in the output. When true, both the filtered object, and any underlying filter effects are not rendered.
Values
false
The source object is displayed on the stage
true
The source object and any underlying filter effect is hidden
Default Value false
type Defines the type of glow displayed.
Values
inner
The glow is rendered inside the displayed object
outer
The glow is rendered outside the displayed object
full
The glow is rendered inside and outside the displayed object
Default Value outer

Child Elements

Stop

Parent Elements

Filters

Examples

None

Image

Back to Top

This defines a image symbol that can be used within the movie. This symbol can be used as an image referenced in an ImageFill of a Shape element, the image in an ImageShape, or exported as a symbol.

Attributes

id A unique name for the symbol within the movie.
Type String
imageType The image format used to store the image.
Values
JPEGBits
JPEG image that all share same common JPEG header and is already stored in SWF format. This is an optimized format but should not be used unless it is known that the header for all JPEGBits images are identical. By default, all JPEGBits images found in a movie are exported as JPEG2 to external image files.
JPEG2
Standard self-contained JPEG image. This is a standard, non-interlaced JPEG image that does not contain an alpha channel. JPEG2 images can be stored as standard image files or as SWF movies.
JPEG3
JPEG image that also includes a stream of alpha colors. The alpha channel is not a standard JPEG feature so all JPEG3 images are stored as SWF movies.
Lossless
Standard GIF/PNG format. Lossless images can be stored externally as PNG images (if Java environment permits - see below) or as SWF movies. The capabilities for reading lossless images depend on the Java environment of the application. If Java Advanced Imaging (JAI) is installed, then BMP, GIF, FlashPix, JPEG, PNG, PNM, TIFF, and WBMP images are supported. If Java 1.4 is used then GIF and PNG are supported as a minimum. Otherwise if Java AWT is available then GIF is supported.
Default Value JPEG2
resourceType The type of file used to store the image. An SWF format is an SWF file in which the image is already pre-processed and stored as SWF. Most commonly, this is as a result of a previous SWF decompilation. The first Image symbol found in the movie is used.
Values External
SWF
Default Value External
resourceLocation Identifier for this resource within the repository. For the default 'File' repository this is the file name within the images directory.
Type String
Default Value No default
format Informational attribute for images of type 'Lossless' produced on decompilation. Not used on input.
Values 8-bit
16-Bit
32-Bit
width Informational attribute for images of type 'Lossless' produced on decompilation. Not used on input.
Type Integer
Default Value No default
height Informational attribute for images of type 'Lossless' produced on decompilation. Not used on input.
Type Integer
Default Value No default

Child Elements

Desc
Metadata

Parent Elements

Repository

Examples

ImageFill Examples
ImageShape Example

ImageFill

Back to Top

This defines a image fill for an enclosed area. A set of transformation attributes for position scale and rotation can be specified with the image and defined in the coordinate space of the parent Shape. The default image location is with the top-left corner of the image at (0,0). Specifying a rotation will rotate the image around the origin. The ImageShape element is a shorthand way of defining a shape with a single image fill and matching the size of the image.

Attributes

imageName The name of the image symbol, as defined in the repository section, to use as a fill.
Type String
clipped When set, if the image is smaller than the filled area then the color at the edge of the image is repeated to the edge of the area. This may result in the appearance of bleeding and the image must be adjusted to rectify this. When false, the image is continuously tiled to the edge of the area.
Values yes
no
Default Value no
smoothed When set, the image is smoothed where possible by the player.
Values yes
no
Default Value yes
index Specifies the index of the current entry in the table. Informational attribute produced on decompilation. Not used on input.
Type Integer

Child Elements

Transform

Parent Elements

FillStylePair
FillStyles

Examples

ImageFill Examples

ImageShape

Back to Top

This defines a shape that contains a single full-sized image. It derives its dimensions from the dimension of the image.

Attributes

id A unique name for the symbol within the movie.
Type String
imageName The symbol name of the image to be displayed in the shape.
Type String

Child Elements

None

Parent Elements

Definitions

Examples

ImageShape Example

ImportSymbol

Back to Top

This defines a single symbol definition that is imported into the movie from an external movie. This symbol can be used in any location where an inline symbol definition is appropriate.

Attributes

id The local name of the symbol.
Type String
libraryName The URL of the SWF movie that contains the imported symbol. This is normally a relative URL however an absolute URL may be specified provided it adheres to the SWF security sandbox restrictions where the import must be loaded from the same domain as the current movie.
Type String
importName The published name of the symbol by which it is referred in the exporting movie.
Type String
bounds An optional attribute specifying the bounding rectangle of the symbol specified as 'bounds( minX, minY, maxX, maxY)'. If the bounding rectangle is unknown or if the symbol cannot be placed on the timeline, then this attribute can be ignored. It is used when calculating the bounds of any container symbols. When not specified the bounds of this symbol will be ignored in such calculations.
Value Template bounds(Coord, Coord, Coord, Coord)
Type Float
Default Value None

Child Elements

Desc
Metadata

Parent Elements

ImportSymbols

Examples

Importing symbols at runtime
Import and Export a Symbol

ImportSymbols

Back to Top

This is a container element for definitions that are imported into this movie from external movies. This is only available when the movie version is 5 or greater.

Attributes

None

Child Elements

ImportSymbol

Parent Elements

Movie

Examples

Import and Export a Symbol
Importing symbols at runtime

Include

Back to Top

Specifies the name of a single MovieClip symbol that must be output in the same frame as the parent MovieClip symbol of this element.

Attributes

name The id for the required Movie Clip symbol.
Type String

Child Elements

None

Parent Elements

InitActions

Examples

None

IncludeClass

Back to Top

This defines a class that must be included in an output SWF movie. The referenced file and all dependent files will all be processed and included as if they were explicitly referenced from within ActionScript. It can also be used to specify the loading order of a class within an output SWF, by specifying the class that it must be output before. A class cannot be specified as both an IncludeClass and an ExcludeClass. The first declaration will always be used in this situation. All included classes can be verified by enabling the ASProperty 'logLoadedClasses' option.

Attributes

name The name of the ActionScript class to be included in the output movie
Type String
outputBeforeClass Optional attribute containing the name of the ActionScript class that this class should be output before.
Type String

Child Elements

None

Parent Elements

ActionScriptSettings

Examples

ActionScriptSettings Example

IncludePath

Back to Top

This is a text element defining a single path that should be used for locating ActionScript include files for the current RVML document. Multiple IncludePath elements can be specified if include files reside in multiple locations. All IncludePath locations take priority over the system-wide include path definitions, however these paths will always be referenced if files cannot be found in any IncludePath locations.

Attributes

None

Child Elements

None

Parent Elements

ActionScriptSettings

Examples

ActionScriptSettings Example

InitActions

Back to Top

This element is a container element that specifies the initialization script to be executed for the parent MovieClip element and the dependencies of that element. There are two kinds of dependencies specified with two different elements:
  • ExportAfter elements define those MovieClips that must already be defined and initialized before this definition
  • Include elements specify those MovieClips that must be available in the output movie in the frame in which this MovieClip is defined
Note that initialization scripts can also be defined globally using the InitClipActions element. Any InitClipAction elements defined under that element will generate a warning but will override this definition. The ordering of output clips in the InitClipActions section is defined by the order of the script declarations.

Attributes

None

Child Elements

ExportAfter
Include
InitScript

Parent Elements

MovieClip

Examples

None

InitClip

Back to Top

This element contains an initialization script to be executed for the specified MovieClip element before any instances of the elements are referenced. There can only be one InitClip element per MovieClip definition. InitClip actions are most commonly used to define ActionScript classes and to map ExportSymbol elements to ActionScript classes.
By default the script is expected as element content however the use of the optional 'src' attribute permits an external script to be identified using a URL. If this is specified then all element content is ignored.

Consult documentation on ActionScript for more information on scripting.

Attributes

name The id for the Movie Clip symbol within the movie.
Type String
src Optional attribute indicating the URL from which to read the script.
Type String

Child Elements

None

Parent Elements

InitClipActions

Examples

Example Of MovieClip classes
Example Of MovieClip classes and scripted animations

InitClipActions

Back to Top

This is a container element for InitClip elements that specify initialization scripts to be executed for specified MovieClip elements before any instances of the elements are referenced.Ordering of InitClip elements within this container is significant - all InitClip actions are executed in Frame 1 of the movie in the order in which they appear in this container. There can be at most one InitClip element per MovieClip definition. This is only available when the movie version is 6 or greater.

Attributes

None

Child Elements

InitClip

Parent Elements

Movie

Examples

Example Of MovieClip classes
Example Of MovieClip classes and scripted animations

InitialText

Back to Top

Text element defines the optional initial text of an EditField element. If HTML is used then the HTML should be placed in a CDATA section to avoid having to escape illegal characters.

Attributes

None

Child Elements

None

Parent Elements

EditField

Examples

EditField Examples
Elliptical Arcs Example
Font Manipulation Examples
Button Example
Button DragTarget Example
CArcs Example
Circle Examples
Color Specification Example
EditField Transformations
Defines simple symbol for export
HTML Support in EditFields
Importing symbols at runtime
ADPCM Sound Example
Simple MP3 Sound Example
Quadratic Curve Example
SVG Arc Example in RVML
Raw MP3 Example
Font Range Examples
Color Gradient Examples
Import and Export a Symbol
MorphShape Example
Sound Envelope Example
Square to Circle Morph Example
Clipping and Text Clipping Example
Simple MP3 Sound From URL Example
User-Defined Font Example

InitScript

Back to Top

This element contains an initialization script to be executed for the parent MovieClip element before any instances of the elements are referenced.
Note that initialization scripts can also be defined globally using the InitClipActions element. Any InitClipAction elements defined under that element will generate a warning but will override this definition.
InitScript actions are most commonly used to define ActionScript classes and to map ExportSymbol elements to ActionScript classes.
By default the script is expected as element content however the use of the optional 'src' attribute permits an external script to be identified using a URL. If this is specified then all element content is ignored.
Consult documentation on ActionScript for more information on scripting.

Attributes

src Optional attribute indicating the URL from which to read the script.
Type String

Child Elements

None

Parent Elements

InitActions

Examples

None

JavaDataSource

Back to Top

This creates a new JavaBean object and adds it into the data model. If the object needs to be initialized, the JavaBean must also implement the com.kinesis.interfaces.datasource.JavaDataSourceType interface. Child Argument elements can be used to pass string parameters to the object on initialization. For more information please see here .

Attributes

name The top-level name in the internal data model to which the JavaBean object is mapped. This name must be specified.
Type String
classname A mandatory attribute specifying the class name for the JavaBean instance. This class name must be locatable by the KineticFusion class loader. The initialize() method will be called automatically if it implements the interface com.kinesis.interfaces.datasource.JavaDataSourceType.
Type String

Child Elements

None

Parent Elements

DataSources

Examples

None

KerningPair

Back to Top

This defines kerning pairs in RVML that are used to adjust the advances between specific pairs of font glyphs. Kerning is supported within the SWF format however no players currently utilize kerning information in embedded fonts. However, KineticFusion will take kerning information into account when creating advances for text segments when the advances attribute is set to 'auto' so kerning definitions should be defined when converting font definitions from other formats.

Attributes

char1 The integer character code of the first glyph of the pair.
Type Integer
From Value 1
To Value 65535
char2 The integer character code of the second glyph of the pair.
Type Integer
From Value 1
To Value 65535
adjustment A decimal number indicating a positive or negative adjustment added to the advance of the first glyph when the second glyph follows
Type Float

Child Elements

None

Parent Elements

FontMetrics

Examples

None

Layer

Back to Top

There are four possible states associated with a button : up, over, down, hit. This element specifies a single symbol that is defined when the Button is in any of the specified states. The 'hit' state defines the active area for the button within which mouse events are processed. In this case the bounds of the symbol are used to define the boundary of the button and symbols associated exclusively with this state are never displayed. The 'up' state specifies that the symbol is to be displayed when the button is in the 'up' state. The 'over' state specifies that the symbol is to be displayed when the mouse is over the defined 'hit' area of the button. The 'down' state specifies that the symbol is to be displayed when the mouse is pressed within the defined 'hit' area. A single layer can specify a symbol defined in multiple states and multiple layers can specify symbols used in the same state. Multiple symbols defined for the 'up', 'over', or 'down' states will be displayed according to their specified symbol depths.
For each layer an additional Transform element can be used to place the symbol and an RGBAColorTransform element can be used to apply a color transform to the symbol.

Attributes

states A list of states support by this layer.
Value Template (State,...)
Values
up
The mouse is outside the hit area of the button.
down
The mouse is pressed within the hit area of the button.
over
The mouse is within the hit area of the button.
hit
Symbol whose bounds define the hit area of the button.
symbol Symbol to use for the specified state.
depth Display depth to place the symbol. If only one symbol is used for a particular button layer then a display depth of 1 is sufficient. However if multiple symbols are used then each must be assigned an unique depth with symbols on a higher depth obscuring those on a lower depth.
Type Integer
Default Value 1

Child Elements

Transform
RGBAColorTransform

Parent Elements

Layers

Examples

Button Example
Button DragTarget Example
Button Sound Example

Layers

Back to Top

This is a container element for button layers used in a button symbol.

Attributes

None

Child Elements

Layer

Parent Elements

Button

Examples

Button Example
Button DragTarget Example
Button Sound Example

Line

Back to Top

Draw a line in the current line style from the current drawing position to the specified destination location.

Attributes

x X coordinate for the destination position.
Type Float
Default Value 0
y Y coordinate for the destination position.
Type Float
Default Value 0
isRelative When set, coordinates are relative to last drawing position, otherwise coordinates are absolute.
Values yes
no
Default Value no

Child Elements

None

Parent Elements

Edges
Glyph
ShapeTransform

Examples

Shape Fill Examples
Color Gradient Examples
User-Defined Font Example
CArcs Example
Line Style Z-Ordering
Square to Circle Morph Example
Line Style and Scaling
Shape Transform Examples
Examples of Elliptical Arcs and Circular Arcs
Quadratic Curve Example
Shape Origin Example

LinearGradient

Back to Top

This defines a linear gradient fill for an enclosed area. The bounds of the gradient are specified with a base point and a distance over which the gradient is rendered. A gradient can have up to eight stop points each defining a percentage offset from the start of the ramp and a color. Colors are interpolated between the stop points from left to right to create the color ramp. At least two gradient stop points must be specified. All area to the left of the ramp are padded with the first ramp color and all colors to tight of the ramp are padded with the final color. The ramp can be rotated around the base point. The color offsets of stop points must be in ascending order and where two adjacent stop points are specified with the same offset all colors to the left of the specified offset will ramp to the first color and colors to the right will ramp from the second color.

Attributes

x X coordinate for the base point of the gradient.
Type Float
Default Value 0
y Y coordinate for the base point of the gradient. Only used when the gradient is rotated.
Type Float
Default Value 0
length The length of the gradient.
Type Float
Default Value None
rotate Optional attribute indicating a clockwise rotation in degrees of the gradient about the base location.
Type Float
Default Value 0
index Specifies the index of the current entry in the table. Informational attribute produced on decompilation. Not used on input.
Type Integer
linearRGB Flash renders all gradients in a manner that produces different output from those of other applications. Flash 8 has added a new flag to gradient fills that permits the gradient to be interpolated using a linear RGB interpolation which is used for SVG-like gradients.
Values
no
The gradient should be rendered using normal Flash interpolation
yes
The gradient should be rendered using an SVG-compatible interpolation
Default Value no
spreadMethod Prior to Flash 8, the color outside the defined gradient box was the same color as the terminal gradient colors. Flash 8 provides additional control over the colors outside of the gradient box by allowing two additional overflow modes: 'repeat', and 'reflect'
Values
pad
The colors outside the gradient box are painted with the terminal colors of the gradient
repeat
The gradient box is repeated for the entire fill area
reflect
The gradient box is mirrored creating a reflected gradient for the entire fill area
Default Value pad

Child Elements

Stop

Parent Elements

FillStylePair
FillStyles

Examples

Color Gradient Examples
MorphShape Example

LineStyle

Back to Top

This defines the style for all line drawing operations.

Attributes

width The width of the line in pixels. The width of the line will be evenly distributed across both sides of the line. A value 0.01 will result in a hairline width regardless of scale. In practice, line widths are significant to approx 0.06 of a pixel.
Type Float
color The color specified as an RGB/RGBA tuple, a hex string or a color name. The first number of the tuple represents the red intensity, the second green, and the third blue. A minimum value of 0 for each color results in black and a max value of 255 for each color results in white. For RGBA the first three attributes are the same as above and the fourth is the degree of opacity of the color with 0 being totally transparent and 255 totally opaque. Alternatively the color can be specified as in SVG either in hexadecimal with a '#' leading character or by name using the color names defined in the SVG specification. Since these do not specify opacity, an additional opacity attribute can be defined.
Value Template rgb(Color, Color, Color)
Value Template rgba(Color, Color, Color, Color)
From Value 0
To Value 255
Value Template #Color Color Color
From Value 00
To Value ff
Value Range Any SVG color name supported in the SVG1.1 specification.
opacity Optional attribute specifying the opacity of the color with 0 being totally transparent and 1.0 totally opaque. This will override any opacity channel value specified as part of the color attribute.
From Value 0.0
To Value 1.0
Default Value 1.0
dashArray Optional attribute specifying the length of the dash and space in all straight lines(curves can not be dashed and this attribute is ignored for all non-straight lines). At least two values must be specified. The first entry is the length if the dash and second is the length of the gap. If an odd number of intervals are specified then the dash array is appended to itself to give an even number of intervals. All dashed lines will be terminated in a dash which may cause the last dash to be longer than specified. This attribute should be used carefully as there is no native support for dashed lines in the SWF format and all dashed lines are decomposed into smaller solid and empty lines.
Value Template (Value, Value,...)
Type Float
index Specifies the index of the current entry in the table. Informational attribute produced on decompilation. Not used on input.
Type Integer

Child Elements

None

Parent Elements

LineStylePair
LineStyles

Examples

Line Style and Scaling
Shape Fill Examples
CArcs Example
Elliptical Arcs Example
Examples of Elliptical Arcs and Circular Arcs
Line Style Z-Ordering
Shape Transform Examples
Square to Circle Morph Example
Circle Examples
SVG Arc Example in RVML
Dynamic MovieClip Clipping
Rectangle Example
Animate simple symbols on timeline
Color Specification Example
Quadratic Curve Example
Color Gradient Examples
ImageFill Examples
MorphShape Example
Timeline Replace Examples
Clipping and Text Clipping Example
Button Example
Button DragTarget Example
Button Sound Example
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Timeline Color Transformations
Defines simple symbol for export
Polygon Example
Simple Polyline Example
Shape Origin Example

LineStylePair

Back to Top

This is a container element for defining a pair of line styles in a MorphShape. The first style defined in a pair is the style associated with the source FromShape element. The second style defined in the pair is the style associated with the destination ToShape element. The player will interpolate between these two styles for all intermediate shapes. Line styles for MorphShapes cannot specify dashArray attributes.

Attributes

index Specifies the index of the current entry in the table. Informational attribute produced on decompilation. Not used on input.
Type Integer
join This attribute defines the join type between two two consecutive line segments. Prior to Flash 8, all line joins were implemented as 'round' joins and this could not be altered. Flash 8 introduced two additional join types for line segments: 'miter' and 'bevel'. The join style is only applicable for line segments that are contiguous and that are not separated by a style change.
Values
round
This is the default pre-Flash 8 representation of the join style. Lines are always joined by a circular arc with the center at the intersection of the two segments.
miter
This defines a pointed join between two segments whose extension beyond the intersection point is determined by the magnitude of the angle between the two lines. A small acute angle will cause the miter join to extend further than a larger angle. To prevent the miter from extending too far for extremely small angles, a miter value can be specified that constrains the extension of the join and can convert the join to a bevel appearance.
bevel
This defines a bevelled join between two segments. The bevelled join is similar to the round join with the join drawn as a straight line between the two intersection points of the segments and join arc to create a straight-edged join.
Default Value round
miter When a miter join is defined, this attribute allows the extent of the miter to be constrained. The value of this attribute defines the maximum magnitude of of the miter as a multiplier of the line width. When the maximum magnitude is reached the miter is terminated with a bevel join.
Type Float
Default Value 3
cap This attributes defines the style of the end-point of a segment that is not joined to any other line segments. Prior to Flash 8, all line end-points were implemented with a 'round' cap style. Flash 8 introduced two additional line cap styles: 'none' and 'square'.
Values
round
This is the default pre-Flash 8 representation of the cap style. Lines are always capped by a circular arc extending in a semicircle (of radius width /2) beyond the endpoint location.
none
The cap of a line does not extend beyond the endpoint location and the cap is a straight line perpendicular to the direction of the segment.
square
The cap of a line extends by hald the line width beyond the endpoint location and the cap is a straight line perpendicular to the direction of the segment.
Default Value round
constrainScale This attributes defines constraints that can be added to a style that modifies the width of the line style when scaled. Prior to Flash 8, altering the displayed scale of a shape symbol in Flash 8 caused the thickness of all line styles to scale by a corresponding amount. Hence a line of width 8 would be displayed with an onscreen width of 16 pixels when viewed at a scale of 200%. Flash 8 introduces new constraints that allows line styles to be constrained when scaling the symbol in one or both axes.
Values
normal
The width of the line style is scaled normally.
horizontal
The width of the line is not scaled if the shape is scaled horizontally.
vertical
The width of the line is not scaled if the shape is scaled vertically.
both
The width of the line is never scaled.
Default Value normal
hinting This attributes defines whether the Flash 8 player should attempt to modify the locations of drawing endpoints to ensure that the lines are rendered at their best. The Flash player uses a coordinate system that is much larger than that displayable one a normal screen. The Flash player transparently converts between the two coordinate systems and the result is normally a clear and consistent display. However, certain lines may appear to be less distinct than others when their endpoints are not aligned on full pixels. In Flash 8 this attribute was introduced to indicate that all segment endpoints should be adjusted so that they are placed on full pixels, regardless of line width.
Values
false
Segment end points are defined as specified by the user
true
Segment endpoints are adjusted so that they are located on full pixels.
Default Value false

Child Elements

LineStyle

Parent Elements

CommonLineStyles

Examples

Square to Circle Morph Example
MorphShape Example

LineStyles

Back to Top

This is a container element for line styles used in the Shape element. The line style table can be overridden by later definitions in the edges group. Styles are indexed by their location in this table, the first element at index 1. The visibility of LinesStyle elements is relative to their index in the table. Those with a higher index have a higher display depth and will obscure those with a lower index. All line styles will appear on top of all Fill styles defined in the same style table. In order to show a fill over a line, the fill must be defined in a later table or the shape redrawn so the overlapping boundary does not occur.

Attributes

None

Child Elements

LineStyle

Parent Elements

Edges
Shape
ShapeTransform

Examples

CArcs Example
Shape Fill Examples
Circle Examples
Dynamic MovieClip Clipping
Animate simple symbols on timeline
Color Specification Example
Color Gradient Examples
ImageFill Examples
Line Style and Scaling
Timeline Replace Examples
Shape Transform Examples
Clipping and Text Clipping Example
Button Example
Button DragTarget Example
Button Sound Example
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Timeline Color Transformations
Quadratic Curve Example
Elliptical Arcs Example
Examples of Elliptical Arcs and Circular Arcs
SVG Arc Example in RVML
Defines simple symbol for export
Line Style Z-Ordering
Polygon Example
Simple Polyline Example
Rectangle Example
Shape Origin Example

Metadata

Back to Top

This defines optional XML fragments that can be stored with a Movie document or symbol. Any valid XML document fragment can be specified under this element.

Attributes

None

Child Elements

Any

Parent Elements

Button
EditField
Font
FontDefinition
Image
ImportSymbol
MorphShape
Movie
MovieClip
Shape
Sound
Text
Video

Examples

None

MorphShape

Back to Top

The MorphShape is the most complex symbol type to use. It defines a transformation between a source shape and a destination shape, transforming shape and style. There are several caveats to this process. Both the source shape and the destination shape must have the same number of drawing edges, and the styles changes must occur in the same relative location. Styles to be transformed must be of the same type and, in the case of ImageFills, must refer to the same image. For Gradient Fills, both GradientFills must have the same number of gradient points.
The MorphShape is defined by first defining the style pairs that correspond to the source and destination styles for the two shapes. The FromShape and ToShape are then defined. The FromShape, as well as containing Edge definitions, contains all SetStyle elements for both the FromShape and the ToShape. It is assumed that location for the definition of a source style in the FromShape is the same location as the corresponding definition of the destination style in the ToShape. The ToShape, therefore, contains no SetStyle elements at all, only drawing elements.
To display the shape it must be places on the stage with a ratio value between 0 and 65535. A value of 0 will display only the FromShape, a value of 65535 will display only the ToShape. Any other intermediate value will display an interpolation between the two shapes. For more information on this see the PlaceCommand element.

Attributes

id A unique name for the symbol within the movie.
Type String
bounds Optional attribute specifying the bounding rectangle of the MorphShape specified as 'bounds( minX, minY, maxX, maxY)'. This attribute can be produced on decompilation as a guide to the actual runtime bounds of the symbol but it is not referenced by the RVML compiler. This is useful for the timeline elements (Place, Alter, Replace) to specify new scaling attributes for the MorphShape symbol.
Value Template bounds(Coord, Coord, Coord, Coord)
Type Float

Child Elements

Desc
Metadata
CommonLineStyles
CommonFillStyles
FromShape
ToShape

Parent Elements

Definitions

Examples

Timeline Replace Examples
Square to Circle Morph Example
MorphShape Example

Move

Back to Top

Move the drawing position to the specified location. No drawing operation is executed.

Attributes

x X coordinate for the drawing position.
Type Float
Default Value 0
y Y coordinate for the drawing position.
Type Float
Default Value 0
isRelative When set, coordinates are relative to last drawing position, otherwise coordinates are absolute.
Values no
yes
Default Value no

Child Elements

None

Parent Elements

Edges
Glyph
ShapeTransform

Examples

User-Defined Font Example
Elliptical Arcs Example
Line Style Z-Ordering
Shape Fill Examples
Square to Circle Morph Example
Examples of Elliptical Arcs and Circular Arcs
Color Gradient Examples
Shape Origin Example
CArcs Example
Quadratic Curve Example
Shape Transform Examples
Color Specification Example
Line Style and Scaling

Movie

Back to Top

All RVML files must have a single root movie element. This contains all information relating to a single SWF movie. Each MovieElement has up to 6 sections defining the structure and content for the movie:
  • An optional DataSources element are used to group all external data sources used in the document
  • An optional Components element are used specify the external components to be included in the movie
  • Zero or more Repository elements used to define external resources to be used in the compilation of the SWF movie.
  • An optional ImportSymbols element are used to group all external symbols that are imported into the movie at runtime
  • An optional Definitions element are used to group all internally defined symbols in the movie
  • An optional ExportSymbols element are used to specify those elements of the movie that may be imported by other movies
  • An optional InitClip element containing the ActionScript initialization of symbols and their corresponding classes
  • A single Timeline element defining the movie resulting from the interaction between all local and imported symbols in a series of Frames.
The visible stage of the movie is defined as the rectangle from (0,0) to ( width, height) and all elements partially or completely outside this coordinate space will be clipped.

Attributes

version The lowest SWF version of the movie. SWF players produced by Macromedia increased in capability and complexity from early versions and most platforms now support a version of 5 or greater. The highest possible version should be selected as many file and ActionScript features are only available in later versions. This documentation will detail the lowest supported version for each RVML element however for ActionScript information please consult Macromedia information. If the ActionScript defined in the file is not applicable for the specified version an error will be created during processing of the script.
Values 4
5
6
7
8
Default Value 7
width The width of the movie in pixels. Will be overridden if a sizeShape attribute is specified. The largest legal width is greater than 53,000,000 however the maximum supported by any player is more likely to be around 3000.
From Value 0
To Value 53,687,091
Default Value 800
height The height of the movie in pixels. Will be overridden if a sizeShape attribute is specified.The largest legal width is greater than 53,000,000 however the maximum supported by any player is more likely to be around 3000.
Type Integer
From Value 0
To Value 53,687,091
Default Value 600
sizeShape Optional attribute specifying the symbol name of a Shape symbol from which to derive the width and height attributes. This may be particularly useful for ImageShape symbols whose size is unknown.
Type String
rate The frame rate of the movie. This is the number of frames per second that the movie displays. Typical values are between 12 and 30 for movies which contain any animated element. All movie clips inherit their frame rate from this value. While it can go as high as 255 normal frame rates vary from 1 to 30. High frame rates may result in the player dropping frames to keep up.
Type Integer
From Value 1
To Value 255
Default Value 12
backgroundColor The color specified as an RGB tuple or a color name. The first number of the tuple represents the red intensity, the second green, and the third blue. A minimum value of 0 for each color results in black and a max value of 255 for each color results in white. Alternatively the color can be specified by name using the color names defined in the SVG specification.
Value Template rgb(Color, Color, Color)
From Value 0
To Value 255
Value Range Any SVG color name supported in the SVG1.1 specification.
compressed Only applicable when the movie version is 6 or greater. Setting this attribute results in the SWF file being automatically compressed on output with the potential to significantly reduce the size of the resulting SWF movie.
Values no
yes
Default Value no
enableDebug Only applicable when the movie version is 6 or greater. Setting this attribute' allows the SWF movie to be debugged using an active copy of Macromedia Flash MX. Due to the nature of the facility provided by Macromedia ActionScript debugging cannot be carried out as a debug symbol file cannot be created. However the state of all defined elements can be queries at run-time as can the output of ActionScript trace statements. An empty password is provided for the debugger.
Values no
yes
Default Value no
fileAccess In Flash 8, the security model of the Flash player changed so that an SWF could either freely access the internet or local resources but not both (without additional configuration). This attribute defines the security access for the resulting SWF for Version 8 movies and above.
Values
local
Access is permitted to local resources
network
Access is permitted to network resources
Default Value local

Child Elements

Title
Desc
Metadata
DataSources
MovieAttributes
ActionScriptSettings
Components
Repository
ImportSymbols
Definitions
ExportSymbols
InitClipActions
Timeline

Parent Elements

None

Examples

ADPCM Sound Example
Simple MP3 Sound Example
ActionScriptSettings Example
Animate simple symbols on timeline
Button Example
Button DragTarget Example
Button Sound Example
CArcs Example
Circle Examples
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Color Specification Example
Timeline Color Transformations
Quadratic Curve Example
Elliptical Arcs Example
Examples of Elliptical Arcs and Circular Arcs
SVG Arc Example in RVML
EditField Examples
EditField Transformations
Defines simple symbol for export
Raw MP3 Example
Font Manipulation Examples
HTML Support in EditFields
Font Range Examples
ActionScript on the Timeline
Color Gradient Examples
ImageFill Examples
ImageShape Example
Import and Export a Symbol
Importing symbols at runtime
Line Style Z-Ordering
Line Style and Scaling
MorphShape Example
Dynamic MovieClip Clipping
Polygon Example
Simple Polyline Example
Rectangle Example
Timeline Replace Examples
Text Segments Example
Shape Fill Examples
Shape Origin Example
Shape Transform Examples
Sound Envelope Example
Square to Circle Morph Example
Clipping and Text Clipping Example
Simple MP3 Sound From URL Example
User-Defined Font Example
Video Example

MovieAttributes

Back to Top

It may be required to have the attributes of a movie specified by an external data source, specific to an RVML document. In this case, the attributes cannot be specified on the Movie element as any RVML-specified data sources will not yet be defined. This element allows the full definition of the attributes of a movie AFTER the declaration of data sources, allowing attributes to contain expressions that refer to data sources declared with the DataSource elements. Any existing Movie attribute will be overridden by values specified under this element.

Attributes

version The lowest SWF version of the movie. SWF players produced by Macromedia increased in capability and complexity from early versions and most platforms now support a version of 5 or greater. The highest possible version should be selected as many file and ActionScript features are only available in later versions. This documentation will detail the lowest supported version for each RVML element however for ActionScript information please consult Macromedia information. If the ActionScript defined in the file is not applicable for the specified version an error will be created during processing of the script.
Values 1
2
3
4
5
6
7
Default Value 5
width The width of the movie in pixels. Will be overridden if a sizeShape attribute is specified. The largest legal width is greater than 53,000,000 however the maximum supported by any player is more likely to be around 3000.
From Value 0
To Value 53,687,091
Default Value 800
height The height of the movie in pixels. Will be overridden if a sizeShape attribute is specified.The largest legal width is greater than 53,000,000 however the maximum supported by any player is more likely to be around 3000.
Type Integer
From Value 0
To Value 53,687,091
Default Value 600
rate The frame rate of the movie. This is the number of frames per second that the movie displays. Typical values are between 12 and 30 for movies which contain any animated element. All movie clips inherit their frame rate from this value. While it can go as high as 255 normal frame rates vary from 1 to 30. High frame rates may result in the player dropping frames to keep up.
Type Integer
From Value 1
To Value 255
Default Value 12
backgroundColor The color specified as an RGB tuple or a color name. The first number of the tuple represents the red intensity, the second green, and the third blue. A minimum value of 0 for each color results in black and a max value of 255 for each color results in white. Alternatively the color can be specified by name using the color names defined in the SVG specification.
Value Template rgb(Color, Color, Color)
From Value 0
To Value 255
Value Range Any SVG color name supported in the SVG1.1 specification.
compressed Only applicable when the movie version is 6 or greater. Setting this attribute results in the SWF file being automatically compressed on output with the potential to significantly reduce the size of the resulting SWF movie.
Values no
yes
Default Value no
enableDebug Only applicable when the movie version is 6 or greater. Setting this attribute' allows the SWF movie to be debugged using an active copy of Macromedia Flash MX. Due to the nature of the facility provided by Macromedia ActionScript debugging cannot be carried out as a debug symbol file cannot be created. However the state of all defined elements can be queries at run-time as can the output of ActionScript trace statements. An empty password is provided for the debugger.
Values no
yes
Default Value no
fileAccess In Flash 8, the security model of the Flash player changed so that an SWF could either freely access the internet or local resources but not both (without additional configuration). This attribute defines the security access for the resulting SWF for Version 8 movies and above.
Values
local
Access is permitted to local resources
network
Access is permitted to network resources
Default Value local

Child Elements

None

Parent Elements

Movie

Examples

None

MovieClip

Back to Top

This is the most powerful construct available for animation. A movie clip contains a single Timeline element containing one or more Frame elements that position or alter objects on a stage. Each movie clip has it's own coordinate system and each symbol placed on the stage under a MovieClip element is placed relative to the coordinate system of the clip, not of the global stage. The number of frames a Movie Clip can have is unlimited however it inherits the animation frame rate from the parent movie.

Attributes

id A unique name for the Movie Clip symbol within the movie.
Type String
bounds Optional attribute specifying the bounding rectangle of the MovieClip specified as 'bounds( minX, minY, maxX, maxY)'. This attribute can be produced on decompilation as a guide to the actual runtime bounds of the symbol but it is not referenced by the RVML compiler. This is useful for the timeline elements (Place, Alter, Replace) to specify new scaling attributes for the MovieClip symbol.
Value Template bounds(Coord, Coord, Coord, Coord)
Type Float
slice9Grid Flash 8 introduces a new mechanism for constraining the scaling of MovieClip symbols. The coordinate space of the symbol is divided into 9 rectangular regions using a grid. The contents of the center of the grid are scaled normally. The center-top and center-bottom regions only scale horizontally, and the center-left and center-right regions only scale vertically. All 4 corner regions are unscaled.This attribute defines the bounding rectangle of the center region, specified as 'bounds( minX, minY, maxX, maxY)'. The bounds of all other regions can be calculated from this.
Value Template bounds(Coord, Coord, Coord, Coord)
Type Float
Default Value Not specified

Child Elements

Desc
Metadata
InitActions
Timeline

Parent Elements

Definitions

Examples

Dynamic MovieClip Clipping
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Defines simple symbol for export
Color Gradient Examples

MovieClipActions

Back to Top

This element specifies the text of one or more MovieClip event handlers attached to the current MovieClip instance on the active timeline. All ActionScript must be enclosed in onClipEvent() handlers. Movies of version 6 and upwards can also attach button event handlers to MovieClips.

A new event type is introduced in RVML called setParameters. An event handler for this event type will be called once only when the handler is defined and the handler can define object properties and methods associated with the MovieClip instance before the class constructor is called. In effect, this can be used to set parameters used in the constructor. Event Handlers for 'load' events are called after the constructor is called.

By default the script is expected as element content however the use of the optional 'src' attribute permits an external script to be identified using a URL. If this is specified then all element content is ignored.

Consult documentation on ActionScript for more information on scripting.

Attributes

src Optional attribute indicating the URL from which to read the script.
Type String

Child Elements

None

Parent Elements

Place

Examples

Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Color Gradient Examples
Dynamic MovieClip Clipping

Path

Back to Top

Implementation of the SVG path element for all drawing operations. All cubic Bezier curves will be rendered using quadratic Bezier approximations. The only attribute supported is the 'd' attribute.

Attributes

d Full implementation of SVG path attribute with all drawing operations supported. cosult the SVG documentation for full details on the operations and representations supported.
Type String

Child Elements

None

Parent Elements

Edges
Glyph
ShapeTransform

Examples

SVG Arc Example in RVML
Shape Transform Examples

Place

Back to Top

This element places an instance of a symbol onto the timeline at a specified display depth. The display depth is a type of z-ordering where elements at a higher depth appear in front of elements at lower depths. Only a single symbol can occupy a specified depth on a single timeline until the symbol is removed with a Remove element or replaced with a Replace element. Place elements can also take basic transformation attributes. These, in general, should be used in preference to a nested Transform element in situations where the placed symbol is already defined and the bounds are known. The location of the referenced symbol can be modified with the x and y attributes, the scale of the symbol can be modified using the width and height attributes, and the rotation of the symbol modified using the rotate attribute. Note that when the width and height attributes are used for compound symbols such as MovieClips and Buttons, their bounds are calculated by summing the bounds of all symbols on their timeline or, in the case of buttons, their hit areas.

If it is necessary to specify skew attributes using differing values for rotateX and rotateY, or if it is preferred to specify an absolute transform independent of the placed symbol, then the nested Transform element can be used

Attributes

name The id of the symbol to place on the timeline.
Type String
depth This is the unique depth at which to place this instance of the symbol.
Type Integer
From Value 1
To Value 65535
instanceName Optional name used to refer to the instance from ActionScript. Only elements of type EditField, MovieClip, Button and Video can be assigned names. Import symbols resolving to these types are also supported.
Type String
clipDepth Optional attribute which, if set, defines this instance as a clipping symbol clipping all depths from the instance's depth to the specified depth which must be greater than the depth at which the symbol is placed. The instance will be used as a mask allowing only those overlapping symbol parts within the specified clipping depths to be displayed. Only those filled areas of shapes are used as clipping areas, lines are ignored. Elements already placed on the stage in previous frames cannot be subsequently masked in later frames in current players unless removed and replaced.

EditField elements cannot be used as clipping symbols however all text fields can be used as they depend solely on embedded character definitions. Prior to Version 6 MovieClip elements cannot be used as clipping shapes.

Type Integer
From Value 1
To Value 65535
tabIndex Optional attribute specifying a tab index for the symbol. Tab indices are used by screen readers and provide a means to signal that the current symbol has content that is renderable by such a reader.
Type Integer
From Value 0
To Value 65535
ratio Optional attribute used for MorphShapes and Videos. When used for a MorphShape, this refers to the degree of interpolation between the FromShape and the ToShape. A value of 0 displays the FromShape, a value of 65535 displays the ToShape and all values in between result in an interpolation between the two in direct proportion to the ratio.

For Video symbols this moves the video playhead to the frame number specified by the ratio value.

Type Integer
From Value 0
To Value 65535
x X position for specified symbol. Moves the origin of the symbol to the specified X coordinate.
Type Float
Default Value 0
y Y position for specified symbol. Moves the origin of the symbol to the specified Y coordinate.
Type Float
Default Value 0
width The new width of the symbol. The symbol width is independent of the coordinate system of the symbol being altered. In order for this attribute to be specified, the symbol must already be defined in RVML, and it cannot have a width of zero.
Type Float
Default Value Width of existing symbol
height The new height of the symbol. The symbol height is independent of the coordinate system of the symbol being altered. In order for this attribute to be specified, the symbol must already be defined in RVML, and it cannot have a height of zero.
Type Float
Default Value Height of existing symbol
rotate Rotation in degrees about the origin of the shape, applied before the application of the x and y attribute definitions, if specified.
Type Float
Default Value 0
blend Flash 8 introduced blending of multiple overlapping symbols on a stage. There are 14 different blend types supported. Blends remain applied to a symbol instance until explicitly reset. To remove a previously applied blend mode, the blend value should be set to 'normal'.
Values normal
layer
multiply
screen
lighten
darken
difference
add
subtract
invert
alpha
erase
overlay
hardlight
cacheAsBitmap Flash 8 introduced a new setting for indicating that a MovieClip or Button placed on the timeline should be converted to a bitmap for faster rendering. This enables the Flash player to optimize the rendering of display objects that are frequently redrawn on the stage.
Values
yes
The displayed symbol should be converted to a bitmap
no
The displayed symbol should not be converted to a bitmap
Default Value no

Child Elements

Transform
RGBAColorTransform
Filters
MovieClipActions

Parent Elements

Frame

Examples

EditField Examples
Timeline Color Transformations
Line Style and Scaling
CArcs Example
Elliptical Arcs Example
EditField Transformations
Circle Examples
Shape Fill Examples
Shape Origin Example
Button Example
Font Manipulation Examples
Dynamic MovieClip Clipping
Clipping and Text Clipping Example
Button DragTarget Example
Color Specification Example
Defines simple symbol for export
HTML Support in EditFields
Importing symbols at runtime
Timeline Replace Examples
Text Segments Example
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Color Gradient Examples
Animate simple symbols on timeline
Button Sound Example
Quadratic Curve Example
SVG Arc Example in RVML
Import and Export a Symbol
MorphShape Example
Shape Transform Examples
Square to Circle Morph Example
User-Defined Font Example
ADPCM Sound Example
Simple MP3 Sound Example
ActionScriptSettings Example
Examples of Elliptical Arcs and Circular Arcs
Raw MP3 Example
Font Range Examples
ActionScript on the Timeline
ImageFill Examples
ImageShape Example
Line Style Z-Ordering
Polygon Example
Simple Polyline Example
Rectangle Example
Sound Envelope Example
Simple MP3 Sound From URL Example
Video Example

PlaceSound

Back to Top

This element initiates the playing of the specified sound. The characteristics of the sound are defined using a SoundInfo element

Attributes

name The id of the sound to start playing.
Type String

Child Elements

SoundInfo

Parent Elements

Frame

Examples

ADPCM Sound Example
Simple MP3 Sound Example
Raw MP3 Example
Sound Envelope Example
Simple MP3 Sound From URL Example

Polygon

Back to Top

Implementation of the SVG polygon element. The only attribute supported is the 'points' attribute.

Attributes

points Full impementation of SVG attribute. This contains a list of points making up the vertices of the line. At least 2 points must be specified. Points are represented as pairs of decimal numbers separated by spaces or commas. The x and y values of a single pair may be separated by spaces or commas. The last point is implicitly connected to the first by a final line.
Type String

Child Elements

None

Parent Elements

Edges
ShapeTransform

Examples

Dynamic MovieClip Clipping
Polygon Example
Clipping and Text Clipping Example

Polyline

Back to Top

Implementation of the SVG polyline element. The only attribute supported is the 'points' attribute.

Attributes

points Full implementation of the SVG attribute. This contains a list of points making up the vertices of the line. At least 2 points must be specified. Points are represented as pairs of decimal numbers separated by spaces or commas. The x and y values of a single pair may be separated by spaces or commas.
Type String

Child Elements

None

Parent Elements

Edges
Glyph
ShapeTransform

Examples

Simple Polyline Example

PropertyDataSource

Back to Top

This loads all the data from the specified Java Properties file into the data model. Hierarchical property names can be specified and each property name can be suffixed with a modifier indicating the variable type. For more information please see here .

Attributes

name The top-level name in the internal data model under which all the mappings defined in the properties file are placed. This name must be specified.
Type String
location A mandatory attribute containing the physical location of the properties file. This can be specified as either a file name of a URL (the type attribute is used to determine the location type). When a relative filepath is specified, it is assumed to be relative to the document root of the RVML document - in general this is the folder in which the RVML document is located.
Type String
type The type of location specified in the location attribute.
Type String
Values file
url
Default Value file

Child Elements

None

Parent Elements

DataSources

Examples

None

RadialGradient

Back to Top

This defines a radial gradient fill for an enclosed area. The bounds of the gradient are specified with a center point and a pair of elliptical radii over which the gradient is rendered. A gradient can have up to eight stop points each defining a percentage offset from the start of the ramp and a color. Colors are interpolated between the stop points from left to right to create the color ramp. At least two gradient stop points must be specified. All area to the left of the ramp are padded with the first ramp color and all colors to tight of the ramp are padded with the final color. When the radii are different values the ramp can be rotated around the base point. The color offsets of stop points must be in ascending order and where two adjacent stop points are specified with the same offset all colors to the left of the specified offset will ramp to the first color and colors to the right will ramp from the second color.

Attributes

cx X coordinate for the center point of the gradient.
Type Float
Default Value 0
cy Y coordinate for the center point of the gradient.
Type Float
Default Value 0
rx The X radius of the gradient.
Type Float
Value Range >0
Default Value None
ry The Y radius of the gradient.
Type Float
Value Range >0
Default Value None
rotate Optional attribute indicating a clockwise rotation in degrees of the gradient about the base location. Only used when the rx and ry attributes are different.
Type Float
Default Value 0
index Specifies the index of the current entry in the table. Informational attribute produced on decompilation. Not used on input.
Type Integer
linearRGB Flash renders all gradients in a manner that produces different output from those of other applications. Flash 8 has added a new flag to gradient fills that permits the gradient to be interpolated using a linear RGB interpolation which is used for SVG-like gradients.
Values
no
The gradient should be rendered using normal Flash interpolation
yes
The gradient should be rendered using an SVG-compatible interpolation
Default Value no
spreadMethod Prior to Flash 8, the color outside the defined gradient box was the same color as the terminal gradient colors. Flash 8 provides additional control over the colors outside of the gradient box by allowing two additional overflow modes: 'repeat', and 'reflect'
Values
pad
The colors outside the gradient box are painted with the terminal colors of the gradient
repeat
The gradient box is repeated for the entire fill area
reflect
The gradient box is mirrored creating a reflected gradient for the entire fill area
Default Value pad
xDisp Prior to Flash 8, all radial gradients were uniform and it was not possible to adjust the center of the gradient without modifying the bounds of the gradient. The xDisp attribute was added in FLash 8 to allow the ceter of the gradient to be shifted left or right along the X axis woutout modifying the bounds of the gradient. This permits must more realistic effects alloing different gradient densities from a single gradient definition.
Type Float
From Value -100
To Value +100
Default Value 0

Child Elements

Stop

Parent Elements

FillStylePair
FillStyles

Examples

Color Gradient Examples
Clipping and Text Clipping Example

Rect

Back to Top

Draw a rectangle from the specified top-left position using the specified width and height. If optional radii are specified, then these are used to draw arcs at each of the corners of the rectangle. If only a single radius is specified then both are assumed to be the same.

Attributes

x X coordinate for the top-left position.
Type Float
Default Value 0
y Y coordinate for the top-left position.
Type Float
Default Value 0
width Width of the rectangle.
Type Float
Default Value 0
height Height of the rectangle.
Type Float
Default Value 0
rx Optional x-axis radius of the arc to use for rounded corners. If this value is greater than width/2 then the value of width/2 is used.
Type Float
Default Value 0
ry Optional y-axis radius of the arc to use for rounded corners. If this value is greater than height/2 then the value of height/2 is used.
Type Float
Default Value 0

Child Elements

None

Parent Elements

Edges
Glyph
ShapeTransform

Examples

Timeline Replace Examples
ImageFill Examples
Rectangle Example
Animate simple symbols on timeline
Timeline Color Transformations
MorphShape Example
Dynamic MovieClip Clipping
Button Example
Button DragTarget Example
Button Sound Example
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
SVG Arc Example in RVML
Shape Transform Examples

Remove

Back to Top

This element removes the instance of the symbol on the timeline at the specified display depth.

Attributes

name The id of the symbol to remove on the timeline. This attribute is optional from Version 2.0.04 - when supplied, the existing symbol on the specified depth is checked to ensure that it has the specified symbol ID.
Type String
depth The depth of the symbol instance to remove.
Type Integer
From Value 1
To Value 65535

Child Elements

None

Parent Elements

Frame

Examples

Button Example
Button Sound Example

Replace

Back to Top

This element replaces the symbol at the specified depth with a new instance of a symbol of the specified type and is the equivalent of a Remove element followed by a Place element with optional transformations. This element will only replace Shape, MorphShape and Text elements. Any other element is ignored. The new symbol will inherit the clipDepth and ratio attributes and Transform and RGBAColorTransform elements that were defined for the replaced symbol unless otherwise specified.

Replace elements can also take basic transformation attributes. These, in general, should be used in preference to a nested Transform element in situations where the referenced symbol is already defined and the bounds are known. The location of the referenced symbol can be modified with the x and y attributes, the scale of the symbol can be modified using the width and height attributes, and the rotation of the symbol modified using the rotate attribute. Note that when the width and height attributes are used for compound symbols such as MovieClips and Buttons, their bounds are calculated by summing the bounds of all symbols on their timeline or, in the case of buttons, their hit areas.

If it is necessary to specify skew attributes using differing values for rotateX and rotateY, or if it is preferred to specify an absolute transform independent of the new symbol, then the nested Transform element can be used

Attributes

name The id of the symbol to place on the timeline.
Type String
depth This is the depth at which to replace an existing instance with this instance of the symbol.
Type Integer
From Value 1
To Value 65535
instanceName Optional name used to refer to the instance from ActionScript.
Type String
tabIndex Optional attribute specifying a tab index for the symbol. Tab indices are used by screen readers and provide a means to signal that the current symbol has content that is renderable by such a reader.
Type Integer
From Value 0
To Value 65535
ratio Optional attribute used for MorphShapes.This refers to the degree of interpolation between the FromShape and the ToShape. A value of 0 displays the FromShape, a value of 65535 displays the ToShape and all values in between result in an interpolation between the two in direct proportion to the ratio.
Type Integer
From Value 1
To Value 65535
x X position for specified symbol. Moves the origin of the symbol to the specified X coordinate.
Type Float
Default Value 0
y Y position for specified symbol. Moves the origin of the symbol to the specified Y coordinate.
Type Float
Default Value 0
width The new width of the symbol. The symbol width is independent of the coordinate system of the symbol being altered. In order for this attribute to be specified, the symbol must already be defined in RVML, and it cannot have a width of zero.
Type Float
Default Value Width of existing symbol
height The new height of the symbol. The symbol height is independent of the coordinate system of the symbol being altered. In order for this attribute to be specified, the symbol must already be defined in RVML, and it cannot have a height of zero.
Type Float
Default Value Height of existing symbol
rotate Rotation in degrees about the origin of the shape, applied before the application of the x and y attribute definitions, if specified.
Type Float
Default Value 0
blend Flash 8 introduced blending of multiple overlapping symbols on a stage. There are 14 different blend types supported. Blends remain applied to a symbol instance until explicitly reset. To remove a previously applied blend mode, the blend value should be set to 'normal'.
Values normal
layer
multiply
screen
lighten
darken
difference
add
subtract
invert
alpha
erase
overlay
hardlight
cacheAsBitmap Flash 8 introduced a new setting for indicating that a MovieClip or Button placed on the timeline should be converted to a bitmap for faster rendering. This enables the Flash player to optimize the rendering of display objects that are frequently redrawn on the stage.
Values
yes
The displayed symbol should be converted to a bitmap
no
The displayed symbol should not be converted to a bitmap
Default Value no

Child Elements

Transform
RGBAColorTransform
Filters

Parent Elements

Frame

Examples

Timeline Replace Examples
Animate simple symbols on timeline
Color Gradient Examples

Repository

Back to Top

This element defines the location of external resources such as fonts, images, sounds and video. A Movie element can have zero, one or more Repository elements.

Attributes

repositoryType Defines the type of repository. This indicates the type of resources that are contained within the repository.
Values
File
All resources are stored in a directory tree root at the location of the repositoryBase/repositoryName directory. Under this will be a directory for each resource type: fonts, images, sounds, video. The font directory contains further sub-directories for Bold, Italic and BoldItalic. Resource names specify the file stored in the relevant directory. This is the default repository type on decompilation.
AbsoluteFile
All resources are stored as files and the resource names are absolute file names.
URL
All resources are represented as absolute URLs.
Server
All resources are stored in a user-specified UserResourceManagerType. This type is only valid for the Server Edition
Default Value File
repositoryBase An optional identifier specific to the repository type that indicates the location of the resources within the repository. For the repository type of 'File' this attribute represents the base directory where the repository is stored. Not used for other repository types. If the repository base is not specified, the the value of the configuration property kinesis.repository.directory is used. If the repositoryBase attribute is specified but the value is empty, or represents a relative file path, the base path for the repository will be created by appending the specified value of the repositoryBase attribute onto the folder of the RVML document.
Type String
Default Value The value of the kinesis.repository.directory configuration value
repositoryName An identifier specific to the repository type that indicates the location of the resources for this movie relative to the specified base. For the repository type of 'File' this attribute represents the sub-directory under the base where resources are stored. Not used for other repository types.
Type String

Child Elements

SoundStreams
Sound
Image
Font
Video

Parent Elements

Movie

Examples

ADPCM Sound Example
Simple MP3 Sound Example
Button Sound Example
EditField Transformations
Raw MP3 Example
Font Manipulation Examples
HTML Support in EditFields
Font Range Examples
ActionScript on the Timeline
ImageFill Examples
ImageShape Example
Timeline Replace Examples
Text Segments Example
Sound Envelope Example
Clipping and Text Clipping Example
Simple MP3 Sound From URL Example
Video Example

RGBAColorTransform

Back to Top

This defines a set of transformation attributes than can be applied to the color and transparency of a symbol.

Attributes

multRed A multiplier to be applied to the red color component of the symbol used to alter the red color component by a fixed percentage. A value of 1 leaves the red component unchanged.
Type Float
From Value 0
To Value 256
Default Value 1
multGreen A multiplier to be applied to the green color component of the symbol used to alter the green color component by a fixed percentage. A value of 1 leaves the green component unchanged.
Type Float
From Value 0
To Value 256
Default Value 1
multBlue A multiplier to be applied to the blue color component of the symbol used to alter the blue color component by a fixed percentage. A value of 1 leaves the blue component unchanged.
Type Float
From Value 0
To Value 256
Default Value 1
multAlpha A multiplier to be applied to the alpha color component of the symbol used to alter the alpha color component by a fixed percentage. A value of 1 leaves the alpha component unchanged.
Type Float
From Value 0
To Value 256
Default Value 1
addRed A constant to be added to the red color component of the symbol used to increment or decrement the red color component by a fixed value. A value of 0 leaves the red component unchanged.
Type Integer
From Value -255
To Value 255
Default Value 0
addGreen A constant to be added to the green color component of the symbol used to increment or decrement the green color component by a fixed value. A value of 0 leaves the green component unchanged.
Type Integer
From Value -255
To Value 255
Default Value 0
addBlue A constant to be added to the blue color component of the symbol used to increment or decrement the blue color component by a fixed value. A value of 0 leaves the blue component unchanged.
Type Integer
From Value -255
To Value 255
Default Value 0
addAlpha A constant to be added to the alpha color component of the symbol used to increment or decrement the alpha color component by a fixed value. A value of 0 leaves the alpha component unchanged.
Type Integer
From Value -255
To Value 255
Default Value 0

Child Elements

None

Parent Elements

Alter
Layer
Place
Replace

Examples

Timeline Color Transformations
Button Example
Button DragTarget Example
Button Sound Example

Segment

Back to Top

This defines a single text segment inside a Textfield symbol. All text in a segment shares a common font, text size, and color. The first segment must define a font, font size and color. All subsequent segments can inherit those attributes from segments defined previously. The segment must contain at least one character specified in either the text attribute or in the binaryCodes attribute and the maximum muber of characters in a Segment is 255.

Attributes

fontID The name of the Font or FontDefinition symbol used to render the text.
Type String
fontSize The size of the font used to render the text.
Type Float
x Optional X position to place text. Continues from prior segment (0 if this is the first Segment element) if not specified.
Type Float
Default Value 0
y Optional Y position to place text. Continues from prior segment (0 if this is the first Segment element) if not specified.
Type Float
Default Value 0
text Actual text string to render.
Type String
binaryCodes Alternative representation or text string to render specifying a tuple of character codes used in the text. This can be used where no codes are applicable for the glyphs stored in the font and each glyph is referenced by index only. This can occasional occur for some pre-existing optimized SWF movies.
Value Template (Code,...)
From Value 1
To Value Unlimited provided codes are defined within the Font element.
color The color specified as an RGB/RGBA tuple, a hex string or a color name. The first number of the tuple represents the red intensity, the second green, and the third blue. A minimum value of 0 for each color results in black and a max value of 255 for each color results in white. For RGBA the first three attributes are the same as above and the fourth is the degree of opacity of the color with 0 being totally transparent and 255 totally opaque. Alternatively the color can be specified as in SVG either in hexadecimal with a '#' leading character or by name using the color names defined in the SVG specification. Since these do not specify opacity, an additional opacity attribute can be defined.
Value Template rgb(Color, Color, Color)
Value Template rgba(Color, Color, Color, Color)
From Value 0
To Value 255
Value Template #Color Color Color
From Value 00
To Value ff
Value Range Any SVG color name supported in the SVG1.1 specification.
opacity Optional attribute specifying the opacity of the color with 0 being totally transparent and 1.0 totally opaque. This will override any opacity channel value specified as part of the color attribute.
From Value 0.0
To Value 1.0
Default Value 1.0
advances Optional list of advances for each specified text character. Each advance is added to the current X position after rendering a character. This allows tight control over rendering. If a value of 'auto' is specified then the the system will calculate advances automatically using the specified font. Negative advances permits the text to flow from right-to-left.
Value Template (Advance,...)
Type Float

Child Elements

None

Parent Elements

Text

Examples

Text Segments Example
User-Defined Font Example
Clipping and Text Clipping Example
Timeline Replace Examples

SetStyle

Back to Top

Set the active styles for future vector drawing operations. Line styles, main fills and right fills can all be specified with an index to their respective style tables. Table entries begin at 1 and index 0 is used to specify an empty style. Styles remain active until set to another value or disabled with an index of zero.
Styles with a lower index have a lower display depth than those later in the table so those fills defined with an higher style index will obscure those with lower indices. All line styles will appear on top of all Fill styles defined in the same style table. In order to show a fill over a line, the fill must be defined in a later table or the shape redrawn so the overlapping boundary does not occur.

Attributes

line Optional index of line style in line style table to use for future drawing operations. An index of 0 means that no line style is applied.
Type Integer
Default Value 0
mainFill Optional attribute that sets the main fillstyle to the table entry specified by the index. All areas will be filled with the specified style until another drawing edge is encountered. An index of 0 means that no fill style is applied.
Type Integer
Default Value 0
rightFill Optional attribute that sets the right fillstyle to the table entry specified by the index. In general, this style should only be used when drawing operation separates two different fill regions. In this scenario, the main fill will specify the fill on the left on the line and the right fill will specify the fill to the right of the line.
Type Integer
Default Value 0

Child Elements

None

Parent Elements

Edges
ShapeTransform

Examples

Elliptical Arcs Example
Examples of Elliptical Arcs and Circular Arcs
Shape Fill Examples
Line Style Z-Ordering
Line Style and Scaling
Color Gradient Examples
Shape Origin Example
CArcs Example
ImageFill Examples
Shape Transform Examples
SVG Arc Example in RVML
Timeline Replace Examples
Circle Examples
Quadratic Curve Example
Dynamic MovieClip Clipping
Rectangle Example
Animate simple symbols on timeline
Color Specification Example
Timeline Color Transformations
Square to Circle Morph Example
Clipping and Text Clipping Example
Button Example
Button DragTarget Example
Button Sound Example
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Defines simple symbol for export
MorphShape Example
Polygon Example
Simple Polyline Example

Shape

Back to Top

This defines a vector shape element. A Shape element is the parent element for all style definitions and vector drawing operations. A FillStyles element defines all fill styles for the shape, a LineStyles element defines all the line styles for the shape. All vector drawing operations are defined under an Edges element.

Attributes

id A unique name for the symbol within the movie.
Type String
bounds The bounding rectangle of the shape specified as 'bounds( minX, minY, maxX, maxY)'. If the bounding rectangle is unknown, a value of 'auto' can be specified and the shape bounds will be calculated automatically. Incorrect specification of this may result in parts of the shape being occluded.
Value Template bounds(Coord, Coord, Coord, Coord)
Type Float
Default Value auto
translateX An optional delta to add to every every X coordinate in the shape, providing an X-Axis translation.
Type Float
Default Value 0
translateY An optional delta to add to every every Y coordinate in the shape, providing a Y-Axis translation.
Type Float
Default Value 0
origin An optional attribute specifying where the origin of the shape should be relative to its bounding rectangle. This is the location that is used when placing and performing geometry transformations. Shapes are always transformed about their point of origin. The translateX and translateY attributes are evaluated before the origin attribute.
Values topLeft
topRight
bottomLeft
bottomRight
center
Default Value top-left

Child Elements

Desc
Metadata
LineStyles
FillStyles
Edges

Parent Elements

Definitions

Examples

CArcs Example
Shape Fill Examples
Shape Origin Example
Circle Examples
Dynamic MovieClip Clipping
Animate simple symbols on timeline
Color Specification Example
Timeline Color Transformations
Quadratic Curve Example
Color Gradient Examples
ImageFill Examples
Line Style and Scaling
Timeline Replace Examples
Shape Transform Examples
Clipping and Text Clipping Example
Button Example
Button DragTarget Example
Button Sound Example
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Elliptical Arcs Example
Examples of Elliptical Arcs and Circular Arcs
SVG Arc Example in RVML
Defines simple symbol for export
Line Style Z-Ordering
Polygon Example
Simple Polyline Example
Rectangle Example

ShapeTransform

Back to Top

This defines a set of transformation attributes for position scale and rotation on all shape vector elements defined within this element. Any attributes not set will be set to their default value. Multiple ShapeTransforms can be nested. Transformations are applied after scaling and rotation. This is equivalent to changing the coordinate space in which the child elements are rendered.

Attributes

translateX X position for specified symbol. This x-axis displacement is added to all path components defined within.
Type Float
Default Value 0
translateY Y position for specified symbol. This y-axis displacement is added to all path components defined within.
Type Float
Default Value 0
scaleX Scale the symbol by the specified amount on the X-axis
Type Float
Default Value 1
scaleY Scale the symbol by the specified amount on the Y-axis
Type Float
Default Value 1
rotate Clockwise rotation in degrees about the current origin of the shape.
Type Float
Default Value 0

Child Elements

ShapeTransform
Move
Line
Curve
CArc
EArc
Circle
Rect
Path
Polyline
Polygon
SetStyle
LineStyles
FillStyles

Parent Elements

Edges
Glyph
ShapeTransform

Examples

Shape Transform Examples
CArcs Example
SVG Arc Example in RVML
Line Style Z-Ordering
MorphShape Example

Sound

Back to Top

This defines a single sound element that can be used within the movie. This may be played using a PlaceSound element, attached to buttons using the ButtonSound element of a button or accessed using ActionScript if exported as a symbol. Currently all sounds stored in SWF movies can be used or any CBR MP3 sound. All sounds must have a sample rate of 5.5KHz, 11KHz, 22KHz or 44KHz. MP3 sounds sounds are restricted to 11KHz, 22KHz or 44KHz. If the rendered pitch and duration of a sound is not as expected then check the sampling rate of the input sounds.

Attributes

id A unique name for the symbol within the movie.
Type String
format Optional informational attribute specifying the native format of the sound. Only 'Raw', 'MP3' and 'ADPCM' formats are supported below version 6.
Values MP3
ADPCM
Raw
RawPS
Nellymoser
Default Value MP3
resourceType The type of file used to store the sound. An SWF file format is an SWF file in which the sound is already pre-processed and stored as SWF. Most commonly, this be be as a result of a previous SWF decompilation. Only MP3 sounds can be read from external file formats. If other sound formats are required to be streamed then they should be either converted to MP3 or imported into a Flash movie using another authoring tool and exported to a .SWF resource file.
Values External
SWF
Default Value External
resourceLocation Identifier for this resource within the repository. For the default 'File' repository this indicated the file name within the sounds subdirectory.
Type String
Default Value No default
sourceStartTime Optional attribute specifying the position within the sound at which to start. Position is specified in Milliseconds into the specified sound.
Type Integer
Default Value 0
duration Optional attribute specifying the duration, in milliseconds, of the sound.
Type Integer
Default Value The duration of the timeline or the duration of the sound, whichever is less.
latency When sounds are converted to MP3 format by Flash, the decoder automatically creates all sounds with a predefined latency, representing the number of sound samples to be skipped. This latency cannot be retrieved by directly inspecting the MP3 produced as it is a property of the built-in transcoder. When the latency is not specified correctly, audible clicks or gaps may be heard when playing the sound. This attribute is not necessary for MP3 sounds created externally and should rarely need to be manually specified by a user.
Type Integer
Default Value 0
sampleCount When an MP3 sound extracted from an SWF has a defined latency, the number of sound samples present in the sound will differ from those implicitly defined by the MP3 format. When the latency attribute is non-zero, this attribute can be used to specify the actual number of defined samples in the sound. When the sampleCount is not specified correctly, audible clicks or gaps may be heard when playing the sound. This attribute is not necessary for MP3 sounds created externally and should rarely need to be manually specified by a user.
Type Integer
Default Value No Default

Child Elements

Desc
Metadata

Parent Elements

Repository

Examples

ADPCM Sound Example
Simple MP3 Sound Example
Button Sound Example
Raw MP3 Example
Sound Envelope Example
Simple MP3 Sound From URL Example

SoundEnvelope

Back to Top

This element defines the volume of the left and right channels of the sound at a particular point. The volume of the channel at points not specified by a SoundEnvelope are interpolated linearly using those specified. The volume of each channel at the beginning and end is automatically set to the maximum value unless explicitly set using a SoundEnvelope.

Attributes

mark The position within the sound at which these channel values apply. Position is specified in milliseconds.
Type Integer
leftVolume The volume of the sound in the left channel.
Type Integer
From Value 0
To Value 100>
Default Value 0
rightVolume The volume of the sound in the right channel.
Type Integer
From Value 0
To Value 100>
Default Value 0

Child Elements

None

Parent Elements

SoundInfo

Examples

Button Sound Example
Sound Envelope Example

SoundInfo

Back to Top

This element sets the properties of the sound to be played. Up to eight SoundEnvelope elements can also be specified to modify the sound envelope. Each SoundEnvelope modifies the volume of the left and right channels at a particular position in the sound and must be ordered by mark attribute.

Attributes

uniquePlay Optional attribute that, if yes, will not start the specified sound if the sound is already playing.
Values yes
no
Default Value no
stopPlaying Optional attribute that, if yes, will stop the specified sound if the sound is already playing in the current timeline. If the sound is not already playing then no action is taken.
Values yes
no
Default Value no
loopCount Optional attribute that specifies the number iterations to play the sound.
Type Integer
Default Value 1
startPoint Optional attribute specifying the position within the sound at which to start. Position is specified in Milliseconds into the specified sound.
Type Integer
Default Value 0
endPoint Optional attribute specifying the position within the sound at which to end. Position is specified in Milliseconds into the specified sound.
Type Integer

Child Elements

SoundEnvelope

Parent Elements

ButtonPressSound
ButtonReleaseSound
ButtonRollOutSound
ButtonRollOverSound
PlaceSound

Examples

Button Sound Example
ADPCM Sound Example
Simple MP3 Sound Example
Raw MP3 Example
Sound Envelope Example
Simple MP3 Sound From URL Example

SoundStream

Back to Top

This details the parameters of a sound to be output as streaming sound. On decompilation, where a Timeline has a sound stream separated by gaps, the application will split a sound stream into separate SoundStream elements. As this is a streaming-type element there must be sufficient frames in the destination timeline to contain the defined stream. If insufficient frames are defined then the stream will be truncated. SoundStream elements are particularly useful when a continual stream needs to be associated with a set of frames so that navigation to a particular frame will automatically play the sound associated with that frame.

Attributes

format Optional informational attribute specifying the native format of the sound. Only 'Raw', 'MP3' and 'ADPCM' formats are supported below version 6.
Values MP3
ADPCM
Raw
RawPS
Nellymoser
Default Value MP3
resourceType The type of file used to store the sound. An SWF file format is an SWF file in which the sound is already pre-processed and stored as SWF. Most commonly, this be be as a result of a previous SWF decompilation. Only MP3 sounds can be read from external file formats. If other sound formats are required to be streamed then they should be either converted to MP3 or imported into a Flash movie using another authoring tool and exported to a .SWF resource file.
Values External
SWF
Default Value External
resourceLocation Identifier for this resource within the repository. For the default 'File' repository this indicated the file name within the sounds subdirectory.
Type String
Default Value No default
movieClip Optional attribute specifying the symbol name of a movie clip in whcih the sound streams. If no movieClip attribute is specified the sound will be streamed in the main timeline.
Type String
movieStartTime Time within the Movie or MovieClip element, milliseconds, at which to start this sound.
Type Integer
Default Value 0
sourceStartTime Optional attribute specifying the position within the sound at which to start. Position is specified in Milliseconds into the specified sound.
Type Integer
Default Value 0
duration Optional attribute specifying the duration, in milliseconds, of the sound.
Type Integer
Default Value The duration of the timeline or the duration of the sound, whichever is less.

Child Elements

None

Parent Elements

SoundStreams

Examples

None

SoundStreams

Back to Top

This a container element for one or more SoundStream elements that specify sounds to be included as streaming sounds in the movie. The sound streams will play on the main timeline unless a MovieClip element is specified.

Attributes

None

Child Elements

SoundStream

Parent Elements

Repository

Examples

None

Stop

Back to Top

This defines a stop point in a gradient color ramp.

Attributes

offset Position of stop point for the specified color. Each offset is specified as a percentage along the ramp. Values are significant to the nearest 0.4%
Type Float
From Value 0
To Value 100
Default Value 0
color The color specified as an RGB/RGBA tuple, a hex string or a color name. The first number of the tuple represents the red intensity, the second green, and the third blue. A minimum value of 0 for each color results in black and a max value of 255 for each color results in white. For RGBA the first three attributes are the same as above and the fourth is the degree of opacity of the color with 0 being totally transparent and 255 totally opaque. Alternatively the color can be specified as in SVG either in hexadecimal with a '#' leading character or by name using the color names defined in the SVG specification. Since these do not specify opacity, an additional opacity attribute can be defined.
Value Template rgb(Color, Color, Color)
Value Template rgba(Color, Color, Color, Color)
From Value 0
To Value 255
Value Template #Color Color Color
From Value 00
To Value ff
Value Range Any SVG color name supported in the SVG1.1 specification.
opacity Optional attribute specifying the opacity of the color with 0 being totally transparent and 1.0 totally opaque. This will override any opacity channel value specified as part of the color attribute.
From Value 0.0
To Value 1.0
Default Value 1.0

Child Elements

None

Parent Elements

GradientBevel
GradientGlow
LinearGradient
RadialGradient

Examples

Color Gradient Examples
Clipping and Text Clipping Example
MorphShape Example

TabIndex

Back to Top

This specifies a tab index that should be assigned to an existing timeline symbol. Tab indices are used by screen readers and provide a means to signal that the current symbol has content that is renderable by such a reader.

Attributes

name The id of the symbol on the timeline.
Type String
depth This is the depth of the instance of the symbol.
Type Integer
From Value 1
To Value 65535
tabIndex Mandatory attribute specifying a tab index for the symbol.
Type Integer
From Value 0
To Value 65535

Child Elements

None

Parent Elements

Frame

Examples

None

Template

Back to Top

This text element specifies FreeMarker template code to be dynamically evaluated in-place at the current location. Templates can be used to create both RVML document fragments or text blocks and templates have full access to the entire data model defined for the document.

A Template element is permitted anywhere within an RVML document and can be specified either inline or as an external resource. The output of a template can be RVML (which can include recursive calls to the Template element) or text. When the isXML attribute is 'true' the output of the template is assumed to be XML and will be included in the RVML document at the location of the Template element. KineticFusion treats all XML templates as full XML documents and each is parsed separately. If it is necessary to create a sequence of RVML elements without a root element then the hasRoot attribute should be set to 'false' and KineticFusion will automatically wrap the XML with a 'root' root element - this will be automatically discarded on processing.

Data model variables can also be defined locally for a single Template element using the Variable child element. These consist of simple name-value pairs. If a value is set as a result of a Variable element, it is immediately restored to its previous value after the execution of the template.

Attributes

location Optional attribute containing the physical location of the template document. This can be specified as either a file name of a URL (the type attribute is used to determine the location type). When a file is specified, it is assumed to be relative to the template root folder configured from the kinesis.templates.templateRoot . If a URL is specified it must be an absolute URL.
Type String
type The type of location specified in the location attribute.
Type String
Values file
url
Default Value file
isXML Should the output of the template be interpreted as XML?
Type Boolean
Values
true
The text output of the template should be treated as an RVML document fragment. Use the hasRoot attribute to indicate whether the XML should be treated as a complete document or an XML fragment
false
The output of the templates is interpreted as inline text
Default Value true
hasRoot Does the XML fragment have a single root element? For XML output only.
Type Boolean
Values
true
The output is a well-formed XML document
false
The output is a collection of well-formed elements without a single document root. KineticFusion will automatically surround the text with a <root></root>
Default Value true
encoding The file encoding for an external template file.
Type String
Default Value The value specified by kinesis.templates.defaultEncoding
locale The locale to be used when evaluating locale-specific template operations
Type String
Default Value The value specified by kinesis.templates.defaultLocale

Child Elements

None

Parent Elements

None

Examples

None

Text

Back to Top

This defines a static text symbol that can be used within the movie. A text symbol is composed of one or more Segment elements each of which a single unit of text. A Transform element can also be defined for the composite text symbol. While EditField elements are more powerful for dynamic or system text, Text elements give very powerful control over kerning and text effects and is the only text symbol that can be used as a clipping symbol.

Attributes

id A unique name for the symbol within the movie.
Type String
bounds The bounding rectangle of the text symbol specified as 'bounds( minX, minY, maxX, maxY)'. If the bounding rectangle is unknown, a value of 'auto' can be specified and the text bounds will be calculated automatically. Incorrect specification of this may result in parts of the text being occluded.
Value Template bounds(Coord, Coord, Coord, Coord)
Type Float
antialias Flash 8 introduces a new antialias attribute that allows the use to specify the degree of antialiasing to be applied to a text element. Antialias values can be specified as 'reading', which is the default setting for maximum legibility, or as a pair of values indicating the thickness and sharpness of the antialiasing. When not specified, antialias behaviour defaults to that used in Flash player 7 and below. Thickness and sharpness, when specified should be in the following ranges:
Thickness: -200 -> +200
Sharpness: -400 -> + 400.
The default 'reading' setting is equivalent to setting both thickness and sharpness to 0.
Values reading
custom( thickness, sharpness)
Default Value Not specified

Child Elements

Desc
Metadata
Segment
Transform

Parent Elements

Definitions

Examples

Text Segments Example
Timeline Replace Examples
Clipping and Text Clipping Example
User-Defined Font Example

Timeline

Back to Top

A Timeline element is the container for frames containing instances of symbols. If a timeline contains more than one frame then the timeline displays successive frames at the rate defined for the movie unless otherwise instructed using ActionScript. The timeline will automatically return to the first frame after the last frame has been displayed.

Attributes

frameCount Optional informational attribute indicating the number of frames in timeline. Output when decompiling but not used on input.
Type Integer

Child Elements

Frame
EmptyFrame

Parent Elements

Movie
MovieClip

Examples

Dynamic MovieClip Clipping
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Defines simple symbol for export
Color Gradient Examples
ADPCM Sound Example
Simple MP3 Sound Example
ActionScriptSettings Example
Animate simple symbols on timeline
Button Example
Button DragTarget Example
Button Sound Example
CArcs Example
Circle Examples
Color Specification Example
Timeline Color Transformations
Quadratic Curve Example
Elliptical Arcs Example
Examples of Elliptical Arcs and Circular Arcs
SVG Arc Example in RVML
EditField Examples
EditField Transformations
Raw MP3 Example
Font Manipulation Examples
HTML Support in EditFields
Font Range Examples
ActionScript on the Timeline
ImageFill Examples
ImageShape Example
Import and Export a Symbol
Importing symbols at runtime
Line Style Z-Ordering
Line Style and Scaling
MorphShape Example
Polygon Example
Simple Polyline Example
Rectangle Example
Timeline Replace Examples
Text Segments Example
Shape Fill Examples
Shape Origin Example
Shape Transform Examples
Sound Envelope Example
Square to Circle Morph Example
Clipping and Text Clipping Example
Simple MP3 Sound From URL Example
User-Defined Font Example
Video Example

Title

Back to Top

Text element defines optional title metadata for the document. This text can be optionally stored when the document is translated to SWF.

Attributes

None

Child Elements

None

Parent Elements

Movie

Examples

ADPCM Sound Example
Simple MP3 Sound Example
ActionScriptSettings Example
Animate simple symbols on timeline
Button Example
Button DragTarget Example
Button Sound Example
CArcs Example
Circle Examples
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Color Specification Example
Timeline Color Transformations
Quadratic Curve Example
Elliptical Arcs Example
Examples of Elliptical Arcs and Circular Arcs
SVG Arc Example in RVML
EditField Examples
EditField Transformations
Defines simple symbol for export
Raw MP3 Example
Font Manipulation Examples
HTML Support in EditFields
Font Range Examples
ActionScript on the Timeline
Color Gradient Examples
ImageFill Examples
ImageShape Example
Import and Export a Symbol
Importing symbols at runtime
Line Style Z-Ordering
Line Style and Scaling
MorphShape Example
Dynamic MovieClip Clipping
Polygon Example
Simple Polyline Example
Rectangle Example
Timeline Replace Examples
Text Segments Example
Shape Fill Examples
Shape Origin Example
Shape Transform Examples
Sound Envelope Example
Square to Circle Morph Example
Clipping and Text Clipping Example
Simple MP3 Sound From URL Example
User-Defined Font Example
Video Example

ToShape

Back to Top

Specifies the definition of edge elements for the destination shape used in a MorphShape object. Only move and drawing elements are allowed here. The ToShape will implicitly inherit all style elements defined in the FromShape at the corresponding edge position. It is possible to use derived elements such as Rect, CArc and EArc elements provided the user can guarantee that the number of edges in the FromShape and ToShape are the same (e.g by using the same elements in both). These are included in the list of valid child elements however care should be taken with their use.

Attributes

None

Child Elements

Edges

Parent Elements

MorphShape

Examples

Timeline Replace Examples
Square to Circle Morph Example
MorphShape Example

Transform

Back to Top

This defines a set of transformation attributes for position scale and rotation. Any attributes not set will be reset to their default value. Any specified translation will only be applied after the rotation and scale transformations.

Attributes

translateX X position for specified symbol. Moves the origin of the symbol to the specified X coordinate.
Type Float
Default Value 0
translateY Y position for specified symbol. Moves the origin of the symbol to the specified Y coordinate.
Type Float
Default Value 0
scale Scale the symbol on both axes by the specified value. This will scale all aspects of the symbol including all distance of the shape from the origin.
Type Float
Default Value 1
scaleX Specifies the scale of the symbol on the X-axis. This will scale all aspects of the symbol including all distance of the shape from the origin. Ignored if the scale attribute is specified.
Type Float
Default Value 1
scaleY Specifies the scale of the symbol on the Y-axis. This will scale all aspects of the symbol including all distance of the shape from the origin. Ignored if the scale attribute is specified.
Type Float
Default Value 1
rotate Combined rotation and skew in degrees about the origin of the shape in both axes.
Type Float
Default Value 0
rotateX Clockwise rotation and skew in degrees about the origin of the shape in the X axis. Ignored if the rotate attribute is specified.
Type Float
Default Value 0
rotateY Clockwise rotation and skew in degrees about the origin of the shape in the Y axis. Ignored if the rotate attribute is specified.
Type Float
Default Value 0

Child Elements

None

Parent Elements

Alter
ImageFill
Layer
Place
Replace
Text

Examples

EditField Examples
Timeline Color Transformations
Animate simple symbols on timeline
Line Style and Scaling
Button Example
Button DragTarget Example
CArcs Example
Elliptical Arcs Example
EditField Transformations
Text Segments Example
Button Sound Example
Circle Examples
Font Manipulation Examples
ImageFill Examples
Shape Fill Examples
Color Specification Example
HTML Support in EditFields
Timeline Replace Examples
Clipping and Text Clipping Example
Defines simple symbol for export
Importing symbols at runtime
Example Of MovieClip classes
Example Of MovieClip classes and scripted animations
Quadratic Curve Example
Color Gradient Examples
Import and Export a Symbol
Square to Circle Morph Example
User-Defined Font Example
ADPCM Sound Example
Simple MP3 Sound Example
SVG Arc Example in RVML
Raw MP3 Example
Font Range Examples
ActionScript on the Timeline
Line Style Z-Ordering
MorphShape Example
Polygon Example
Simple Polyline Example
Shape Transform Examples

Variable

Back to Top

Defines a single global variable value. The value is only used if the value does not already exist in the global data source unless the override attribute is set to true

Attributes

name A mandatory attribute specifying the top-level name in the global data source for which the value should be applied
Type String
value The value of the variable
Type String
override Should this specified value always be used as the value of the specified variable?
Type Boolean
Values
true
The specified value will always be used for the specified variable when processing this document regardless of the existing value
false
The specified value is only used if no value currently exists for the specified variable
Default Value false

Child Elements

None

Parent Elements

None

Examples

None

Video

Back to Top

This defines a single video symbol that can be used within the movie. Can be placed within a frame and the framehead positioned using the ratio attribute of the place command.

Attributes

id A unique name for the symbol within the movie.
Type String
resourceType The type of file used to store the video. Only SWF files produced as a result of a previous decompilation can be used.
Values SWF
Default Value SWF
resourceLocation Identifier for this resource within the repository. For the default 'File' repository this indicated the file file within the sounds directory.
Default Value No default
numFrames Number of video frames stored in resource. Optional informational attribute overridden on SWF creation by value stored in resource.
Type Integer
width Width in pixels of the movie. Optional informational attribute overridden on SWF creation by value stored in resource.
Type Integer
height Height in pixels of the movie. Optional informational attribute overridden on SWF creation by value stored in resource.
Type Integer

Child Elements

Desc
Metadata

Parent Elements

Repository

Examples

Video Example

XMLDataSource

Back to Top

This loads all the data from the specified XML document into the data model. For more information please see here .

Attributes

name The top-level name in the internal data model to which the root element of the XML document is mapped. This name must be specified.
Type String
location A mandatory attribute containing the physical location of the XML document. This can be specified as either a file name of a URL (the type attribute is used to determine the location type). When a relative filepath is specified, it is assumed to be relative to the document root of the RVML document - in general this is the folder in which the RVML document is located.
Type String
type The type of location specified in the location attribute.
Type String
Values file
url
Default Value file
resoveNamespaces Should the internal model store the namespace information for the XML document? There is generally no need to resolve namespaces since all elements should be uniquely identifiable.
Type Boolean
Values
true
The XML nodes in the data model must be referenced by their qualified node names. This needs to be defined in FreeMarker using the <#ftl ns_prefixes={ Put mapping here}>.
false
The XML nodes in the data model are only referenced by their local names
Default Value false
validate Should the input XML document be validated by the KineticFusion XML parser?
Type Boolean
Values
true
The document is validated before adding it to the model. It is the responsibility of the XML document author to ensure sufficient information is available to validate the document.
false
The document is not validated before adding it to the model.
Default Value false

Child Elements

None

Parent Elements

DataSources

Examples

None