RTSP Stream Diagnostics APIs

Transcription

1 CHAPTER 3 This chapter describes the format and content of the RTSP stream diagnostic API messages. The Real Time Streaming Protocol (RTSP) API messages are used for RTSP environments and consist of the following: StreamsBySmartcard, page 3-1 GetStreamDetailsBySessionId, page 3-3 GetStreamTrickmodesBySessionId, page 3-4 All HTTP request messages follow the format given in the HTTP Headers section on page 1-2. StreamsBySmartcard The StreamsBySmartcard request-response message returns the streams associated with a specified smart card. A smart card is a unique identifier (ID) that represents a set-top box (STB). Request Element: StreamsBySmartcard Table 3-1 describes the XML attributes for the StreamsBySmartcard request. Table 3-1 StreamsBySmartcard Attributes Data Types Descriptions Smartcard xs:string Unique ID for STB. Starttime xs:integer Stream start time. The time and date is represented in seconds since the start of UNIX epoch time. 1 Endtime xs:integer Stream end time. The time and date is represented in seconds since the start of UNIX epoch time UNIX epoch time is T00:00:00Z Request Example POST /rtsp/sdi?action=streamsbysmartcard HTTP/1.0 User-Agent: HTTPTool/1.0 Content-Type: text/xml Cseq: 123 Content-Length:

2 StreamsBySmartcard Chapter 3 <StreamsBySmartcard Smartcard = Starttime = Endtime = Note If you do not specify a Starttime and Endtime, all the streams that the STB has sent are listed. The Starttime and Endtime parameters represent the range to use for searching the start time of the streams. The response returns all the streams that have a start time that falls within Starttime and Endtime range. Response One of the following HTTP status codes is returned: 200 Ok Request was successful. 400 Bad Request Request parameters were incomplete or invalid. The StreamsBySmartcardResponse element is returned in the XML body response. Table 3-2 describes the XML body elements and attributes returned in the StreamsBySmartcardResponse element. Table 3-2 StreamsBySmartcardResponse Element Attributes Data Types Descriptions StreamObject Element Element that contains the stream information. SessionId xs:string Session ID associated with this stream. Content xs:string Name of content. Starttime xs:integer Stream start time (since start of UNIX epoch time). 1 Endtime xs:integer Stream end time (since start of UNIX epoch time) UNIX epoch time is T00:00:00Z Response Example <StreamsBySmartcardResponse> <StreamObject SessionId = Content = aviator.mpg Starttime = Endtime = <StreamObject SessionId = Content = looney.mpg Starttime = Endtime = </StreamsBySmartcardResponse> 3-2

3 Chapter 3 GetStreamDetailsBySessionId GetStreamDetailsBySessionId The GetStreamDetailsBySessionId request-response message returns a list of the stream details for a specified session ID. Request Element: GetStreamDetailsBySessionId Attribute: SessionId The SessionId attribute is a string data type. Request Example POST /rtsp/sdi?action=getstreamdetailsbysessionid HTTP/1.0 User-Agent: HTTPTool/1.0 Content-Type: text/xml Cseq: 123 Content-Length: 103 <GetStreamsDetailsBySessionId SessionId = " " Response One of the following HTTP status codes is returned: 200 Ok Request was successful. 400 Bad Request Request parameters were incomplete or invalid. The GetStreamDetailsBySessionIdResponse element is returned in the XML body response. Table 3-4 describes the XML body elements and attributes returned in the GetStreamDetailsBySessionIdResponse element. Table 3-3 GetStreamDetailsBySessionIdResponse Element Attributes Data Types Descriptions StreamDetails Element Element that contains the stream details. SessionId xs:string Session ID associated with this stream. Content xs:string Name of content. Starttime xs:integer Stream start time (since start of UNIX epoch time). 1 Endtime xs:integer Stream end time (since start of UNIX epoch time). 1 DestinationIP xs:string Destination IP address for this stream. DestinationPort xs:integer Destination port for this stream. ServiceGroup xs:integer Service Group used to send the stream. AllocatedBandwidth xs:integer Bandwidth allocated, in bits per second, for this stream. 1. UNIX epoch time is T00:00:00Z 3-3

4 GetStreamTrickmodesBySessionId Chapter 3 Response Example <?xml version="1.0" encoding="utf-8"?> <GetStreamDetailsBySessionIdResponse> <StreamDetails SessionId = " " StartTime = " " EndTime = " " DestinationIP = " " DestinationPort = "8198" ServiceGroup = "1234" AllocatedBandwidth = " " </GetStreamDetailsBySessionIdResponse> GetStreamTrickmodesBySessionId The GetStreamTrickmodesBySessionId request-response message returns a list of trick modes for a specified session ID. Request Element: GetStreamTrickmodesBySessionId Attribute: SessionId The SessionId attribute is a string data type. Request Example POST /rtsp/sdi?action=getstreamtrickmodesbysessionid HTTP/1.0 User-Agent: HTTPTool/1.0 Content-Type: text/xml Cseq: 123 Content-Length: 105 <GetStreamTrickmodesBySessionId SessionId = Response: One of the following HTTP status codes is returned: 200 OK Request was successful. 400 Bad Request Request parameters were incomplete or invalid. The GetStreamTrickmodesBySessionIdResponse element is returned in the XML body response. Table 3-4 describes the XML body elements and attributes returned in the GetStreamTrickmodesBySessionIdResponse element. 3-4

5 Chapter 3 GetStreamTrickmodesBySessionId Table 3-4 GetStreamTrickmodesBySessionIdResponse Element Attributes Data Types Descriptions TrickmodeAction list element Element that contains the trick-mode information. ActionTime xs:date-time Coordinated universal time (UTC) time when the trick mode occurred. Date and time are specified in ISO 8601:2000 format. NPTOffset xs:integer Current normal play time (NPT) offset of content in milliseconds. Speed xs:integer Play speed change that occurred at the ActionTime. Response Example: <?xml version="1.0" encoding="utf-8"?> <GetStreamTrickmodesBySessionIdResponse> <TrickmodeList <TrickmodeAction ActionTime = " T23:43:56Z" NPTOffset = "0" Speed = "1" </TrickmodeList> </GetStreamTrickmodesBySessionIdResponse> 3-5

6 GetStreamTrickmodesBySessionId Chapter 3 3-6