Appendix E: Preference File Syntax

This appendix describes the properties of the RealProducer preferences file, which affect the operation of both the graphical application and the command-line application. You can edit this file manually if you need to change the preferences settings.

Note: If you are not familiar with XML syntax, refer to Appendix A for information about XML namespaces, tags, attributes, and values.

Editing RealProducer Preferences

RealProducer records application preferences in the file producer.pref, located in the main installation directory. This XML-formatted text file specifies values such as the path to audience and server files. It also sets the location of the temporary directory used when encoding clips. You can change most preference properties using the graphical application, as described in "Adjusting RealProducer Preferences". If you are using the command-line application, edit the preferences using any text or XML editor.

Note: This appendix does not describe how to change the applicationState properties, which record the graphical application's display state. Under normal circumstances, you should not need to edit these properties.

File Path Preferences

The <paths/> tag contains three properties that set the paths to files used by RealProducer.

Path Preferences
Property	Value	Function
`audiences`	path	Provides the full path to the directory that stores audience files, which are described in Appendix C. Relative paths are not allowed. The default is the `audiences` directory under the main installation directory.
`servers`	path	Specifies the full path to the directory that stores server files, which are described in Appendix D. Relative paths are not allowed. The default is the `servers` directory under the main installation directory.
`tempDir`	path`\|%TEMP%\| %OUTPUTDIR%`	Indicates the directory used to store temporary files during encoding. See "Temporary Directory".

Temporary Directory

For tempDir, you can enter the full path name of the directory to use as the temporary directory. Or, you can use one of the following variables:

If you use %TEMP% as the value, RealProducer uses the same directory specified by the Windows TEMP or Linux TEMPDIR variable. If the Linux TEMPDIR variable is not set, RealProducer uses the /tmp directory.

Use a value of %OUTPUTDIR% to set the temporary directory for each job to the same directory used to store the job's output clip.

Tip: RealProducer operates faster if the temporary directory resides on the local RealProducer machine, rather than a network drive.

Note: After you restart the RealProducer graphical application, the graphical preferences dialog lists the full path to the directory specified by the %TEMP% or %OUTPUTDIR% variable.

File Path Example

The following example illustrates the <paths/> tag:

<paths audiences="C:\Program Files\Real\RealProducer Plus 10\audiences\"
    servers="C:\Program Files\Real\RealProducer Plus 10\servers\"
    tempDir="%TEMP%"/>

Log File Preferences

The <fileLogging/> tag uses the properties described in the following table to set the RealProducer logging preferences.

Log File Preferences
Property	Value	Function
`category`	`error\|warning\| info\|diagnostic`	Sets the logging category. Choose any combination of categories, separating them with commas. For more information on categories, refer to "Logging Category (-lc)".
`disable`	`true\|false`	Turns off logging when set to `true`. The default is `false`.
`enableRolling`	`true\|false`	Enables the creation of multiple log files (log rolling) when set to `true`. The default is `false`.
`filename`	file name	Sets the log file name. You can use a full path or a path relative to the installation directory.
`filterFunctionalArea`	`true\|false`	Filters the log according to functional area when set to `true`. The default is `false`, which captures all logging areas.
`format`	`detailed\|short`	Determines the log format. You can choose `short` to log only the job name and message. The default `detailed` format logs more information, such as the message category, functional area, time, and message number.
`formatSeparator`	character	Defines the character used to separate entries on a line within the log. The default is `\t` for a tab.
`functionalArea`	`all\|list`	Defines which functional areas are logged. The default value `all` logs all areas. Otherwise, enter a comma-separated list of specific areas.
`previousFilename`	file name	Indicates the file name of the last log created if log rolling is used. The file extension includes a numeric designation to indicate the order of the logs. For example, for a log named `producer.log`, the first rolled file is named `producer.log1`, the second is `producer.log2`, and so on.
`rollTimeIntervalType`	`hourly\|daily\| weekly\|monthly`	Determines how frequently the log file is rolled if time-based rolling is turned on. The default is `monthly`.
`rollType`	`size\|time`	Determines if log files are rolled according to size or preset time if log rolling is enabled. The default is `time`.
`sizeRollSize`	`1-99999`	Sets the size of the log file in Megabytes when log files are rolled according to size. Use any integer up to `99999`.

Log File Example

The following example illustrates the <fileLogging/> tag:

<fileLogging format="detailed"
    formatSeparator="\t"
    disable="false"
    filename="producer.log"
    previousFilename="C:\Program Files\Real\RealProducer Plus 10\producer.log"
    enableRolling="false"
    rollType="time"
    sizeRollSize="5"
    rollTimeIntervalType="monthly"
    filterFunctionalArea="false"
    functionalArea="all"
    category="error,warning,informational"/>

Log Viewing Properties

The log viewer is available through the graphical application, as described in "Viewing Log Messages". The <screenLogging/> tag uses the properties described in the following table to set the log viewer preferences.

Log Viewing Preferences
Property	Value	Function
`disable`	`true\|false`	Turns off log viewing when set to `true`. The default is `false`.
`filterFunctionalArea`	`true\|false`	Filters log viewing according to functional area when set to `true`. The default is `false`, which displays all logging areas.
`functionalArea`	`all\|list`	Defines which functional areas are displayed. The default value `all` displays all areas. You can also create a comma-separated list of specific areas.
`category`	`error\|warning\| info\|diagnostic`	Sets the logging category. Choose any combination of categories, separating them with commas. For more information on categories, refer to "Logging Category (-lc)".

Log File Example

The following example illustrates the <screenLogging/> tag:

<screenLogging disable="false"
    filterFunctionalArea="false"
    functionalArea="all"
    category="error,warning,info"/>

©2004 RealNetworks, Inc.
For more information, visit RealNetworks
Click here if the Table of Contents frame is not visible at the left side of your screen.