CURLOPT_INTERLEAVEDATA.3 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
  9. .\" *
  10. .\" * This software is licensed as described in the file COPYING, which
  11. .\" * you should have received as part of this distribution. The terms
  12. .\" * are also available at https://curl.se/docs/copyright.html.
  13. .\" *
  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15. .\" * copies of the Software, and permit persons to whom the Software is
  16. .\" * furnished to do so, under the terms of the COPYING file.
  17. .\" *
  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19. .\" * KIND, either express or implied.
  20. .\" *
  21. .\" **************************************************************************
  22. .\"
  23. .TH CURLOPT_INTERLEAVEDATA 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_INTERLEAVEDATA \- pointer passed to RTSP interleave callback
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INTERLEAVEDATA, void *pointer);
  30. .fi
  31. .SH DESCRIPTION
  32. This is the userdata \fIpointer\fP that will be passed to
  33. \fICURLOPT_INTERLEAVEFUNCTION(3)\fP when interleaved RTP data is received. If
  34. the interleave function callback is not set, this pointer is not used
  35. anywhere.
  36. .SH DEFAULT
  37. NULL
  38. .SH PROTOCOLS
  39. RTSP
  40. .SH EXAMPLE
  41. .nf
  42. static size_t rtp_write(void *ptr, size_t size, size_t nmemb, void *user)
  43. {
  44. struct local *l = (struct local *)user;
  45. /* take care of the packet in 'ptr', then return... */
  46. return size * nmemb;
  47. }
  48. {
  49. struct local rtp_data;
  50. curl_easy_setopt(curl, CURLOPT_INTERLEAVEFUNCTION, rtp_write);
  51. curl_easy_setopt(curl, CURLOPT_INTERLEAVEDATA, &rtp_data);
  52. }
  53. .fi
  54. .SH AVAILABILITY
  55. Added in 7.20.0
  56. .SH RETURN VALUE
  57. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  58. .SH "SEE ALSO"
  59. .BR CURLOPT_INTERLEAVEFUNCTION "(3), " CURLOPT_RTSP_REQUEST "(3), "