pullStream

This will try to pull in a stream from an external source. Once a stream has been successfully pulled it is assigned a “local stream name” which can be used to access the stream from the EMS.

Note: When you want to record the content of your pulled stream using record, createHlsStream, or commands similar to these, it is advisable to call the recording command first before issuing the pullStream command. The rationale for this is because the pulled stream will already be running in the background once pulled. This may become the reason for missing some of the stream’s content if it is already running beforehand, and the recording configuration has not started up yet.

This function has the following parameters:

The EMS provides several shorthand User Agent strings (not case-sensitive) for convenience:

An example of the pullStream interface is:

pullStream uri=rtsp://AddressOfStream keepAlive=1 localStreamname=RTSPteststream

pullStream uri=rtmp://AddressOfStream keepAlive=1 localStreamname=RTMPteststream

Then, to access that stream via a flash player, the following URI can be used:

rtsp://AddressOfEMS:5544/RTSPteststream

rtmp://AddressOfEMS/live/RTMPteststream

Example:

API Call:

pullstream uri=rtmp://s2pchzxmtymn2k.cloudfront.net/cfx/st/mp4:sintel.mp4 localStreamname=testpullstream

JSON Response:

{
"data":{
    "audioCodecBytes":"",
    "configId":1,
    "emulateUserAgent":"EvoStream Media Server (www.evostream.com) player",
    "forceTcp":false,
    "httpProxy":"",
    "isAudio":true,
    "keepAlive":true,
    "localStreamName":"testpullstream",
    "operationType":1,
    "pageUrl":"",
    "ppsBytes":"",
    "rangeEnd":-1,
    "rangeStart":-2,
    "rtcpDetectionInterval":10,
    "sendRenewStream":false,
    "spsBytes ":"",
    "ssmIp":"",
    "swfUrl":"",
    "tcUrl":"",
    "tos":256,
    "ttl":256,
    "uri":{
      "document":"mp4:sintel.mp4",
      "documentPath":"\/cfx\/st\/",
      "documentWithFullParameters":"mp4:sintel.mp4",
      "fullD ocumentPath":"\/cfx\/st\/mp4:sintel.mp4",
      "fullDocumentPathWithParameters":"\/cfx\/st\/mp4:sintel.mp4",
      "fullParameters":"",
      "fullUri":"rtmp:\/\/s2pchzxmtymn2k.cloudfront.net\/cf x\/st\/mp4:sintel.mp4",
      "fullUriWithAuth":"rtmp:\/\/s2pchzxmtymn2k.cloudfront.net\/cfx\/st\/mp4:sintel.mp4",
      "host":"s2pchzxmtymn2k.cloudfront.net",
      "ip":"54.239.131.57",
      "original Uri":"rtmp:\/\/s2pchzxmtymn2k.cloudfront.net\/cfx\/st\/mp4:sintel.mp4",
      "parameters":{
          },
      "password":"",
      "port":1935,
      "portSpecified":false,
      "scheme":"rtmp",
      "userName":""
      }
},
"description":"Stream rtmp:\/\/s2pchzxmtymn2k.cloudfront.net\/cfx\/st\/mp4:sintel.mp4 enqueued for pulling",
"status":"SUCCESS”
}

The JSON response for pullStream contains the following details:

• data – The data to parse
  • audioCodecBytes - The audio codec setup of thisRTP stream if it is audio
  • configID – The configuration ID for this command
  • emulateUserAgent – This is 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 orself
  • isAudio - Indicates if the currently pulled stream is an audio source
  • keepAlive – If true, the stream will attempt to reconnect if the connection is severed
  • localStreamName – The local name for the stream
  • 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 sendRenewStream via SET_PARAMETER when a new client connects
  • spsBytes - The video SPS bytes of this RTP stream if it is video
  • ssmIp - The source IP from source-specific-multicast
  • swfUrl – The location of the Flash Client thatis generating the stream (if any)
  • tcUrl – An RTMP parameter that is essentially acopy of the URI
  • tos – Type of Service network flag
  • ttl – Time To Live network flag
  • uri – Contains key/value pairs describing thesource stream’s URI
    • document – The document name of the source stream
    • documentPath – The document path of the source stream
    • documentWithFullParameters – The document name with parameters of the source stream
    • fullDocumentPath - The document path of the destination stream
    • fullDocumentPathWithParameters - The document path with parameters of the destination stream
    • fullParameters – The parameters for the source stream’s URI
    • fullUri – The full URI of the source stream
    • fullUriWithAuth – The full URI with authentication of the source stream
    • host – Name of the source stream’s host
    • ip – IP address of the source stream’s host
    • originalUri – The source stream’s URI where it was generated
    • parameters – Parameters for the source stream’s URI (if any)
    • password – Password for authenticating the source stream (if required)
    • port – Port used by the source stream
    • portSpecified – True if the port for the source stream is specified
    • scheme – The protocol used by the source stream
    • userName – The user name for authenticating the source stream (if required)

• description– Describes the result of parsing/executing the command

• status– SUCCESS if the command was parsed and executed successfully, FAIL if not