comparison rtsp.h @ 1871:50ad5902d797 libavformat

Doxygenize comments in rtsp.h
author takis
date Mon, 05 Mar 2007 13:53:00 +0000
parents 22f6839eb478
children 3e1bdfd67724
comparison
equal deleted inserted replaced
1870:22f6839eb478 1871:50ad5902d797
36 #define RTSP_DEFAULT_AUDIO_SAMPLERATE 44100 36 #define RTSP_DEFAULT_AUDIO_SAMPLERATE 44100
37 #define RTSP_RTP_PORT_MIN 5000 37 #define RTSP_RTP_PORT_MIN 5000
38 #define RTSP_RTP_PORT_MAX 10000 38 #define RTSP_RTP_PORT_MAX 10000
39 39
40 typedef struct RTSPTransportField { 40 typedef struct RTSPTransportField {
41 int interleaved_min, interleaved_max; /* interleave ids, if TCP transport */ 41 int interleaved_min, interleaved_max; /**< interleave ids, if TCP transport */
42 int port_min, port_max; /* RTP ports */ 42 int port_min, port_max; /**< RTP ports */
43 int client_port_min, client_port_max; /* RTP ports */ 43 int client_port_min, client_port_max; /**< RTP ports */
44 int server_port_min, server_port_max; /* RTP ports */ 44 int server_port_min, server_port_max; /**< RTP ports */
45 int ttl; /* ttl value */ 45 int ttl; /**< ttl value */
46 uint32_t destination; /* destination IP address */ 46 uint32_t destination; /**< destination IP address */
47 enum RTSPProtocol protocol; 47 enum RTSPProtocol protocol;
48 } RTSPTransportField; 48 } RTSPTransportField;
49 49
50 typedef struct RTSPHeader { 50 typedef struct RTSPHeader {
51 int content_length; 51 int content_length;
52 enum RTSPStatusCode status_code; /* response code from server */ 52 enum RTSPStatusCode status_code; /**< response code from server */
53 int nb_transports; 53 int nb_transports;
54 /* in AV_TIME_BASE unit, AV_NOPTS_VALUE if not used */ 54 /** in AV_TIME_BASE unit, AV_NOPTS_VALUE if not used */
55 int64_t range_start, range_end; 55 int64_t range_start, range_end;
56 RTSPTransportField transports[RTSP_MAX_TRANSPORTS]; 56 RTSPTransportField transports[RTSP_MAX_TRANSPORTS];
57 int seq; /* sequence number */ 57 int seq; /**< sequence number */
58 char session_id[512]; 58 char session_id[512];
59 } RTSPHeader; 59 } RTSPHeader;
60 60
61 /* the callback can be used to extend the connection setup/teardown step */ 61 /** the callback can be used to extend the connection setup/teardown step */
62 enum RTSPCallbackAction { 62 enum RTSPCallbackAction {
63 RTSP_ACTION_SERVER_SETUP, 63 RTSP_ACTION_SERVER_SETUP,
64 RTSP_ACTION_SERVER_TEARDOWN, 64 RTSP_ACTION_SERVER_TEARDOWN,
65 RTSP_ACTION_CLIENT_SETUP, 65 RTSP_ACTION_CLIENT_SETUP,
66 RTSP_ACTION_CLIENT_TEARDOWN, 66 RTSP_ACTION_CLIENT_TEARDOWN,