Administration API entries

addAdmin()

RTMP/E

addAdmin(username:String, password:String [,scope:String]): Object

HTTP

http://www.example.com:1111/admin/addAdmin?auser=aUsername&apswd=aPassword&user|username=username&pass|password=password[&scope=scope]

Adds an administrator to the system. The administrator can be a server administrator or a virtual host administrator depending on which parameters you pass. If the administrator already exists, this method fails. Otherwise, the administrator is added and the Users.xml file is updated with the new values. (Virtual host administrators are added to the Users.xml file in a specific virtual host folder.)

You must be a server administrator to add server administrators or to add administrators for virtual hosts other than the one currently connected to.

Availability

Flash Communication Server 1.0.

Parameters

user|username
A String indicating the user name of the administrator being added.

pass|password
A String indicating the password of the administrator being added. The password is encoded before it is written to the Users.xml configuration file. If the scope parameter has a virtual host specified, the new administrator is added to the Users.xml file of the virtual host.

aUsername
A String indicating the username of the administrator making the call.
Note: In the RTMP/E call, the username and password of the administrator making the call are passed in the NetConnection.connect() call.

aPassword
A String indicating the password of the administrator making the call.

scope
A String indicating whether the administrator is a server administrator or a virtual host administrator, and for which virtual host. To add a server administrator, specify server. To add an administrator to the virtual host to which you’re connected, omit this parameter. To add a virtual host administrator to a different virtual host, specify the virtual host as adaptor_name/virtual_host_name.
Note: The parameter data types are relevant only for RTMP/E calls.

Returns

RTMP/E
If the call succeeds, the server sends an information object with a level property of status and a code property of NetConnection.Call.Success. If the call fails, the server sends an information object with a level property of error and a code property of NetConnection.Admin.CommandFailed or a more specific value, if available. The information object also includes a timestamp property indicating the date and time the call was made.

HTTP
The call returns XML with the following structure:
<result> 
    <level> 
    <code> 
    <timestamp> 
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Example

The following three examples show how you can specify parameters in a call to the addAdmin() method over RTMP:

nc_admin = new NetConnection(); 
nc_admin.connect("rtmp://localhost:1111/admin", "JLee", "x52z49ab"); 
 
/* Adds a server administrator named "GLee" with password "boat4907" */ 
nc_admin.call("addAdmin", new onAddAdmin(), "GLee", "boat4907", "server"); 
 
/* Adds a virtual host administrator named "ChrisM" with password "tree2981" */ 
nc_admin.call("addAdmin", new onAddAdmin(), "ChrisM", "tree2981"); 
 
/* Adds a virtual host administrator "DHong" with password "wate3235" */ 
/* for vhost tree.oak.com */ 
nc_admin.call("addAdmin", new onAddAdmin(), "DHong", "wate3235", "_defaultRoot_/¬ tree.oak.com");

addApp()

RTMP/E

addApp(appname:String) : Object 

HTTP

http://www.example.com:1111/admin/addApp?auser=username&apswd=password&app|appname=applicationname

Adds a new application to the virtual host you are connected to by creating the required directory for the new application in the directory tree. Once the directory for the new application is created, you (or another administrator with file system access) can put any required server-side scripts in the directory. The client-side code uses the new application directory in the URI parameter of the NetConnection.connect call.

A virtual host may have multiple application directories. This application is created in the first application directory specified in the XML configuration file.

Availability

Flash Communication Server 1.0.

Parameters

app|appname
A String indicating the name of the application to be added.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server returns an Object with a level property of status and a code property of NetConnection.Call.Success.

If the call fails, the server returns an Object with a level property of error and a code property of NetConnection.Admin.CommandFailed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
The call returns XML with the following structure:
<result> 
    <level></level> 
    <code></code> 
    <timestamp></timestamp> 
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call. The XML may contain a description element if available.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Example

The following example shows a call to add the ChatApp application to the connected virtual host:

nc_admin = new NetConnection(); 
nc_admin.connect("rtmp://localhost:1111/admin", "JLee", "x52z49ab"); 
nc_admin.call("addApp", new onAddApp(), "ChatApp");

addVHostAlias()

RTMP/E

addVHostAlias(vhost:String, alias:String, persist:Boolean) : Object

HTTP

http://www.example.com:1111/admin/addVHostAlias?auser=username&apswd=password&vhost=hostname&alias=alias&persist=value

Adds an alias to a virtual host. Aliases are alternative names for virtual hosts that are used as targets by incoming Flash Media Server connections. When you remove an alias, that name is no longer available for incoming connections.

Availability

Flash Media Server 2.0.

Parameters

vhost
A String indicating the virtual host to which to add an alias.

alias
A String indicating the alias name to add to the specified virtual host.

persist
A Boolean value indicating whether the alias change will be written to the configuration file to last beyond the virtual host’s next restart (true), or whether this alias will be lost on virtual host restart (false).

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server returns an Object with a level property of status and a code property of NetConnection.Call.Success. If the call fails, the server returns an Object with a level property of error and a code property of NetConnection.Admin.CommandFailed.

HTTP
A call returns XML with the following structure:
<result> 
    <level></level> 
    <code></code> 
    <timestamp></timestamp> 
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Example

nc_admin = new NetConnection(); 
nc_admin.connect("rtmp://localhost:1111/admin", "JLee", "x52z49ab"); 
nc_admin.call("addVHostAlias",new Result(),"myvhost","myalias",true);

approveDebugSession()

RTMP/E

approveDebugSession(appInst:String, PIN:Number) : Object
Note: This method is not supported over HTTP.

Approves a pending debug session’s request to connect to a selected application. Once approved and permitted, the debug session may connect to its application and act as a regular client. Connecting to an application with a debug session allows you to view the streams and shared objects for an application through the Administration Console.

Availability

Flash Media Server 2.0.

Parameters

appInst
A String indicating the application and instance name that has a pending debug connection to approve.

PIN
A number indicating the debug session personal identification number. Each debug connection issues a debug number when queueing to connect to an application. This same number is included on this API. When this API is processed, the PIN numbers are matched and the corresponding connection is allowed to connect. This is a security measure to prevent unauthorized users from using the debug connection.

Keep in mind that 0 is not a valid PIN value. To maintain security, PIN numbers should not be able to be easily guessed. PIN numbers must be non-zero and must be within the range of +/- (2^31 - 1) that is between positive or negative 2147483648. If there is a pending connection with a given PIN, and another connection arrives with the same PIN while the original is still waiting, the second connection with the same PIN will be rejected as a security measure.

Returns

RTMP/E
If the call succeeds, the server returns an Object with a level property of status and a code property of NetConnection.Call.Success. If the call fails, the server returns an Object with a level property of error and a code property describing the failure.

Example

The following is an example of a debug session:

nc_admin.connect("rtmp://serverName/appName%3F%5Ffcs%5Fdebugreq%5F%3D1234"); 
// The original string is _fcs_debugreq_=1234.

The following is an example of a Debug approval request:

nc_admin.call("approveDebugSession", null, "appName/instName", 1234);

broadcastMsg()

RTMP/E

broadcastMsg(scope:String, method:String [, arg0, ..., argN])

HTTP

http://localhost:1111/admin/broadcastMsg?auser=admin&apswd=admin&scope="App:accept"&method="bounceback"&arg0="hello"&arg1="world"

Broadcasts a message to specified clients (either server, adaptor, vhost, application, or application instance wide).

Availability

Flash Communication Server 1.0.

Parameters

scope
A String indicating the broadcast audience. It can be any of the following:
  • “Server” (server-wide broadcast)

  • “VHost” (current vhost-wide broadcast)

  • “App:<name>” (application-wide broadcast on current vhost)

  • “App:<name>/<instance>” (instance-wide broadcast on current vhost)

  • “Adaptor[:<name>]” (a specific, adaptor-wide broadcast)

  • “Adaptor[:<name>]/VHost[:<name>]” (a specific vhost-wide broadcast on the specified adaptor)

  • “Adaptor[:<name>]/VHost[:<name>]/App:<name>” (an application-wide broadcast on the specified adaptor and vhost

  • “Adaptor[:<name>]/VHost[:<name>]/App:<name>/<instance>” (an instance-wide broadcast on the specified adaptor, vhost, and application)

method
A String indicating the remote method that is invoked on all the broadcast recipients.

arg0, ..., argN
Positional arguments (arg0, arg1, arg2, etc.) passed in as the remote method invocation arguments. There can be multiple arguments, but they must be in the form argN, where N is the argument position. The arguments must be numbered contiguously.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status and a code property of NetConnection.Call.Success

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Admin.CommandFailed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure. If the specific administrator does not exist, this method fails.

HTTP
A call returns XML with the following structure:
<result> 
    <level></level> 
    <code></code> 
    <timestamp></timestamp> 
</result>

Example

nc_admin = new NetConnection(); 
nc_admin.connect("rtmp://localhost:1111/admin", "JLee", "x52z49ab"); 
nc_admin.call("broadcastMsg", new Result(), "App:test", "testMethod", "Hello", "World"); 

changePswd()

RTMP/E

changePswd(admin_name:String, password:String [,scope:String]) : Object

HTTP

http://www.example.com:1111/admin/changePswd?auser=username&apswd=password&username=name &password=password[&scope=scope]

Changes the password for the specified administrator. The password is encoded before it is written to the Users.xml configuration file.

Virtual host administrators can change only their own password.

Availability

Flash Communication Server 1.0.

Parameters

admin_name
A String indicating the name of the administrator whose password is being changed.

username
A String indicating the name of the administrator whose password is being changed.

password
A String indicating the administrator’s new password.

scope
A String indicating whether the administrator is a server administrator or virtual host administrator, and for which virtual host.

To change the password for the specified administrator on the virtual host to which you’re connected, omit this parameter. To change the password for the specified administrator on a different virtual host, specify adaptor_name/virtual_hostname.

To change a server administrator’s password, specify server.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status and a code property of NetConnection.Call.Success.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Admin.CommandFailed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

If the specified administrator does not exist, this method fails.

HTTP
A call returns XML with the following structure:
<result> 
    <level></level> 
    <code></code> 
    <timestamp></timestamp> 
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Example

nc_admin = new NetConnection(); 
nc_admin.connect("rtmp://localhost:1111/admin", "JLee", "x52z49ab"); 
 
/* Change password for server administrator named "ASilva" to "cbx5978y" */ 
nc_admin.call("changePswd", new onChangePswd(), "ASilva", "cbx5978y", "server"); 
 
/* Change password for virtual host administrator "JLee" to "kbat3786" on */ 
/* virtual host "tree.oak.com" */ 
nc_admin.call("changePswd", new onChangePswd(), "JLee", "kbat3786", "_defaultRoot_/¬ tree.oak.com");

gc()

RTMP/E

gc() : Object

HTTP

http://www.example.com:1111/admin/gc?auser=username&apswd=password

Forces collection and elimination of all server resources that are no longer used, such as closed streams, instances of applications, and nonpersistent shared objects. This operation is performed within about one second of the call.

You must be a server administrator to perform this operation.

Availability

Flash Communication Server 1.0.

Parameters

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status and a code property of NetConnection.Call.Success.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Admin.CommandFailed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
A call returns XML with the following structure:
<result> 
    <level></level> 
    <code></code> 
    <timestamp></timestamp> 
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call. Some XML might also have a description element that contains a string describing the cause of the failure.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

disconnectUsers()

RTMP/E

disconnectUsers(appInst:String, client:String | clients:Array) : Object

HTTP

http://www.example.com:1111/admin/disconnectUsers?auser=username&apswd=password&appinst=appname/instname&clients=clientid[&clients=clientid]

Disconnects one or more clients from an application.

You must be a server administrator to perform this operation.

Availability

Flash Media Server 3.0.

Parameters

auser
A String specifying the user name of the administrator.

apswd
A String specifying the password of the administrator.

appInst
A String specifying the application name and instance name in the form appname/instname. To disconnect a client from the default instance of an application, include the application name only.

clients
Specifies a client id. The client id is contained in the Server-Side ActionScript Client.id property.

Over RTMP, pass a String containing the id of a single client or pass an Array of multiple client ids.

Over HTTP, to disconnect a single client, use a single clients parameter, as in the following:

http://www.examples.com:1111/admin/disconnectUsers?auser=admin&apswd=admin&appInst=testapp&clients=oAAIAAAA

Over HTTP, to disconnect multiple clients, use a single clients parameter followed by comma-delimited client ids enclosed in brackets. The following code disconnects multiple clients:

http://www.example.com:1111/admin/disconnectUsers?auser=admin&apswd=admin&appInst=testapp&clients=[oAAIAAAA,oAAJAAAA,oAALAAAA]

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status and a code property of NetConnection.Call.Success.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Admin.CommandFailed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
A call returns XML with the following structure:
<result> 
    <level></level> 
    <code></code> 
    <timestamp></timestamp> 
    <data></data> 
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call. Some XML might also have a description element that contains a string describing the cause of the failure.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getActiveInstances()

RTMP/E

getActiveInstances(processID:Number) : Object

HTTP

http://www.example.com:1111/admin/getActiveInstances?auser=username&apswd=password&pid|processID=number

Returns an array of strings that contains the names of all running application instances on the FMSCore process specified by the processID parameter.

Availability

Flash Communication Server 1.0.

Parameters

pid|processID
A number indicating the process identifier of an FMSCore process.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an array of strings containing the names of all running instances of an application on the server or on a specified process.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Admin.CommandFailed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
A successful call returns XML with the following structure:
<result> 
    <level></level> 
    <code></code> 
    <timestamp></timestamp> 
    <data></data> 
</result>

An unsuccessful call returns XML with the following structure:

<result> 
    <level></level> 
    <code></code> 
    <description></description> 
    <timestamp></timestamp> 
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Example

nc_admin = new NetConnection(); 
nc_admin.connect("rtmp://localhost:1111/admin", "JLee", "x52z49ab"); 
nc_admin.call("getActiveInstances", new Result()); 

getActiveVHosts()

RTMP/E

getActiveVHosts([adaptor]);

HTTP

http://www.example.com:1111/admin/getActiveVHosts?auser=username&apswd=password[&adaptor=name]

Returns an array of active virtual hosts defined for the specified adaptor. You must be a server administrator to call this method. A virtual host is active if at least one application running on it is connected.

Availability

Flash Media Server 3.

Parameters

adaptor
A String indicating the user name of the adaptor. If not specified, it is assumed to be _defaultRoot_.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an array of strings containing the names of all the active virtual hosts.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML like the following:
<result> 
    <level>status</level> 
    <code>NetConnection.Call.Success</code> 
    <timestamp>9/23/2007 6:16:40 PM</timestamp> 
    <data> 
        <_0> 
            <vhost_name>vhost1</vhost_name> 
        </_0> 
        <_1> 
            <vhost_name>_defaultVHost_</vhost_name> 
        </_1> 
    </data> 
</result>
Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getActiveVHostStats()

RTMP/E

getActiveVHostStats([verbose]:Boolean) : Object

HTTP

http://www.example.com:1111/admin/getActiveVHostStats?auser=username&apswd=password[&verbose=value][&adaptor=name]

Returns aggregate performance data for all instances for all applications for the active virtual hosts on any active core processes. To return data for virtual hosts on an adaptor, use the optional adaptor parameter. Whenever a virtual host functions among multiple cores, this method displays the statistics for the active core processes. Only server administrators can call this method.

Availability

Flash Media Server 3.

Parameters

verbose
Boolean; true displays the statistics for the applications running on the active virtual host along with the aggregate statistics for the virtual host; false displays only the aggregate statistics of the active virtual host and not the statistics per virtual host. The default value is true.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

adaptor
A String indicating the user name of the adaptor. If not specified, the value is _defaultRoot_.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object containing the active virtual host performance data. The data object has the following properties:

Property

Description

msg_in

Number; total number of messages processed by this virtual host.

msg_out

Number; total number of messages sent by this virtual host.

msg_dropped

Number; total number of messages dropped by this virtual host.

bytes_in

Number; total number of bytes read by this virtual host.

bytes_out

Number; total number of bytes written by this virtual host.

accepted

Number; total number connections accepted by this virtual host.

rejected

Number; total number of connections rejected by this virtual host.

connected

Number; total number of connections currently active.

total_apps

Number; total number of applications that have been created.

total_connects

Number; total number of connections to the server.

total_disconnects

Number; total number of disconnections from the server.

total_instances_loaded

Number; total number of instances that have been loaded.

This property does not represent the total number of active instances loaded. To get the number of active instances loaded, subtract the value of total_instances_unloaded from total_instances_loaded.

total_instances_unloaded

Number; total number of instances that have been unloaded.

bw_in

Number; current bandwidth in, in bytes per second.

bw_out

Number; current bandwidth out, in bytes per second.

server_bytes_in

Number; total number of rtmp bytes read by an SSAS NetConnection

server_bytes_out

Number; total number of rtmp bytes sent by an SSAS NetConnection

tunnel_bytes_in

Number; total number of bytes read through the tunnel.

tunnel_bytes_out

Number; total number of bytes written through the tunnel.

tunnel_requests

Number; number of current requests.

tunnel_idle_requests

Number; number of currently idle requests.

tunnel_idle_responses

Number; number of currently idle responses.

normal_connects

Number; total number of normal connections.

virtual_connects

Number; total number of connections through a remote edge.

group_connects

Number; total number of remote edges that are connected.

service_connects

Number; total number of service connections.

service_requests

Number; total number of services requested.

admin_connects

Number; total number of administrator connections.

debug_connects

Number; total number of debug connections.

swf_verification_attempts

A counter of the number of SWF verification attempts made. Represents the total SWF verification credentials passed to the server for checking. There may be more than one credential presented per connection.

swf_verification_exceptions

A counter of the number of SWF verification exceptions made. Exceptions are allowed through explicit configuration in the Application.xml file that allows certain user agents to bypass the requirement for SWF verification. Every connection allowed as an exception is counted here.

swf_verification_failures

A counter of the number of SWF verification failures. Failures result from the presentation of SWF verification credentials that are found not to be a match for any loaded credential. Each failure corresponds to a disconnection of the presenting connection.

swf_verification_unsupported_rejects

A counter of the number of SWF verification unsupported rejections. When a version of Flash Player that doesn’t support SWF verification connects to an application that requires SWF verification, the unsupported rejection count is increased. Also, the connecting client is disconnected.

swf_verification_matches

A counter of the total number of matches. When an authentic SWF verification credential is presented, this number increases. There may be more than one match per connection.

swf_verification_remote_misses

A counter of the proxy/remote server process’s missed SWF verification attempts. Whenever a proxy/remote server receives a SWF verification attempt it looks to its local cache for valid SWF verification. If it does not locate a match it logs a remote miss and defers to the origin to answer the verification attempt.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result>  
    <level></level>  
    <code></code>  
    <timestamp></timestamp> 
    <data></data> 
</result>

Nested in the data element are elements with each of the properties listed in the RTMP/E returns section.

If the call fails, it returns something like the following:

<result>  
    <level>error</level>  
    <code>Admin.API.InvalidMethod</code>  
    <description>getactivevhoststatss - No such method found!</description>  
    <timestamp>9/13/2007 7:55:58 PM</timestamp>  
</result>
Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getAdaptors()

RTMP/E

getAdaptors() : Object

HTTP

http://www.example.com:1111/admin/getAdaptors?auser=username&apswd=password

Returns an array of adaptors that are defined. You must be a server administrator to call this method.

Availability

Flash Communication Server 1.0.

Parameters

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an array of strings containing the names of all the adaptors.

HTTP
If the call succeeds, it returns something like the following:
<result>  
    <level>status</level>  
    <code>NetConnection.Call.Success</code>  
    <timestamp>7/23/2007 8:25:52 AM</timestamp>  
    <data>  
        <_0>Adaptor2</_0>  
        <_1>_defaultRoot_</_1>  
    </data>  
</result> 

If the call fails, it returns something like the following:

<result>  
    <level>error</level>  
    <code>NetConnection.Connect.Rejected</code>  
    <description>Administrator login failed for user Admin.</description>  
    <timestamp>7/23/2007 8:26:36 AM</timestamp>  
</result>
Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Example

nc_admin = new NetConnection(); 
nc_admin.connect("rtmp://localhost:1111/admin", "JLee", "x52z49ab"); 
nc_admin.call("getAdaptors", new Result());

getAdminContext()

RTMP/E

getAdminContext([adminName:String][, adaptorName:String][, vhostName:String]) : Object

HTTP

http://www.example.com:1111/admin/getAdminContext?auser=username&apswd=password[&adminName=name][&adaptorName=name] [&vhostName=name]

Gets the administrative context for an administrator, including information about the specified user’s administrative permissions, the name of the adaptor and virtual host to which the user is connected, and whether the user is currently connected to Flash Media Server.

Availability

Flash Communication Server 1.0.

Parameters

adminName
A String indicating the name of an administrator.

adaptorName
A String indicating an alternate adaptor, other than _defaultRoot_, on which to find administrators. If not specified, _defaultRoot_ is used.

vhostName
A String indicating an alternate virtual host, other than _defaultVHost_, on which to find virtual host administrators. If not specified, server level admin is used.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object. The data object has the following properties:

Property

Description

admin_type

String; the type of administrator, either server or virtual host.

adaptor

String; name of the adaptor for which the user is an administrator.

vhost

String; name of the virtual host for which the user is an administrator.

connected

String; this property is deprecated and always returns true.

HTTP
If the call succeeds, it returns something like the following:
<result>  
    <level>status</level>  
    <code>NetConnection.Call.Success</code>  
    <timestamp>7/23/2007 8:57:26 AM</timestamp>  
    <data>  
        <admin_type>server</admin_type>  
        <adaptor>_defaultRoot_</adaptor>  
        <vhost>_defaultVHost_</vhost>  
        <connected>true</connected>  
    </data>  
</result> 
 

If the call fails, it returns something like the following:

<result>  
    <level>error</level>  
    <code>NetConnection.Connect.Rejected</code>  
    <description>Administrator login failed for user Admin.</description>  
    <timestamp>7/23/2007 9:00:44 AM</timestamp>  
</result>
Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getAdmins()

RTMP/E

getAdmins(adaptorName:String) : Object

HTTP

http://www.example.com:1111/admin/getAdmins?auser=username&apswd=password&adaptorName=name

Returns an array of all administrators on Flash Media Server. The returned data has two top‑level groups: server-level administrators and virtual host-level administrators. The server-level administrators group is a simple list of names. The virtual host administrators are subdivided by virtual host and each virtual host contains a list of administrator names.

Availability

Flash Media Server 2.0.

Parameters

adaptorName
A String indicating an alternate adaptor, other than _defaultRoot_, on which to find virtual host administrators. If not specified, _defaultRoot_ is used.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an array. The data object has the following properties:

Property

Description

server_admins

Array; an array of administrator names.

admin

String; name of an administrator.

vhost_admins

Array; an array of virtual host names.

admin

String; name of the virtual host for which the user is an administrator.

HTTP
If the call succeeds, it returns something like the following:
<result>  
    <level>status</level>  
    <code>NetConnection.Call.Success</code>  
    <timestamp>7/23/2007 9:05:00 AM</timestamp>  
    <data>  
        <server_admins>  
            <admin>Admin</admin>  
            <admin>John</admin>  
            <admin>Mary</admin>  
        </server_admins>  
        <vhost_admins>  
            <_defaultVHost_>  
                <_0>Kent</_0>  
            </__defaultVHost_>  
        </vhost_admins>  
    </data>  
</result>

If the call fails, it returns something like the following:

<result>  
    <level>error</level>  
    <code>NetConnection.Connect.Rejected</code>  
    <description>Administrator login failed for user Admin.</description>  
    <timestamp>7/23/2007 9:08:25 AM</timestamp>  
</result>
Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getApps()

RTMP/E

getApps([verbose:Boolean][, force:Boolean]):Object

HTTP

http://www.example.com:1111/admin/getApps?auser=username&apswd=password[&verbose=true|false[&force=true|false]]

Returns an array of strings that contains the names of all the applications that are installed. Call addApp() or removeApp() to refresh the cached application list.

Note: Applications that are added or removed using the file system are not reflected in the cached list.

Availability

Flash Communication Server 1.0. The verbose and force parameters are available in Flash Media Server 3.

Parameters

verbose
Boolean; true displays all the applications under a virtual host; false displays the total number of applications. The default value is true.

force
Boolean; true forces a refresh of the cached list of applications and retrieves the list; false retrieves a cached list of applications. If you want to force a refresh, you must specify both the verbose and force parameters. The default value is false.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an array of strings containing the names of all the applications that are installed.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result>  
    <level>status</level>  
    <code>NetConnection.Call.Success</code>  
    <timestamp>7/23/2007 9:10:37 AM</timestamp>  
    <data>  
        <total_apps>3</total_apps>  
        <_0>live</_0>  
        <_1>livetest</_1>  
        <_2>vod</_2>  
    </data>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call. Some XML might also have a description element that contains a string describing the cause of the failure.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getAppStats()

RTMP/E

getAppStats(appname:String):Object

HTTP

http://www.example.com:1111/admin/getAppStats?auser=username&apswd=password&app|appname=name

Gets aggregate performance data for all instances of the specified application.

Beginning with Flash Media Server 3.5, you can dynamically control the core to which an application is sent. Controlling the cores allows load balancing across cores based on their performance counters. In getAppStats, an additional field consisting of the pids and core ids of the cores running the application are sent in the response.

Availability

Flash Communication Server 1.0.

Parameters

appname
A String indicating the name of the application to be added.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object. The data object has the following properties:

Property

Description

accepted

Number; total number of connection attempts accepted by this application.

bytes_in

Number; total number of bytes read by this application.

bytes_out

Number; total number of bytes written by this application.

connected

Number; total number of connections currently active.

launch_time

ActionScript Date object; time the application started.

msg_dropped

Number; total number of messages dropped by this application.

msg_in

Number; total number of messages processed by this application.

msg_out

Number; total number of messages sent by this application.

normal_connects

Number; total number of normal connections.

virtual_connects

Number; total number of connections through a remote edge.

group_connects

Number; total number of remote edges that are connected.

service_connects

Number; total number of service connections.

service_requests

Number; total number of services requested.

admin_connects

Number; total number of administrator connections.

debug_connects

Number; total number of debug connections.

rejected

Number; total number of connection attempts rejected by this application.

bw_in

Number; current bandwidth in, in bytes per second.

bw_out

Number; current bandwidth out, in bytes per second.

total_connects

Number; total number of socket connections to the application since the application was started.

total_disconnects

Number; total number of disconnections from the application since the application was started.

total_instances_loaded

Number; total number of instances that have been loaded since the application started.

This property does not represent the total number of active instances loaded. To get the number of active instances loaded, subtract the value of total_instances_unloaded from total_instances_loaded.

total_instances_unloaded

Number; total number of instances that have been unloaded since the application started.

up_time

Number; time, in seconds, the application has been running.

swf_verification_attempts

A counter of the number of SWF verification attempts made. Represents the total SWF verification credentials passed to the server for checking. There may be more than one credential presented per connection.

swf_verification_exceptions

A counter of the number of SWF verification exceptions made. Exceptions are allowed through explicit configuration in the Application.xml file that allows certain user agents to bypass the requirement for SWF verification. Every connection allowed as an exception is counted here.

swf_verification_failures

A counter of the number of SWF verification failures. Failures result from the presentation of SWF verification credentials that are found not to be a match for any loaded credential. Each failure corresponds to a disconnection of the presenting connection.

swf_verification_unsupported_rejects

A counter of the number of SWF verification unsupported rejections. A version of Flash Player that doesn’t support SWF verification may try to connect to an application that requires SWF verification. When this occurs, the unsupported rejection count is increased and the connecting client is disconnected.

swf_verification_matches

A counter of the total number of matches. When an authentic SWF verification credential is presented, this number increases. There may be more than one match per connection.

swf_verification_remote_misses

A counter of the proxy/remote server process’s missed SWF verification attempts. Whenever a proxy/remote server receives a SWF verification attempt it looks to its local cache for valid SWF verification. If it does not locate a match it logs a remote miss and defers to the origin to answer the verification attempt.

cores

An array containing elements “pid” and “core_id”. The number of elements in the core_id array depends on the number of cores in which the application is running currently.

Following is the output of getAppStats:

<result>  
    <level>status</level>  
    <code>NetConnect.Call.Success</code>  
    <timestamp>7/24/2008 3:50:55 PM</timestamp> 
    <data> 
        <launch_time>7/24/2008 3:21:02 PM</launch_time> 
        <up_time>1792</up_time> 
        <bw_in>0</bw_in> 
        <bw_out>0</bw_out> 
        <bytes_in>3073</bytes_in> 
        <bytes_out>3417</bytes_out> 
        <msg_in>0</msg_in> 
        <msg_out>1</msg_out> 
        <msg_dropped>0</msg_dropped> 
        <total_connects>1</total_connects> 
        <total_disconnects>0</total_disconnects> 
        <connected>1</connected> 
        <normal_connects>1</normal_connects> 
        <virtual_connects>0</virtual_connects> 
        <group_connects>0</group_connects> 
        <service_connects>0</service_connects> 
        <service_requests>0</service_requests> 
        <admin_connects>0</admin_connects> 
        <accepted>1</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_verficiation_exceptions>0</swf_verfication_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>1234</pid> 
                <core_id>0</code_id> 
            </_0> 
            <_1> 
                <pid>5678</pid> 
                <core_id>1</core_id> 
            </_1> 
        </cores>     
    </data> 
</result>

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, the server returns XML with the following structure:
<result>  
    <level></level>  
    <code></code>  
    <timestamp></timestamp> 
    <data></data> 
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Example

The following two examples use an application instance named app_1 on both an origin and an edge server. Use the following URL to call getAppStats() on an origin server:

http://origin.example.com:1111/admin/getAppStats?auser=username&apswd=password &appName=app_1

Use the following URL to call getAppStats() on an edge server:

http://edge.example.com:1111/admin/getAppStats?auser=username&apswd=password&appName=app_1@edge.example.com
Note: To obtain the application name, log in to the edge server on the Administration Console or call getActiveInstances(). When appName=app_1 is run on the edge server, all zeroed information is displayed.

getConfig()

RTMP/E

getConfig(key:String [,scope:String]) : Object

HTTP

http://www.example.com:1111/admin/getConfig?auser=username&apswd=password&key=configkey[&scope=scope]

This API has been deprecated; use getConfig2().

Gets the value of a configuration parameter in a configuration file.

Virtual host administrators can view configuration parameters in the Vhost.xml file and Application.xml files for their own virtual hosts. You must be a server administrator to view most of the configuration parameters for the Server.xml and Adaptor.xml files. For a description of the XML configuration files, see Adobe Flash Media Server Configuration and Administration Guide.

Availability

Flash Communication Server 1.0.

Parameters

key
A String indicating the configuration parameter for which information is retrieved.

A key is specified as a list of subkeys that are delimited by slashes (/). The first subkey specifies the XML configuration file that contains the desired configuration parameter. Subsequent subkeys correspond to tags that are relative to the XML configuration file; the hierarchy and names of the subkeys match the tags in the XML file.

Depending on your permissions, you can get configuration parameters for the following files:

  • For the Server.xml file, specify Admin or Server as the first subkey. All subsequent keys correspond to tags that are relative to the Admin or Server tag in the Server.xml file.

    You must be a server administrator to view configuration parameters in the Server tag.

    Virtual host administrators can view configuration parameters in the Admin tag for their own virtual host only. They might not be able to view certain kinds of sensitive information; for example, they can view the names of other administrators for their own virtual host, but they cannot view those administrators’ passwords or permission settings.

  • For the Adaptor.xml file, specify as the first subkey Adaptor:adaptor_name, where adaptor_name is the name of the adaptor. All subsequent parameters correspond to keys that are relative to the Adaptor tag in the Adaptor.xml file.

  • For the Vhost.xml file, specify as the first subkey Adaptor:adaptor_name/VirtualHost:vhost_name, where adaptor_name is the name of the adaptor and vhost_name is the name of the virtual host. All subsequent keys correspond to tags that are relative to the VirtualHost tag in the Vhost.xml file.

  • For the Application.xml file of an application that is running on the same virtual host to which you connected when you logged on to the administration server, specify as the first subkey Application:app_name, where app_name is the name of the application.

    To get a parameter in the Application.xml file for an application that is running on a different virtual host, specify the full key Adaptor:adaptor_name/VirtualHost:vhost_name/Application:app_name. You must also specify the scope parameter.

    To get the default Application.xml file, specify Application without the colon (:) and the app_name attribute.

scope
A String. To get a configuration parameter in the Server.xml file, Adaptor.xml file, or Vhost.xml file, specify a slash (/).

To get a configuration parameter in the Application.xml file for an application that is running on the same virtual host to which you connected when you logged on to Flash Media Server, omit this parameter.

Note: To determine the adaptor or virtual host to which you’re connected, use the getAdminContext() method.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data object whose properties contain the values of the specified tag.

If the call fails (that is, if the specified configuration parameter isn’t found), the server returns an empty string.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Examples

The following examples show how to get configuration keys in each of the four XML files:

// Establish connection to server. 
nc_admin = new NetConnection(); 
nc_admin.connect("rtmp://localhost:1111/admin", "JLee", "xm1472dy"); 
 
// For a virtual host administrator, find key in Server.xml. 
key = "Admin/Server/UserList/User:JLee/Password"; 
nc_admin.call("getConfig", new onGetConfig(), key, "/"); 
 
// For a server administrator; find key in Server.xml. 
key = "Server/LicenseInfo"; 
nc_admin.call("getConfig", new onGetConfig(), key, "/"); 
 
// Find key in Adaptor.xml. 
key = "Adaptor:_defaultRoot_/HostPortList/HostPort"; 
nc_admin.call("getConfig", new onGetConfig(), key, "/"); 
 
// Find key in Vhost.xml. 
key = "Adaptor:_defaultRoot_/VirtualHost:_defaultVhost_/RecordAccessLog"; 
nc_admin.call("getConfig", new onGetConfig(), key, "/"); 
 
// Find key in Application.xml for an application on the virtual host you 
// connected to when you logged on to the administration server. 
// Note that the previous subkeys and the second parameter "/" are not necessary. 
key = "Application:FinanceApp/RecordAppLog"; 
nc_admin.call("getConfig", new onGetConfig(), key); 
 
// Find key in Application.xml for an application on a different virtual host. 
key = "Adaptor:_defaultRoot_/VirtualHost:www.redpin.com/Application:ChatApp/ ¬ RecordAppLog"; 
nc_admin.call("getConfig', new onGetConfig(), key, "/");

getConfig2()

RTMP/E

getConfig2(key:String, scope:String) : Object

HTTP

http://www.example.com:1111/admin/getConfig2?auser=username&apswd=password&key=configkeyname&scope=scope

Gets the value of a configuration parameter in a specified configuration file. Flash Media Server has six server configuration files from which you can retrieve information: Users.xml, Logger.xml, Server.xml, Adaptor.xml, Vhost.xml, and Application.xml. For a description of the XML configuration files, see Adobe Flash Media Server Configuration and Administration Guide.

Virtual host administrators can view configuration parameters in the Vhost.xml file and Application.xml files for their own virtual hosts. You must be a server administrator to view most of the configuration parameters for the Server.xml and Adaptor.xml files.

Note: It is possible to have more than one XML tag with the same name at the same level in the XML tree. In the configuration file, you should distinguish such tags by using a name attribute in the XML tag (for example, if you have more than one VirtualHost tag: <VirtualHost name="www.redpin.com"></VirtualHost>). When you call the getConfig() method and specify the configuration subkeys, you can indicate which tag you want by specifying the tag name, followed by a colon and the correct name attribute, for example, Admin/Adaptor:_defaultRoot_/VirtualHost:www.redpin.com.

Availability

Flash Media Server 2.0.

Parameters

key
A String indicating the configuration parameter for which information is retrieved.

A key is specified as a list of subkeys that are delimited by slashes (/). The first subkey specifies the XML configuration file that contains the desired configuration key. Subsequent subkeys correspond to tags that are relative to the XML configuration file; the hierarchy and names of the subkeys match the tags in the XML file. If multiple tags exist with the same name and same parent, they can be distinguished by specifying a name attribute and appending the name attribute to the tag name separated by a colon in the key parameter. If the specified tag is a leaf node, then its tag data is returned. If the specified tag is not a leaf node, the whole tag is returned as an XML string.

scope
A String indicating which configuration file to search for the configuration tag specified in the key parameter.

Flash Media Server has six server configuration files: Server.xml, Users.xml, Logger.xml, Adaptor.xml, Vhost.xml, and Application.xml. Depending on your permissions, you can get configuration keys for all these files, as described in the following list:

  • / specifies Server.xml.

  • Users specifies Users.xml for server administrators.

  • Logger specifies Logger.xml.

  • Adaptor:<adaptor_name> specifies Adaptor.xml. Specify the adaptor name in place of the <adaptor_name> placeholder. You must have server administrator privileges to access the Adaptor.xml file. If <adaptor_name> is not the name of the adaptor the caller is connected to, the call fails.

  • Adaptor:<adaptor_name>/VHost:<vhost_name> specifies VHost.xml. Specify the virtual host name in place of the <vhost_name> placeholder. If <adaptor_name> is not the name of the adaptor the caller is connected to, or <vhost_name> is not the name of the virtual host that the caller is connected to, the call fails.

  • Adaptor:<adaptor_name>/VHost:<vhost_name>/Users.xml specifies Users.xml for virtual host administrators.

  • Adaptor:<adaptor_name>/VHost:<vhost_name>/App[:<app_name>] specifies Application.xml. If no <app_name> is specified, the default Application.xml file is assumed. Otherwise, the application-specific Application.xml for the specified application is used. If the specified application is not defined, or the application does not have an application-specific Application.xml file, the call fails.

Note: To determine the adaptor or virtual host to which you’re connected, call the getAdminContext() method.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data object whose properties contain information about the specified tag.

If the specified tag is a leaf node, the call returns the tag data. Otherwise, the call returns the tag itself. For example, if the desired tag is <foo>bar</foo>, the call returns "bar". However, if the desired tag contains child tags such as <foo><bar>foobar</bar></foo>, the call returns "<foo><bar>foobar</bar></foo>".

If the call fails (that is, if the specified configuration key isn’t found), the server returns an empty string.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Examples

The following examples get XML data from various configuration files:

tSocket = new NetConnection(); 
tSocket.connect("rtmp://localhost/admin", "user", "password"); 
 
// find key in Server.xml 
key = "Server/LicenseInfo"; 
tSocket.call("getConfig2", new onGetConfig(), key, "/"); 
 
// find key in Adaptor.xml 
key = "HostPortList/HostPort"; 
scope = "Adaptor:_defaultRoot_"; 
tSocket.call("getConfig2", new onGetConfig(), key, scope); 
 
// find key in Vhost.xml 
key = "AppsDir"; 
scope = "Adaptor:_defaultRoot_/VHost:_defaultVHost_"; 
tSocket.call("getConfig2", new onGetConfig(), key, scope); 
 
// find key in Application.xml for app "foo" 
key = "Process/Scope"; 
scope = "Adaptor:_defaultRoot_/VHost:_defaultVHost_/App:foo"; 
tSocket.call("getConfig2", new onGetConfig(), key, scope); 
 
// find key in default Application.xml 
key = "Process/Scope"; 
scope = "Adaptor:_defaultRoot_/VHost:_defaultVHost_/App"; 
tSocket.call("getConfig2", new onGetConfig(), key, scope); 
 
// return the whole Vhost.xml 
key = ""; 
scope = "Adaptor:_defaultRoot_/VHost:_defaultVHost_"; 
tSocket.call("getConfig2", new onGetConfig(), key, scope);

getEdgeConnections()

RTMP/E

getEdgeConnections(appInst:String) : Object

HTTP

http://www.example.com:1111/admin/getEdgeConnections?auser=username&apswd=password&appInst=name

Returns a list of the edge connections for a particular application instance. Edge connections are multiplexed connections from a remote edge server to an origin server. Each edge connection represents at least one individual connection to another Flash Media Server that is acting as an edge for this server.

This method was formerly known as getGroups().

Availability

Flash Media Server 2.0.

Parameters

appInst
A String indicating the name of the instance of the application for which you want performance statistics, in the form application_name/instance_name. You must specify both the application name and the instance name, separated by a slash (/), even if you want performance statistics for the default instance of the application. For example, to specify the default instance for an application named ChatApp, specify ChatApp/_defInst_.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success,and a data property that is an array of the client IDs of all groups connected to this application.

HTTP
If the call succeeds, it returns XML like the following:
<result> 
    <level>status</level> 
    <code>NetConnection.Call.Success</code> 
    <timestamp>7/24/2007 9:08:59 AM</timestamp> 
    <data>  
        <name>_defaultRoot_:_defaultVHost_:::_2</name>  
        <_0>CCAoQVeF</_0> 
    </data>  
</result>

If the call fails, it returns XML like the following:

<result>  
    <level>error</level>  
    <code>NetConnection.Admin.CommandFailed</code>  
    <timestamp>7/24/2007 9:10:11 AM</timestamp>  
    <description>Application instance is not loaded : vo</description>  
</result>
Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getEdgeConnectionStats()

RTMP/E

getEdgeConnectionStats(appInst:String, groupid:String) : Object

HTTP

http://www.example.com:1111/admin/getEdgeConnectionStats?auser=username&apswd=password&appInst=name&groupid=string

Gets statistics for a particular edge server connection. This connection is special because it multiplexes for more than one client connection and contains a unique statistic called members_count. Edge connections are established from one server to another as proxies.

You can call getEdgeConnections() to get a value for groupid.

This method was formerly known as getGroupStats().

Availability

Flash Media Server 2.0.

Parameters

appInst
A String indicating the name of the instance of the application on which the virtual client resides, in the form application_name/instance_name. You must specify both the application name and the instance name, separated by a slash (/), even if you want performance statistics for the default instance of the application. For example, to specify the default instance for an application named ChatApp, specify ChatApp/_defInst_.

groupid
A String indicating the group’s client ID.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object containing the client performance data. The data object has the following properties:

Property

Description

connect_time

ActionScript Date object; time the application connected to the server.

protocol

String; protocol used by the client to connect to the server (rtmp, rtmpe, or rtmpt).

msg_in

Number; total number of messages processed by this application.

msg_out

Number; total number of messages sent by this application.

msg_dropped

Number; total number of messages dropped by this application.

bytes_in

Number; total number of bytes read by this application.

bytes_out

Number; total number of bytes written by this application.

msg_queue

Object; client message queue statistics.

total_queues

Number; total number of queues for this client.

audio

Number; total number of audio messages in all audio queues.

video

Number; total number of video messages in all video queues.

other

Number; total number of cmd/data messages in the “other” queue.

stream_ids

Array; an array of numbers (stream IDs).

members_count

Number; the number of clients multiplexing on this group connection.

HTTP
If the call succeeds, it returns XML with the following structure:
<result>  
    <level>status</level>  
    <code>NetConnection.Call.Success</code>  
    <timestamp>10/23/2007 12:43:47 PM</timestamp>  
    <data>  
             <name>_defaultRoot_:_defaultVHost_:::_2</name>  
             <bytes_in>3283</bytes_in>  
             <bytes_out>3878</bytes_out>  
             <msg_in>5</msg_in>  
             <msg_out>1</msg_out>  
             <msg_dropped>0</msg_dropped>  
             <connect_time>10/23/2007 12:16:08 PM</connect_time>  
             <protocol>rtmp</protocol>  
            <msg_queue>  
                 <total_queues>1</total_queues>  
                 <audio>0</audio>  
                 <video>0</video>  
                 <other>0</other>  
             </msg_queue>  
            <stream_ids />  
        <members_count>1</members_count>  
    </data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level>error</level>  
    <code>NetConnection.Call.BadValue</code>  
    <timestamp>10/23/2007 3:30:12 PM</timestamp>  
    <description>Invalid group ID (0).</description>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getEdgeVirtualClients()

RTMP/E

getEdgeVirtualClients(appInst:String, groupid:String) : Object

HTTP

http://www.example.com:1111/admin/getEdgeVirtualClients?auser=username&apswd=password&appInst=name&groupid=string

Returns a list of the virtual client connections from the specified edge server. Virtual clients are clients connected to an origin server through an edge server. They are referred to as “virtual” clients because they are not connected directly to the origin.

Call getEdgeConnections()to get a value for the groupid parameter.

This method was formerly known as getGroupMembers().

Availability

Flash Media Server 2.0.

Parameters

appInst
A String indicating the name of the instance of the application to which the virtual client is connected, in the form application_name/instance_name. You must specify both the application name and the instance name, separated by a slash (/), even if you want performance statistics for the default instance of the application. For example, to specify the default instance for an application named ChatApp, specify ChatApp/_defInst_.

groupid
A String indicating the virtual client’s client ID.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an array containing the client IDs of all the individual clients connected through this virtual client.

HTTP
If the call succeeds, it returns XML like the following:
<result> 
    <level>status</level>  
    <code>NetConnection.Call.Success</code>  
    <timestamp>10/23/2007 12:19:24 PM</timestamp>  
    <data>  
        <name>_defaultRoot_:_defaultVHost_:::_2</name>  
        <_0>DDAAQMsI</_0>  
    </data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level>error</level> 
    <code>NetConnection.Call.BadValue</code> 
    <timestamp>10/23/2007 1:59:00 PM</timestamp> 
    <description>Invalid group ID (0).</description>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getFileCacheStats()

RTMP/E

getFileCacheStats([verbose:Boolean] [, file:String]) : Object

HTTP

http://www.example.com:1111/admin/getFileCacheStats?auser=username&apswd=password[&verbose=value][&file=string]

Obtains data about the file cache including size of cache, number of file objects held in cache, and number of segment hits and misses. If the verbose parameter is set to true, individual statistics for each file in the cache are returned.

Beginning with Flash Media Server 3.5, you can dynamically control the core to which an application is sent. Controlling the cores allows load balancing across cores based on their performance counters. In getFileCacheStats, the results are grouped by core.

Availability

Flash Media Server 3.

Parameters

verbose
Boolean; true displays individual statistics for each file in the cache; false displays a summary of all the objects in the cache. The default value is false.

file
A String indicating the statistics of a file. Specify a value in the form [object_name] value.

The file property value requires the following syntax, "flv:[path]", "mp3:[path]", "mp4:[path]", and so on. To determine this value, first call the API with verbose=true and grab the path from the result, as in the following:

<object_name>5888_C:\Program Files\Adobe\Flash Media Server 4\applications\app_1\streams\_definst_\Coral_Reef_Adventure_spark_150k_105s</object_name>
Note: Remove 5888_ when it is used in the file property; only the file path should be used.

Do not use the verbose and file parameters at the same time. If both are used, the first one is taken and the second one is ignored. If there are many files in the cache, using verbose and setting it to true can be time-consuming. It may also cause a browser timeout if you call the API from a web browser. To reduce the amount of data being returned, pass the name of a single object as a parameter. Passing the name of a single object returns only the statistics for that object.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object. The data object has the following properties:

Property

Description

num_objs

Number; total number of file objects held in the cache.

hits

Number; total number of segment “hits” since the server started.

misses

Number; total number of segment misses since the server started.

bytes

Number; current size of the cache, in bytes.

bytes_inuse

Number; current amount of cache being used, in bytes

released

Number; total number of segments released since the server started.

cores

An object containing information about specific core processes. This object contains all the properties of the data object and an additional core_id property. For example, <data><hits> contains an aggregate value for the server. The property <core><hits> contains a value for a specific core. If no cores are running, the <cores> element is empty.

core_id

Number; the ID of a core process.

num_segments

Number; total number of segments held in the cache.

num_segments_inuse

Number; total number of segments in the cache being actively used. Added in Flash Media Server 3.5.1.

If the verbose parameter is set to true, the data property has an objects property with the following individual statistics for each file in the cache:

Property

Description

object_name

Name of the stream object.

num_segments

Number; total number of segments from this object currently cached.

num_segments_inuse

Number; total number of segments from this object being actively used. Added in Flash Media Server 3.5.1.

hits

Hits for this object.

misses

Misses for this object.

useCount

Number; total number of clients accessing this object (including internal server clients).

released

Number; total number of segments released from this object.

recording

If this file is being recorded.

bytes

Number; size of this object in the cache.

num_kfs

Number; total number of frames in the keyframe cache for this object.

kfbytes

Number; size of the keyframe cache for this object, in bytes.

bytes_inuse

Number; the amount of this object being actively used, in bytes.

overhead

Number; the fixed memory overhead of this object, in bytes.

Following is the output of a call to getFileCacheStats() with verbose set to false:

<result>  
    <level>status</level>  
    <code>NetConnect.Call.Success</code>  
    <timestamp>7/24/2008 3:59:22 PM</timestamp> 
    <data> 
        <num_objs>0</num_objs> 
        <hits>0</hits> 
        <misses>0</misses> 
        <bytes>0</bytes> 
        <bytes_inuse>0</bytes_inuse> 
        <released>0</released> 
        <cores> 
            <_26432> 
                <num_objs>0</num_objs> 
                <hits>0</hits> 
                <misses>0</misses> 
                <bytes>0</bytes> 
                <bytes_inuse>0</bytes_inuse> 
                <released>0</released> 
                <core_id>0</core_id> 
            <_26432>                 
        </cores>     
    </data> 
</result>
Note: If no cores have started (no applications running), then only the aggregate data is returned.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure (the data is sample data):
<result> 
    <level>status</level>  
    <code>NetConnection.Call.Success</code>  
    <timestamp>7/16/2008 10:23:59 AM</timestamp>  
    <data> 
         <num_objs>1</num_objs>  
         <hits>10</hits>  
         <misses>17</misses>  
         <bytes>2064203</bytes>  
        <bytes_inuse>261875</bytes_inuse> 
        <released>0</released> 
        <cores> 
            <_3644> 
                <num_objs>1</num_objs> 
                <hits>10</hts> 
                <misses>17</misses> 
                <bytes>2064203</bytes> 
                <bytes_inuse>261875<bytes_inuse> 
                <released>0</released> 
                <objects>     
                    <_0> 
                            <_3644> 
                        <num_objects>1</num_objs> 
                        <hits>6</hits> 
                        <misses>28</misses> 
                        <bytes>2440227</bytes> 
                        <bytes_inuse>528112</bytes_inuse> 
                        <released>0</released> 
                        <core_id>1</core_id> 
                        <objects></objects> 
                        </_3364> 
                    <_0> 
                </objects> 
            <_3644> 
        </cores> 
        <objects> 
            <_0> 
                <object_name>3644_C:\Program Files\Adobe\Flash Media Server 
                    4\applications\vod\media\sample</object_name> 
                <num_segments>9</num_segments>  
                <hits>10</hits>  
                <misses>9</misses> 
                <useCount>3</useCount>  
                <released>0</released>  
                <recording>false</recording>  
                <bytes>2064203</bytes>  
                <num_kfs>0</num_kfs>  
                <kfbytes>0</kfbytes>  
            </_0> 
        </objects> 
    </data> 
</result>

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>
Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getInstanceStats()

RTMP/E

getInstanceStats(appInst:String) : Object

HTTP

http://www.example.com:1111/admin/getInstanceStats?auser=username&apswd=password&appInst=name

Gets the performance data for a specified instance of an application.

If you need information about the performance of a specific script, use the getScriptStats() method.

Beginning with Flash Media Server 3.5, you can dynamically control the core to which an application is sent. Controlling the cores allows load balancing across cores based on their performance counters. For more information, see Configure how applications are assigned to server processes.

Availability

Flash Communication Server 1.0

Parameters

appInst
A String indicating the name of the instance of the application for which you want performance statistics, in the form application_name/instance_name. Specify both the application name and the instance name, separated by a slash (/). Specify the two names, even if you want performance statistics for the default instance of the application. For example, to specify the default instance for an application named ChatApp, specify ChatApp/_defInst_.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object. The data object has the following properties:

Property

Description

name

String; The instance name of the application.

bw_in

Number; current bandwidth in, in bytes per second.

bw_out

Number; current bandwidth out, in bytes per second.

bytes_in

Number; total number of bytes read by this instance of the application.

bytes_out

Number; total number of bytes written by this instance of the application.

msg_in

Number; total number of messages processed by this instance of the application.

msg_out

Number; total number of messages sent by this instance of the application.

msg_dropped

Number; total number of messages dropped by this instance of the application.

total_connects

Number; total number of socket connections to this instance of the application since the instance was started.

total_disconnects

Number; total number of socket disconnections from this instance of the application since the instance was started.

connected

Number; total number of connections currently active.

normal_connects

Number; total number of normal connections.

virtual_connects

Number; total number of connections through a remote edge.

group_connects

Number; total number of connections from edge servers.

service_connects

Number; total number of service connections.

service_requests

Number; total number of services requested.

accepted

Number; total number of connection attempts accepted by this application.

rejected

Number; total number of connection attempts rejected by this application.

admin_connects

Number; total number of administrator connections.

debug_connects

Number; total number of debug connections.

launch_time

ActionScript Date object; time the instance was launched.

pid

Number; The pid of the core process running the instance.

core_id

Number; The core id of the core running the instance.

up_time

Number; length of time, in seconds, the instance has been running.

mode

String; “local” or “remote”. If the server is configured as an origin, the value is “local.” If the server is configured as an edge, the value is “remote”.

debug

Boolean; true if a debug session is enabled, otherwise false. See approveDebugSession().

script

Object that contains script engine performance data. The following are properties of the script object:

name: The instance name of the application.

time_high_water_mark: Number; maximum amount of time, in seconds, that the script has taken to execute an event.

queue_size: Number; total number of events currently in the script engine queue.

total_processed: Number; total number of events processed by the script engine.

queue_high_water_mark: Number; maximum number of events in the queue.

total_process_time: Number; number of seconds taken to process the number of events in total_processed.

swf_verification_attempts

Number; a counter of the number of SWF verification attempts made. Represents the total SWF verification credentials passed to the server for checking. There may be more than one credential presented per connection.

swf_verification_exceptions

Number; a counter of the number of SWF verification exceptions made. Exceptions are allowed through explicit configuration in the Application.xml file that allows certain user agents to bypass the requirement for SWF verification. Every connection allowed as an exception is counted here.

swf_verification_failures

Number; a counter of the number of SWF verification failures. Failures result from the presentation of SWF verification credentials that are found not to be a match for any loaded credential. Each failure corresponds to a disconnection of the presenting connection.

swf_verification_unsupported_rejects

Number; a counter of the number of SWF verification unsupported rejections. When a version of Flash Player that doesn’t support SWF verification connects to an application that requires SWF verification, the unsupported rejection count is increased. Also, the connecting client is disconnected.

swf_verification_matches

Number; a counter of the total number of matches. When an authentic SWF verification credential is presented, this number increases. There may be more than one match per connection.

swf_verification_remote_misses

Number; a counter of the proxy/remote server process’s missed SWF verification attempts. Whenever a proxy/remote server receives a SWF verification attempt it looks to its local cache for valid SWF verification. If it does not locate a match it logs a remote miss and defers to the origin to answer the verification attempt.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result>  
    <level>status</level>  
    <code>NetConnect.Call.Success</code>  
    <timestamp>7/24/2008 7:16:27 PM</timestamp> 
    <data> 
        <name>_defaultRoot_:_defaultVHost_:::_0</name>> 
        <bw_in>0</bw_in> 
        <bw_out>0</bw_out> 
        <bytes_in>3073</bytes_in> 
        <bytes_out>3453</bytes_out> 
        <msg_in>0</msg_in> 
        <msg_out>1</msg_out> 
        <msg_dropped>0</msg_dropped> 
        <total_connects>1</total_connects> 
        <total_disconnects>0</total_disconnects> 
        <connected>1</connected> 
        <normal_connects>1</normal_connects> 
        <virtual_connects>0</virtual_connects> 
        <group_connects>0</group_connects> 
        <service_connects>0</service_connects> 
        <service_requests>0</service_requests> 
        <admin_connects>0</admin_connects> 
        <accepted>1</accepted> 
        <rejected>0</rejected> 
        <launch_time>7/24/2008 6:41:10 PM</launch_time> 
        <pid>26912></pid> 
        <core_id>0</core_id> 
        <up_time>2117.079311</up_time> 
        <mode>local</mode> 
        <debug>false</debug> 
        <script> 
            <name>_defaultRoot_:_defaultVHost_:::_0</name> 
            <time_high_water_mark>22</time_high_water_mark> 
            <queue_size>0</queue_size> 
            <total_processed>10</total_processed> 
            <queue_high_water_mark>1</queue_high_water_mark> 
            <total_process_time>44</total_process_time> 
        </script> 
        <swf_verification_attempts>0</swf_verification_attempts> 
        <swf_verficiation_exceptions>0</swf_verfication_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> 
    </data> 
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getIOStats()

RTMP/E

getIOStats() : Object

HTTP

http://www.example.com:1111/admin/getIOStats?auser=username&apswd=password

Returns detailed information about the network I/O characteristics of the connected adaptor.

You must be a server administrator to perform this operation.

Availability

Flash Communication Server 1.0.

Parameters

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnectiona.Call.Success, and a data property that is an object. The data object has the following properties:

Property

Description

msg_in

Number; total number of messages processed by the adaptor.

msg_out

Number; total number of messages sent by the adaptor.

bytes_in

Number; total number of bytes read by the adaptor.

bytes_out

Number; total number of bytes written by the adaptor.

reads

Number; total number of system read calls.

writes

Number; total number of system writes.

connected

Number; number of currently active socket connections to the adaptor.

total_connects

Number; total number of socket connections to the adaptor since the adaptor was started.

total_disconnects

Number; total number of socket disconnections from the adaptor.

msg_dropped

Number; total number of messages dropped.

tunnel_responses

Number; number of tunneling responses thus far.

normal_connects

Number; total number of normal connections.

virtual_connects

Number; total number of connections through a remote edge.

group_connects

Number; total number of remote edges that are connected.

service_connects

Number; total number of service connections.

service_requests

Number; total number of services requested.

admin_connects

Number; total number of administrator connections.

debug_connects

Number; total number of debug connections.

server_bytes_in

Number; total number of rtmp bytes read by an SSAS NetConnection

server_bytes_out

Number; total number of rtmp bytes sent by an SSAS NetConnection

swf_verification_attempts

A counter of the number of SWF verification attempts made. Represents the total SWF verification credentials passed to the server for checking. There may be more than one credential presented per connection.

swf_verification_exceptions

A counter of the number of SWF verification exceptions made. Exceptions are allowed through explicit configuration in the Application.xml file that allows certain user agents to bypass the requirement for SWF verification. Every connection allowed as an exception is counted here.

swf_verification_failures

A counter of the number of SWF verification failures. Failures result from the presentation of SWF verification credentials that are found not to be a match for any loaded credential. Each failure corresponds to a disconnection of the presenting connection.

swf_verification_unsupported_rejects

A counter of the number of SWF verification unsupported rejections. When a version of Flash Player that doesn’t support SWF verification connects to an application that requires SWF verification, the unsupported rejection count is increased. Also, the connecting client is disconnected.

swf_verification_matches

A counter of the total number of matches. When an authentic SWF verification credential is presented, this number increases. There may be more than one match per connection.

swf_verification_remote_misses

A counter of the proxy/remote server process’s missed SWF verification attempts. Whenever a proxy/remote server receives a SWF verification attempt it looks to its local cache for valid SWF verification. If it does not locate a match it logs a remote miss and defers to the origin to answer the verification attempt.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a String describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getLicenseInfo()

RTMP/E

getLicenseInfo() : Object

HTTP

http://www.example.com:1111/admin/getLicenseInfo?auser=username&apswd=password

Retrieves complete license information including information on the maximum number of connections, adaptors, and virtual hosts that are allowed by the license. This method provides resultant summary information about your licenses followed by specific information about each license. This call returns information about license keys (also called license numbers) or license file.

Availability

Flash Communication Server 1.0.

Parameters

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object. The data object has the same properties as the data element in the XML returned by an HTTP call.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure (this XML is for a license file):
Note: The value -1 means unlimited.
<?xml     version="1.0" encoding="utf-8" ?> 
<result> 
    <level>status</level> 
    <code>NetConnection.Call.Success</code> 
    <timestamp>6/21/2010 10:18:28 AM</timestamp> 
    <data> 
        <edition>Custom</edition> 
        <expires>Jun 01, 2011</expires> 
        <version>4.0.0</version> 
        <build>r1119</build> 
        <copyright>Copyright(c) 1993-2010 Adobe Systems Incorporated. All Rights Reserved.</copyright> 
        <max_rtmp_connections>unlimited</max_rtmp_connections> 
        <max_rtmfp_connections>unlimited</max_rtmfp_connections> 
        <max_adaptors>unlimited</max_adaptors> 
        <max_vhosts>unlimited</max_vhosts> 
        <max_core_process>unlimited</max_core_process> 
        <http_live_timeout>unlimited</http_live_timeout> 
        <edge>enabled</edge> 
        <auth_plugin>enabled</auth_plugin> 
        <access_plugin>enabled</access_plugin> 
        <file_plugin>enabled</file_plugin> 
        <origin>enabled</origin> 
        <rtmfp_peer_introductions>enabled</rtmfp_peer_introductions> 
        <ip_multicast>enabled</ip_multicast> 
        <multicast_timeout>unlimited</multicast_timeout> 
        <rtmfp_groups>enabled</rtmfp_groups> 
        <license_files> 
            <_0> 
                <filename>fms40_expires_06-01-2011.lic</filename> 
                <description>Adobe Internal Use</description> 
                <type>NFR</type> 
                <id>XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXS</id> 
                <account_id/> 
                <expires>Jun 01, 2011</expires> 
            </_0> 
        </license_files> 
        <key_details/> 
    </data> 
</result>

If the call succeeds, it returns XML with the following structure (this XML is for a license key):

<?xml version="1.0" encoding="utf-8" ?> 
<result> 
<level>status</level> 
<code>NetConnection.Call.Success</code> 
<timestamp>6/21/2010 10:16:41 AM</timestamp> 
<data> 
    <edition>Streaming</edition> 
    <expires /> 
    <version>4.0.0</version> 
    <build>r1119</build> 
    <copyright>Copyright(c) 1993-2010 Adobe Systems Incorporated. All Rights Reserved.</copyright> 
    <max_rtmp_connections>unlimited</max_rtmp_connections> 
    <max_rtmfp_connections>0</max_rtmfp_connections> 
    <max_adaptors>1</max_adaptors> 
    <max_vhosts>unlimited</max_vhosts> 
    <max_core_process>1</max_core_process> 
    <http_live_timeout>0</http_live_timeout> 
    <edge>disabled</edge> 
    <auth_plugin>disabled</auth_plugin> 
    <access_plugin>enabled</access_plugin> 
    <file_plugin>disabled</file_plugin> 
    <origin>enabled</origin> 
    <rtmfp_peer_introductions>disabled</rtmfp_peer_introductions> 
    <ip_multicast>disabled</ip_multicast> 
    <multicast_timeout>0</multicast_timeout> 
    <rtmfp_groups>disabled</rtmfp_groups> 
    <license_files /> 
    <key_details> 
        <_0> 
            <key>XXXXXXXXXXXXXXXXXXXXXXXX</key> 
            <version>3.5</version> 
            <type>Full</type> 
            <edition>Streaming</edition> 
        </_0> 
        <_1> 
            <key>XXXXXXXXXXXXXXXXXXXXXXXX</key> 
            <version>4.0</version> 
            <type>Upgrade</type> 
            <edition>Streaming</edition> 
        </_1> 
    </key_details> 
    </data> 
</result>

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getLiveStreams()

RTMP/E

getLiveStreams(appInst:String) : Object

HTTP

http://www.example.com:1111/admin/getLiveStreams?auser=username&apswd=password&appInst=name

Gets an array of strings that contains the names of all the live streams that are currently publishing to the specified instance of an application.

Availability

Flash Communication Server 1.0.

Parameters

appInst
A String indicating the name of the instance of the application, in the form application_name/instance_name.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an array of strings containing the names of all the live streams that are currently publishing to the specified instance of an application.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getLiveStreamStats()

RTMP/E

getLiveStreamStats(appInst:String, stream:String) : Object

HTTP

http://www.example.com:1111/admin/getLiveStreamStats?auser=username&apswd=password&appInst=name&stream=name

Returns detailed information about a live stream.

Availability

Flash Communication Server 1.0.

Parameters

appInst
A String indicating the name of the instance of the application, in the form application_name/instance_name.

stream
A String indicating the name of the stream.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object. The data object has the following properties:

Property

Description

publisher

Object; publisher statistics. The object has the following properties:

name: String; the name of the published live stream.

time: Date object; time that the stream was published. This property is a duplicate of publish_time and exists for backward compatibility.

type: String; the type of stream for the publisher. The value is "publishing".

client: Number; the client ID of the publisher.

stream_id: Number; the stream ID of the publisher.

publish_time: Date object; time that the stream was published.

client_type: String; the string type of the publishing client.

subscribers

Array of subscriber statistics. The array contains a subscriber property that is an object containing the following properties:

client: Number; user ID.

subscribe_time: Date object; the time that the user subscribed to the stream.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getMsgCacheStats()

RTMP/E

getMsgCacheStats() : Object

HTTP

http://www.example.com:1111/admin/getMsgCacheStats?auser=username&apswd=password

Returns server TCMessage cache statistics. You must be a server administrator to perform this command.

Availability

Flash Communication Server 1.0.

Parameters

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object. The data object has the following message cache statistics:

Property

Description

allocated

Number; total number of message objects allocated.

reused

Number; total number of objects used.

size

Number; current size.

thread_count

Total number of per-thread pools in use.

units

Object with the following properties:

global_size The size of the global pool that is available.

thread_size The total size of the per-thread pool that is available.

size The total size of the global and per-thread pool that is available.

reused The total number of messages reused.

allocated The total number of messages allocated from the heap.

released The total number of messages released back to the heap.

relocated The total number of messages that have been reallocated.

bulk_allocated The total number of messages allocated from the global pool.

bulk_released The total number of messages released back to the global pool.

huge_allocated The total number of huge messages (greater than 16 kilobytes) allocated.

huge_released The total number of huge messages (greater than 16 kilobytes) released.

bytes

Object with the following properties:

global_size The size of the global pool that is available.

thread_size The total size of the per-thread pool that is available.

size_total The size of the global and per-thread pool that is available.

reused The total number of bytes reused.

allocated The total number of bytes allocated from the heap.

released The total number of bytes released back to the heap.

relocated The total number of bytes that have been reallocated.

bulk_allocated The total number of bytes allocated from the global pool.

bulk_released  The total number of bytes released back to the global pool.

huge_allocated The total number huge messages (greater than 16 kilobytes) allocated in bytes.

huge_released The total number of huge messages (greater than 16 kilobytes) released in bytes.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getNetStreams()

RTMP/E

getNetStreams(appInst:String) : Object

HTTP

http://www.example.com:1111/admin/getNetStreams?auser=username&apswd=password&appInst=name

Returns an array of numbers that represent the server-assigned IDs of all the network streams that are currently connected to the specified instance of the application.

Availability

Flash Communication Server 1.0.

Parameters

appInst
A String indicating the name of the instance of the application, in the form application_name/instance_name.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an array of numbers. The numbers represent the server-assigned IDs of all network streams that are currently connected to the specified instance of the application.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getNetStreamStats()

RTMP/E

getNetStreamStats(appInst:String, streamids:Number) : Object

HTTP

http://www.example.com:1111/admin/getNetStreamStats?auser=username&apswd=password&appInst=name&streamids=number

Gets detailed information for one or more network streams that are connecting to the specified instance of an application.

Availability

Flash Communication Server 1.0.

Parameters

appInst
A String indicating the name of the instance of the application, in the form application_name/instance_name.

streamids
A Number indicating the ID of the network stream or an array of numbers that represents the network stream ID. To get information for all the network streams that are currently connected, specify a value of -1 for the streamids parameter.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an array of statistics for the network stream. Each element in the array is an object that has the following properties:

Property

Name

name

String; stream name or empty if the stream is idle.

time

ActionScript Date object; possible values are shown in the following list:

If type = "idle", value is 0.

If type = "publishing", the value is the time the stream was published.

If type = "playing live", the value is the time playback started.

If type = "play recorded", the value is the time playback started.

type

String; stream type. Possible values are shown in the following list:

"idle"

"publishing"

"playing live"

"play recorded"

client

A hexadecimal number indicating the user ID.

streamid

A hexadecimal number indicating the stream ID.

client_type

String; possible values are: "normal", "group", "virtual", or "service". Connections between clients and edge servers or origin servers are "normal". Connections between edge servers and orgin servers are "group" or "virtual".

diffserv_bits

This value updates when you successfully set Differentiated Services bits on a socket and indicates the value of the bits.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getRecordedStreams()

RTMP/E

getRecordedStreams(appInst:String) : Object

HTTP

http://www.example.com:1111/admin/getRecordedStreams?auser=username&apswd=password&appInst=name

Returns an array containing the names of all the recorded streams currently playing from a particular instance of an application.

Availability

Flash Media Server 2.0.

Parameters

appInst
A String indicating the name of the application or instance of the application, in the form application_name[/instance_name].

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an array of all the recorded stream names. The extended name of a recorded stream is used. The name is encoded with keyName*type:streamName, where keyName is the virtual key, type is the stream type (for example: flv, mp3, and so on), and streamName is the text name of the stream.

The properties are defined in the following table:

Property

Name

streamName

String; name of the recorded stream.

type

String; type of the recorded stream.

keyName

String; virtual key of this recorded stream.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getRecordedStreamStats()

RTMP/E

getRecordedStreamStats(appInst:String, stream:String) : Object

HTTP

http://www.example.com:1111/admin/getRecordedStreamStats?auser=username&apswd=password&appInst=name&stream=name

Returns detailed information about a recorded stream.

Availability

Flash Media Server 2.0.

Parameters

appInst
A String indicating the name of the instance of the application, in the form application_name/instance_name.

stream
A String indicating the name of the stream. If the stream has a nondefault virtual key or type, these items should be encoded into the stream name. The following is an example of how to encode key and type: key?type:name and on2key?flv:myStream.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object that contains the following properties:

Property

Name

cache_bytes

Number; total number of cached bytes of this recorded stream.

cache_segments

Number; number of segments cached for this recorded stream.

cache_hits

Number; number of hits on this stream within the cache.

cache_misses

Number; number of misses on the cache for this stream.

modified_time

ActionScript Date object; date when this file was last modified.

size

Number; number of bytes in this recorded file.

length

Number; length of this file in seconds.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getScriptStats()

RTMP/E

getScriptStats(appInst:String) : Object

HTTP

http://www.example.com:1111/admin/getScriptStats?auser=username&apswd=password&appInst=name

Gets the performance data for a script running on the specified instance of an application.

Availability

Flash Communication Server 1.0.

Parameters

appInst
A String indicating the name of the instance of the application, in the form application_name/instance_name.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object. The data object has the following properties:

Property

Description

name

The name of the fmscore process on which the specified application instance is running. For example, defaultRoot_:_defaultVHost_:::_1.

time_high_water_mark

Number; maximum amount of time, in seconds, the script has taken to execute an event.

queue_size

Number; total number of events currently in the script engine queue.

total_processed

Number; total number of events processed by the script engine.

queue_high_water_mark

Number; maximum number of events in the script engine queue.

total_process_time

Number; number of seconds taken to process the number of events in total_processed.

memory_used

The amount of memory used. The server uses this number for warnings

gc_memory_used

The amount of memory used for overhead. The server uses this number for warnings. This number is included in memory_used.

max_memory_used

The peak amount of memory used during the application’s lifetime.

gc_count

The number of garbage collection operations run during the application’s lifetime. This number includes engine-initiated and server-initiated garbage collections.

server_gc_count

The number of server-initiated (external) garbage collection operations during the application’s lifetime. This number is included in gc_count.

last_gc_duration

The duration of the last garbage collection operation, in fractional seconds.

max_gc_duration

The maximum duration of any garbage collection operation during the application’s lifetime, in fractional seconds.

avg_gc_duration

The average duration of all garbage collection operations during the application’s lifetime, in fractional seconds.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getServerStats()

RTMP/E

getServerStats() : Object

HTTP

http://www.example.com:1111/admin/getServerStats?auser=username&apswd=password

Retrieves the server status and statistics about the operation of the server. Information reported includes the length of time the server has been running and I/O and message cache statistics.

You must be a server administrator to perform this operation.

If you only need information about the I/O characteristics of the server, use the getIOStats() method instead.

Availability

Flash Communication Server 1.0.

Parameters

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object. The data object has the following properties:

Property

Description

cpu_Usage

Number; approximate percentage of CPU in use by the Flash Media Server processes—not by the entire system. This number includes all the CPUs on the server. For example, on a dual core system, if this value is 100, Flash Media Server is using approximately 50% on each CPU.

launchTime

ActionScript Date object; time the server was started.

memory_Usage

Number; approximate percentage of total physical system memory in use.

msg_cache

Flash Media Server message packet cache statistics, returned as an object with the following properties:

allocated: Number; total number of message objects allocated.

reused: Number; total number of objects reused.

size: Number; size of the cache, in number of message packets.

num_cores

Number; total number of core processes.

physical_Mem

Number; total physical memory used by edge and core server processes, in bytes.

server_bytes_in

Number; total number of RTMP bytes read by a Server-Side ActionScript NetConnection.

server_bytes_out

Number; total number of RTMP bytes sent by Server-Side ActionScript NetConnection.

up_time

Number; length of time, in seconds, that the server has been running.

The data object also has an io property. The io property is an object containing the following properties about input and output statistics:

Property

Description

admin_connects

Number; number of admin connections.

bw_in

Number; incoming bandwidth.

bw_out

Number; outgoing bandwidth.

bytes_in

Number; total number of bytes read by the server.

bytes_out

Number; total number of bytes written by the server.

connected

Number; total number of active socket connections to the server.

debug_connects

Number; number of debug connections.

group_connects

Number; number of connected groups.

group_join

Number; the number of requests to join a group.

group_leave

Number; the number of requests to leave a group.

msg_dropped

Number; total number of messages dropped by the server.

msg_in

Number; total number of messages processed by the server.

msg_out

Number; total number of messages sent by the server.

normal_connects

Number; number of Flash Player connections to the server.

reads

Number; total number of system read calls.

rtmfp_forwards

Count of forwards sent to directly connected clients in response to a successful local lookup.

rtmfp_lookups

Number; count of peer lookups performed on behalf of directly connected clients.

rtmfp_redirects

Number; count of redirects sent to directly connected clients in response to a successful local lookup.

rtmfp_remote_forwards

Count of forwards sent to directly connected clients on behalf of another server that handled the initiating lookup (for example, an edge server sends a forward to a client on behalf of a lookup handled at the origin server).

rtmfp_remote_forward_requests

Count of forward requests sent to other servers (e.g. origin performs lookup and sends a forward request to the edge the target client is directly connected to).

rtmfp_remote_lookups

Number; count of peer lookups performed on behalf of a separate server and client (for example, an origin server performing a lookup on behalf of a downstream edge server).

rtmfp_remote_lookup_requests

Number; count of lookup requests sent to an alternate server (for example, an edge server requested that an upstream origin server perform a lookup on its behalf).

rtmfp_remote_redirects

Number; count of redirects sent to directly connected clients on behalf of another server that handled the initiating lookup (for example, an edge server sends a redirect to a client on behalf of a lookup handled at the origin server).

rtmfp_remote_redirect_requests

Number; count of redirect requests sent to other servers (for example, the origin server performs a lookup and sends a redirect request to the edge server that the initiating client is directly connected to).

service_connects

Number; number of service connections.

service_requests

Number; number of requests made for services.

swf_verification_attempts

Number; count of the number of SWF verification attempts made. Represents the total SWF verification credentials passed to the server for checking. There may be more than one credential presented per connection.

swf_verification_exceptions

Number; count of the number of SWF verification exceptions made. Exceptions are allowed through explicit configuration in the Application.xml file that allows certain user agents to bypass the requirement for SWF verification. Every connection allowed as an exception is counted here.

swf_verification_failures

Number; count of the number of SWF verification failures. Failures result from the presentation of SWF verification credentials that are found not to be a match for any loaded credential. Each failure corresponds to a disconnection of the presenting connection.

swf_verification_matches

Number; count of the total number of matches. When an authentic SWF verification credential is presented, this number increases. There may be more than one match per connection.

swf_verification_remote_misses

Number; count of the proxy/remote server process’s missed SWF verification attempts. Whenever a proxy/remote server receives a SWF verification attempt it looks to its local cache for valid SWF verification. If it does not locate a match it logs a remote miss and defers to the origin to answer the verification attempt.

swf_verification_unsupported_rejects

Number; count of the number of SWF verification unsupported rejections. When a version of Flash Player that doesn’t support SWF verification connects to an application that requires SWF verification, the unsupported rejection count is increased. Also, the connecting client is disconnected.

total_connects

Number; total number of socket connections to the server.

total_disconnects

Number; total number of socket disconnections from the server.

virtual_connects

Number; number of virtual connections proxied on groups.

working_threads

Number; number of working threads.

writes

Number; total number of system writes.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

See also

getIOStats()

getSharedObjects()

RTMP/E

getSharedObjects(appInst:String) : Object

HTTP

http://www.example.com:1111/admin/getSharedObjects?auser=username&apswd=password&appInst=name

Gets the names of all the shared objects that are currently active.

Availability

Flash Communication Server 1.0.

Parameters

appInst
A String indicating the name of the instance of the application, in the form application_name/instance_name.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object. The data object has the following properties:

Property

Description

persistent

Array of strings that contain persistent shared object names.

volatile

Array of strings that contain shared object names that are not persistent.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

This call fails if you supply an application or instance name that does not exist.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getSharedObjectStats()

RTMP/E

getSharedObjectStats(appInst:String, sharedObject:String, persistent:Boolean) : Object

HTTP

http://www.example.com:1111/admin/getSharedObjectStats?auser=username&apswd=password&appInst=name&sharedObject=name&persistent=value

Gets detailed information about a shared object.

Availability

Flash Communication Server 1.0.

Parameters

appInst
A String indicating the name of the instance of the application, in the form application_name/instance_name.

sharedObject
A String indicating the name of the shared object. You can get the names of all active shared objects by using the getSharedObjects() method.

persistent
A Boolean value: true for persistent; false for nonpersistent.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object. The data object has the following properties:

Property

Description

version

Number; version number of the shared object.

num_properties

Number; total number of properties in the shared object.

msg_in

Number; total messages in to the shared object.

msg_out

Number; total messages out from the shared object.

total_connects

Number; total number of connections to the shared object.

total_disconnects

Number; total number of disconnections from the shared object.

connected

Number; number of active subscribers.

resync_depth

Number; maximum version retained before resynchronization. If the difference between the server version number and the client version number is greater than the resync_depth value, Flash Media Server sends only changes between versions.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getUsers()

RTMP/E

getUsers(appInst:String) : Object

HTTP

http://www.example.com:1111/admin/getUsers?auser=username&apswd=password&appInst=name

Gets an array of strings that represent the server-assigned IDs of all users who are connected to the specified instance of an application.

Availability

Flash Communication Server 1.0.

Parameters

appInst
A String indicating the name of the instance of the application, in the form application_name/instance_name.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an array of strings that represent the IDs of users who are connected to the specified instance of an application. The user IDs are assigned by the server.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data> 
        <names></names> 
    </data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getUserStats()

RTMP/E

getUserStats(appInst:String, userid:String) : Object

HTTP

http://www.example.com:1111/admin/getUserStats?auser=username&apswd=password&appInst=name&userid=ID

Gets the performance data for the connection of a specified user.

Availability

Flash Communication Server 1.0.

Parameters

appInst
A String indicating the name of the instance of the application, in the form application_name/instance_name.

userid
A String indicating the user ID, as assigned by the server. You can retrieve a user ID with the getUsers() method.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object. The data object has the following properties:

Property

Description

connect_time

ActionScript Date object; time, in seconds, that the user has been connected to the specified instance of the application.

msg_in

Number; total number of messages processed by this user.

msg_out

Number; total number of messages sent by this user.

msg_dropped

Number; total number of messages dropped by this user.

bytes_in

Number; total number of bytes read by this user.

bytes_out

Number; total number of bytes written by this user.

msg_queue

Object that contains the client message queue statistics. The msg_queue object contains the following properties:

total_queues: Total number of queues for this client.

audio: Total number of audio messages in all audio queues.

video: Total number of video messages in all video queues.

other: Total number of command/data messages in the other queue.

protocol

String; protocol used by the client to connect to the server (rtmp, rtmpe, rtmpt, or rtmps.)

stream_ids

Array of numbers that represent the stream IDs.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

See also

getUsers()

getVerifiedSWFs()

RTMP/E

getVerifiedSWFs(appInst:String) : Object

HTTP

http://www.example.com:1111/admin/getVerifiedSwfs?auser=username&apswd=password&appInst=name

Returns the hashes for all the SWFs connected with a specified application.

Availability

Flash Communication Server 3.5.5.

Parameters

appInst
A String indicating the name of the instance of the application, in the formapplication_name/instance_name.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object. The data object has the following properties:

Property

Description

name

Name of FMSCore for which the files are listed.

i

Where i is an int and is index of swf data. It repeats for number of swfs. Each of this data object contains following properties:

  • path - Complete path to the SWF

  • expires - The time when SWF verification expires. In UTC format.

  • fileSize - Disk size of file (in bytes)

  • uncompressSize - If compressed, provides full length of uncompressed swf. Else it is the same as fileSize. (in bytes)

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level>status</level> 
     <code>NetConnection.Call.Success</code> 
     <timestamp>1/10/2011 12:54:43 PM</timestamp> 
     <data> 
         <name>_defaultRoot::::_0</name> 
         <_0> 
             <path>path to swf</path> 
             <expires>1/11/2011 12:54:43</expires> 
             <fileSize>464601</fileSize> 
             <uncompressSize>866393</uncompressSize> 
         </_0> 
         <_1> 
             <path>path to swf</path> 
             <expires>1/11/2011 12:54:43</expires> 
             <fileSize>464601</fileSize> 
             <uncompressSize>866393</uncompressSize> 
         </_1> 
     </data> 
</result>

If the application instance is distributed over different cores then response would be like this:

<result> 
     <level>status</level> 
    <code>NetConnection.Call.Success</code> 
    <timestamp>1/10/2011 12:54:43 PM</timestamp> 
    <data> 
         <_0> 
             <name>_defaultRoot::::_0</name> 
             <_0> 
                 <path>path to swf</path> 
                 <expires>1/11/2011 12:54:43</expires> 
                 <fileSize>464601</fileSize> 
                 <uncompressSize>866393</uncompressSize> 
             </_0> 
         </_0> 
         <_1> 
             <name>_defaultRoot::::_1</name> 
             <_0> 
                 <path>path to swf</path> 
                 <expires>1/11/2011 12:54:43</expires> 
                 <fileSize>464601</fileSize> 
                 <uncompressSize>866393</uncompressSize> 
             </_0> 
         </_1> 
     </data> 
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

getVHosts()

RTMP/E

getVHosts([adaptor:String]) : Object

HTTP

http://www.example.com:1111/admin/getVHosts?auser=username&apswd=password [&adaptor=name]

Returns an array of virtual hosts defined for the specified adaptor. You must be a server administrator to call this method.

Availability

Flash Communication Server 1.0.

Parameters

adaptor
A String indicating the user name of the adaptor. If not specified, it is assumed to be "_defaultRoot_".

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an array of strings containing the names of all the virtual hosts.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

getVHostStats()

RTMP/E

getVHostStats([adaptor:String, vhost:String]) : Object

HTTP

http://www.example.com:1111/admin/getVHostStats?auser=username&apswd=password&adaptor=name&vhost=name

Returns aggregate performance data for all instances for all applications for the specified virtual host. You must be a server administrator to call this method.

Availability

Flash Communication Server 1.0.

Parameters

adaptor
A String indicating the user name of the adaptor. If not specified, it is assumed to be _defaultRoot_.

vhost
A String indicating the user name of the virtual host. If not specified, it is assumed to be _defaultVHost_.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object containing the virtual host performance data. The data object has the following properties:

Property

Description

msg_in

Number; total number of messages processed by this virtual host.

msg_out

Number; total number of messages sent by this virtual host.

msg_dropped

Number; total number of messages dropped by this virtual host.

bytes_in

Number; total number of bytes read by this virtual host.

bytes_out

Number; total number of bytes written by this virtual host.

accepted

Number; total number connections accepted by this virtual host.

rejected

Number; total number of connections rejected by this virtual host.

connected

Number; total number of connections currently active.

total_apps

Number; total number of applications that have been created.

total_connects

Number; total number of connections to the server.

total_disconnects

Number; total number of disconnections from the server.

total_instances_loaded

Number; total number of instances that have been loaded.

This property does not represent the total number of active instances loaded. To get the number of active instances loaded, subtract the value of total_instances_unloaded from total_instances_loaded.

total_instances_unloaded

Number; total number of instances that have been unloaded.

server_bytes_in

Number; total number of rtmp bytes read by an SSAS NetConnection

server_bytes_out

Number; total number of rtmp bytes sent by an SSAS NetConnection

bw_in

Number; current bandwidth in, in bytes per second.

bw_out

Number; current bandwidth out, in bytes per second.

normal_connects

Number; total number of normal connections.

virtual_connects

Number; total number of connections through a remote edge.

group_connects

Number; total number of remote edges that are connected.

service_connects

Number; total number of service connections.

service_requests

Number; total number of services requested.

admin_connects

Number; total number of administrator connections.

debug_connects

Number; total number of debug connections.

swf_verification_attempts

A counter of the number of SWF verification attempts made. Represents the total SWF verification credentials passed to the server for checking. There may be more than one credential presented per connection.

swf_verification_exceptions

A counter of the number of SWF verification exceptions made. Exceptions are allowed through explicit configuration in the Application.xml file that allows certain user agents to bypass the requirement for SWF verification. Every connection allowed as an exception is counted here.

swf_verification_failures

A counter of the number of SWF verification failures. Failures result from the presentation of SWF verification credentials that are found not to be a match for any loaded credential. Each failure corresponds to a disconnection of the presenting connection.

swf_verification_unsupported_rejects

A counter of the number of SWF verification unsupported rejections. When a version of Flash Player that doesn’t support SWF verification connects to an application that requires SWF verification, the unsupported rejection count is increased. Also, the connecting client is disconnected.

swf_verification_matches

A counter of the total number of matches. When an authentic SWF verification credential is presented, this number increases. There may be more than one match per connection.

swf_verification_remote_misses

A counter of the proxy/remote server process’s missed SWF verification attempts. Whenever a proxy/remote server receives a SWF verification attempt it looks to its local cache for valid SWF verification. If it does not locate a match it logs a remote miss and defers to the origin to answer the verification attempt.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

logClientData()

RTMP/E

logClientData(auser:String, apswd:String, appinst:String, client:String, mode:Array) : Object

HTTP

http://my_server_ip_address:1111/admin/logClientData?auser=fmsadmin&apswd=fmsadminpassword&appinst="live/_definst_"&client="-1"&mode=[bytes-in,msgs-in] 

Sends data about clients connected to an application instance to two new log files: bytes_in_xxxxx.log and msgs_in_xxxxx.log. These logs live in the rootinstall/logs folder.

Before calling this API, do the following:

  1. Load the application into Flash Media Server.

  2. Enable all HTTP commands in the rootinstall/conf/Users.xml configuration file:

    <HTTPCommands> 
        <Allow>All</Allow> 
        <Deny/> 
    </HTTPCommands>
  3. Restart Flash Media Administration Server.

Availability

Flash Media Server 3.5.3

Parameters

auser
A string indicating the user name of the administrator.

apswd
A string indicating the password of the administrator.

appinst
A string indicating the path from the application name to the application instance name.

client
A string indicating the client or clients to log data for. To log data about all clients, use "-1". To log data based on Client.id, use the format: client="id:CBAYgnfG". To log data based on Client.ip, use the format client="ip:10.20.30.40".

mode
An array indicating the logs to create. Possible values are bytes-in and msgs-in.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a timestamp property that is a Date object. The Date object indicates the time that the method was executed.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level>status</level>  
    <code>NetConnection.Call.Success</code>  
    <timestamp>3/30/2011 5:56:07 PM</timestamp>  
    <data /> 
</result>

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

ping()

RTMP/E

ping() : Object

HTTP

http://www.example.com:1111/admin/ping?auser=username&apswd=password 

Verifies that the server is running; the server responds with a status message. You can use this method to check the status of the server.

Availability

Flash Communication Server 1.0.

Parameters

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a timestamp property that is a Date object. The Date object indicates the time that the method was executed.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

reloadApp()

RTMP/E

reloadApp(appInst:String) : Object

HTTP

http://www.example.com:1111/admin/reloadApp?auser=username&apswd=password&appInst=name

Shuts down an instance of the application, if running, and reloads it. All users are disconnected.

Note: If you specify an application name, this call reloads the _definst_ instance.

After this method executes, users must reconnect to the application or instance of the application.

Call this method to preload an instance of an application or reload it when application configuration changes are made or the script that is associated with the application has been changed.

Availability

Flash Communication Server 1.0.

Parameters

appInst
A String indicating the name of the application or instance of the application, in the form application_name[/instance_name]. To reload the default instance of an application, specify only the name of the application.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status and a code property of NetConnection.Call.Success.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Admin.Command.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

Nested in the data element are elements for each property of the data object listed in the RTMP/E section.

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

See also

unloadApp()

removeAdmin()

RTMP/E

removeAdmin(user:String [,scope:String]) : Object

HTTP

http://www.example.com:1111/admin/removeAdmin?auser=username&apswd=password&user=name[&scope=scope]

Removes an administrator from the system. Depending on the parameters you specify, you can remove server administrators or virtual host administrators.

You must be a server administrator to remove an administrator from the system.

Availability

Flash Communication Server 1.0.

Parameters

user
A String indicating the user name of the administrator being removed.

scope
A String indicating which administrator you want to remove.

To remove a virtual host administrator from the virtual host to which you’re connected, omit this parameter. To remove a virtual host administrator from a different virtual host, specify the virtual host as adaptor_name/virtual_hostname.

To remove a server administrator, specify server.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status and a code property of NetConnection.Call.Success.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Admin.Command.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

If the specified administrator does not exist, the call fails.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
</result>

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Example

The following examples show the removeAdmin() method:

nc_admin = new NetConnection(); 
nc_admin.connect("rtmp://localhost:1111/admin", "JLee", "x52z49ab"); 
 
/* Remove a server administrator named "DYoung" */ 
nc-admin.call("removeAdmin", new onRemoveAdmin(), "DYoung", "server"); 
 
/* Remove a virtual host administrator named "LPark" */ 
nc_admin.call("removeAdmin", new onRemoveAdmin(), "LPark"); 
 
/* Remove a virtual host administrator "JGarcia" from vhost tree.oak.com */ 
nc_admin.call("removeAdmin", new onRemoveAdmin(), "JGarcia", "_defaultRoot_/ ¬  
tree.oak.com");

See also

addAdmin()

removeApp()

RTMP/E

removeApp(appName:String) : Object

HTTP

http://www.example.com:1111/admin/removeApp?auser=username&apswd=password&appName=name

Removes the specified application or instance of an application from the virtual host. First, all instances of the specified application are unloaded. Then the application directory is removed from the virtual host. If you specify an instance of an application, only that instance is unloaded and removed, and all streams and shared objects for that instance are deleted.

Availability

Flash Communication Server 1.0.

Parameters

appName
A String indicating the name of the application or instance of the application you want to remove, in the form application_name[/instance_name].

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status and a code property of NetConnection.Call.Success.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Admin.Command.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
</result>

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Example

The following example shows how you remove the entire application ChatApp and then shows how you remove a specific instance Instance1 of an application ChatApp.

nc_admin = new NetConnection(); 
nc_admin.connect("rtmp://localhost:1111/admin", "JGarcia", "ezcabby1"); 
 
/* Removes the application along with all instances of the application */ 
 
nc_admin.call("removeApp", new onRemoveApp(), "ChatApp"); 
 
/* Removes only the specified instance */ 
 
nc_admin.call("removeApp", new onRemoveApp(), "ChatApp/Instance1");

See also

addApp()

removeVHostAlias()

RTMP/E

removeVHostAlias(vhost:String, alias:String) : Object

HTTP

http://www.example.com:1111/admin/removeVHostAlias?auser=username&apswd=password&vhost=name&alias=name

Removes an alias from a virtual host. Aliases are alternative names for virtual hosts that are used as targets by incoming Flash Media Server connections. When you remove an alias, that name is no longer available for incoming connections.

Availability

Flash Media Server 2.0.

Parameters

vhost
A String indicating the virtual host from which to remove an alias.

alias
A String indicating the alias name to remove from the specified virtual host.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, and a code property of NetConnection.Call.Success.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
</result>

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Example

nc_admin = new NetConnection(); 
nc_admin.connect("rtmp://localhost:1111/admin", "JLee", "x52z49ab") 
admin_nc.call("removeVHostAlias",new Result(),"myvhost","myalias");

restartVHost()

RTMP/E

restartVHost([vhost:String]) : Object

HTTP

http://www.example.com:1111/admin/restartVHost?auser=username&apswd=password[&vhost=vhost]

Restarts a virtual host that is currently running. Restarting a virtual host disconnects all connected users, unloads all currently loaded applications, and reloads the configuration files for that virtual host. For restartVHost() to work properly, there must be at least one application instantiated on the virtual host.

If you make changes to the configuration files for a virtual host, you can call this method to restart the virtual host without restarting the server.

Users must reconnect each time you restart a virtual host. Before calling this method, you might want to take steps to notify connected users.

Virtual host administrators can only restart the virtual hosts to which they are connected. You must be a server administrator to start a virtual host other than the one to which you’re connected.

Note: To start a virtual host that is stopped, call the startVHost() method. You must be a server administrator to call this method.

Availability

Flash Communication Server 1.0.

Parameters

vhost
A String indicating which virtual host you want to restart.

To restart the virtual host to which you’re connected, omit this parameter.

To restart a different virtual host, specify the virtual host as adaptor_name/virtual_hostname.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status and a code property of NetConnection.Call.Success.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Admin.Command.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
</result>

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Example

The following example shows a call to restart the connected virtual host and then a call to restart a specified virtual host tree.oak.com on the default adaptor:

nc_admin = new NetConnection(); 
nc_admin.connect("rtmp://localhost:1111/admin", "JLee", "x52z49ab"); 
 
/* Restart the connected virtual host */ 
nc_admin.call("restartVHost", new onRestartVHost()); 
 
/* Restart the virtual host tree.oak.com on the default adaptor. */ 
nc_admin.call("restartVHost", new onRestartVHost(), "_defaultRoot_/tree.oak.com");

setConfig()

RTMP/E

setConfig(key:String, value:String, [,scope:String]) : Object

HTTP

http://www.example.com:1111/admin/setConfig?auser=username&apswd=password&key=string&value=string [&scope=scope]

This API has been deprecated; use setConfig2() instead. Changes the value of the specified configuration key in a specified configuration file. For a description of the XML configuration files, see Adobe Flash Media Server Configuration and Administration Guide.

Virtual host administrators can change the values of configuration keys in the Vhost.xml file and Application.xml files for their own virtual hosts. You must be a server administrator to change the values of most configuration keys in the Server.xml and Adaptor.xml files.

Note: It is possible to have more than one XML tag with the same name at the same level in the XML tree. In the configuration file, you should distinguish such tags by using a name attribute in the XML tag (for example, if you have more than one virtual host: <VirtualHost name="www.redpin.com"></VirtualHost>.) When you call the setConfig() method and specify the configuration subkeys, you can indicate which tag you want by specifying the tag name, followed by a colon and the correct name attribute, for example: Adaptor:_defaultRoot_/VirtualHost:www.redpin.com.

Availability

Flash Communication Server 1.0.

Parameters

key
A String indicating the configuration key for which you want to change the value.

A key is specified as a list of subkeys delimited by slashes (/). The first subkey specifies the XML configuration file that contains the desired configuration key. Subsequent subkeys correspond to tags that are relative to that XML configuration file; the hierarchy and names of the subkeys match the tags in the XML file.

Depending on your permissions, you can change the values of configuration keys for the following files:

  • For the Server.xml file, specify Admin or Server as the first subkey. All subsequent keys correspond to tags that are relative to the <Admin> or <Server> tag in the Server.xml file.

    You must be a server administrator to set configuration keys in the <Server> tag.

    Virtual host administrators can set configuration keys for their own virtual host only. They might not be able to set certain kinds of sensitive information; for example, they can set their own password, but they cannot set other virtual host administrators’ passwords or permission settings.

  • For the Adaptor.xml file, specify as the first subkey Adaptor:adaptor_name, where adaptor_name is the name of the adaptor. All subsequent keys correspond to tags relative to the <Adaptor> tag in the Adaptor.xml file.

  • For the Vhost.xml file, specify as the first subkey Adaptor:adaptor_name/VirtualHost:vhost_name, where vhost_name is the name of the virtual host. All subsequent keys correspond to tags relative to the <VirtualHost> tag in the Vhost.xml file.

  • For the Application.xml file of an application that is running on the same virtual host to which you connected when you logged on to the administration server, specify as the first subkey Application:app_name, where app_name is the name of the application.

    To get a key in the Application.xml file for an application that is running on a different virtual host, specify the full key: Adaptor:adaptor_name/VirtualHost:vhost_name/Application:app_name. You must also specify the scope parameter; see the code example later in this entry.

    To get the default Application.xml file, specify Application without the colon (:) and the app_name attribute.

Note: If a subkey is specified but a corresponding tag doesn’t exist in the XML file, a new tag is created in the XML file.

value
A String indicating the value to set for the specified configuration key.

scope
A String; to change a configuration key in the Server.xml file, Adaptor.xml file, or Vhost.xml files, you must specify a slash (/) for this parameter.

To change a configuration key in the Application.xml file for an application that is running on the same virtual host to which you connected when you logged on to Flash Media Server, omit this parameter.

Note: To determine the adaptor or virtual host to which you’re connected, use the getAdminContext() method.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status and a code property of NetConnection.Call.Success. The value of the configuration key is changed.

If the call fails, the server sends a reply information object with a level property of error, a code property of NetConnection.Call.BadValue, and a description property that contains a string describing the cause of the failure.

This call fails if the specified configuration key cannot be found or if you do not have permission to change its value.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
</result>

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Examples

The following examples show how to set new values for configuration keys in each of the four XML files:

// Establish connection to server 
nc_admin = new NetConnection(); 
nc_admin.connect("rtmp://localhost:1111/admin", "LGreen", "123jn098"); 
 
// For a virtual host administrator, change key in Server.xml 
// Set Password for user LGreen to "strawman28" 
key = "Admin/Server/UserList/User:LGreen/Password"; 
val = "strawman28" 
nc_admin.call("setConfig", new onSetConfig(), key, val, "/"); 
 
// For a server administrator, change key in Server.xml 
// Set LicenseInfo to "Helloworld" 
key = "Server/LicenseInfo"; 
val = "Helloworld"; 
nc_admin.call("setConfig", new onSetConfig(), key, val, "/"); 
 
// Change key in Adaptor.xml 
// Set HostPort to 128.0.0.1:1938 
key = "Adaptor:_defaultRoot_/HostPortList/HostPort"; 
val = "128.0.0.1:1938"; 
nc_admin.call("setConfig", new onSetConfig(), key, val, "/"); 
 
// Change key in Vhost.xml 
// Set RecordAccessLog to true 
key = "Adaptor:_defaultRoot_/VirtualHost:_defaultVHost_/RecordAccessLog"; 
val = "true"; 
nc_admin.call("setConfig", new onSetConfig(), key, val, "/"); 
 
// Change key in Application.xml for an application on the virtual host  
// you connected to when you logged on to the administration server. 
// Note that the previous subkeys and the final parameter "/" are not 
// necessary. 
key = "Application:FinanceApp/RecordAppLog"; 
val = "true"; 
nc_admin.call("setConfig", new onSetConfig(), key, val); 
 
// Change key in Application.xml for a different virtual host. 
// The adaptor and virtual host names and the second parameter are necessary. 
key = "Adaptor:_defaultRoot_/VirtualHost:www.redpin.com/Application:ChatApp/ ¬ RecordAppLog"; 
val = "true"; 
nc_admin.call("setConfig', new onSetConfig(), key, val, "/");

setConfig2()

RTMP/E

setConfig2(key:String, value:String, scope:String) : Object

HTTP

http://www.example.com:1111/admin/setConfig2?auser=username&apswd=password&key=string&value=string&scope=scope

Changes the value of the specified configuration key in a specified configuration file. Flash Media Server has six server configuration files: Server.xml, Users.xml, Logger.xml, Adaptor.xml, Vhost.xml, and Application.xml. For a description of the XML configuration files, see Adobe Flash Media Server Configuration and Administration Guide.

Virtual host administrators can change the values of configuration keys in the Vhost.xml file and Application.xml files for their own virtual hosts. You must be a server administrator to change the values of most configuration keys in the Server.xml and Adaptor.xml files.

Note: It is possible to have more than one XML tag with the same name at the same level in the XML tree. In the configuration file, you should distinguish such tags by using a name attribute in the XML tag (for example, if you have more than one virtual host: <VirtualHost name="www.redpin.com"></VirtualHost>.) When you call the setConfig() method and specify the configuration subkeys, you can indicate which tag you want by specifying the tag name, followed by a colon and the correct name attribute, for example: Adaptor:_defaultRoot_/VirtualHost:www.redpin.com.

Availability

Flash Media Server 2.0.

Parameters

key
A String indicating the configuration key for which you want to change the value.

A key is specified as a list of subkeys delimited by slashes (/). The first subkey specifies the XML configuration file that contains the desired configuration key. Subsequent subkeys correspond to tags that are relative to that XML configuration file; the hierarchy and names of the subkeys match the tags in the XML file. Here is an example: "/Server/LicenseInfo"

value
A String indicating the value to set for the specified configuration key. If the value specified is a simple string, it is set as the tag data for the specified tag. If the value is valid XML, for example, <foo>bar</foo>, the XML is added as a child tag to the specified tag. If the value is an empty string, the specified tag is removed.

scope
A String indicating which configuration file to search for the configuration tag specified in the key parameter.

Flash Media Server has six server configuration files: Server.xml, Users.xml, Logger.xml, Adaptor.xml, Vhost.xml, and Application.xml. Depending on your permissions, you can get configuration keys for all these files, as described in the following list:

  • / specifies Server.xml.

  • Users specifies Users.xml for server administrators.

  • Logger specifies Logger.xml.

  • Adaptor:<adaptor_name> specifies Adaptor.xml. Specify the adaptor name in place of the <adaptor_name> placeholder. You must have server administrator privileges to access the Adaptor.xml file. If <adaptor_name> is not the name of the adaptor the caller is connected to, the call fails.

  • Adaptor:<adaptor_name>/VHost:<vhost_name> specifies VHost.xml. Specify the virtual host name in place of the <vhost_name> placeholder. If <adaptor_name> is not the name of the adaptor the caller is connected to, or <vhost_name> is not the name of the virtual host that the caller is connected to, the call fails.

  • Adaptor:<adaptor_name>/VHost:<vhost_name>/Users.xml specifies Users.xml for virtual host administrators.

  • Adaptor:<adaptor_name>/VHost:<vhost_name>/App[:<app_name>] specifies Application.xml. If no <app_name> is specified, the default Application.xml file is assumed. Otherwise, the application-specific Application.xml for the specified application is used. If the specified application is not defined, or the application does not have an application-specific Application.xml file, the call fails.

Note: To determine the adaptor or virtual host to which you’re connected, call the getAdminContext() method.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status and a code property of NetConnection.Call.Success. The value of the configuration key is changed.

If the call fails, the server sends a reply information object with a level property of error, a code property of NetConnection.Call.BadValue, and a description property that contains a string describing the cause of the failure.

This call fails if the specified configuration key cannot be found or if you do not have permissions to change its value.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
</result>

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Examples

The following examples show how to set new values for configuration keys:

tSocket = new NetConnection(); 
tSocket.connect("rtmp://localhost/admin", "user", "password"); 
 
// set tag data in Server.xml 
key = "Server/LicenseInfo"; 
val = "SFD150-XXXXX-XXXXX-XXXXX"; 
tSocket.call("setConfig2", new onSetConfig(), key, val, "/"); 
 
// set tag data in Adaptor.xml 
key = "HostPortList/HostPort"; 
val = ":1935, 80, 443"; 
scope = "Adaptor:_defaultRoot_"; 
tSocket.call("setConfig2", new onSetConfig(), key, val, scope); 
 
// set tag data in Vhost.xml 
key = "AppsDir"; 
val = "c:\\applications"; 
scope = "Adaptor:_defaultRoot_/VHost:_defaultVHost_"; 
tSocket.call("setConfig2", new onSetConfig(), key, val, scope); 
 
// set tag data in Application.xml for app "foo" 
key = "Process/Scope"; 
val = "inst"; 
scope = "Adaptor:_defaultRoot_/VHost:_defaultVHost_/App:foo"; 
tSocket.call("setConfig2", new onSetConfig(), key, val, scope); 
 
// add child tag to a tag in default Application.xml 
key = "Process"; 
val = "<Scope>inst</Scope>"; 
scope = "Adaptor:_defaultRoot_/VHost:_defaultVHost_/App"; 
tSocket.call("setConfig2", new onSetConfig(), key, val, scope); 
 
// delete tag in default Application.xml 
key = "Process"; 
val = ""; 
scope = "Adaptor:_defaultRoot_/VHost:_defaultVHost_/App"; 
tSocket.call("setConfig2", new onSetConfig(), key, val, scope);

startServer()

RTMP/E

startServer([mode:String]) : Object

HTTP

http://www.example.com:1111/admin/startServer?auser=username&apswd=password[&mode=string]

Starts the Flash Media Server service or stops it and restarts it.

You must be a server administrator to perform this operation.

Availability

Flash Communication Server 1.0.

Parameters

mode
A String indicating whether to restart the server.

If the server is not running and you want to start it, omit this parameter. If the server is already running and you want to stop it and then restart it, you must specify restart for this parameter. (If the server is running and you omit this parameter, this method does nothing.)

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status and a code property of NetConnection.Call.Success.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Admin.Command.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
    <data></data>  
</result>

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

See also

stopServer()

startVHost()

RTMP/E

startVHost(vhost:String) : Object

HTTP

http://www.example.com:1111/admin/startVHost?auser=username&apswd=password&vhost=name

Starts a stopped virtual host or enables a new virtual host.

This method lets you enable a new virtual host at run time without restarting the server. The new virtual host directory and configuration files must already be present in the server’s conf directory; the startVHost() method does not create or copy any directories or configuration files. For information on adding virtual hosts, see Adobe Flash Media Server Configuration and Administration Guide.

You must be a server administrator to use the startVHost() method.

Availability

Flash Communication Server 1.0.

Parameters

vhost
A String indicating the name of the virtual host you want to start or the new virtual host you want to enable, in the form [adaptor/]vhost.

If you are enabling a new virtual host on the adaptor to which you’re connected, omit adaptor/.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status and a code property of NetConnection.Call.Success.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Admin.Command.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
</result>

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Example

The following example starts a virtual host named diamond.world.com on the currently connected adaptor and then starts a virtual host named diamond.world.com on the gem adaptor.

nc_admin = new NetConnection(); 
nc_admin.connect("rtmp://localhost:1111/admin", "JLee", "x52z49ab"); 
 
/* Starts a virtual host named diamond.world.com */ 
nc_admin.call("startVHost", new onStartVHost(), "diamond.world.com"); 
 
/* Starts a virtual host named diamond.world.com on the adaptor, gem */ 
nc_admin.call("startVHost", new onStartVHost(), "gem/diamond.world.com");

stopServer()

RTMP/E

stopServer(mode:String) : Object

HTTP

http://www.example.com:1111/admin/stopServer?auser=username&apswd=password&mode=string

Shuts down the Flash Media Server. If you call this method while users are connected, you should take steps to notify users of an imminent server shutdown so that they do not lose their work.

You must be a server administrator to perform this operation.

Availability

Flash Communication Server 1.0.

Parameters

mode
A String indicating how the server is to be shut down. Possible values are normal or abort. If you use the value normal, the server shuts down, allowing running applications to end normally. If you use the value abort, the server immediately shuts down and running applications will not be allowed to stop normally. Use the value abort only in an emergency or if specifying normal does not work.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status and a code property of NetConnection.Call.Success.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Admin.Command.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
</result>

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

See also

startServer()

stopVHost()

RTMP/E

stopVHost([vhost:String]) : Object

HTTP

http://www.example.com:1111/admin/stopVHost?auser=username&apswd=password[&vhost=name]

Stops a running virtual host. (The stopVHost() command cannot be used on the default virtual host.) After the virtual host stops, all applications are unloaded and all users are disconnected. The virtual host does not accept any requests until it has been restarted by means of the startVHost() method or until the server is restarted.

Availability

Flash Communication Server 1.0.

Parameters

vhost
A String indicating the virtual host that you want to stop. To stop the virtual host to which you’re connected, omit this parameter.

To stop a different virtual host, specify vhost_name in the form adaptor_name/vhost_name. You must be a server administrator to stop a virtual host other than the one to which you’re connected.

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status and a code property of NetConnection.Call.Success.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Admin.Command.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
</result>

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

Example

The following example stops the virtual host tree.oak.com and then stops the virtual host tree.oak.com on the default adaptor.

nc_admin = new NetConnection(); 
nc_admin.connect("rtmp://localhost:1111/admin", "JLee", "x52z49ab"); 
 
/* Stop the vhost named tree.oak.com */  
nc_admin.call("stopVHost", new onStopVHost(), "tree.oak.com");  
 
/* Stop the vhost named tree.oak.com on the default adaptor */ 
nc_admin.call("stopVHost", new onStopVHost(), "_defaultRoot_/tree.oak.com");

unloadApp()

RTMP/E

unloadApp(appInst:String) : Object

HTTP

http://www.example.com:1111/admin/unloadApp?auser=username&apswd=password&appInst=name

Shuts down all instances of the specified application or instance of an application. If an application name is specified, all instances of the application are shut down and all the users who are connected to any instance of the application are immediately disconnected. If an instance of an application is specified, only that instance is shut down, and all the users who are connected to that instance are immediately disconnected.

Note: Before calling this method, take steps to notify users of the imminent shutdown of an application.

Availability

Flash Communication Server 1.0.

Parameters

appInst
A String indicating the name of the application or instance of the application, in the form application_name[/instance_name].

auser
A String indicating the user name of the administrator.

apswd
A String indicating the password of the administrator.

Returns

RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status and a code property of NetConnection.Call.Success.

If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Admin.Command.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.

HTTP
If the call succeeds, it returns XML with the following structure:
<result> 
    <level></level>  
    <code></code>  
    <timestamp></timestamp>  
</result>

If the call fails, it returns XML with the following structure:

<result>  
    <level></level>  
    <code></code>  
    <description></description>  
    <timestamp></timestamp>  
</result>

The XML elements contain the same information as the Object properties returned in an RTMP/E call.

Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).

See also

reloadApp()