mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 12:46:58 +00:00
48 lines
1.4 KiB
Groff
48 lines
1.4 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_RTSP_SESSION_ID.md
|
|
.TH CURLOPT_RTSP_SESSION_ID 3 "2024-06-01" libcurl
|
|
.SH NAME
|
|
CURLOPT_RTSP_SESSION_ID \- RTSP session ID
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_SESSION_ID, char *id);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a char pointer 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
|
|
\fICURLE_RTSP_SESSION_ERROR\fP 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.
|
|
.SH DEFAULT
|
|
NULL
|
|
.SH PROTOCOLS
|
|
RTSP
|
|
.SH EXAMPLE
|
|
.nf
|
|
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);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.20.0
|
|
.SH 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.
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_RTSP_REQUEST (3),
|
|
.BR CURLOPT_RTSP_STREAM_URI (3)
|