Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_RTSP_SESSION_ID (3)

Name

CURLOPT_RTSP_SESSION_ID - set RTSP session ID

Synopsis

#include <curl/curl.h>

CURLcode  curl_easy_setopt(CURL  *handle, CURLOPT_RTSP_SESSION_ID, char
*id);

Description

curl_easy_setopt options                            CURLOPT_RTSP_SESSION_ID(3)



NAME
       CURLOPT_RTSP_SESSION_ID - set RTSP session ID

SYNOPSIS
       #include <curl/curl.h>

       CURLcode  curl_easy_setopt(CURL  *handle, CURLOPT_RTSP_SESSION_ID, char
       *id);

DESCRIPTION
       Pass a char * as a parameter to set the value of the current RTSP  Ses-
       sion  ID  for  the  handle. Useful for resuming an in-progress session.
       Once this value is set to  any  non-NULL  value,  libcurl  will  return
       CURLE_RTSP_SESSION_ERROR if ID received from the server does not match.
       If unset (or set to NULL), libcurl will automatically set  the  ID  the
       first time the server sets it in a response.

       The  application  does not have to keep the string around after setting
       this option.

DEFAULT
       NULL

PROTOCOLS
       RTSP

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         char *prev_id; /* saved from before somehow */
         curl_easy_setopt(curl, CURLOPT_URL, "rtsp://example.com/");
         curl_easy_setopt(curl, CURLOPT_RTSP_SESSION_ID, prev_id);
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.20.0

RETURN VALUE
       Returns CURLE_OK if the option is  supported,  CURLE_UNKNOWN_OPTION  if
       not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_RTSP_REQUEST(3), CURLOPT_RTSP_STREAM_URI(3),



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was    downloaded    from    https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    19 Jun 2014
                                                    CURLOPT_RTSP_SESSION_ID(3)