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

See also

Get help faster and easier

New user?