docs/libcurl/opts/CURLOPT_RTSP_SESSION_ID.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_SESSION_ID 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_RTSP_SESSION_ID \- set RTSP session ID
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_SESSION_ID, char *id);
  31 .SH DESCRIPTION
  32 Pass a char * as a parameter to set the value of the current RTSP Session ID
  33 for the handle. Useful for resuming an in-progress session. Once this value is
  34 set to any non-NULL value, libcurl will return \fICURLE_RTSP_SESSION_ERROR\fP
  35 if ID received from the server does not match. If unset (or set to NULL),
  36 libcurl will automatically set the ID the first time the server sets it in a
  37 response.
  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   char *prev_id; /* saved from before somehow */
  50   curl_easy_setopt(curl, CURLOPT_URL, "rtsp://example.com/");
  51   curl_easy_setopt(curl, CURLOPT_RTSP_SESSION_ID, prev_id);
  52   ret = curl_easy_perform(curl);
  53   curl_easy_cleanup(curl);
  54 }
  55 .fi
  56 .SH AVAILABILITY
  57 Added in 7.20.0
  58 .SH RETURN VALUE
  59 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  60 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  61 .SH "SEE ALSO"
  62 .BR CURLOPT_RTSP_REQUEST "(3), " CURLOPT_RTSP_STREAM_URI "(3), "