Application.xml file

The Application.xml file contains the settings for Flash Media Server applications. These settings include the size of the Server-Side Media ActionScript runtime engine, the location at which streams and shared objects are stored, and bandwidth limitations.

The Application.xml file in the virtual host directory configures the default settings for all applications within the virtual host. If you want to have different settings for a particular application, copy an Application.xml file to the application's registered application directory (/applications/app_name) and edit it to include the settings you want.

In most cases, the settings in the Application.xml file in the application directory override settings in the Application.xml file in the virtual host directory, but not always. You can add an override attribute to certain elements in a virtual host's Application.xml file, as in the following:

<LoadOnStartup override="no">false</LoadOnStartup>

The server uses the following rules when applying the override attribute:

When the override attribute is included in an element and set to no, application-specific Application.xml files cannot override that element's setting.
If an element has the override attribute set to no, then all subelements also cannot be overridden.
If an Application.xml file is located in the application directory and specifies a different value than the default for an element that is not overridable, it is ignored, and the default is used.
If the default Application.xml file is missing or invalid, the server will not start.
If the user-specified Application.xml configuration file is invalid, it is ignored.
All subelements under the LoadOnStartup element cannot be overridden.
If you omit the override attribute, the LoadOnStartup element can be overridden.
To change an element so it cannot be overridden, set the override tag to no in the uppermost tag that you wish to make non-overridable.

Note: By default, the Bandwidth and BandwidthCap container elements include an override parameter set to yes, which allows the values for the ClientToServer and ServerToClient elements nested in these sections to be overridden. The Client element in this XML file includes an override="no" attribute by default.

To see the element structure and default values in Application.xml, see the Application.xml file installed with Flash Media Server in the RootInstall/conf/_defaultRoot_/_defaultVhost_ directory.

Summary of elements

Application.xml element	Description
`Access`	Container element; contains element that controls the permission levels in the Module (the libconnect.dll file).
`AccumulatedIFrames`	Container element; contains elements that configure intermediate frames in a live stream.
`AggregateMessages (Client)`	Specifies whether or not to send aggregate messages to clients.
`AggregateMessages (Queue)`	Container element; contains elements that control the size of the aggregate messages. This element also specifies, when queuing is enabled, if messages in the queue can be combined to form aggregate messages.
`Allow`	Allows or disallows the `"following and Location:"` header added with HTTP redirection.
`AllowDebugDefault`	Specifies the default value for allowing debug connections per application.
`AllowHTTPTunnel`	Configures Flash Media Server to allow tunneling connections into this application.
`Application`	Root element; this element contains all elements in Application.xml.
`Audio`	Container element; contains elements to configure the audio stream settings.
`AudioSampleAccess`	Enables access to the raw uncompressed audio data in a stream.
`AutoCommit`	Enables or disables the Shared Object Manager to automatically commit shared objects.
`Bandwidth`	Container element; contains elements to configure the bandwidth settings for server-client communications.
`BandwidthCap`	Container element; contains elements that specify the maximum bandwidth values that a user can set.
`BandwidthDetection`	Container element; contains elements that specify how data is sent to the client.
`Bits`	Contains the settings for different versions of Flash Player on the Windows and Macintosh platforms.
`BufferRatio`	Specifies the ratio of the buffer length used by server-side stream to live buffer.
`Cache`	Container element; contains elements that configure the cache setting for SWF verification.
`CachePrefix`	Specifies the cache prefix that is passed from the origin server to the edge server.
`CacheUpdateInterval`	Specifies the interval for updating cache streaming in the edge server.
`Client`	Container element; contains elements to configure the client.
`ClientToServer (Bandwidth)` `Bandwidth`	Container element; specifies the bandwidth settings for client-to-server communications.
`ClientToServer (BandwidthCap)` `BandwidthCap`	Container element; specifies the bandwidth settings for client-to-server communications that can be set by the user.
`CombineSamples`	Container element; contains elements to configure how to use sound sampling.
`Connections`	Container element; contains elements to configure settings for HTTP connections.
`DataSize`	Specifies the amount of data the server sends to the client.
`Debug`	Container element; contains elements that configure debug connections.
`Distribute`	Specifies how to distribute application instances to processes.
`DuplicateDir`	Specifies a backup location for shared objects and recorded stream files.
`Duration`	Specifies the wait time before the server notifies clients when audio stops in a stream.
`EnhancedSeek`	Enables the fine-tuning of the seeking performance within streams by creating a key frame.
`Exception`	Specifies user agents to except from authentication.
`FileObject`	Container element; contains element with file object setting.
`FlushOnData`	Specifies whether the server flushes the message queue when a data message arrives.
`FolderAccess`	Configures folder-level permissions for the readAccess and writeAccess functions in the Access Module.
`HiCPU`	Specifies the upper limit to begin sound sampling.
`Host`	Specifies the HTTP proxy to use.
`HTTP`	Container element; contains elements to configure the HTTP connections for this application.
`HTTP1_0`	Allows or disallows use of the HTTP 1.0 protocol.
`HTTPTunnel`	Container element; contains elements to configure HTTP tunneling.
`IdleAckInterval`	Specifies the wait time before the server responds to an idle post sent to it.
`IdlePostInterval`	Specifies the wait time before Flash Player sends an idle post message to the server.
`Interface`	Specifies the name to use as the outgoing network interface.
`Interval`	Specifies the interval for sending silence messages when no audio is being published to a live stream.
`JSEngine`	Container element; contains the elements in this section that configure the JavaScript engine.
`KeyFrameInterval`	Specifies the time interval for saving keyframes in a FLV file.
`LifeTime`	Specifies the lifetime of stateless core processes.
`Live (StreamManager)`	Container element; contains elements that specify the configuration of intermediate frames in a live stream.
`Live (MsgQueue)`	Container element; contains elements that specify the configuration of live audio.
`LoadOnStartup`	Specifies whether or not to load this application when the server starts.
`LockTimeout`	Specifies the time-out value before unlocking a shared object file.
`LoCPU`	Specifies the lower limit to halt sound sampling.
`Max`	Specifies the maximum number of HTTP redirections allowed.
`MaxAggMsgSize`	Specifies the maximum size in bytes of the aggregate messages created from the message queue, when aggregate messages are enabled.
`MaxAppIdleTime`	Specifies the maximum time an application instance can be idle.
`MaxAudioLatency`	Specifies that live audio should be dropped after a set amount of time.
`MaxBufferRetries`	Specifies default buffer length for live audio and video.
`MaxCores`	Specifies the maximum number of core processes for an application.
`MaxFailures`	Specifies the maximum number of failures for a core process.
`MaxGCSkipCount`	Specifies the maximum number of times that the server will skip garbage collection (GC) when the JS engine is busy.
`MaxMessageSizeLosslessVideo`	Specifies the maximum size of messages for screen-sharing packets.
`MaxPendingDebugConnections`	Specifies the maximum number of pending debug connections. allowed.
`MaxProperties`	The maximum number of properties that can be set per shared object.
`MaxPropertySize`	The maximum size in bytes for each property of a shared object.
`MaxQueueDelay`	Specifies how often the server will flush the message queue, in milliseconds.
`MaxQueueSize`	Specifies how often the server will flush the message queue, in bytes.
`MaxRate`	Specifies the maximum rate at which the server sends data to the client.
`MaxSamples`	Specifies the maximum number of samples that can be combined into a message.
`MaxSize`	Specifies the maximum size of intermediate frames a live stream can hold in the buffer.
`MaxStreamsBeforeGC`	Specifies that a GC should be forced if the stream list grows over set value.
`MaxTime`	Specifies the maximum duration of intermediate frames a live stream can hold in the buffer.
`MaxTimeOut (Connections)` `Connections`	Container element; specifies the maximum time for a transfer to be completed.
`MaxTimeOut (JSEngine)` `JSEngine`	Container element; specifies the maximum time a script can take to execute a Java server function.
`MaxUnprocessedChars`	Specifies the amount of data that can be received from the XML server before XMLSocket closes the connection.
`MaxWait`	Specifies how long, in seconds, the server waits before sending data to the client.
`MimeType`	Specifies the default MIME-type header sent on tunnel responses.
`MinBufferTime (Live)`	Specifies the default buffer length for the live audio and video queue.
`MinBufferTime (Recorded)`	Specifies the default buffer length for audio and video.
`MinGoodVersion`	Specifies the minimum accepted version of SWF verification allowed by the server.
`MsgQueue`	Container element; contains elements that configure live and recorded audio.
`NetConnection`	Container element; specifies object encoding to use for SSAS NetConnection.
`Password`	Specifies whether the server is notified when an audio transmission ending on a stream is encountered.
`ObjectEncoding`	Specifies default object encoding to use for SSAS NetConnection.
`OutChunkSize`	Specifies the RTMP chunk size to use in all streams for this application.
`OverridePublisher`	Deprecated; see `PublishTimeout`.
`Password`	Specifies the password for connections to the edge.
`Port`	Specifies the proxy port to connect to if not specified.
`Prioritization`	Specifies whether outgoing messages are prioritized by message type when sending across server-to-server connection.
`Process`	Container element; contains elements to configure the process and recovery settings for applications.
`Proxy`	Container element; contains elements to configure the HTTP proxy.
`PublishTimeout`	Specifies how long in milliseconds the server waits to receive a response from a publisher when another client tries to publish to the same stream.
`Queue`	Container element; configures the settings of the message queue.
`Recorded`	Container element; specifies aspects of buffer length.
`RecoveryTime`	Specifies the recovery time for a core.
`Redirect`	Container element; contains elements to configure HTTP redirection.
`ResyncDepth`	Specifies the resyncing interval for shared object files.
`Reuse`	Specifies whether or not to close the HTTP connection after each transfer.
`RollOver`	Specifies the time length a core process is in use.
`RuntimeSize`	Specifies the maximum size for the script engine.
`Scope`	Specifies the process scope in which the application runs.
`ScriptLibPath`	Contains a list of paths the Java Server engine can search to resolve a script file.
`SendDuplicateOnMetaData`	Specifies if an onMetaData message is sent at the beginning of the video file for all commands.
`SendDuplicateStart`	Specifies if the status message NetStream.Play.Start is sent for all commands.
`SendSilence`	Container element; contains elements to configure the sending of silence messages.
`Server`	Container element; contains element that specifies the ratio of the buffer length used by server-side stream to live buffer.
`ServerToClient (Bandwidth)` `Bandwidth`	Specifies the bandwidth settings for server-to-client communications.
`ServerToClient (BandwidthCap)` `BandwidthCap`	Specifies the maximum bandwidth a user can set for data sent from the server to the client.
`SharedObjManager`	Container element; contains elements to configure the Shared Object Manager of an application.
`StorageDir`	Specifies the locations where recorded streams and shared objects are stored.
`StreamManager`	Container element; contains the Stream Manager settings for the application.
`Subscribers`	Specifies a base number of subscribers required before implementing sound sampling.
`SWFFolder`	Specifies a single folder or a list of folders containing copies of client SWF files that can be verified for connecting to the application.
`SWFVerification`	Container element; contains elements that specify how a SWF file connecting to an application is verified.
`ThrottleBoundaryRequest`	Controls the maximum number of concurrent boundary requests per recorded stream.
`ThrottleDisplayInterval`	Controls the interval at which the server displays the throttle queue length.
`ThrottleDisplayInterval`	Controls the interval at which the server displays the throttle queue length.
`Tunnel`	Specifies whether or not to tunnel all operations through a given HTTP proxy.
`TTL`	Specifies in minutes how long each SWF file remains in the cache. The default value is 1440 minutes (24 hours).
`Type`	Specifies the type of proxy being connected to.
`UnrestrictedAuth`	Allows or disallows sending the user name/password with each HTTP redirection.
`UpdateInterval`	Specifies the maximum time in minutes to wait for the server to scan the SWF folders for updates when there is a miss in the cache.
`UserAgent`	Specifies the version dependency settings for clients that use different versions of Flash Player on different platforms.
`UserAgentExceptions`	Container element; contains element that specifies exceptions to SWF verification.
`Username`	Specifies the user name for connections to the proxy.
`Verbose`	Enables or disables the use of verbose information during HTTP operations.
`VideoSampleAccess`	Enables access to the raw uncompressed video data in a stream.
`VirtualDirectory`	Specifies virtual directory mappings for Server-Side ActionScript File objects and video files.
`WriteBufferSize`	Specifies the size of the write buffer.
`XMLSocket`	Container element; contains element that specifies the amount of data XMLSocket accepts from XML server before closing the connection.

Send me an e-mail when comments are added to this page | Comment Report

Adobe Flash Media Server

Application.xml file