52d607845805a1356048a6dc82d5dbc4a4a7d07b
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_RTSP_TRANSPORT.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, 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_TRANSPORT 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_RTSP_TRANSPORT \- set RTSP Transport: header
26 .SH SYNOPSIS
27 .nf
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_TRANSPORT,
31                           char *transport);
32 .SH DESCRIPTION
33 Pass a char * to tell libcurl what to pass for the Transport: header for this
34 RTSP session. This is mainly a convenience method to avoid needing to set a
35 custom Transport: header for every SETUP request. The application must set a
36 Transport: header before issuing a SETUP request.
37
38 The application does not have to keep the string around after setting this
39 option.
40 .SH DEFAULT
41 NULL
42 .SH PROTOCOLS
43 RTSP
44 .SH EXAMPLE
45 TODO
46 .SH AVAILABILITY
47 Added in 7.20.0
48 .SH RETURN VALUE
49 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
50 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
51 .SH "SEE ALSO"
52 .BR CURLOPT_RTSP_REQUEST "(3), " CURLOPT_RTSP_SESSION_ID "(3), "