Use the Administration API to monitor, manage, and configure the server from an Adobe Flash Player or Adobe AIR client over RTMP or RTMPE or from a web client over HTTP. The Adobe Media Server Administration Console was built using the Administration API. The API is documented in Adobe Media Server Administration API Reference.

Here are a few important tips for working with the Administration API:

• Both Adobe Media Server and Adobe Media Administration Server must be running.

• This document assumes that you have not changed the default port number (1111) for the Administration Server; if you have, use your valid port number in all examples.

• If you do not specify an optional parameter, a default value may be used depending on the method. For example, if you do not specify a virtual host in the scope parameter, it is assumed that you want to perform the command on the virtual host to which you connected when you logged in to Adobe Media Server.

• By default, administrators are logged in to the “_defaultRoot_” adaptor. When logging in to a virtual host not on the default adaptor, virtual-host administrators must specify the name of the adaptor. For example, when logging in (over RTMP using NetConnection) to a virtual host on the adaptor _secondAdaptor_, the administrator JLee would enter the following information for the administrator user name parameter in the method call: _secondAdaptor_/JLee.

Set permissions for Administration API method calls over HTTP

Call an Administration API method over HTTP

Constructing an HTTP request string

Many Administration APIs expect one or more parameters in addition to auser and apswd. Parameters passed in an HTTP request must adhere to the following formatting rules:

• Name the parameters in the string. For example, the following code calls the addAdmin() method:

  http://localhost:1111/admin/addAdmin?auser=adminname&apswd=adminpassword&username="joe"&password="pass123"&vhost="_defaultRoot_/foo.myCompany.com"

• Strings are passed as literals surrounded by quotation marks. You can use either single quotation marks (') or double quotation marks (").

  "Hello World"

  'String2'

  The only exceptions are the auser and apswd parameters, which should be passed without quotation marks.

• Numbers are passed as either integer or floating-point literals.

  245

  1.03

  -45

  Note: When a number is used for an application name, the application name must be included within quotation marks (" ") for methods such as reloadApp() and unload App() to work properly.

• Arrays are passed as comma-separated values enclosed in square brackets.

  [1,2,3,4]

  ['abcd',34,"hi"]

  [10,20,[31,32],40]

• Objects are passed as inline object literals.

  {foo:123,bar:456}

  {user:"Joe",ssn:"123-45-6789"}

Call Administration API methods over RTMP or RTMPE

To call the Administration API over RTMP or RTMPE, you need a Flash Player or AIR client.

Create your first Flash application

This section contains the code for a simple Flash application that calls the getAppStats() method.

To call Administration APIs over RTMP, you need a Flash Player or AIR client. The following sample is built in Flash.

This example uses the NetConnection class to make a single request to the Adobe Media Server. If you want to create a persistent connection that updates automatically (like the Administration Console), you can use the NetStream class to create a streaming connection over the NetConnection.

Create your first application in Flex

The following application built in Flex uses the HTTPService class to call the Adobe Media Server administration API. It calls the getAppStats method and prints the results to the TextArea control.

Before you compile and run this example, you must add your admin username and password to the request parameters.

When you run the example, enter an application name in the TextInput control and click the Get App Stats button. Default applications include “live” and “vod”, but you can use the name of any application that you created on the server.

This application was written for Flex 4.

If the call is successful, the getAppStats method returns a result similar to the following:<result> <level>status</level> <code>NetConnection.Call.Success</code> <timestamp>6/30/2010 2:42:21 PM</timestamp> <data> <launch_time>6/30/2010 2:42:03 PM</launch_time> <up_time>17</up_time> <bw_in>17060</bw_in> <bw_out>17501</bw_out> <bytes_in>290075</bytes_in> <bytes_out>271130</bytes_out> <msg_in>202</msg_in> <msg_out>61</msg_out> <msg_dropped>0</msg_dropped> <total_connects>2</total_connects> <total_disconnects>0</total_disconnects> <connected>2</connected> <normal_connects>2</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>2</accepted> <rejected>0</rejected> <total_instances_loaded>1</total_instances_loaded> <total_instances_unloaded>0</total_instances_unloaded> <swf_verification_attempts>0</swf_verification_attempts> <swf_verification_exceptions>0</swf_verification_exceptions> <swf_verification_failures>0</swf_verification_failures> <swf_verification_unsupported_rejects>0</swf_verification_unsupported_rejects> <swf_verification_matches>0</swf_verification_matches> <swf_verification_remote_misses>0</swf_verification_remote_misses> <cores> <_0> <pid>15720</pid> <core_id>0</core_id> </_0> </cores> <server_bytes_in>0</server_bytes_in> <server_bytes_out>0</server_bytes_out> </data> </result>