Page 1 ADOBE FLASH MEDIA SERVER 4.5 ® ® Configuration and Administration Guide...
Page 2: Legal Notices
Legal notices Legal notices For legal notices, see http://help.adobe.com/en_US/legalnotices/index.html. Last updated 11/28/2012...
Page 3: Table Of Contents
..................53 Configure Apache for Adobe HTTP Dynamic Streaming and Apple HTTP Live Streaming .
Page 4 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Contents Application.xml file ....................138 Logger.xml file .
Page 5: Chapter 1: Deploying The Server
Chapter 1: Deploying the server Configure ports When you install Flash Media Server, you can accept the default ports on which Flash Media Server and Flash Media Administration Server listen. You can also enter new ports. The default ports for Flash Media Server are 1935 and 80. The default port for Flash Media Administration Server is 1111.
Page 6 1111. Clients must specify port 1111 in connection URLs. Clients cannot access Flash Media Administration Server over RTMPS. As a result, Adobe recommends that you block all external access to port 1111 so that access to the Administration Server is restricted to clients that are inside your firewall.
Page 7 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Deploying the server “Add an adaptor” on page 15 Configure IP addresses and ports for RTMFP RTMFP connection flow An RTMFP client connects to a Flash Media Server fmsedge process over UDP port 1935. Specify this port in the parameter of the fms.ini file.
Page 8 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Deploying the server Save the file and restart the server. See Start and stop the server About the HostPort element The value of the element has the following format: HostPort <value-of-HostPort> := [<host-port-range> [; <host-port-range> [; ... ] ] ] <host-port-range>...
Page 9 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Deploying the server In an Internet application, the application developer must choose how to handle cases in which a firewall or NAT blocks a direct peer-to-peer connection. To create an application that works for connections that aren’t peer-to-peer, create a protocol fallback to client-server RTMP and/or RTMPT.
Page 10 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Deploying the server Test Description Can receive from same IP address, Indicates whether your firewall is “port restricted”. A port restricted different UDP port number firewall requires an outbound connection to the same address and port number before inbound traffic is permitted from that address and port number.
Page 11: Load Balancing
Cookies can be enabled in the load balancer or in the Adaptor.xml configuration file in element. Adaptor/HTTPTunnel/SetCookie Note: For tunnelling connections, cookies are currently supported only on Adobe® Flash® Player 9.0.28 or later in Windows only. For more information, see the following articles: •...
Page 12: Deploying Edge Servers
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Deploying the server Load balancing peer-assisted networking applications Use one of the following two techniques to load balance a peer-assisted networking applications: • Distribute introductions across a server-only RTMFP NetGroup. This technique is new in Flash Media Server 4.5. Use a Server-Side ActionScript API to distribute peer lookup requests across multiple servers.
Page 13 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Deploying the server 4. If you’re installing multiple edge servers, copy the Vhost.xml file to the same directory on each edge server. 5. Verify that each edge server can communicate with the origin server. 6.
Page 14 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Deploying the server Element Required/optional Description Required Enter to configure the server to run as an origin server. Enter Mode local remote to configure the server to run as an edge server. Anonymous Optional A Boolean value specifying whether the edge server connection is implicit true...
Page 15 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Deploying the server Restart the server. More Help topics “Adaptors and virtual hosts” on page 14 Set up caching on edge servers Streams that are played via an edge server can optionally be cached on that edge server’s hard drive to avoid extra network traffic back to the origin.
Page 16 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Deploying the server Element Description Specifies the maximum allowed size of the disk cache, in gigabytes. The server MaxSize does LRU (least recently used) cleanup of the cache to keep it under the maximum size.
Page 17: Deploying 64-Bit Servers
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Deploying the server Use the following syntax in a client-side call to make an implicit connection to an NetConnection.connect() edge server: rtmp://edge/app/appinstance Connect edge servers in a chain ❖ You can chain together any number of edges when you make connections to the origin server. Use the following syntax to chain two explicit edges to direct connection requests to the origin server: rtmp://edge1/?rtmp://edge2/?rtmp://origin/app/inst As the connection moves through each edge in the chain, the server consumes the first token in the string.
Page 18: Chapter 2: Configuring The Server
Chapter 2: Configuring the server Configure the server for virtual hosting Adaptors and virtual hosts To host multiple tenants on a server, configure the server so that each customer has their own section. Administrators can configure their own sections to serve their content most effectively. You can configure virtual hosting in several ways, depending on your needs.
Page 19 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Edit any of these XML files in a text or XML editor and restart the server for the changes to take effect. If you modify Users.xml or fms.ini, you also must restart Flash Media Administration Server. For more information, see “Working with configuration files”...
Page 20 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server To log in to the Administration Console on the new adaptor, use the syntax adaptorname/username in the Username box; for example, adaptor2/admin. For information about logging in to the Administration Console, see “Connecting to the Administration Console”...
Page 21: Working With Configuration Files
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server For information about logging in to the Administration Console, see “Connecting to the Administration Console” on page 80. Connect to the new virtual host by specifying the virtual host name, for example, www.example.com, in the Server name field.
Page 22 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server To edit a configuration file, including fms.ini, do the following: Open the file in a text editor. Edit the file. Save the file. Validate the XML. Restart Flash Media Server. If you modify the Users.xml file, restart Flash Media Administration Server, too.
Page 23 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server The server has two predefined symbols, , that are always available. The symbol is mapped to the ROOT CONF ROOT location of the FMSMaster.exe file and the symbol is mapped to the location of the Server.xml file. CONF The server builds the symbol map in the following order: The predefined symbols...
Page 24: Configuring Performance Features
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server <Root> <KeyValueFile>C:\testfiles\mySymbols.txt</KeyValueFile> </Root> These external files are not in XML format. They simply contain a collection of symbol-value pairs, where each pair appears on a separate line and takes the following form: symbol=value The following example shows three symbol-value pairs: USER_NAME=foo...
Page 25 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server In this use case, you want to keep latency as low as Large Scale Broadcast (low latency is more important than scale) possible while reaching as many people as possible. You are willing to trade some scale for decreased latency. Send smaller aggregate messages.
Page 26 To decrease the amount of memory the server process uses, decrease the value of SERVER.FLVCACHE_MAXSIZE While a large cache size is useful, Adobe recommends that you ensure that your total system memory usage does not exceed the process limit of your OS. Consider memory limits and desired memory and stream performance when utilizing the memory cache.
Page 27 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server For more information, see “Application.xml file” on page 138. Restart the server. Send aggregate messages Important: Do not send aggregate messages and combine audio samples in the same application. An aggregate message is a single message that contains a list of submessages. Sending aggregate messages reduces CPU usage and increases server capacity.
Page 28 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Element Configuration file Description Server.xml Enables the creation of aggregate messages in the FLV Streams/EnableAggMsgs module. When this setting is “true”, the FLV module returns aggregate messages when loading segment data. When this setting is “false”, the FLV module returns regular audio, video, and data messages.
Page 29 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Element Configuration file Description StreamManager/Live/Queue/MaxQu Application.xml Defines the maximum time (in milliseconds) that the live eueDelay queue delays messages before the messages are transmitted. This setting can be used to ensure that unacceptable amounts of latency are not introduced into the publishing stream.
Page 30 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server After you confirm that aggregate messaging is enabled, you can use the settings in the Server.xml file to configure the size of the messages. You can also enable or disable the messages based on the type of stream. For more information, see “Streams”...
Page 31 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Element Description Impact The maximum number of incoming connections Connections requested at a rate above this MaxConnectionRate per second the server accepts, per listener. value remain in the TCP/IP socket queue and Listeners are defined in the element in are silently discarded by the operating system...
Page 32 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Element Description Impact Set the attribute to to close AutoCloseIdleClients enable true idle clients. If the attribute is enable omitted or not set to , the feature is true disabled. The default value is false CheckInterval Specifies the interval, in seconds, at which...
Page 33 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Element Description Disable this feature for an individual application by setting the attribute to . If this AutoCloseIdleClients enable false element is disabled in Server.xml, the feature is disabled for all applications, even if you specify in the Application.xml file.
Page 34 40. Depending on numprocs available RAM, a number between 3 and 11 is realistic for most cases. Adobe recommends using prime number values because they result in a more even distribution of connections to processes.
Page 35 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Configure the number of core processes and how long each process runs ❖ Specify the number of core processes in the tag (the maximum number of core processes that can exist MaxCores concurrently) and the number of seconds that a core process can run in the tag.
Page 36 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Check for process failures Enter a value in the tag to specify the maximum number of process failures allowed before a core MaxFailures process is disabled. The default value is 2. Once disabled, a master process will not launch a core process until a minimum recovery time elapses.
Page 37: Configuring Security Features
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server In some scenarios, however, you might want to disable RTMPE (encrypted Real-Time Messaging Protocol). Because RTMPE uses encrypted channels, there is a minor impact on performance; RTMPE requires about 15% more processing power than RTMP.
Page 38 SWF file. 4\webroot</SWFFolder> Note: If you’re deploying an Adobe AIR application, copy the SWF file you compiled into the AIR package to the server or external content repository. When the client SWF file connects to the server, the server verifies it. If the SWF file is verified, it is allowed to connect to the application.
Page 39 None. Specifies the minimum version of this feature to accept. The default value MinGoodVersion which allows this and all future versions. This is a reserved field that works with Flash Player; Adobe recommends keeping the default value. Last updated 11/28/2012...
Page 40 Exception UserAgentExceptions Certain applications—for example, Adobe® Flash® Media Live Encoder—do not support the form of SWF verification used by the server. You can add one or more exceptions to the SWF verification rules that allow specified user agents, such as Flash Media Live Encoder, to bypass SWF verification, as in the following: <SWFVerification enabled="true">...
Page 41 The Administration Console connects to Adobe Flash Media Administration Server, which connects to Adobe Flash Media Server. By default, the Administration Server in installed on port 1111. Adobe recommends that you block all external access to port 1111 so that access to the admin server is restricted only to clients that are within your firewall.
Page 42 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Set limits on unsuccessful login attempts You can use the settings in the rootinstall/conf/Server.xml file to set the number of unsuccessful LogInLimits attempts a client is allowed when trying to log in to the admin server. With these settings, you define how many failed attempts are allowed before the client must wait to attempt to log in again.
Page 43 Configuring the server var nc:NetConnection = new NetConnection(); nc.proxyType = "best"; nc.connect("rtmps://fmsexamples.adobe.com/vod/instance1"); If you configure any port other than 443 as secure, for example, -1935, the client must specify the port in the URI, for example, “rtmps://host:1935/app”. Note: All server editions support a version of RTMP called RTMPE, which is an 128-bit encrypted protocol. RTMPE is more lightweight than SSL and is enabled by default.
Page 44 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Element Description The location of the certificate file to send to the client. Specify an absolute path or SSLCertificateFile a path relative to the adaptor folder. SSLCertificateKeyFile type="PEM" The location of the private key file for the certificate. Specify an absolute path or a path relative to the adaptor folder.
Page 45 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server For example, add the following tag in addition to the default tag: HostPort HostPort <HostPort name="edge2" ctl_channel=":19351">:1936,-444</HostPort> For each element, enter an element under the element with an identical attribute. If you HostPort Edge name...
Page 46 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Element Description The number of bytes of entropy to use for seeding the pseudo-random number generator SSLRandomSeed (PRNG). You cannot specify anything less than 8 bytes, and the default value is 16. Entropy is a measure of randomness.
Page 47 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server <VirtualHost> <Proxy> <SSL> <SSLClientCtx> <SSLVerifyCertificate></SSLVerifyCertificate> <SSLCACertificatePath></SSLCACertificatePath> <SSLCACertifcateFile></SSLCACertificateFile> <SSLVerifyDepth></SSLVerifyDepth> <SSLCipherSuite></SSLCipherSuite> </SSLClientCtx> </SSL> </Proxy> </VirtualHost> When the tag is present, the entire section is used to configure the virtual host. If an tag is omitted from this section, the server uses the default settings.
Page 48 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server <RPC enable="true"> Add the method you want to allow to the class’s element. The following example allows the <Allow> getLocal() methods to be called on the SharedObject class: setFps() <SharedObject> <Method>...
Page 49: Performing General Configuration Tasks
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server <Application> <ScriptEnging> <FileObject override="no"> <VirtualDirectory> /flashapps;C:\dev\Code\Flash\tincan\flashapps\ </VirtualDirectory> </FileObject> Performing general configuration tasks Enable checkpoint logging events Many companies use statistics from the access log to bill customers. If your programming includes live events or 24/7 programming, the events you use to calculate billing might not occur within a billing cycle.
Page 50: Configuring Ipv6
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Allow application debugging connections To play back streams and obtain data from shared objects, the Administration Console must make a special debugging connection to the server. By default, the server does not allow this connection. Open the Application.xml file.
Page 51 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server It’s a good idea to register the RTMP, RTMPS, and RTMPE protocols with a network services database and use a service name (or decimal port number, if necessary) in the server configuration files. Check the logs When the server starts, it logs available stack configuration, host name, and all available IP addresses for the host in the master.xx.log, edge.xx.log, and admin.xx.log files (located in the rootinstall/logs/ directory).
Page 52 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server trace("I am " + application.config.user_name + " and I work in the " + application.config.dept_name + " department."); trace("I am " + application.config["user_name"] + " and I work in the " + application.config["dept_name"] + "...
Page 53: Configuring Content Storage
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Note: You can set these values in an Application.xml file at the VHost level or at the application level. To set the value at the application level, copy an Application.xml file to the application’s folder. Locate the following code: <BandwidthDetection enabled="true">...
Page 54 By default, all recorded streams for an application are stored in a streams folder in the application directory. Shared objects are stored in a shared objects folder in the application directory. Note: Adobe strongly recommends that folders that store streams always contain only streams and no other application files.
Page 55 All applications on the virtual host can access video files in the specified location, although Adobe recommends that if you want control at the virtual host level, you configure tag in Vhost.xml file instead of the virtual-host Application.xml file.
Page 56 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server ns.play("sample"); element in the application-specific Application.xml file affects only that application, <VirtualDirectory> protecting your streams from being accessed by other applications on the same virtual host. It overrides settings in the Vhost.xml file.
Page 57: Configuring Apache Http Server
Note: The Flash Media Server documentation uses “rootinstall” to indicate the Flash Media Server root installation folder (C:\Program Files\Adobe\Flash Media Server 4 by default on Windows). The Apache documentation and configuration files use “ServerRoot” to indicate the Apache root installation folder.
Page 58 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server • The log files are in the rootinstall/Apache2.2/logs folder. For more information, see “Monitoring and Managing Log Files” on page 95. Alternate configurations To do any of the following, edit the rootinstall/Apache2.2/conf/httpd.conf file: •...
Page 59 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server HTTPPROXY.HOST = :8134 • Open the Adaptor.xml configuration file in a text editor. If you have multiple adaptors, open the file for the adaptor you want to configure. The default Adaptor.xml file is located in the rootinstall\conf\_defaultRoot_ folder.
Page 60 Open a Command prompt. Change directories to the rootinstall/Apache2.2/bin folder. For example, at the command prompt, enter the following: cd ../../Program Files/Adobe/Flash Media Server 4/Apache2.2/bin To install Apache to run as a service, enter the following: httpd.exe -f conf/httpd.conf -n FMSHttpd -k install Note: To uninstall Apache, enter the following: httpd.exe -n FMSHttpd -k uninstall.
Page 61 Check the master log file for errors. The master.00.log file should have a line that launches the httpd process and returns 0; for example: - C:\Program Files\Adobe\Flash Media Server 4\Apache2.2\bin\httpd -f ./conf/httpd.conf -d "C:\Program Files\Adobe\Flash Media Server 4\Apache2.2" -n FMSHttpd -k start returned 0: Try playing videos using the “http” protocol.
Page 62 Check the master log file for errors or warnings. The master.00.log file should have a line that launches the httpd process and returns 0; for example: - C:\Program Files\Adobe\Flash Media Server 4\Apache2.2\bin\httpd -f ./conf/httpd.conf -d "C:\Program Files\Adobe\Flash Media Server 4\Apache2.2" -n FMSHttpd -k start returned 0: Try playing videos using the “http” protocol.
Page 63: Configure Apache For Adobe Http Dynamic Streaming And Apple Http Live Streaming
Configure the HTTP modules Apache HTTP Server that installs with Flash Media Server is configured by default for Adobe HTTP Dynamic Streaming (to Flash Player and AIR) and Apple HTTP Live Streaming (to iOS and Mac OS). The Flash Media Server Apache installation includes three custom modules that handle HTTP streaming: •...
Page 64: Live Streaming
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Response code Error message Description mod_f4fhttp [404]: %s does not exist An error occurs when the request file is not found. The variable %s is the file path. For example, the request URI is http://servername/media/sample.fmf mod_hlshttp[404]: %1 does not exist but the file sample.f4m does not exist.
Page 65 HLSMediaFileDuration 8000 HLSSlidingWindowLength 6 HLSFmsDirPath ".." HLSM3U8MaxAge 2 HLSTSSegmentMaxAge -1 Options -Indexes FollowSymLinks </Location> • For on-demand Adobe HTTP Dynamic Streaming, packaged in just-in-time, add the following: LoadModule jithttp_module modules/mod_jithttp.so <IfModule jithttp_module> <Location /hds-vod> HttpStreamingJITPEnabled true HttpStreamingContentPath "../webroot/vod" JitFmsDirPath ".."...
Page 66: Configure Http Streaming Failover
In the directives that you entered in your httpd.conf file, edit the following: • —set to the Flash Media Server HttpStreamingLiveEventPath HttpStreamingContentPath applications folder, for example: C:\Program Files\Adobe\Flash Media Server 4.5\applications • —set to the location of your Flash Media Server installation, for example: JitFmsDirPath HLSFmsDirPath C:\Program Files\Adobe\Flash Media Server 4.5 For information about ports, see “Using a third-party web...
Page 67 You enable best-effort fetch by adding and configuring a element in the manifest.xml file <bestEffortFetchInfo> on the server side, as as illustrated in the following: <?xml version="1.0" encoding="UTF-8"?> <manifest xmlns="http://ns.adobe.com/f4m/2.0"> <dvrInfo windowDuration="7200"/> <bestEffortFetchInfo segmentDuration="40.000" fragmentDuration="4.000" maxForwardFetches="2"...
Page 68 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server OSMF The OSMF 2.0 player adds client-side robustness by supporting best-effort fetch. Specifically, when best-effort fetch is enabled on the server, OSMF 2.0 attempts fetches for fragments that have not been advertised in the bootstrap, but are expected to be present.
Page 69 Sample request [GET] http://www.example-server.com/ctrlplane/livepkgr/_definst_/livestream.f4m/status Sample response This is an example response for an MBR stream in which all streams are disabled: 200 OK <?xml version="1.0" encoding ="UTF-8"?> <controlplane-event-status xmlns="http://ns.adobe.com/hds/controlplane/status/1.0"> <manifest-file> /livepkgr/_definst_/livestream.f4m </manifest-file> <status> disabled </status> <up>...
Page 70 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server <done> false </done> </ bootstrap> <bootstrap name="livestream 3"> <up> false </up > <age> </age> <status> disabled </status> <done> false </done> </ bootstrap> <bootstrap name="livestream 1"> <up > false </up> < age> </age>...
Page 71 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Sample request [POST] http://www.example-server.com/ctrlplane/livepkgr/_definst_/livestream.f4m/disable Sample response <?xml version="1.0" encoding="UTF-8"?> <controlplane-response xmlns="http://ns.adobe.com/hds/controlplane/status/1.0"> <manifest-file> /livepkgr/_definst_/livestream.f4m </manifest-file> <stream name="livestream2"> <status-code> </status-code> <status-desc> Command executed successfully. </status-desc> </stream> <stream name="livestream3"> <status-code> </status-code> <status-desc> Command executed successfully.
Page 72 If a file exists, the module returns a 503 error .disabled .disabled (configurable in httpd.conf). Sample request [POST] http://www.example-server.com/ctrlplane/livepkgr/_definst_/livestream.f4m/disable <controlplane-request> <stream> livestream2</stream> </controlplane-request> Sample response <controlplane-response xmlns="http://ns.adobe.com/hds/controlplane/status/1.0"> <manifest-file> /livepkgr/_definst_/livestream.f4m </manifest-file> <stream name="livestream2"> <status-code> </status-code> <status-desc> Command executed successfully. </status-desc> </stream>...
Page 73 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Sample response <?xml version="1.0" encoding="UTF-8"?> <controlplane-response xmlns="http://ns.adobe.com/hds/controlplane/status/1.0"> <manifest-file> /livepkgr/_definst_/livestream.f4m </manifest-file> <stream name="livestream2"> <status-code> </status-code> <status-desc> Command executed successfully. </status-desc> </stream> <stream name="livestream3"> <status-code> </status-code> <status-desc> Command executed successfully. </status-desc> </stream>...
Page 74 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server <controlplane-request> <stream>livestream2</stream> </controlplane-request> Sample response <?xml version="1.0" encoding="UTF-8"?> <controlplane-response xmlns="http://ns.adobe.com/hds/controlplane/status/1.0"> <manifest-file> /livepkgr/_definst_/livestream.f4m </manifest-file> <stream name="livestream2"> <status-code> </status-code> <status-desc> Command executed successfully. </status-desc> </stream> </controlplane-response> Mark an event as done Description Signals that an event is complete.
Page 75 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Sample response <?xml version="1.0" encoding="UTF-8"?> <controlplane-response xmlns="http://ns.adobe.com/hds/controlplane/status/1.0"> <manifest-file> /livepkgr/_definst_/livestream.f4m </manifest-file> <stream name="livestream1"> <status-code> </status-code> <status-desc> Command executed successfully. </status-desc> </stream> <stream name="livestream2"> <status-code> </status-code> <status-desc> Command executed successfully. </status-desc> </stream>...
Page 76 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Sample response <?xml version="1.0" encoding="UTF-8"?> <controlplane-response xmlns="http://ns.adobe.com/hds/controlplane/status/1.0"> <manifest-file> /livepkgr/_definst_/livestream.f4m </manifest-file> <stream name="livestream1"> <status-code> </status-code> <status-desc> Command executed successfully. </status-desc> </stream> </controlplane-response> Mark an event as in-progress Description Signals that an event is still in progress. You send this as an HTTP POST request with no body. This request undoes a request.
Page 77 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Sample response <?xml version="1.0" encoding="UTF-8"?> <controlplane-response xmlns="http://ns.adobe.com/hds/controlplane/status/1.0"> <manifest-file> /livepkgr/_definst_/livestream.f4m </manifest-file> <stream name="livestream1"> <status-code> </status-code> <status-desc> Command executed successfully. </status-desc> </stream> <stream name="livestream2"> <status-code> </status-code> <status-desc> Command executed successfully. </status-desc> </stream>...
Page 78: Using A Third-Party Web Server
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Sample response <?xml version="1.0" encoding="UTF-8"?> <controlplane-response xmlns="http://ns.adobe.com/hds/controlplane/status/1.0"> <manifest-file> /livepkgr/_definst_/livestream.f4m </manifest-file> <stream name="livestream1"> <status-code> </status-code> <status-desc> Command executed successfully. </status-desc> </stream> </controlplane-response> Using a third-party web server You can use web servers other than the included version of Apache to serve Flash Media Server files. Note, however, that the HTTP Module for HTTPDynamic streaming is currently supported only on Apache web servers.
Page 79: Configuring Differentiated Services (Diffserv)
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Configuring Differentiated Services (DiffServ) Flash Media Server 3.5.2 Understanding DiffServ Use Differentiated Services to handle different types of traffic differently within a network. For example, you could give RTMP traffic a higher priority than FTP traffic. Or, you could give higher bandwidth and latency to RTMP than to HTTP.
Page 80 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server For IPv6, Linux provides no standard way to set the Differentiated Services field (which has been renamed TCLASS field).If Flash Media Server has IPv6 enabled and clients connect using an IPv6 address, setting bits on IPv6 clients does not result in an error.
Page 81 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server U8 dscpVal; if(getU8Field(m_pAev, IFmsAuthEvent::F_CLIENT_DIFFSERV_BITS, dscpVal)) dscpVal = 0xFC; bool res = setU8Field(m_pAev, IFmsAuthEvent::F_CLIENT_DIFFSERV_BITS, dscpVal); U8 dscpMask; dscpMask = 0xF0; bool res = setU8Field(m_pAev, IFmsAuthEvent::F_CLIENT_DIFFSERV_MASK, dscpMask); The following table shows how to use the mask and bits fields together to get the desired bit settings on the socket: Current value on DiffServ bits DiffServ mask...
Page 82 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server Condition Message Log file Setting DSCP bits for group/service/virtual connections. Setting Diff Serv bits is not supported for group, service or Core virtual connections. Attempting to set DSCP values on Windows. Setting Diff Serv bits is not supported for Windows Auth Platforms.
Page 83 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Configuring the server <result> <level>status</level> <code>NetConnection.Call.Success</code> <timestamp>Mon 25 Jan 2010 08:00:00 PM PST</timestamp> <data> <_0> <name>sample</name> <time>Sun 24 Jan 2010 06:00:00 PM PST</time> <type>playing recorded</type> <client>BCAgYLpK</client> <stream_id>BBAgYLpK</stream_id> <client_type>normal</client_type> <diffserv_bits>0xfc</diffserv_bits> </_0> </data> </result> element updates only when bits are set successfully. diffserv_bits Verifying bits in an RTMP stream Suppose a client connects to the server and plays a stream.
Page 84: Chapter 3: Using The Administration Console
To open the Administration Console, do one of the following: • On Windows, select Start > Programs > Adobe > Flash Media Server 4.5 > Adobe Flash Media Administration Console. • On Linux, open the fms_adminConsole.htm and fms_adminConsole.swf files in a browser with Flash Player.
Page 85 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration Console In the Server Address box, do one of the following: • Type localhost if the server and the Administration Console are running on the same computer. If the Administration Server is installed on a port other than 1111 (the default), you must enter the port number as well;...
Page 86: Inspecting Applications
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration Console Change the refresh rate of the Administration Console ❖ Click the pop-up menu next to Refresh Rate (upper-right corner) and select a new time duration, such as 10 seconds. Pause refreshing the Administration Console Click the pop-up menu next to Refresh Rate (upper-right corner), scroll down, and select Pause.
Page 87 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration Console Click View Applications. Click New Instance. Select the application from the pop-up menu. (The application must already be configured on the server.) The Administration Console adds a default instance , which can be edited.
Page 88 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration Console Viewing log messages for an application The Administration Console Live Log panel displays log messages and statements from server-side scripts trace() for the selected application instance. The information in this panel is updated whenever the application instance generates a log message.
Page 89 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration Console Streams panel Follow the steps in “Connect to the Administration Console” on page 80. Click View Applications. Click Streams. Select an application from the list. The Streams panel displays the following information: •...
Page 90 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration Console Clients panel Follow the steps in “Connect to the Administration Console” on page 80. Click View Applications. Click Clients. Select an application from the list. The following information is displayed: •...
Page 91 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration Console Shared Objects panel Note: The Administration Console was built using ActionScript 2.0 and cannot understand AMF3 data. Therefore, the Administration Console cannot display data in remote shared objects in applications built in ActionScript 3.0 unless the application sets the property to NetConnection.objectEncoding...
Page 92 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration Console Performance panel Follow the steps in “Connect to the Administration Console” on page 80. Click View Applications. Click Performance. Select an application from the list. The following information is displayed: •...
Page 93: Manage Administrators
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration Console Manage administrators About administrator roles Administrators are users who are allowed to log in to the Administration Console. There are two types of administrators: server administrators and virtual host administrators. Server administrators can control all virtual hosts and perform server-level tasks, such as restarting or shutting down the server.
Page 94 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration Console Validate the XML and save the Users.xml file. Add virtual host administrators Open the Users.xml file in the root folder of the virtual host; for example, rootinstall/conf/_defaultRoot_/www.sampleVhost.com/Users.xml. If the file doesn’t exist, copy the Users.xml file from the rootinstall/conf folder.
Page 95: Managing The Server
Use the command line to reset a user password Open a shell window. Go to the Flash Media Server installation directory: (Windows) C:\Program Files\Adobe\Flash Media Server 4.5 (Linux) /opt/adobe/fms Stop Flash Media Server and Flash Media Administration Server. See Start and stop the server.
Page 96 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration Console Manage Servers panel Use the small buttons at the top and bottom of the panel to perform the following tasks: • Add a new server to the list. • Edit server login information (user name and password) and select options such as remembering the password and automatically connecting when logging in to the server.
Page 97: Viewing Connection Details
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration Console • Graphical displays of active connections, bandwidth resources consumed, and CPU and memory resources consumed Viewing connection details The Administration Console Connections panel lists all client connections to the selected server. Follow the steps in “Connect to the Administration Console”...
Page 98 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration Console Click License. Select a server from the list. For each license, the following information is displayed: • The individual serial key number • Authorized peak number of client connections •...
Page 99: Chapter 4: Monitoring And Managing Log Files
Files Adobe Flash Media Server has a variety of log files to help you manage and troubleshoot the server. The log files track server activity, such as who is accessing the server, how users are working with applications, and general diagnostics.
Page 100: Access Logs
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Monitoring and Managing Log Files Rotating and backing up log files Log files grow larger over time, but there are methods for managing log file size. One option is to rotate log files, moving or deleting the oldest files. Use the element in the Logger.xml file rotation to specify a rotation schedule for log files.
Page 101 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Monitoring and Managing Log Files Access events defined in access logs Event Category Description connect-pending session Client connects to the server, waiting for the client to be authenticated. connect session Client connects to the server. disconnect session Client disconnects.
Page 102 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Monitoring and Managing Log Files Event Category Description app-stop application An application instance has stopped. service.request registry A service request has been made. debug-pending session A debug request is pending. debug-approved session A debug request has been approved. filenametransform authorization A virtual stream path has been mapped to a physical location.
Page 103 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Monitoring and Managing Log Files Field Description Time zone information. x-ctx Event-dependent context information. s-ip IP address or addresses of the server. x-pid Server process ID. x-cpu-load CPU load. x-mem-load Memory usage (as reported by the method).
Page 104 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Monitoring and Managing Log Files Field Description x-suri-stem This is a composite field: cs-uri-stem + x-sname + x-file-ext. x-suri This is a composite field: cs-uri-stem + x-sname + x-file-ext + x-sname-query. x-file-name Full path of the file representing the x-sname stream. x-file-ext Stream type (FLV, MP3, or MP4).
Page 105 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Monitoring and Managing Log Files Field Description x-codec-type Codec type of the frame retrieved in the Authorization plug-in’s E_CODEC event. This event is visible only in the auth.log file. This field is empty in the access.log file. x-codec-value Codec value of the “x-codec-type”...
Page 106 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Monitoring and Managing Log Files Field Symbol Status Code Description connect process_msg_failed Unable to process message received when client connection was in pending or closed state. disconnect process_msg_exception Error handling message. disconnect process_remote_msg_failed Expected response not provided when command was issued.
Page 107: Application Logs
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Monitoring and Managing Log Files Field Symbol Status Code Description disconnect js_exception An unknown exception is thrown from the JS engine. disconnect js_chunkstream_error Bad application data. disconnect js_debug_forbidden Application does not allow debug connections. play js_gc_object ~fcstreamjshook() clean up.
Page 108: Diagnostic Logs
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Monitoring and Managing Log Files Diagnostic logs Diagnostic log file The diagnostic log records information about Flash Media Server operations (this is in addition to the information logged by the operating system). This log is used primarily for debugging (logging uncommon events that occur in Flash Media Server processes).
Page 109 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Monitoring and Managing Log Files Category Description SMTP Adaptor JavaScript TCApplication TCConnector Admin SharedObject Configuration VirtualHost Last updated 11/28/2012...
Page 110: Chapter 5: Administering The Server
Do one of the following: • Choose Start > All Programs > Adobe > Adobe Flash Media Server 4 > Start Adobe Flash Media Server 4 • Choose Start > All Programs > Adobe > Adobe Flash Media Server 4 > Start Adobe Flash Media Administration...
Page 111: Checking Server Status
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Administering the server Start, stop, or restart the Administration Server using fmsmgr Log in as a root user. Change to the directory where the server is installed. Open a shell window and type one of the following: •...
Page 112 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Administering the server • Can publish and play a stream • Can play the available server-side stream for an application Note: Currently, FMSCheck only supports RTMP connections and does not check for shared objects. FMSCheck commands and options Option Description...
Page 113 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Administering the server Option Description --query <" "> Allows you to input your own string for special purposes, such as authentication. Example: rtmp://host/app/inst?foo=abcd Specifies a timeout value, in seconds. If the program does not receive a response from the --timeout <sec>...
Page 114: Checking Video Files
Checking other video files Flash Media Server supports playback and recording of H.264-encoded video and HE-AAC-encoded audio within an MPEG-4–based container format. A subset of the MPEG-4 standards are supported. All MP4 files and Adobe F4V files are part of the supported subset.
Page 115 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Administering the server Option Description -d [ --duration ] Specifies the margin of error, in seconds, that FLVCheck reports. (The default is 2 seconds.) When validating metadata, the absolute difference between metadata_duration actual_duration is calculated and compared against the margin specified in this command.
Page 116 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Administering the server Error numbers Error type Error messages General Cannot create corrected file. This error occurs if you run the tool with the option set, but the tool cannot create a file with corrected metadata. Invalid FLV signature.
Page 117 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Administering the server FLVCheck warnings Generally, warnings are informative and are not fatal errors; Flash Media Server will ignore the error that caused the warning and continue to load and play back the video or audio file, but you may experience problems with playback. Warnings are logged to the stdout file in the following format: Date, Time, Warning Number, Warning Message, and File Name.
Page 118: Managing The Server On Linux
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Administering the server Managing the server on Linux Use the utility to perform basic management tasks for Flash Media Server running on Linux systems, such as fmsmgr starting and stopping the server and services. You must be a root user to use the utility.
Page 119: Scramble Tool
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Administering the server Scramble tool The scramble tool obfuscates data on disk to prevent people who have access to the system from reading sensitive information. Protected HTTP Dynamic Streaming (PHDS) and Protected HTTP Live Streaming (PHLS) use the scramble tool to obfuscate credential passwords and the content encryption key.
Page 120: Chapter 6: Using The Administration Api
About the Administration API Use the Administration API to monitor, manage, and configure the server from an Adobe Flash Player or Adobe AIR client over RTMP or RTMPE or from a web client over HTTP. The Flash Media Server Administration Console was built using the Administration API.
Page 121 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration API Call an Administration API method over HTTP Verify that Flash Media Administration Server is running. Open a browser window and enter the following in the address bar: http://localhost:1111/admin/ping?auser=username&apswd=password If the web browser is on a different computer than Flash Media Server, use the server address instead of localhost Substitute your administrator user name and password, which are located in the fms.ini file.
Page 122 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration API {user:"Joe",ssn:"123-45-6789"} Call Administration API methods over RTMP or RTMPE To call the Administration API over RTMP or RTMPE, you need a Flash Player or AIR client. Note: To call the Administration API over RTMPE, follow the instructions below, but change the protocol in the example call to RTMPE.
Page 123 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration API Note: You can call Administration APIs from applications written in ActionScript 1.0, ActionScript 2.0, or ActionScript 3.0. In Flash, create an application with the following elements: • An input text field named appName •...
Page 124 When you run the example, enter an application name in the TextInput control and click the Get App Stats button. Default applications include “live” and “vod”, but you can use the name of any application that you created on the server. <?xml version="1.0" encoding="utf-8"?> <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark" xmlns:mx="library://ns.adobe.com/flex/mx"> <fx:Declarations>...
Page 125 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration API /* Add the appName parameter to the request. */ /* Examples include "vod" and "live". */ myService.request.appName = appName.text; myService.send(); ]]> </fx:Script> <s:layout> <s:VerticalLayout paddingTop="10" paddingLeft="10"/> </s:layout> <s:Label text="Enter an app name (e.g., live or vod):" fontSize="14"...
Page 126 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION Using the Administration API <accepted>2</accepted> <rejected>0</rejected> <total_instances_loaded>1</total_instances_loaded> <total_instances_unloaded>0</total_instances_unloaded> <swf_verification_attempts>0</swf_verification_attempts> <swf_verification_exceptions>0</swf_verification_exceptions> <swf_verification_failures>0</swf_verification_failures> <swf_verification_unsupported_rejects>0</swf_verification_unsupported_rejects> <swf_verification_matches>0</swf_verification_matches> <swf_verification_remote_misses>0</swf_verification_remote_misses> <cores> <_0> <pid>15720</pid> <core_id>0</core_id> </_0> </cores> <server_bytes_in>0</server_bytes_in> <server_bytes_out>0</server_bytes_out> </data> </result> Last updated 11/28/2012...
Page 127: Chapter 7: Xml Configuration Files Reference
Chapter 7: XML configuration files reference Edit the configuration files in the RootInstall/conf directory to configure the server. Important: Do not modify certain XML elements without contacting Adobe Support. These elements are marked with an Important note. More Help topics “Edit a configuration...
Page 128: Adaptor.xml File
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Logger.xml file changes There are no changes to the Logger.xml file. Server.xml file changes element and element specify how long to wait before /RTMP/ConnectionTimeout /HTTP/ConnectionTimeout timing out an outgoing connection, in milliseconds. The default is -1 which uses the OS timeout to block outgoing connections.
Page 129 XML configuration files reference Allow A comma-delimited list of host names, domain names, and/or full or partial IP addresses from which clients can connect to the server. Example <Allow>foo.yourcompany.com, adobe.com, 10.60.1.133, 10.60</Allow> See also Deny Order Deny A comma-delimited list of host names, domain names, and/or full or partial IP addresses from which clients cannot connect to the server.
Page 130 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Example <Enable>true</Enable> See also IdlePostInterval IdleAckInterval MimeType WriteBufferSize SetCookie Redirect MimeType EnableAltVhost Determines whether an alternative virtual host may be specified as a part of the RTMP URL as query parameter rtmp://host1/app/?_fcs_vhost=host2.
Page 131 The entire response is enclosed in elements, which are added by the server. <FCS></FCS> If the function is enabled but no content is specified, the response is returned without HTTPIdent <FCS></FCS> content. Example <HTTPIdent enable="true"> <Company>Adobe System Inc</Company> <Team>Flash Media Server</Team> </HTTPIdent> Last updated 11/28/2012...
Page 132 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference The following is an example request: http://serverIP:1935/fcs/ident The following is an example response: <fcs> <Company>Adobe System Inc</Company> <Team>Flash Media Server</Team> </fcs> See also HTTPNull HTTPTunnel HTTPUserInfo HTTPIdent2 Configures the server to respond to or reject a special HTTP request from the client before the client attempts to make a RTMPT connection to Flash Media Server.
Page 133 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Example <HTTPNull enable="false"> HttpProxy Specifies whether the server proxies unknown requests to an external server. For proxying to work, HTTPTunnel/Enable must be set to true Request proxying to a specific host can be further controlled based upon port on which the request arrived. Flow control kicks in when the buffer in either direction fills up, automatically handling the case when producers and consumers differ widely in bandwidth.
Page 134 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference IdleAckInterval Specifies the maximum time in milliseconds the server waits before it sends an acknowledgement code for a client idle post. An acknowledgement code is a transmission control character used to indicate that a transmitted message was received uncorrupted and without errors, and that the receiving server is ready to accept transmissions.
Page 135 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference MaxFailures Specifies the maximum number of failures an edge server may incur before it restarts. The default number of failures is 2. Example <MaxFailures>2</MaxFailures> See also IdleAckInterval MaxHeaderLineLength The maximum size of an HTTP header line, in bytes, that the server can accept. The default value is 8192. To accept longer header lines, increase this value.
Page 136 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference See also HTTPTunnel NeedClose A Boolean value specifying whether or not HTTP 1.0 non-keepalive connections are closed once the response is written. The default value is , which closes the connections. true Example <NeedClose>true</NeedClose>...
Page 137 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference RecoveryTime Specifies the number of seconds an edge server waits before restarting after a failure. When an edge server fails, it waits for the interval specified here before it restarts. The wait time is specified in seconds. The number of failures is specified by the element.
Page 138 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Contained elements RTMPE RTMPE Specifies whether encrypted RTMP (RTMPE) can be used. RTMPE is the encrypted RTMP protocol covering both RTMPE and RTMPTE. This element is enabled by default; setting will not allow RTMPE or enabled false...
Page 139 This element contains a list of colon-delimited components. A component can be a key exchange algorithm, authentication method, encryption method, digest type, or one of a selected number of aliases for common groupings. Note: Contact Adobe Support before changing the default settings as listed in this example. Example <SSLCipherSuite>ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH</SSLCipherSuite>...
Page 140 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Specifies the password to use for decrypting the key file if the key file is encrypted. If the key file is not encrypted, this element is left blank. To prevent plain text passwords from appearing in the configuration file, encode the password in base64 format and set the attribute to encrypt...
Page 141 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference SSLVerifyClient Sets the certificate verifcation level for client authentication. The following are valid levels: • none Server does not send request for client certificate. • optional The client may send a certificate. If sent, it is checked. If certificate verification fails, TLS/SSL handshake is immediately terminated.
Page 142: Application.xml File
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Application.xml file The Application.xml file contains the settings for Flash Media Server applications. The Application.xml file in the virtual host directory configures the default settings for all applications within the virtual host.
Page 143 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference AccumulatedIFrames Container element. The elements in this section specify the maximum size and duration of intermediate frames a live stream can hold in the buffer. Contained elements MaxTime MaxSize (AccumulatedIFrames) AdaptorId Availability Flash Media Server 4...
Page 144 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference See also MaxAggMsgSize HTTPTunnel MaxMessageSizeLosslessVideo OutChunkSize Allow Specifies whether or not to allow the " :" header that is sent with redirection of an HTTP following and Location header. The default is , allowing HTTP redirects.
Page 145 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference See also Allow Application This is the root element for Application.xml. See also Process LoadOnStartup MaxAppIdleTime JSEngine StreamManager SharedObjManager AllowHTTPTunnel Client Debug HTTP SWFVerification AssumeAbsoluteTime Determines whether an incoming live stream has timestamps that are based on an absolute clock. An example of an absolute clock is an SMPTE time signal that is contained within the encoder’s input source.
Page 146 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference To configure the closing of idle connections, you must enable the feature in the Server.xml file. Once you enable the feature in the Server.xml file, you can disable the feature for individual virtual hosts in the Vhost.xml files or for individual applications in Application.xml.
Page 147 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Bandwidth Container element. The elements nested in this container specify the bandwidth settings for upstream (client-to-server) and downstream (server-to-client) data. By default, the element includes an parameter set to , which allows the values for the Bandwidth override...
Page 148 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Element Description MaxRate The maximum rate in Kbps at which the server sends data to the client. The default value is -1, which sends the data at whatever rate is necessary to measure bandwidth. The amount of data in bytes that the server sends to the DataSize client.
Page 149 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference See also UpdateInterval CachePrefix Specifies the cache prefix that is passed from the origin server to the edge server. This element is set on the origin server. The edge server uses the value of this element as a relative path to locate the cache file defined in the element.
Page 150 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference resolves to: origin1/data/c/fms/flvs/foo.flv See also StorageDir DuplicateDir CacheUpdateInterval CacheUpdateInterval This element defines the wait interval for updating cache streaming in the edge server. The interval is defined in milliseconds. The default value is 10 minutes. The minimum interval is 10 seconds. The maximum interval is 24 hours. Example <CacheUpdateInterval>10</CacheUpdateInterval>...
Page 151 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Contained elements Method Example <Client> <Method> <Allow></Allow> </Method> </Client> See also NetConnection (RPC) Stream SharedObject Availability Flash Media Server 4 ClientToServer (Bandwidth) Specifies the bandwidth the client can use for sending data upstream to the server. The default bandwidth is 1,250,000 bytes per second.
Page 152 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference CombineSamples Container element. The server conserves system resources by combining sound samples. This strategy saves the CPU and bandwidth overhead when transmitting individual audio packets only. Note: Use this strategy of combining sound samples advisedly during periods of high CPU usage, as it can cause latency. Contained elements LoCPU HiCPU...
Page 153 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference The elements in this section configure debug connections, including the maximum number of connections and the value for application.allowDebug. Contained elements AllowDebugDefault MaxPendingDebugConnections Diagnostic Specifies whether diagnostic logging for the message queue is enabled. The default value is false. See also Enabled DirLevelSWFScan...
Page 154 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference The following table lists the values available for the element: Distribute Value Description All instances of applications in a virtual host run together in a process. vhosts apps All instances of an application run together in a process. Each application instance runs in its own process.
Page 155 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference See also Password Enabled Specifies whether diagnostic logging for the message queue is enabled. The default value is false. See also Diagnostic EnhancedSeek This element enables or disables fine-tuning of the seeking performance within streams by creating a keyframe. Keyframes improve the visual display of video files while seeking.
Page 156 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference For example, using a specific Flash Player will report WIN 9,0,28,0 as its UserAgent. Add To="WIN 9,0,28,0" and only that version is an exception. From="WIN 9,0,28,0" See also UserAgentExceptions FileObject Container element.
Page 157 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference See also Access GroupControl Settings within the GroupControl section control server-side functionality corresponding to the server channel. A server channel is a channel that clients within a Flash Group can open to the server. The presence of a server channel depends on for the GroupSpecifier used to generate the value to join a...
Page 158 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Contained elements HTTP1_0 Verbose Connections Proxy Redirect HTTP1_0 This element determines whether or not the server can use the HTTP 1.0 protocol. The default is , disallowing false the use of the HTTP 1.0 protocol. Example <HTTP1_0>false</HTTP1_0>...
Page 159 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference The server may respond sooner than the value of this element if it has data to send back to the client or if some other client is being blocked by the current idle request. This interval implies that the client may not be able to reach the server for the selected duration.
Page 160 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Example <Interval>3</Interval> See also SendSilence JoinLeaveEvents Flash Media Server 4.5 element controls whether events for clients that join or leave a Group are dispatched to server- JoinLeaveEvents side script or handled internally. This element has a mode attribute with the following possible values: (default)—All Group join and leave events are handled internally at this Flash Media Server node.
Page 161 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Note: The properties you define are accessible from , not from application.config.property application.property Contained elements RuntimeSize MaxGCSkipCount MaxTimeOut (JSEngine and ScriptEngine) ScriptLibPath FileObject XMLSocket NetConnection (ScriptEngine) KeyFrameInterval This element defines how often to generate and save keyframes in an FLV file. The initial value is 60000, which is the recommended value.
Page 162 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Live (MsgQueue) Container element. The elements nested within this container configure live audio. Contained elements MaxAudioLatency MinBufferTime (Live) LoadOnStartup This element determines whether or not the server loads an application instance when the server starts. Having an application instance loaded at server start-up saves time when the first client connects to that application.
Page 163 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Contained elements Access (Logging) LogInterval The interval at which the server logs checkpoint events. See also Checkpoints This element defines the maximum number of redirects allowed. See also Allow MaxAggMsgSize Specifies the maximum size in bytes of the aggregate messages created from the message queue, when aggregate messages are enabled.
Page 164 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference MaxBufferRetries Specifies the maximum number of attempts to start buffering stream data. This configuration tag prevents the server from indefinitely trying to buffer data that is never delivered by the origin server. It is only applicable in edge servers. The default value of 128 is sufficient in most cases.
Page 165 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference MaxGCSkipCount Specifies the maximum number of times that the server will skip garbage collection (GC) when the JS engine is busy. This element determines the frequency of the garbage collection process. By default, the server only performs GC when the JS engine is not busy.
Page 166 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference MaxLatency The maximum latency, in milliseconds, of incoming messages in a live stream. When a server-side script injects a data message into a live stream, this setting determines the timestamp of the message. If the injection time is larger than , the server adds the time difference between the last message time and the injection time to the timestamp MaxLatency of the data message.
Page 167 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference See also StorageDir DuplicateDir ResyncDepth LockTimeout AutoCommit MaxProperties MaxQueueDelay Specifies how often the server will flush the message queue, in milliseconds. The default value is 500 milliseconds. See also Queue MaxQueueSize FlushOnData...
Page 168 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference See also Subscribers LoCPU HiCPU MaxSize (Recording) Specifies the maximum size, in kilobytes, of a recorded file. The value -1 means there is no maximum size. The value 0 disables recording. The default value is -1. Set this parameter when you deploy a DVR application to prevent the disk from exceeding its capacity.
Page 169 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference See also RuntimeSize MaxGCSkipCount ScriptLibPath FileObject XMLSocket NetConnection (ScriptEngine) MaxTimeOut (Connections) This element defines the maximum time for a transfer to be completed. The default time is 60 seconds. Operations such as DNS lock-ups may take more time.
Page 170 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Use this element to restrict the lengths of outgoing SSAS-initiated NetConnection URLs. For incoming requests, use element in the Server.xml file. MaxUrlLength Example <MaxUrlLength>65536</MaxUrlLength> See also Security MaxWait This element specifies the number of seconds to wait before the server sends data to the client. Increasing this number provides a more accurate bandwidth figure, but it also forces the client to wait longer.
Page 171 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Example <MinBufferTime>2000</MinBufferTime> See also Recorded MinGoodVersion Specifies the minimum accepted version of SWF verification allowed by the server. The default value is 0, which allows the current and all future versions. Example <MinGoodVersion>0</MinGoodVersion>...
Page 172 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference To add methods, use a comma-delimited list of method names in the sub-elements. <Method><Allow> The default is to allow the method for NetConnection RPCs. onStatus Contained elements Method Example <NetConnection>...
Page 173 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference OutChunkSize Specifies the RTMP chunk size in bytes to use in all streams for this application. The server breaks stream content into chunks of this size. Larger values reduce CPU usage but cause larger writes that can delay other content on lower bandwidth connections.
Page 174 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Value Description The default value. Lookup events are handled by the server. You cannot use Server-Side None ActionScript to distribute peer introductions or filter peer introductions. Partial The server automatically handles peer lookup events for clients connected to the same core process.
Page 175 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference The following table lists descriptions of the contained elements. Value Description Specifies the level at which application instances are assigned to core processes. Scopes have an enclosing Scope relationship with a strict ordering: adaptors contain virtual hosts, which contain applications, which contain instances, which contain clients.
Page 176 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Queue Container element; contains elements that configure the settings of the message queue. A message queue is used to buffer incoming messages from the publisher so that the server can send messages in chunks to the subscribers. You can disable queuing so that individual messages are immediately sent to subscribers.
Page 177 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Redirect Container element. The elements nested within this container configure the settings for redirecting the HTTP connection. Contained elements Allow UnrestrictedAuth ResyncDepth This element instructs the server to resynchronize a shared object file. The shared object is resynchronized when its version number is greater than the head version minus the current version.
Page 178 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Configures RPCs (remote procedure calls) for each class. By default, all methods are rejected. Only methods that are explicitly listed for each class are allowed. This whitelisting approach is more secure than a blacklist. Contained Elements NetConnection (RPC) Stream...
Page 179 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Value Description All application instances in an adaptor run together in a process. adaptor vhost All application instances in a virtual host run together in a process. This is the default value. All instances of a single application run together in a process.
Page 180 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Contained elements AdaptorId RuntimeSize MaxGCSkipCount MaxTimeOut (JSEngine and ScriptEngine) ScriptLibPath FileObject XMLSocket NetConnection (ScriptEngine) Security ScriptLibPath A list of paths delimited by semicolons instructing the server where to look for server-side scripts loaded into a main.asc file with the method.
Page 181 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference SendDuplicateStart Specifies whether status message is sent for all commands, including play, seek, and unpause. NetStream.Play.Start If set to , only the play command receives the start message. false Example <SendDuplicateStart>true</SendDuplicateStart>...
Page 182 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference The default bandwidth is 10,000,000 bytes per second. You can configure this value in the section of XML and in the section of XML. The values Bandwidth BandwidthCap in the section can be overridden, but the values in the section can not.
Page 183 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference StartClockOnPublish Specifies whether the stream time is sensitive to the difference between publish time and the arrival of the first stream message. The default value is false To use dynamic, multibitrate streaming, leave this value false See also Live (StreamManager)
Page 184 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Contained elements StorageDir DuplicateDir EventsDir CachePrefix CacheUpdateInterval MaxBufferRetries ThrottleBoundaryRequest ThrottleLoads ThrottleDisplayInterval EnhancedSeek KeyFrameInterval MaxStreamsBeforeGC Audio Live (StreamManager) SendDuplicateStart SendDuplicateOnMetaData MaxSize (Recording) MaxSizeCap MaxDuration MaxDurationCap Subscribers This element instructs the server to combine sound samples only if there are more than the default number of subscribers to that stream.
Page 185 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference The default value is 8. Example <ThrottleBoundaryRequest enable="false">8</ThrottleBoundaryRequest> See also ThrottleDisplayInterval ThrottleLoads ThrottleDisplayInterval Controls the interval at which the server displays the throttle queue length. The default value is 64, which means the server displays the message 1 out of 64 times when the throttle queue is full.
Page 186 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Type Specifies the type of proxy being connected to. The value for this element can be . The default is HTTP SOCKS5 HTTP Example <Type>HTTP</Type> See also Host Port Tunnel Username Password...
Page 187 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Contained elements Exception Username Specifies the user name for connecting to the edge. See also Host Port Type Tunnel Password Verbose This element determines whether or not the server outputs verbose information during HTTP operations. Example <Verbose>false</Verbose>...
Page 188 WindowsPerAck Controls how many messages can be sent before receiving an acknowledgement from the other end. Note: Adobe recommends that you do not change the value of this element. WriteBufferSize Specifies in kilobytes the size of the write buffer. The default size is 16 KB.
Page 189: Logger.xml File
The elements nested within this container configure the Application log file settings. Contained elements Directory Time Rotation AuthEvent Container element. The elements in this section configure the AuthEvent log file settings. For more information, see the Plug-in Developer Guide at www.adobe.com/go/learn_fms_plugindev_en. Last updated 11/28/2012...
Page 190 Fields Delimiter QuoteFields EscapeFields AuthMessage Container element. The elements in this section configure the AuthMessage log file settings. For more information, see the Developer Guide at www.adobe.com/go/learn_fms_plugindev_en. Contained elements Directory Time Rotation core Container element. The elements nested within this container configure the core log settings.
Page 191 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Directory Specifies the directory where the log files are located. By default, the log files are located in the logs directory in the server installation directory. Example <Directory>${LOGGER.LOGDIR}</Directory> See also Time Rotation DisplayFieldsHeader...
Page 192 The keyword * specifies that all fields are to be logged. Fields without data are left empty. Adobe recommends that you include the following fields in the fields to be logged: the type, category, date, and time fields.
Page 193 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference History Specifies the maximum number of log files to keep. The files are named access.01.log, access.02.log, access.03.log, and so on. The default number of files to retain is 5. Example <History>5<History>...
Page 194 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference See also Schedule History Rename QuoteFields Formatting element. Specifies whether or not to use quotation marks to surround those fields in the log file that include a space. This element can be set to .
Page 195: Server.xml File
FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference If the attribute is , the timestamp causes the file to rotate every midnight. type hh:mm 00:00 <Schedule type="hh:mm"></Schedule> If the attribute is , rotation occurs when the duration of the log exceeds a specified length. The duration type duration is specified in minutes.
Page 196 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference ACCP Container element. The elements nested within the container configure the Admin Core Communication Protocol (ACCP). Flash ACCP Media Administration Server and the active cores communicate over ACCP. This protocol is also used for collecting performance metrics and issuing administrative commands to Flash Media Server cores.
Page 197 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Example <AdminElem>true</AdminElem> See also Process Allow Deny Order AdminServer Container element. The elements nested within the container configure Flash Media Administration Server. AdminServer Contained elements RTMP (AdminServer) HostPort SocketGC Process AdminElem Allow...
Page 198 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference AllowedVideoLag The number of milliseconds the server holds audio messages in the recording buffer while waiting for a video message. This lag allows the server to sort timestamps before flushing the buffer to disk when video is delayed. The default value is 5. Application Container element.
Page 199 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference AutoCloseIdleClients Container element. Determines whether or not to automatically close idle clients. Set the attribute to to close idle clients. If the attribute is omitted or set to , the feature is enable true enable...
Page 200 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Checkpoints Enables logging checkpoint events. Checkpoint events log bytes periodically from the start to the end of an event. The following are available as checkpoint events: , and connect-continue play-continue publish-continue This element contains the enable attribute which you can set to...
Page 201 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Example <Content type="Streams">true</Content> <Content type="SWF">false</Content> See also FilePlugin Core Container element. The elements nested within the container configure the RTMP protocol for the FMSCore.exe process. Core Contained elements MinIOThreads MaxIOThreads SocketTableSize SocketOverflowBuckets...
Page 202 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference CPUMonitor Specifies, in seconds, how often the server monitors CPU usage. The default interval is 1 second. The value cannot be set to less than 1 second. Example <CPUMonitor>1</CPUMonitor> See also ResourceLimits CrossDomainPath...
Page 203 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference DiffServ Flash Media Server 3.5.2 Use this element with the element to specify the DiffServ field for all sockets that connect to the RTMP DiffServMask listener (these include tunneling and HTTP proxy sockets). There is little use for this unless you have set up a DSCP domain.
Page 204 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Edge Container element. The elements nested within the container configure the RTMP protocol for the fmsedge process. Edge Contained elements MinIOThreads MaxIOThreads SocketTableSize SocketOverflowBuckets Edge (ResourceLimits) Container element. The elements nested within the container configure resources for the fmsedge process.
Page 205 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference EnableAggMsgs (raw) Specifies whether the RAW adaptor generates aggregate messages (true) or not (false). Aggregating messages improves server performance. The default value is true. Example <EnableAggMsgs>true</EnableAggMsgs> See also EnableSystemLogging Enables logging of high severity entries to the system log (true) or not (false).
Page 206 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference FLVCache Container element. Contains elements that control the size and features of the recorded media cache. Contained elements FileCheckInterval MaxSize (FLVCache) MaxKeyframeCacheSize FLVCachePurge Located in the container. ResourceLimits Specifies how often, in minutes, to remove unused files from the cache. The default value is 60 minutes. The minimum value is 1 minute.
Page 207 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference GCInterval Located in the container. HandleCache Specifies in minutes how often to remove idle handles. The default is 60 minutes. Example <GCInterval>60</GCInterval> Located in the containers. Process Specifies the group ID of the process. If you do not specify a , the server or Administration Server runs as root.
Page 208 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference HeapSize Specifies the maximum size, in kilobytes, of the shared memory heap used for an IPC (interprocess communication) message queue. The default value for this element varies according to its container. Container Default Value Description...
Page 209 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Contained elements MinConnectionThreads MaxConnectionThreads MaxConnectionQueueSize HandleCache Httpd Specifies how the built-in webserver is stopped and started. By default the attribute is set to enabled . By default, the variable is set to in the fms.ini file.
Page 210 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference The elements nested within the container configure the large memory pool, which caches large chunks LargeMemPool of memory within the server to increase the performance of large allocations. Contained elements MaxCacheUnits MaxCacheSize MaxUnitSize...
Page 211 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Contained Elements LockoutLimit MaxFailures RecoveryTime See also Security LogInterval Specifies how often to log a checkpoint, in seconds. This value should be larger than the value for . If CheckInterval the value is smaller, the server logs a checkpoint every check interval.
Page 212 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Contained elements CoreGC CoreExitDelay MaxAge Located in the , and containers. MessageCache SmallMemPool LargeMemPool SegmentsPool This element defines the maximum reuse count before the cache unit is freed. The default count is 1,000,000. Example <MaxAge>1000000</MaxAge>...
Page 213 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Example <MaxCacheSize>100</MaxCacheSize> MaxCacheUnits Located in the , and containers. MessageCache SmallMemPool LargeMemPool SegmentsPool This element defines the maximum number of free units in the cache. Keep in mind that the number of free units may be less than maximum if the value of the limit is reached.
Page 214 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference MaxDataSampleDescriptions Located in the container. Recording Each change in codec for a content type has a sample description. For example, two different data encoding formats each have their own sample description. The server allocates space for sample descriptions when it creates a file. If the encoding format type changes more than the number of available descriptions, the server stops recording.
Page 215 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference MaxIdleTime Located in the container. AutoCloseIdleClients Specifies the maximum idle time allowed, in seconds, before a client is disconnected. The default value is 3600 seconds (60 minutes). If you set a value of 60 or less, the server uses 1200 seconds (20 minutes). A low value may cause unneeded disconnections.
Page 216 By default, Flash Media Server does not count the number of requests made to the File plug-in or responses returned from the File plug-in. If necessary, you can use this value to identify problems with the File plug-in. Adobe generally recommends keeping the default value of 0.
Page 217 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Specifies the maximum size of the recorded media cache in megabytes. The default value is 500 MB. This value shares memory with the running process and has a limit of 2 GB in Windows and 3 GB in Linux on 32-bit configurations. On 64-bit configurations, the file memory available to the process is only limited by the amount of RAM.
Page 218 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference MaxUnitSize Located in the , and containers. MessageCache SmallMemPool LargeMemPool SegmentsPool Specifies the maximum size, in kilobytes, of a memory chunk allowed in a memory pool. The default size is 16 KB. Flash Media Server has several memory pools (distinct from the recorded media cache) that hold memory in chunks.
Page 219 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Contained elements MaxCacheUnits MaxCacheSize MaxUnitSize FreeRatio GlobalRatio MaxAge UpdateInterval FreeMemRatio MinConnectionThreads Located in the containers. HTTP RTMP (Connector) Specifies the minimum number of threads in the pool for I/O operations. The default is 1 multiplied by the number of processors.
Page 220 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Example <ECCP> <MinIOThreads>0</MinIOThreads> </ECCP> Container element. elements configure how the server plays and records MP4, F4V, MOV, and other MP4 file types. Contained elements Playback Recording MsgPoolGC Specifies how often the server checks for content in and removes content from the global message pool. The default interval for checking and removing content is 60 seconds.
Page 221 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Order Located in the container. AdminServer Specifies the order in which to evaluate the elements. Allow Deny Example To process the request if not in or in , set: <Deny>...
Page 222 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Contained elements ProcVMSizeMonitorInterval The monitoring interval for process virtual memory use, in seconds. The default value is 60. ProcVMSizeNominal The log notification threshold for reverting to a nominal process virtual memory use, in megabytes, after the threshold has been triggered.
Page 223 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Flash Media Server supports a RAW (Record and Watch) file format that records media into configurable chunks that can be streamed to any version of Flash Player. The RAW file format enables you to serve long-length, multi-bitrate DVR streams without running into performance issues.
Page 224 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference RecordsNumber The number of records in the log queue. If an attempt to open the log fails and the number of records in the queue is greater than or equal to this number, the core process is shut down.The default value of -1 allows an unlimited number of records.
Page 225 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference RetrySleep Number of milliseconds the server waits before retrying to open a log file. Relevant when opening a log file fails. The default value is 100 ms. Root Container element. element is a container for all the other elements in the Server.xml file.
Page 226 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference RTMPE Located in the container. RTMP Specifies whether Encrypted Real-Time Messaging Protocol (RTMPE) can be used to connect to the Administration Server. (RTMPE also covers RTMPTE.) The default value is .
Page 227 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference ServerDomain Specifies the host name (with the domain) of the server computer. The server uses this value to set the hostname in the referrer header tag when making a net connection to a remote server. If this element is empty the hostname field is empty in referrer header.
Page 228 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Example <Admin> <SocketOverflowBuckets>-1</SocketOverflowBuckets> </Admin> SocketRcvBuff The size of the client socket receive buffer, in bytes. The default value is 0, which tells the server to use the operating system default values. You should explicitly set this value only if you have a very high bandwidth connection that requires a large socket buffer.
Page 229 MD5 hashing, and sort ciphers by strength from highest to lowest level of encryption. Important: Contact Adobe Support before changing the default settings. The cipher list consists of one or more cipher strings separated by colons. Commas or spaces are also acceptable separators, but colons are normally used.
Page 230 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference The components can be combined with the appropriate prefixes to create a list of ciphers, including only those ciphers the server is prepared to accept, in the order of preference. Example This cipher string instructs the server to accept all ciphers except those using anonymous or ephemeral Diffie-Hellman key exchange.
Page 231 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Encryption methods Description eNULL No encoding DES encoding 3DES Triple-DES encoding RC4 encoding RC2 encoding IDEA IDEA encoding NULL No encryption All export ciphers (40-bit encryption) Low-strength ciphers (no export, DES) MEDIUM 128-bit encryption HIGH...
Page 232 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Example <SSLRandomSeed>16</SSLRandomSeed> SSLSessionCacheGC Located in the container. Specifies how often to check for and remove expired sessions from the server-side session cache. Example <SSLSessionCacheGC>5</SSLSessionCacheGC> SSLVerifyCertificate Located in the container. SSLClientCtx Specifies whether the certificate returned by the server should be verified.
Page 233 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference • F4F (processed by the library specified by the sub-element) • ID3 (processed by the library specified by the sub-element) • MP3 (processed by the library specified by the sub-element) •...
Page 234 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Example The following example allows SWF files from either the C or the D directory to be authenticated: <SWFFolder>C:\SWFs;D:\SWFs</SWFFolder> SWFVerification Container element. Contains elements that configure how SWF files connecting to an application are verified. Contained elements SWFFolder DirLevelSWFScan...
Page 235 For more information, see the method in the Flash Media Server Plug-in API Reference available getConfig() at www.adobe.com/go/learn_fms_pluginapi_en. VirtualDirectoryForFile Enables virtual directory mappings for File objects. The default is disabled. If you map File objects in the Application.xml file but don’t have the feature enabled in the Server.xml file, you'll see the following message in the log: "Virtual directories for file objects is not supported due to the Server level security...
Page 236: Users.xml File
HTTP commands for access by creating a comma-separated list of the commands. The value authorizes the administrator to use all HTTP commands. However, Adobe does not recommend this usage as it creates a security risk.
Page 237 IP addresses. Whenever possible, use the IP addresses in the element to improve the server’s Allow performance when processing connection requests. Example <Allow>foo.yourcompany.com, adobe.com, 10.60.1.133, 10.60</Allow> See also Password Deny (User) Order (User) Deny (HTTPCommands)
Page 238 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference See also Password Allow (User) Order (User) Enable This element enables or disables the use of HTTP requests to execute administrative commands. Setting this element enables HTTP requests to execute administrative commands. To disable administrative access through the use of HTTP requests, do not set this element.
Page 239 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Example The default sequence means that administrative access is allowed unless the user is specified in the Allow, Deny Allow list of commands and not in the list: Deny <Order>Allow,Deny</Order>...
Page 240: Vhost.xml File
Each virtual host must have its own directory inside the adaptor directory. The name of the directory must be the actual name of the virtual host, such as streaming.adobe.com. Each defined virtual host must be mapped to a DNS (domain name server) entry or another name resolution, such as a WINS address or a hosts file, that specifies an IP address on the server computer.
Page 241 Example <Alias name="abc">abc.adobe.com</Alias> If the name of this virtual host is “abc.adobe.com”, but you wish to connect by simply specifying “abc”, then specify the alias . Keep in mind that must still map to the same IP address as “abc.adobe.com”.
Page 242 XML configuration files reference This example allows connections only. localhost <Allow>all</Allow> This example allows connections from all domains. Adobe does not recommend the use of ; it may create a security risk. See also Anonymous AllowOverride Specifies whether overriding edge autodiscovery is allowed by specifying the protocol.
Page 243 • In Windows, the default location is C:\Program Files\Adobe\Flash Media Server 4\applications. AppsDir • In Linux, the default location is /opt/adobe/fms/applications. Note: If you use this tag to map to a network drive, see “Mapping directories to network drives” on page 50 for additional information.
Page 244 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Set the attribute to to close idle clients. If the attribute is omitted or set to , the feature is enable true enable false disabled. The default value is false A client is active when it is sending or receiving data.
Page 245 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference You must enable checkpoint events at the server level in the Server.xml file. You can disable checkpoints at the vhost and application level in the Vhost.xml and Application.xml files. You can also override the logging interval at the vhost and application levels.
Page 246 Client.virtualKey entries in the Server-Side ActionScript Language Reference. Stream.setVirtualPath() For more information, see the “Configuring content storage” section of the Configuration and Administration Guide at www.adobe.com/go/learn_fms_content_en. See also VirtualKeys LocalAddress This element binds an outgoing edge connection to a specific local IP address.
Page 247 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference MaxAggMsgSize Specifies the size in bytes of aggregate messages returned from the edge cache. (Aggregate messages must be enabled.) The default size is 65,536. This setting only applies to messages retrieved from the disk cache. Aggregate messages received directly from the origin server are returned as is and their size is determined by the origin server settings for aggregate message size.
Page 248 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference See also MaxConnections MaxAppInstances MaxStreams MaxSharedObjects AppInstanceGC MaxIdleTime Specifies the maximum idle time allowed, in seconds, before a client is disconnected. The default idle time is 3600 seconds (60 minutes). If you set a value lower than 60 seconds, the server uses the value 1200 seconds (20 minutes).
Page 249 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Mode element configures whether the server runs as an origin server or as an edge server. Mode element can be set to . The default setting is Mode local remote local •...
Page 250 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Path Specifies the physical location of the proxy cache. By default, the location is RootInstall/cache/. The value must be an absolute path. Relative paths are ignored and the server uses the default folder. See also Proxy Container element.
Page 251 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference The connection syntax for this element is flexible, as demonstrated in the following examples. Examples This example shows how you can configure the edge to route all connections to the host to the host <Proxy>...
Page 252 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference • Specifying instructs the edge to use a secure outgoing connection, even if the incoming connection was not rtmps secure. You can override the security status for a connection mapping by specifying a attribute in a protocol RouteEntry...
Page 253 MD5 hashing, and sort ciphers by strength from highest to lowest level of encryption. Important: Contact Adobe Support before changing the default settings. The cipher list consists of one or more cipher strings separated by colons. Commas or spaces are also acceptable separators, but colons are normally used.
Page 254 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference This cipher list instructs the server to accept all ciphers but place them in order of decreasing strength. This sequencing allows clients to negotiate for the strongest cipher that both they and the server can accept. <SSLCipherSuite>ALL:+HIGH:+MEDIUM:+LOW:+EXP:+NULL</SSLCipherSuite>...
Page 255 Streams virtual directory mapping. For more information, see the “Configuring content storage” section of the Configuration and Administration Guide at www.adobe.com/go/learn_fms_content_en. Examples The following configuration maps all streams whose names begin with to the physical directory c:\data. The...
Page 256 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference The following configuration maps streams whose paths begin with to the folder common/ C:\flashmediaserver\myapplications\shared\resources. <Streams>common;C:\flashmediaserver\myapplications\shared\resources\</Streams> If the application “videoConference” refers to an item and the application common/video/recorded/june5 “collaboration” refers to , they both point to the same item common/video/recorded/june5 C:\flashmediaserver\myapplications\shared\resources\video\recorded\june5\.
Page 257 FLASH MEDIA SERVER 4.5 CONFIGURATION AND ADMINISTRATION XML configuration files reference Contained elements WaitTime Specifies length to wait in milliseconds for edge autodiscovery. The number must be long enough to establish a TCP connection, perform a UDP broadcast, collect the UDP responses, and return an XML response. Do not set this number too low.

This manual is also suitable for:

Flash media streaming server

Adobe 65029121 - Flash Media Streaming Server Configuration And Administration Manual

Chapter 1: Deploying the Server

Chapter 2: Configuring the Server

Chapter 3: Using the Administration Console

Chapter 4: Monitoring and Managing Log Files

Chapter 5: Administering the Server

Chapter 6: Using the Administration API

Chapter 7: XML Configuration Files Reference

Quick Links

Related Manuals for Adobe 65029121 - Flash Media Streaming Server

Summary of Contents for Adobe 65029121 - Flash Media Streaming Server

This manual is also suitable for:

Table of Contents