docs/libcurl/opts/CURLOPT_RTSP_TRANSPORT.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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 "May 31, 2017" "libcurl 7.56.1" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_RTSP_TRANSPORT \- set RTSP Transport: header
  27 .SH SYNOPSIS
  28 .nf
  29 #include <curl/curl.h>
  30
  31 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_TRANSPORT,
  32                           char *transport);
  33 .SH DESCRIPTION
  34 Pass a char * to tell libcurl what to pass for the Transport: header for this
  35 RTSP session. This is mainly a convenience method to avoid needing to set a
  36 custom Transport: header for every SETUP request. The application must set a
  37 Transport: header before issuing a SETUP request.
  38
  39 The application does not have to keep the string around after setting this
  40 option.
  41 .SH DEFAULT
  42 NULL
  43 .SH PROTOCOLS
  44 RTSP
  45 .SH EXAMPLE
  46 .nf
  47 CURL *curl = curl_easy_init();
  48 if(curl) {
  49   curl_easy_setopt(curl, CURLOPT_URL, "rtsp://example.com/");
  50   curl_easy_setopt(curl, CURLOPT_RTSP_REQUEST, CURL_RTSPREQ_SETUP);
  51   curl_easy_setopt(curl, CURLOPT_RTSP_TRANSPORT,
  52                    "RTP/AVP;unicast;client_port=4588-4589");
  53   ret = curl_easy_perform(curl);
  54   curl_easy_cleanup(curl);
  55 }
  56 .fi
  57 .SH AVAILABILITY
  58 Added in 7.20.0
  59 .SH RETURN VALUE
  60 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  61 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  62 .SH "SEE ALSO"
  63 .BR CURLOPT_RTSP_REQUEST "(3), " CURLOPT_RTSP_SESSION_ID "(3), "