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).

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy