Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLOPT_RTSP_STREAM_URI.3

raw
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <[email protected]>, 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_STREAM_URI 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_RTSP_STREAM_URI \- set RTSP stream URI
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_STREAM_URI, char *URI);
30 .SH DESCRIPTION
31 Set the stream \fIURI\fP to operate on by passing a char * . For example, a
32 single session may be controlling \fIrtsp://foo/twister/audio\fP and
33 \fIrtsp://foo/twister/video\fP and the application can switch to the
34 appropriate stream using this option. If unset, libcurl will default to
35 operating on generic server options by passing '*' in the place of the RTSP
36 Stream URI. This option is distinct from \fICURLOPT_URL(3)\fP. When working
37 with RTSP, the \fICURLOPT_RTSP_STREAM_URI(3)\fP indicates what URL to send to
38 the server in the request header while the \fICURLOPT_URL(3)\fP indicates
39 where to make the connection to. (e.g. the \fICURLOPT_URL(3)\fP for the above
40 examples might be set to \fIrtsp://foo/twister\fP
41
42 The application does not have to keep the string around after setting this
43 option.
44 .SH DEFAULT
45 \&'*'
46 .SH PROTOCOLS
47 RTSP
48 .SH EXAMPLE
49 .nf
50 CURL *curl = curl_easy_init();
51 if(curl) {
52 char *prev_id; /* saved from before somehow */
53 curl_easy_setopt(curl, CURLOPT_URL, "rtsp://example.com/");
54 curl_easy_setopt(curl, CURLOPT_RTSP_STREAM_URI,
55 "rtsp://foo.example.com/twister/video");
56 ret = curl_easy_perform(curl);
57 curl_easy_cleanup(curl);
58 }
59 .fi
60 .SH AVAILABILITY
61 Added in 7.20.0
62 .SH RETURN VALUE
63 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
64 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
65 .SH "SEE ALSO"
66 .BR CURLOPT_RTSP_REQUEST "(3), " CURLOPT_RTSP_TRANSPORT "(3), "