oracular (3) CURLINFO_RTSP_SESSION_ID.3.gz

Provided by: libcurl4-doc_8.9.1-2ubuntu2.2_all bug

NAME

       CURLINFO_RTSP_SESSION_ID - get RTSP session ID

SYNOPSIS

       #include <curl/curl.h>

       CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_RTSP_SESSION_ID, char **id);

DESCRIPTION

       Pass  a  pointer  to a char pointer to receive a pointer to a string holding the most recent RTSP Session
       ID.

       Applications wishing to resume an RTSP session on another connection should  retrieve  this  info  before
       closing the active connection.

       The  id  pointer  is  NULL  or  points to private memory. You MUST NOT free - it gets freed when you call
       curl_easy_cleanup(3) on the corresponding CURL handle.

PROTOCOLS

       This functionality affects rtsp only

EXAMPLE

       int main(void)
       {
         CURL *curl = curl_easy_init();
         if(curl) {
           CURLcode res;
           curl_easy_setopt(curl, CURLOPT_URL, "rtsp://rtsp.example.com");
           res = curl_easy_perform(curl);
           if(res == CURLE_OK) {
             char *id;
             curl_easy_getinfo(curl, CURLINFO_RTSP_SESSION_ID, &id);
           }
           curl_easy_cleanup(curl);
         }
       }

AVAILABILITY

       Added in curl 7.20.0

RETURN VALUE

       Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

SEE ALSO

       CURLINFO_RTSP_CSEQ_RECV(3), curl_easy_getinfo(3), curl_easy_setopt(3)