Data Fields

RTSPMessageHeader Struct Reference

This describes the server response to each RTSP command. More...

#include <rtsp.h>

Data Fields

int content_length
 length of the data following this header
enum RTSPStatusCode status_code
 response code from server
int nb_transports
 number of items in the 'transports' variable below
int64_t range_start
 Time range of the streams that the server will stream.
int64_t range_end
RTSPTransportField transports [RTSP_MAX_TRANSPORTS]
 describes the complete "Transport:" line of the server in response to a SETUP RTSP command by the client
int seq
 sequence number
char session_id [512]
 the "Session:" field.
char location [4096]
 the "Location:" field.
char real_challenge [64]
 the "RealChallenge1:" field from the server
char server [64]
 the "Server: field, which can be used to identify some special-case servers that are not 100% standards-compliant.
int timeout
 The "timeout" comes as part of the server response to the "SETUP" command, in the "Session: <xyz>[;timeout=<value>]" line.
int notice
 The "Notice" or "X-Notice" field value.
char reason [256]
 The "reason" is meant to specify better the meaning of the error code returned.

Detailed Description

This describes the server response to each RTSP command.

Definition at line 114 of file rtsp.h.


Field Documentation

length of the data following this header

Definition at line 116 of file rtsp.h.

Referenced by ff_rtsp_parse_line(), and ff_rtsp_read_reply().

the "Location:" field.

This value is used to handle redirection.

Definition at line 139 of file rtsp.h.

Referenced by ff_rtsp_parse_line().

number of items in the 'transports' variable below

Definition at line 121 of file rtsp.h.

Referenced by ff_rtsp_make_setup_request(), find_transport(), and rtsp_parse_transport().

The "Notice" or "X-Notice" field value.

See http://tools.ietf.org/html/draft-stiemerling-rtsp-announce-00 for a complete list of supported values.

Definition at line 164 of file rtsp.h.

Referenced by ff_rtsp_parse_line(), and ff_rtsp_read_reply().

Definition at line 125 of file rtsp.h.

Referenced by ff_rtsp_parse_line().

Time range of the streams that the server will stream.

In AV_TIME_BASE unit, AV_NOPTS_VALUE if not used

Definition at line 125 of file rtsp.h.

Referenced by ff_rtsp_parse_line(), and rtsp_read_play().

the "RealChallenge1:" field from the server

Definition at line 142 of file rtsp.h.

Referenced by ff_rtsp_parse_line().

The "reason" is meant to specify better the meaning of the error code returned.

Definition at line 169 of file rtsp.h.

Referenced by ff_rtsp_read_reply(), and ff_rtsp_send_cmd_with_content().

sequence number

Definition at line 131 of file rtsp.h.

Referenced by ff_rtsp_parse_line(), ff_rtsp_read_reply(), and rtsp_parse_request().

the "Server: field, which can be used to identify some special-case servers that are not 100% standards-compliant.

We use this to identify Windows Media Server, which has a value "WMServer/v.e.r.sion", where version is a sequence of digits (e.g. 9.0.0.3372). Helix/Real servers use something like "Helix [..] Server Version v.e.r.sion (platform) (RealServer compatible)" or "RealServer Version v.e.r.sion (platform)", where platform is the output of $uname -msr | sed 's/ /-/g'.

Definition at line 151 of file rtsp.h.

Referenced by ff_rtsp_parse_line().

the "Session:" field.

This value is initially set by the server and should be re-transmitted by the client in every RTSP command.

Definition at line 135 of file rtsp.h.

Referenced by ff_rtsp_parse_line(), ff_rtsp_read_reply(), rtsp_cmd_pause(), rtsp_cmd_play(), rtsp_cmd_setup(), and rtsp_cmd_teardown().

The "timeout" comes as part of the server response to the "SETUP" command, in the "Session: <xyz>[;timeout=<value>]" line.

It is the time, in seconds, that the server will go without traffic over the RTSP/TCP connection before it closes the connection. To prevent this, sent dummy requests (e.g. OPTIONS) with intervals smaller than this value.

Definition at line 159 of file rtsp.h.

Referenced by ff_rtsp_make_setup_request(), and ff_rtsp_parse_line().

describes the complete "Transport:" line of the server in response to a SETUP RTSP command by the client

Definition at line 129 of file rtsp.h.

Referenced by ff_rtsp_make_setup_request(), find_transport(), and rtsp_parse_transport().


The documentation for this struct was generated from the following file: