manpagez: man pages & more
man CURLOPT_RTSP_SESSION_ID(3)
Home | html | info | man
CURLOPT_RTSP_SESSION_ID(3)          libcurl         CURLOPT_RTSP_SESSION_ID(3)




NAME

       CURLOPT_RTSP_SESSION_ID - 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
       Session ID for the handle. Useful for resuming an in-progress session.
       Once this value is set to any non-NULL value, libcurl returns
       CURLE_RTSP_SESSION_ERROR if ID received from the server does not match.
       If unset (or set to NULL), libcurl automatically sets 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

       int main(void)
       {
         CURL *curl = curl_easy_init();
         if(curl) {
           CURLcode res;
           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);
           res = 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.


SEE ALSO

       CURLOPT_RTSP_REQUEST(3), CURLOPT_RTSP_STREAM_URI(3)

ibcurl 8.5.0                   December 4, 2023     CURLOPT_RTSP_SESSION_ID(3)

curl 8.5.0 - Generated Tue Dec 19 09:49:21 CST 2023
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.