DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

SWFOBJECTΒΆ

This object will insert a Flash player driven by JavaScript.

Property

file

Data type

string /stdWrap

Description

Media file or URL.

Note: Files are treated as URLs. You need to set fully qualified URLs. Use config.baseURL and/or config.absRefPrefix to get fully qualified URLs automatically.

Property

width

Data type

integer /stdWrap

Description

Width of the swfObject.

If it is not set, it will be filled with defaultWidth of the player configuration.

Property

height

Data type

integer /stdWrap

Description

Height of the swfObject.

If it is not set, it will be filled with defaultHeight of the player configuration.

Property

type

Data type

string /stdWrap

Description

Sets default for different media types. E.g. "audio" or "video". If value is "audio", the player configuration audio.player will be used.

Property

[type].player

Data type

string /stdWrap

Description

Location of the player.

Property

[type].player.default

Data type

array

Description

Default parameter for flashvars / params / attributes.

Usage:

default {

flashvars.allowFullScreen = true

params.wmode = transparent

attributes.align = center

}

flashvars are used for swf file configuration. There is no standard across players, but for flvplayer see description below.

For detailed description of possible params/attributes visit this URL:

http://livedocs.adobe.com/flash/9.0/UsingFlash/help.html?content=WSd6 0f23110762d6b883b18f10cb1fe1af6-7ba7.html

Property

[type].player.defaultWidth

Data type

integer

Description

Default media width.

Property

[type].player.defaultHeight

Data type

integer

Description

Default media height.

Property

[type].player.mapping

Data type

(array of keys)

Description

The audio player does not work with file, but instead expects the file with the flashvar soundFile. mapping does the rename of parameter for you by default.

Example:

mapping {
  flashvars.file = soundFile
}

Property

installUrl

Data type

string /stdWrap

Description

Specifies the URL of your express install SWF.

Default

typo3/contrib/flashmedia/swfobject/expressInstall.swf

Property

forcePlayer

Data type

string /stdWrap

Description

If the file is a URL and forcePlayer is not set, the URL will be called directly instead of using a player.

Property

flashvars

Data type

array

Description

Flash vars.

Property

params

Data type

array

Description

Flash params.

Property

attributes

Data type

array

Description

Flash attributes.

Property

flashVersion

Data type

string /stdWrap

Description

Required flash version.

Default

9

Property

alternativeContent

Data type

->stdWrap

Description

Alternative content.

Default

alternativeContent.field = bodytext

Property

layout

Data type

->stdWrap

Description

HTML Template for the Object. ###SWFOBJECT### is replaced with the sfwobject, ###ID### is replaced with the unique Id of the div/object.

Default

###SWFOBJECT###

Property

stdWrap

Data type

->stdWrap

[tsref:(cObject).SWFOBJECT]