rtsp-transport: clarify port usage

Comment in the docs what the client_port and server_port fields are used
for in TCP mode (if the application wants to set those values).
This commit is contained in:
Wim Taymans 2014-05-20 15:59:53 +02:00
parent b60888fd4b
commit 9a20920aa4

View file

@ -136,8 +136,12 @@ struct _GstRTSPRange {
* @interleaved: the interleave range * @interleaved: the interleave range
* @ttl: the time to live for multicast UDP * @ttl: the time to live for multicast UDP
* @port: the port pair for multicast sessions * @port: the port pair for multicast sessions
* @client_port: the client port pair for receiving data * @client_port: the client port pair for receiving data. For TCP
* @server_port: the server port pair for receiving data * based transports, applications can use this field to store the
* sender and receiver ports of the client.
* @server_port: the server port pair for receiving data. For TCP
* based transports, applications can use this field to store the
* sender and receiver ports of the server.
* @ssrc: the ssrc that the sender/receiver will use * @ssrc: the ssrc that the sender/receiver will use
* *
* A structure holding the RTSP transport values. * A structure holding the RTSP transport values.
@ -158,9 +162,9 @@ struct _GstRTSPTransport {
/* multicast specific */ /* multicast specific */
guint ttl; guint ttl;
/* UDP specific */
GstRTSPRange port; GstRTSPRange port;
/* UDP/TCP specific */
GstRTSPRange client_port; GstRTSPRange client_port;
GstRTSPRange server_port; GstRTSPRange server_port;
/* RTP specific */ /* RTP specific */