Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_RTSP_REQUEST.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
9: .\" *
10: .\" * This software is licensed as described in the file COPYING, which
11: .\" * you should have received as part of this distribution. The terms
12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13: .\" *
14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15: .\" * copies of the Software, and permit persons to whom the Software is
16: .\" * furnished to do so, under the terms of the COPYING file.
17: .\" *
18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19: .\" * KIND, either express or implied.
20: .\" *
21: .\" **************************************************************************
22: .\"
23: .TH CURLOPT_RTSP_REQUEST 3 "July 16, 2019" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_RTSP_REQUEST \- specify RTSP request
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_REQUEST, long request);
31: .SH DESCRIPTION
32: Tell libcurl what kind of RTSP request to make. Pass one of the following RTSP
33: enum values as a long in the \fIrequest\fP argument. Unless noted otherwise,
34: commands require the Session ID to be initialized.
35: .IP CURL_RTSPREQ_OPTIONS
36: Used to retrieve the available methods of the server. The application is
37: responsible for parsing and obeying the response. The session ID is not needed
38: for this method.
39: .IP CURL_RTSPREQ_DESCRIBE
40: Used to get the low level description of a stream. The application should note
41: what formats it understands in the \fI'Accept:'\fP header. Unless set
42: manually, libcurl will automatically fill in \fI'Accept: application/sdp'\fP.
43: Time-condition headers will be added to Describe requests if the
44: \fICURLOPT_TIMECONDITION(3)\fP option is active. \fB(The session ID is not
45: needed for this method)\fP
46: .IP CURL_RTSPREQ_ANNOUNCE
47: When sent by a client, this method changes the description of the session. For
48: example, if a client is using the server to record a meeting, the client can
49: use Announce to inform the server of all the meta-information about the
50: session. ANNOUNCE acts like an HTTP PUT or POST just like
51: \fICURL_RTSPREQ_SET_PARAMETER\fP
52: .IP CURL_RTSPREQ_SETUP
53: Setup is used to initialize the transport layer for the session. The
54: application must set the desired Transport options for a session by using the
55: \fICURLOPT_RTSP_TRANSPORT(3)\fP option prior to calling setup. If no session
56: ID is currently set with \fICURLOPT_RTSP_SESSION_ID(3)\fP, libcurl will
57: extract and use the session ID in the response to this request. The session ID
58: is not needed for this method.
59: .IP CURL_RTSPREQ_PLAY
60: Send a Play command to the server. Use the \fICURLOPT_RANGE(3)\fP option to
61: modify the playback time (e.g. 'npt=10-15').
62: .IP CURL_RTSPREQ_PAUSE
63: Send a Pause command to the server. Use the \fICURLOPT_RANGE(3)\fP option with
64: a single value to indicate when the stream should be halted. (e.g. npt='25')
65: .IP CURL_RTSPREQ_TEARDOWN
66: This command terminates an RTSP session. Simply closing a connection does not
67: terminate the RTSP session since it is valid to control an RTSP session over
68: different connections.
69: .IP CURL_RTSPREQ_GET_PARAMETER
70: Retrieve a parameter from the server. By default, libcurl will automatically
71: include a \fIContent-Type: text/parameters\fP header on all non-empty requests
72: unless a custom one is set. GET_PARAMETER acts just like an HTTP PUT or POST
73: (see \fICURL_RTSPREQ_SET_PARAMETER\fP).
74: Applications wishing to send a heartbeat message (e.g. in the presence of a
75: server-specified timeout) should send use an empty GET_PARAMETER request.
76: .IP CURL_RTSPREQ_SET_PARAMETER
77: Set a parameter on the server. By default, libcurl will automatically include
78: a \fIContent-Type: text/parameters\fP header unless a custom one is set. The
79: interaction with SET_PARAMETER is much like an HTTP PUT or POST. An application
80: may either use \fICURLOPT_UPLOAD(3)\fP with \fICURLOPT_READDATA(3)\fP like a
81: HTTP PUT, or it may use \fICURLOPT_POSTFIELDS(3)\fP like an HTTP POST. No
82: chunked transfers are allowed, so the application must set the
83: \fICURLOPT_INFILESIZE(3)\fP in the former and \fICURLOPT_POSTFIELDSIZE(3)\fP
84: in the latter. Also, there is no use of multi-part POSTs within RTSP.
85: .IP CURL_RTSPREQ_RECORD
86: Used to tell the server to record a session. Use the \fICURLOPT_RANGE(3)\fP
87: option to modify the record time.
88: .IP CURL_RTSPREQ_RECEIVE
89: This is a special request because it does not send any data to the server. The
90: application may call this function in order to receive interleaved RTP
91: data. It will return after processing one read buffer of data in order to give
92: the application a chance to run.
93: .SH DEFAULT
94: .SH PROTOCOLS
95: RTSP
96: .SH EXAMPLE
97: .nf
98: CURL *curl = curl_easy_init();
99: if(curl) {
100: curl_easy_setopt(curl, CURLOPT_URL, "rtsp://example.com/");
101: /* ask for options! */
102: curl_easy_setopt(curl, CURLOPT_RTSP_REQUEST, CURL_RTSPREQ_OPTIONS);
103: ret = curl_easy_perform(curl);
104: curl_easy_cleanup(curl);
105: }
106: .fi
107: .SH AVAILABILITY
108: Added in 7.20.0
109: .SH RETURN VALUE
110: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
111: .SH "SEE ALSO"
112: .BR CURLOPT_RTSP_SESSION_ID "(3), " CURLOPT_RTSP_STREAM_URI "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>