2
0
mirror of https://github.com/curl/curl.git synced 2024-12-09 06:30:06 +08:00
curl/docs/libcurl/opts/CURLOPT_INTERLEAVEDATA.md
Daniel Stenberg e3fe020089
docs/libcurl: generate PROTOCOLS from meta-data
Remove the PROTOCOLS section from the source files completely and
instead generate them based on the header data in the curldown files.

It also generates TLS backend information for options marked for TLS as
protocol.

Closes 
2024-03-23 18:13:03 +01:00

71 lines
1.3 KiB
Markdown

---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Title: CURLOPT_INTERLEAVEDATA
Section: 3
Source: libcurl
Protocol:
- RTSP
See-also:
- CURLOPT_INTERLEAVEFUNCTION (3)
- CURLOPT_RTSP_REQUEST (3)
---
# NAME
CURLOPT_INTERLEAVEDATA - pointer passed to RTSP interleave callback
# SYNOPSIS
~~~c
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INTERLEAVEDATA, void *pointer);
~~~
# DESCRIPTION
This is the userdata *pointer* that is passed to
CURLOPT_INTERLEAVEFUNCTION(3) when interleaved RTP data is received. If
the interleave function callback is not set, this pointer is not used
anywhere.
# DEFAULT
NULL
# EXAMPLE
~~~c
struct local {
void *custom;
};
static size_t rtp_write(void *ptr, size_t size, size_t nmemb, void *userp)
{
struct local *l = userp;
printf("my pointer: %p\n", l->custom);
/* take care of the packet in 'ptr', then return... */
return size * nmemb;
}
int main(void)
{
struct local rtp_data;
CURL *curl = curl_easy_init();
if(curl) {
curl_easy_setopt(curl, CURLOPT_INTERLEAVEFUNCTION, rtp_write);
curl_easy_setopt(curl, CURLOPT_INTERLEAVEDATA, &rtp_data);
curl_easy_perform(curl);
}
}
~~~
# AVAILABILITY
Added in 7.20.0
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.