Media component parameters

The following tables list MediaDisplay, MediaController, and MediaPlayback authoring parameters that you can set for a given media component instance in the Property inspector.

MediaDisplay parameters

Name

Type

Default value

Description

Automatically Play (Media.autoPlay)

Boolean

Selected

Determines if the media plays as soon as it has loaded.

Use Preferred Media Size (Media.autoSize)

Boolean

Selected

Determines whether the media associated with the MediaDisplay instance conforms to the component size or simply uses its default size.

FPS

Integer

30

Indicates the number of frames per second. When the Milliseconds option is selected, this control is disabled.

Cue Points

(Media.cuePoints)

Array

Undefined

An array of cue point objects, each with a name and position in time in a valid HH:MM:SS:FF (Milliseconds option selected) or HH:MM:SS:mmm format.

FLV or MP3 (Media.mediaType)

FLV or MP3

FLV

Designates the type of media to be played.

Milliseconds

Boolean

Unselected

Determines whether the playbar uses frames or milliseconds, and whether the cue points use seconds or frames. When this option is selected, the FPS control is not visible.

URL (Media.contentPath)

String

Undefined

A string that holds the path and filename of the media to be played.

Video Length (Media.totalTime)

Integer

Undefined

The total time needed to play the FLV media. This setting is required in order for the playbar to work correctly. This control is only visible when the media type is set to FLV.

MediaController parameters

Name

Type

Default value

Description

activePlayControl (Media.activePlayControl)

String: pause or play

pause

Determines whether the playbar is in play or pause mode upon instantiation. This mode determines the image displayed on the Play/Pause button, which is the opposite of the playing/paused state that the controller is actually in.

backgroundStyle (Media.backgroundStyle)

String: default or none

default

Determines whether the chrome background is drawn for the MediaController instance.

controllerPolicy (Media.controllerPolicy)

String: auto, on, or off

auto

Determines whether the controller opens or closes according to mouse position, or is locked in the open or closed state.

horizontal (Media.horizontal)

Boolean

true

Determines whether the controller portion of the instance is vertically or horizontally oriented. A true value indicates that the component has a horizontal orientation.

enabled

Boolean

true

Determines whether this control can be modified by the user. A true value indicates that the control can be modified.

visible

Boolean

true

Determines whether this control is viewable by the user. A true value indicates that the control is viewable.

MediaPlayback parameters

Name

Type

Default value

Description

Control Placement (Media.controlPlacement)

String: top, bottom, left, right

bottom

Position of the controller. The value is related to orientation.

Control Visibility (Media.controllerPolicy)

Boolean

true

Determines whether the controller opens or closes according to mouse position.

Automatically Play (Media.autoPlay)

Boolean

true

Determines whether the media plays as soon as it loads.

Use Preferred Media Size (Media.autoSize)

Boolean

true

Determines whether the MediaController instance sizes to fit the media or uses other settings.

FPS

Integer

30

Number of frames per second. When the Milliseconds option is selected, this control is disabled.

Cue Points

(Media.cuePoints)

Array

undefined

An array of cue point objects, each with a name and position in time in a valid HH:MM:SS:mmm (Milliseconds option selected) or HH:MM:SS:FF format.

FLV or MP3 (Media.mediaType)

String: FLV or MP3

FLV

Designates the type of media to be played.

Milliseconds

Boolean

false

Determines whether the playbar uses frames or milliseconds, and whether the cue points use seconds or frames. When this option is selected, the FPS control is disabled.

URL (Media.contentPath)

String

undefined

A string that holds the path and filename of the media to be played.

Video Length (Media.totalTime)

Integer

undefined

The total time needed to play the FLV media. This setting is required for the playbar to work correctly.


Flash CS3