<type> Configuration Element
Prev Chapter 18. XML Configuration API Next

<type> Configuration Element

This element defines the properties of an multimedia (object) type which is to be used with Ephox EditLive! for XML. Some of the attributes of this element map to the attributes of the <OBJECT> element which is inserted into EditLive! for XML when a multimedia type is inserted.

Attributes which map directly to the <OBJECT> element are as follows:

Configuration Element Tree Structure

<editLive>
  ...
  <mediaSettings>
    ...
    <multimedia>
      ...
      <types>
        ...
        <type>
          <!--type configuration settings-->
        </type>
        ...
      </types>
    </multimedia>
  </mediaSettings>
  ...
</editLive>

Required Attributes

name

A unique name for the multimedia type. This value is displayed to the user as a option in the mutlimedia object dialog in the list of available types.

Optional Attributes

allowCustomParams

This boolean attribute specifies if users can provide custom defined parameters in addition to those configured via the <param> elements in the configuration file. When set to true users can specify custom parameters.

Default Value: true

Possible values:

This attribute is a boolean with possible values of true or false.

extension

The file extension to associate with this object type.

urlParam

This attribute specifies the name of the parameter which is to be used to specify the location (URL) for the object's source files.

classid

The meaning of this attribute is browser dependant. Please see information from the provider of your browser(s).

codebase

The meaning of this attribute is browser dependant. Please see information from the provider of your browser(s). In some browsers this attribute is used to specify the download location for the plug-in or program used to render the object.

type

The meaning of this attribute is browser dependant. Please see information from the provider of your browser(s). In some browsers this attribute is used to specify the MIME type for the object.

Child Elements

<param>

This element enables <param> tags associated with the <object> tag to be inserted into the code in EditLive! for XML.

Example

The following example demonstrates how to configure a multimedia type for use with EditLive! for XML. In this case the media type is a Windows Media Player streaming type with the .asx extension.

<editLive>
  ...
  <mediaSettings>
    ...
    <multimedia>
      <types>
        ...
        <type 
          name="Windows Media (Streaming)"
          type="application/x-mplayer2"
          extension="asx"
          allowCustomParams="true"
          urlParam="fileName"
        >
          <param name="animationAtStart" />
          <param name="autoStart" />
          <param name="clickToPlay" />
        </type>
        ...
      </types>
    </multimedia>
  </mediaSettings>
  ...
</editLive>

Remarks

The <type> element can appear multiple times within the <types> element.


Copyright 2001-2004 Ephox Corporation. All Rights Reserved.

Prev Up Next
<types> Configuration Element Home <param> Configuration Element