Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_INTERLEAVEDATA (3)

Name

CURLOPT_INTERLEAVEDATA - pointer passed to RTSP interleave callback

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INTERLEAVEDATA, void *pointer);

Description

CURLOPT_INTERLEAVEDATA(3)  curl_easy_setopt options  CURLOPT_INTERLEAVEDATA(3)



NAME
       CURLOPT_INTERLEAVEDATA - pointer passed to RTSP interleave callback

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INTERLEAVEDATA, void *pointer);

DESCRIPTION
       This is the userdata pointer that will be passed to CURLOPT_INTERLEAVE-
       FUNCTION(3) when interleaved RTP data is received.  If  the  interleave
       function callback is not set, this pointer is not used anywhere.

DEFAULT
       NULL

PROTOCOLS
       RTSP

EXAMPLE
       static size_t rtp_write(void *ptr, size_t size, size_t nmemb, void *user)
       {
         struct local *l = (struct local *)user;
         /* take care of the packet in 'ptr', then return... */
         return size * nmemb;
       }
       {
         struct local rtp_data;
         curl_easy_setopt(curl, CURLOPT_INTERLEAVEFUNCTION, rtp_write);
         curl_easy_setopt(curl, CURLOPT_INTERLEAVEDATA, &rtp_data);
       }

AVAILABILITY
       Added in 7.20.0

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


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_INTERLEAVEFUNCTION(3), CURLOPT_RTSP_REQUEST(3),



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

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



libcurl 7.83.1                 November 26, 2021     CURLOPT_INTERLEAVEDATA(3)