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

#include <libavformat/rtsp.h>

Data Fields
int	content_length
	length of the data following this header More...

enum RTSPStatusCode	status_code
	response code from server More...

int	nb_transports
	number of items in the 'transports' variable below More...

int64_t	range_start
	Time range of the streams that the server will stream. More...

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

int	seq
	sequence number More...

char	session_id [512]
	the "Session:" field. More...

char	location [4096]
	the "Location:" field. More...

char	real_challenge [64]
	the "RealChallenge1:" field from the server More...

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

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

int	notice
	The "Notice" or "X-Notice" field value. More...

char	reason [256]
	The "reason" is meant to specify better the meaning of the error code returned. More...

char	content_type [64]
	Content type header. More...

Detailed Description

This describes the server response to each RTSP command.

Definition at line 127 of file rtsp.h.

Field Documentation

◆ content_length

int RTSPMessageHeader::content_length

length of the data following this header

Definition at line 129 of file rtsp.h.

Referenced by ff_rtsp_open_transport_ctx(), and rtsp_read_announce().

◆ status_code

enum RTSPStatusCode RTSPMessageHeader::status_code

response code from server

Definition at line 131 of file rtsp.h.

Referenced by ff_rtsp_open_transport_ctx(), ff_rtsp_setup_input_streams(), ff_rtsp_setup_output_streams(), rtsp_read_packet(), rtsp_read_pause(), rtsp_read_play(), and rtsp_write_record().

◆ nb_transports

int RTSPMessageHeader::nb_transports

number of items in the 'transports' variable below

Definition at line 134 of file rtsp.h.

Referenced by ff_rtsp_open_transport_ctx(), and rtsp_read_setup().

◆ range_start

int64_t RTSPMessageHeader::range_start

Time range of the streams that the server will stream.

In AV_TIME_BASE unit, AV_NOPTS_VALUE if not used

Definition at line 138 of file rtsp.h.

Referenced by ff_rtsp_open_transport_ctx(), and rtsp_read_play().

◆ range_end

int64_t RTSPMessageHeader::range_end

Definition at line 138 of file rtsp.h.

Referenced by ff_rtsp_open_transport_ctx().

◆ transports

RTSPTransportField RTSPMessageHeader::transports[RTSP_MAX_TRANSPORTS]

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

Definition at line 142 of file rtsp.h.

Referenced by ff_rtsp_open_transport_ctx(), and rtsp_read_setup().

◆ seq

int RTSPMessageHeader::seq

sequence number

Definition at line 144 of file rtsp.h.

Referenced by check_sessionid(), ff_rtsp_open_transport_ctx(), ff_rtsp_parse_streaming_commands(), rtsp_read_announce(), rtsp_read_options(), rtsp_read_record(), rtsp_read_request(), and rtsp_read_setup().

◆ session_id

char RTSPMessageHeader::session_id[512]

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 148 of file rtsp.h.

Referenced by check_sessionid(), and ff_rtsp_open_transport_ctx().

◆ location

char RTSPMessageHeader::location[4096]

the "Location:" field.

This value is used to handle redirection.

Definition at line 152 of file rtsp.h.

Referenced by ff_rtsp_open_transport_ctx().

◆ real_challenge

char RTSPMessageHeader::real_challenge[64]

the "RealChallenge1:" field from the server

Definition at line 155 of file rtsp.h.

Referenced by ff_rtsp_open_transport_ctx().

◆ server

char RTSPMessageHeader::server[64]

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 164 of file rtsp.h.

Referenced by ff_rtsp_open_transport_ctx().

◆ timeout

int RTSPMessageHeader::timeout

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 172 of file rtsp.h.

Referenced by ff_rtsp_open_transport_ctx().