Appendix D: Ram File Summary

This appendix summarizes Ram file parameters, which are described in Chapter 3. Be sure to familiarize yourself with "Conventions Used in this Guide", which explains the typographical conventions used in this appendix.

Parameter Syntax

A Ram file is plain text file that uses the file extension .ram. Each line holds the full URL to a clip or SMIL presentation, and can include parameters that affect playback. Separate the first parameter from the URL with a question mark (?), as shown here:

rtsp://helixserver.example.com/video1.rm?parameter=value

To set two or more parameters for the same clip, precede the second and all subsequent parameters with ampersands (&) instead of question marks:

rtsp://helixserver.example.com/video1.rm?parameter=value&parameter=value&parameter=value...

Parameters and Values

Ram File Parameters and Values
Parameter	Value	Default	Function	Reference
`author`	`text`	(none)	Indicates the clip author.	click here
`clipinfo`	`title=text\| artist name=text\| album name=text\| genre=text\| copyright=text\| year=text\| cdnum=number\| comments=text`	(none)	Gives extended clip information.	click here
`copyright`	`text`	(none)	Gives the copyright notice	click here
`end`	`hh:mm:ss.x`	(none)	Ends the clip at the specified point.	click here
`mode`	`normal\|theater\| toolbar`	`normal`	Opens RealPlayer in one of three initial playback modes.	click here
`rpcontextheight`	`pixels`	media height	Sets the related info pane's height.	click here
`rpcontextparams`	`parameters`	(none)	Adds parameters to `rpcontexturl`.	click here
`rpcontexttime`	`dd:hh:mm:ss.x`	`0`	Specifies a time at which an HTML page displays in the related info pane.	click here
`rpcontexturl`	`URL\|_keep`	(none)	Displays the specified URL in the related info pane.	click here
`rpcontextwidth`	`pixels`	`330`	Sets the related info pane width.	click here
`rpurl`	`URL`	(none)	Gives a URL for the media browser.	click here
`rpurlparams`	`parameters`	(none)	Appends parameters to `rpurl`.	click here
`rpurltarget`	`_rpbrowser\|name`	`_rpbrowser`	Sets the target for `rpurl` as the media browser pane or a secondary window.	click here
`rpvideofillcolor`	`color_value`	`black`	Sets the media playback pane color.	click here
`screensize`	`double\|full\| original`	`original`	Sets the size at which the clip or presentation opens.	click here
`showvideocontrolsoverlay`	`0\|1`	`1`	Hides the video controls overlay in the media playback pane when `0`.	click here
`start`	`hh:mm:ss.x`	`0`	Starts the clip at the specified point.	click here
`title`	`text`	(none)	Specifies the clip title.	click here

Examples

rtsp://helixserver.example.com/video1.rm?rpcontextheight=250
&rpcontextwidth=280&rpcontexturl="http://www.example.com/relatedinfo1.html"

rtsp://helixserver.example.com/video2.rm?rpurl="http://www.example.com/index.html"

rtsp://helixserver.example.com/sample1.smil?screensize=full

rtsp://helixserver.example.com/audio1.rm?start=55&end=1:25

rtsp://helixserver.example.com/introvid.rm?title="Introduction to Streaming Media 
Production"&author="RealNetworks, Inc."&copyright="&#169;2001, RealNetworks, Inc."

rtsp://helixserver.example.com/song1.rm?clipinfo="title=Artist of the Year|artist name=Your Name 
Here|album name=My Debut|genre=Rock|copyright=2001|year=2001|comments=This one really 
knows how to rock!"