Appendix C: SMIL Tag Summary

This appendix summarizes the SMIL 2.0 tags and attributes described in this introductory guide. Be sure to familiarize yourself with "Conventions Used in this Guide", which explains the typographical conventions used in this appendix. For a comprehensive list of SMIL 2.0 tags and attributes, see the SMIL tag summary in RealNetworks Production Guide.

<smil>...</smil>

The <smil> and </smil> tags must start and end the SMIL markup. The SMIL 2.0 namespace declaration is required. You must declare the RealNetworks extension namespace if your SMIL file includes a customized attribute that uses the rn: prefix.

<smil> Tag Namespaces
Namespace	Features Defined	Reference
`xmlns="http://www.w3.org/2001/SMIL20/Language"`	SMIL 2 Language Profile	click here
`xmlns:rn="http://features.real.com/2001/SMIL20/Extensions"`	RealNetworks extensions	click here

Example

<smil xmlns="http://www.w3.org/2001/SMIL20/Language" 
xmlns:rn="http://features.real.com/2001/SMIL20/Extensions">
  ...all additional SMIL 2.0 markup...
</smil>

Header Tags

The SMIL file header, created between <head> and </head> tags, contains tags that let you define the presentation's layout and information. For instructions on defining the SMIL file header, see "SMIL File Basics".

<meta/>

The header region's <meta/> tags provide presentation information. The content and name attributes are required for each <meta/> tag. For basic information about the <meta/> tag, see "Presentation Information".

<meta/> Attributes
Attribute	Value	Function	Reference
`content`	`text`	Provides the content for the `name` attribute.	click here
`name`	`author`	Lists the presentation author's name.	click here
	`copyright`	Supplies the presentation copyright.	click here
	`title`	Gives the presentation title.	click here

Examples

<meta name="author" content="Jane Morales"/>
<meta name="title" content="Multimedia My Way"/>
<meta name="copyright" content="(c)2001 Jane Morales"/>

<layout>...</layout>

The <layout> and </layout> tags within the SMIL header contain other tags that define the layout of visual clips. Within the layout section, you define a root-layout area and separate regions for clips.

<root-layout/>

Within the layout section, a single <root-layout/> tag sets the overall size of the media playback pane. Clips play in regions created within the root-layout area. They do not play in the root- layout area directly. The height and width attributes are required for the <root-layout/> tag. For basic information about <root-layout/>, see "Setting the Media Pane Size".

<root-layout/> Attributes
Attribute	Value	Default	Function	Reference
`backgroundColor`	`color_value`	`black`	Sets the window background color.	click here
`rn:contextWindow`	`auto\|openAtStart`	`auto`	Opens the related info pane.	click here
`height`	`pixels`	`0`	Sets the main window height.	click here
`width`	`pixels`	`0`	Sets the main window width.	click here

Example

<layout>
  <root-layout backgroundColor="maroon" width="320" height="240"/>
  <region ...playback region defined.../>
  <region ...playback region defined.../>
</layout>

<region/>

Following <root-layout/>, <region/> tags define the size, placement, and properties of each region used to play clips. A unique id attribute is required for each <region/> tag. For basic information about the <region/> tag, see "Creating Playback Regions".

<region/> Attributes
Attribute	Value	Default	Function	Reference
`backgroundColor`	`inherit\|transparent\|color_value`	`transparent`	Sets the region background color.	click here
`bottom`	`auto\|pixels`\| `percentage`	`auto`	Sets the region's offset from the bottom of the pane.	click here
`fit`	`fill`\|`hidden`\|`meet`\| `scroll`\|`slice`	`hidden`	Controls how clips fit the region.	click here
`height`	`auto\|pixels`\| `percentage`	`auto`	Sets the region's height.	click here
`id`	`name`	(none)	Creates an ID for assigning clips.	click here
`left`	`auto\|pixels`\| `percentage`	`auto`	Sets the region's offset from the pane's left side.	click here
`right`	`auto\|pixels`\| `percentage`	`auto`	Sets the region's offset from the pane's right side.	click here
`showBackground`	`always\|whenActive`	`always`	Determines when the background color appears.	click here
`top`	`auto\|pixels`\| `percentage`	`auto`	Sets the region's offset from the top of the pane.	click here
`width`	`auto\|pixels`\| `percentage`	`auto`	Defines the region width.	click here

Example

<layout>
  <root-layout .../>
  <region id="video_region" top="5" left="5" width="240" height="180" backgroundColor="blue" showBackground="whenActive"/>
</layout>

Clip Source Tags

You add clips to a presentation with one of the following source tags:


`<audio/>`	audio clip such as RealAudio
`<img/>`	image file in GIF, JPEG, or PNG format
`<ref/>`	any type of clip not covered by the other tags
`<video/>`	video clip such as RealVideo

The choice of tag does not affect playback. All clip source tags can use <ref/>, for example. The src attribute is required for all clip source tags. For basic information, see "Clip Source Tags".

Clip Tag Attributes
Attribute	Value	Default	Function	Reference
`author`	`text`	(none)	Lists the clip's author.	click here
`begin`	`time_value`	`0s`	Delays normal playback time.	click here
`bitrate`	`bits_per_second`	`12288`	Sets an image's streaming speed in a `<param/>` tag.	click here
`clipBegin`	`time_value`	`0s`	Specifies the clip's internal timing mark where playback begins.	click here
`clipEnd`	`time_value`	(none)	Specifies the clip's internal timing mark where playback ends.	click here
`copyright`	`text`	(none)	Lists the copyright for the clip.	click here
`dur`	`time_value`	(none)	Sets the total time the clip plays.	click here
`fill`	`auto\|freeze\|remove`	`auto`	Sets the fill state when the clip ends.	click here
`id`	`name`	(none)	Provides the clip ID.	click here
`regAlign`	`topLeft\|topMid\| topRight\|midLeft\| center\|midRight\| bottomLeft\|bottomMid\| bottomRight`	`topLeft`	Specifies which part of the clip aligns to the registration point.	click here
`region`	`region_ID`	(none)	Assigns the clip to a region.	click here
`regPoint`	`topLeft\|topMid\| topRight\|midLeft\| center\|midRight\| bottomLeft\|bottomMid\| bottomRight`	(none)	Specifies a point on the region.	click here
`src`	`URL`	(none)	Provides a full or relative URL.	click here
`title`	`text`	(none)	Provides a title for the clip.	click here

Examples

<video id="video1" src="rtsp://helixserver.example.com/media/video2.rm" region="video_region"
  begin="40s" clipBegin="5100ms"clipEnd="4.5min" fill="freeze"/>

<img id="image1" src="http://www.example.com/poster.jpg" region="image_region" dur="15s">
  <param name="bitrate" value="5000"/>
</img>

<seq>...</seq>

The <seq> and </seq> tags play the enclosed clips in sequence. No attributes are required for a <seq> tag, which is described in "Playing Clips in Sequence".

<seq> Attributes
Attribute	Value	Default	Function	Reference
`begin`	`time_value`	`0s`	Delays the normal group playback.	click here
`dur`	`time_value`	(none)	Sets the total time the group plays.	click here
`id`	`name`	(none)	Provides a group ID.	click here

Example

<seq begin="30s">
  <audio src="rtsp://helixserver.example.com/one.rm"/>
  <audio src="rtsp://helixserver.example.com/two.rm"/>
</seq>

<par>...</par>

The <par> and </par> tags make enclosed clips play at the same time. No attributes are required for a <par> tag, which is described in "Playing Clips in Parallel".

<par> Attributes
Attribute	Value	Default	Function	Reference
`author`	`text`	(none)	Lists an author for the group.	click here
`begin`	`time_value`	`0s`	Delays the normal playback time.	click here
`copyright`	`text`	(none)	Lists the copyright for the group.	click here
`dur`	`time_value`	(none)	Sets the total time the group plays.	click here
`endsync`	`first\|ID\|last`	`last`	Determines when the group ends.	click here
`id`	`name`	(none)	Provides a group ID.	click here
`title`	`text`	(none)	Lists a title for the group.	click here

Examples

<par title="Song of the Day">
  <video src="rtsp://helixserver.example.com/newsong.rm"/>
  <ref src="rtsp://helixserver.example.com/newsong.rt"/>
</par>

<par endsync="vid1">
  <video id="vid1" src="rtsp://helixserver.example.com/video1.rm" region="video_region"/>
  <ref src="rtsp://helixserver.example.com/moreinfo.rt" region="text_region"/>
</par>

<area/>

An <area/> tag can define a link to an HTML page that opens automatically, or when the viewer clicks a clip. It fits within a clip source tag pair:

<video ...>
  <area .../>
</video>

The following table lists possible <area/> tag attributes. No attributes are required for this tag, but href is typically included. For basic information about the <area/> tag, see "Opening HTML Pages with SMIL".

<area/> Attributes
Attribute	Value	Default	Function	Reference
`actuate`	`onLoad\|onRequest`	`onRequest`	Determines whether or not the link requires user activation.	click here
`alt`	`text`	(none)	Supplies alternate text for the link.	click here
`begin`	`time_value`	`0s`	Sets when the link becomes active.	click here
`dur`	`time_value`	(none)	Sets the total time the link is active.	click here
`external`	`true\|false`	`false`	Sends the link to the browser if `true`.	click here
`height`	`pixels`	media height	Sets related info pane size in `<param>`.	click here
`href`	`URL`	(none)	Gives the link URL.	click here
`id`	`name`	(none)	Defines the tag ID.	click here
`rn:sendTo`	`_osdefaultbrowser\| _rpbrowser\| _rpcontextwin`	(none)	Specifies a browser window that opens the HTML page.	click here
`sourcePlaystate`	`pause\|play\|stop`	`pause`	Sets the clip state as the link opens.	click here
`width`	`pixels`	`330`	Sets related info pane size in `<param>`.	click here

Example

<video src="rtsp://helixserver.example.com/video.rm" region="video_region">
  <area href="http://www.example.com/context.html" external="true" rn:sendTo="_rpcontextwin"
    sourcePlaystate="play">
      <rn:param name="width" value="320"/>
      <rn:param name="height" value="240"/>
  </area>
</video>