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

See also

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