Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_RTSP_STREAM_URI (3)

Name

CURLOPT_RTSP_STREAM_URI - RTSP stream URI

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_STREAM_URI, char *URI);

Description

curl_easy_setopt options                            CURLOPT_RTSP_STREAM_URI(3)



NAME
       CURLOPT_RTSP_STREAM_URI - RTSP stream URI

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RTSP_STREAM_URI, char *URI);

DESCRIPTION
       Set  the  stream URI to operate on by passing a char * . For example, a
       single  session  may  be   controlling   rtsp://foo/twister/audio   and
       rtsp://foo/twister/video  and  the application can switch to the appro-
       priate stream using this option. If  unset,  libcurl  will  default  to
       operating  on generic server options by passing '*' in the place of the
       RTSP Stream URI. This option  is  distinct  from  CURLOPT_URL(3).  When
       working with RTSP, the CURLOPT_RTSP_STREAM_URI(3) indicates what URL to
       send to the server in the request header while the CURLOPT_URL(3) indi-
       cates  where  to  make the connection to.  (e.g. the CURLOPT_URL(3) for
       the above examples might be set to rtsp://foo/twister

       The application does not have to keep the string around  after  setting
       this option.

DEFAULT
       '*'

PROTOCOLS
       RTSP

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         char *prev_id; /* saved from before somehow */
         curl_easy_setopt(curl, CURLOPT_URL, "rtsp://example.com/");
         curl_easy_setopt(curl, CURLOPT_RTSP_STREAM_URI,
                          "rtsp://foo.example.com/twister/video");
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.20.0

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.


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


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

SEE ALSO
       CURLOPT_RTSP_REQUEST(3), CURLOPT_RTSP_TRANSPORT(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_RTSP_STREAM_URI(3)