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