Returns a detailed set of information about a stream.

Parameter Name Mandatory Default Value Description
id true null The uniqueId of the stream. Usually a value returned by listStreamsIDs. This parameter is not mandatory but either this or the localStreamName should be present to identify the particular stream
localStreamName true zero length string The name of the stream. This parameter is not mandatory but either this or the id should be present to identify the particular stream

Example:

API Call:

getStreamInfo id=1

JSON Response:

{
"data":{
    "appName":"evostreamms",
    "audio":{
        "bytesCount":168860,
        "codec":"AAAC",
        "codecNumeric":4702111241970122752,
        "droppedBytesCount":0,
        "droppedPacketsCount":0,
        " packetsCount":521
        },
    "bandwidth":0,
    "connectionType":1,
    "creationTimestamp":14480039 54598.3130,
    "farIp":"54.239.131.151",
    "farPort":1935,
    "ip":"192.168.2.35",
    "name":"t estpullstream",
    "nearIp":"192.168.2.35",
    "nearPort":1299,
    "outStreamsUniqueIds":null,
    "pageUrl":"",
    "port":1299,
    "processId":12848,
    "processType":"origin",
    "pullSetting s":{
        "_callback":null,
        "audioCodecBytes":"",
        "configId":1,
        "emulateUserAgent":"EvoSt ream Media Server (www.evostream.com) player",
        "forceTcp":false,
        "httpProxy":"",
        "isAudio":true,
        "keepAlive":true,
        "localStreamName":"testpullstream",
        "operationType":1,
        "pageUrl":"",
        "ppsBytes":"",
        "rangeEnd":-1,
        "rangeStart":-2,
        "rtcpDetectionInterv al":10,
        "sendRenewStream":false,
        "spsBytes":"",
        "ssmIp":"",
        "swfUrl":"",
        "tcUrl":"",
        "tos":256,
        "ttl":256,
        "uri":"rtmp:\/\/s2pchzxmtymn2k.cloudfront.net\/cfx\/st\/mp4:s intel.mp4"
        },
    "queryTimestamp":1448003961907.7310,
    "serverAgent":"FMS\/3,5,7,7009",
    "swfUrl":"rtmp:\/\/s2pchzxmtymn2k.cloudfront.net\/cfx\/st\/mp4:sintel.mp4",
    "tcUrl":"rtmp:\/\/s2pchzxmtymn2k.cloudfront.net\/cfx\/st\/mp4:sintel.mp4",
    "type":"INR ",
    "typeNumeric":5282249572905648128,
    "uniqueId":1,
    "upTime":7309.4180,
    "video":{
        "bytesCount":825054,
        "codec":"VH264",
        "codecNumeric":6217274493967007744,
        "droppedByte sCount":0,
        "droppedPacketsCount":0,
        "height":306,
        "level":30,
        "packetsCount":291,
        "profile":66,
        "width":720
        }
},
"description":"Stream information",
"status":"SUCCESS"
}

The JSON response contains the following details about a given stream:

  • data – The data to parse
    • appName - ??
    • audio – stats about the audio portion of the stream
      • bytesCount - Total amount of audio data received
      • codec - ??
      • codecNumeric - ??
      • droppedBytesCount - The number of video bytes lost
      • droppedPacketsCount – The number of lost audio packets
      • packetsCount – Total number of audio packets received
    • bandwidth – The current bandwidth utilization of the stream
    • connectionType - ??
    • creationTimestamp – The UNIX timestamp for when the stream was created. UNIX time is expressed as the number of seconds since the UNIX Epoch (Jan 1, 1970)
    • farIp - The IP address of the distant party
    • farPort - The port used by the distant party
    • ip - IP address of the source stream’s host
    • name – the “localStreamName” for this stream.
    • nearIp - The IP address used by the local computer
    • nearPort - The port used by the local computer
    • outStreamsUniqueIDs – For pulled streams. An array of the “out” stream IDs associated with this “in” stream
    • pageUrl - A link to the page that originated the request (often unused)
    • port - The port bound to the service
    • processID - ??
    • preocessType - ??
    • pullSettings/pushSettings – Not present for streams requested by a 3rd party (IE player/client). A copy of the parameters used in the pullStream or pushStream command.
      • _callback - ??
      • audioCodecBytes - The audio codec setup of this RTP stream if it is audio
      • configId – The identifier for the pullPushConfig.xml entry
      • emulateUserAgent – The string that the EMS uses to identify itself with the other server. It can be modified so that EMS identifies itself as, say, a Flash Media Server
      • forceTcp – Whether TCP MUST be used, or if UDP can be used
      • httpProxy - May either be IP:Port combination or self
      • isAudio - Indicates if the currently pulled stream is an audio source
      • keepAlive – If true, the stream will try to reconnect if the connection is severed
      • localStreamName – Same as the above “name” field
      • operationType – The type of operation
      • pageUrl – A link to the page that originated the request (often unused)
      • ppsBytes - The video PPS bytes of this RTP stream if it is video
      • rangeEnd - The length in seconds for the playback
      • rangeStart - A value from which the playback should start expressed in seconds
      • rtcpDetectionInterval – Used for RTSP. This is the time period the EMS waits to determine if an RTCP connection is available for the RTSP/RTP stream. (RTSP is used for synchronization between audio and video)
      • sendRenewStream - If 1, the server will send RenewStream via SET_PARAMETER when a new client connects
      • spsBytes - The video SPS bytes of this RTP stream if it is video
      • swfUrl – The location of the Flash Client that is generating the stream (if any)
      • tcUrl – An RTMP parameter that is essentially a copy of the URI
      • tos – Type of Service network flag
      • ttl – Time To Live network flag
      • uri – The parsed values of the source streams URI
    • queryTimestamp – The time (in UNIX seconds) when the information in this request was populated
    • serverAgent - ??
    • swfUrl - The location of the Flash Client that is generating the stream (if any)
    • tcUrl - An RTMP parameter that is essentially a copy of the URI
    • type – The type of stream this is. The first two characters are of most interest:
      • char 1 = I for inbound, O for outbound
      • char 2 = N for network, F for file
      • char 3+ = further details about stream
      • example: INR = Inbound Network Stream (a stream coming from the network into the EMS)
    • typeNumeric - ??
    • uniqueId – The unique ID of the stream (integer)
    • upTime – The time in seconds that the stream has been alive/running for.
    • video – Stats about the video portion of the stream
      • bytesCount - Total amount of video data received
      • codec - ??
      • codecNumeric - ??
      • droppedBytesCount – The number of video bytes lost
      • droppedPacketsCount – The number of lost video packets
      • height - The video stream’s pixel height
      • level - ??
      • packetsCount – Total number of video packets received
      • profile - ??
      • width - The video stream’s pixel width
  • description – Describes the result of parsing/executing the command
  • status – SUCCESS if the command was parsed and executed successfully, FAIL if not