diff options
author | Wim Taymans <wim.taymans@gmail.com> | 2007-07-24 19:19:33 +0000 |
---|---|---|
committer | Wim Taymans <wim.taymans@gmail.com> | 2007-07-24 19:19:33 +0000 |
commit | 3dff14d6b1854964d15a6099643b9ff1e7282fe2 (patch) | |
tree | 81581fcc294857e9f9c300dc7809d30940057fb2 /docs | |
parent | ee42361c89e45089ac5b1fa04d5578c6338b2c6f (diff) |
Added beginnings of RTSP documentation.
Original commit message from CVS:
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* gst-libs/gst/rtsp/gstrtspbase64.c: (gst_rtsp_base64_encode):
* gst-libs/gst/rtsp/gstrtspbase64.h:
* gst-libs/gst/rtsp/gstrtspconnection.c:
(gst_rtsp_connection_connect), (add_auth_header),
(gst_rtsp_connection_write), (gst_rtsp_connection_send),
(read_body), (gst_rtsp_connection_receive),
(gst_rtsp_connection_next_timeout),
(gst_rtsp_connection_reset_timeout),
(gst_rtsp_connection_set_auth):
* gst-libs/gst/rtsp/gstrtspconnection.h:
* gst-libs/gst/rtsp/gstrtspdefs.c: (rtsp_init_status):
* gst-libs/gst/rtsp/gstrtspdefs.h:
* gst-libs/gst/rtsp/gstrtspmessage.h:
* gst-libs/gst/rtsp/gstrtsprange.c: (parse_npt_time),
(parse_npt_range), (parse_clock_range), (parse_smpte_range),
(gst_rtsp_range_parse):
* gst-libs/gst/rtsp/gstrtspurl.h:
Added beginnings of RTSP documentation.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/libs/gst-plugins-base-libs-docs.sgml | 27 | ||||
-rw-r--r-- | docs/libs/gst-plugins-base-libs-sections.txt | 115 |
2 files changed, 135 insertions, 7 deletions
diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml index b2e91703b5..e190d5a4cb 100644 --- a/docs/libs/gst-plugins-base-libs-docs.sgml +++ b/docs/libs/gst-plugins-base-libs-docs.sgml @@ -42,6 +42,14 @@ <!ENTITY GstBaseRtpPayload SYSTEM "xml/gstbasertppayload.xml"> <!ENTITY GstRtpBuffer SYSTEM "xml/gstrtpbuffer.xml"> <!ENTITY GstRtcpBuffer SYSTEM "xml/gstrtcpbuffer.xml"> +<!-- rtsp --> +<!ENTITY GstRTSPBase64 SYSTEM "xml/gstrtspbase64.xml"> +<!ENTITY GstRTSPConnection SYSTEM "xml/gstrtspconnection.xml"> +<!ENTITY GstRTSPDefs SYSTEM "xml/gstrtspdefs.xml"> +<!ENTITY GstRTSPMessage SYSTEM "xml/gstrtspmessage.xml"> +<!ENTITY GstRTSPRange SYSTEM "xml/gstrtsprange.xml"> +<!ENTITY GstRTSPTransport SYSTEM "xml/gstrtsptransport.xml"> +<!ENTITY GstRTSPUrl SYSTEM "xml/gstrtspurl.xml"> <!-- sdp --> <!ENTITY GstSDP SYSTEM "xml/gstsdp.xml"> <!ENTITY GstSDPMessage SYSTEM "xml/gstsdpmessage.xml"> @@ -171,14 +179,29 @@ &GstRtcpBuffer; </chapter> - <chapter id="gstreamer-SDP"> + <chapter id="gstreamer-rtsp"> + <title>RTSP Library</title> + <para> + This library should be linked to by getting cflags and libs from + <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding + <filename>-lgstrtsp-&GST_MAJORMINOR;</filename> to the library flags. + </para> + &GstRTSPBase64; + &GstRTSPConnection; + &GstRTSPDefs; + &GstRTSPMessage; + &GstRTSPRange; + &GstRTSPTransport; + &GstRTSPUrl; + </chapter> + + <chapter id="gstreamer-sdp"> <title>SDP Library</title> <para> This library should be linked to by getting cflags and libs from <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding <filename>-lgstsdp-&GST_MAJORMINOR;</filename> to the library flags. </para> - &GstSDP; &GstSDPMessage; </chapter> diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt index 0733d9de31..a4aadb58ef 100644 --- a/docs/libs/gst-plugins-base-libs-sections.txt +++ b/docs/libs/gst-plugins-base-libs-sections.txt @@ -964,16 +964,121 @@ GST_RTP_PAYLOAD_TS41 GST_RTP_PAYLOAD_TS48 </SECTION> -# sdp +# rtsp <SECTION> -<FILE>gstsdp</FILE> -<INCLUDE>gst/sdp/sdp.h</INCLUDE> -GstSDPResult +<FILE>gstrtspdefs</FILE> +<INCLUDE>gst/rtsp/gstrtspdefs.h</INCLUDE> +GST_RTSP_CHECK +GstRTSPResult +GstRTSPFamily +GstRTSPState +GstRTSPVersion +GstRTSPMethod +GstRTSPAuthMethod +GST_RTSP_AUTH_MAX +GstRTSPHeaderField +GstRTSPStatusCode +gst_rtsp_strresult +gst_rtsp_method_as_text +gst_rtsp_version_as_text +gst_rtsp_header_as_text +gst_rtsp_status_as_text +gst_rtsp_find_header_field +gst_rtsp_find_method +</SECTION> + +<SECTION> +<FILE>gstrtsptransport</FILE> +<INCLUDE>gst/rtsp/gstrtsptransport.h</INCLUDE> +GstRTSPTransMode +GstRTSPProfile +GstRTSPLowerTrans +GstRTSPTransport +gst_rtsp_transport_new +gst_rtsp_transport_init +gst_rtsp_transport_parse +gst_rtsp_transport_as_text +gst_rtsp_transport_get_mime +gst_rtsp_transport_get_manager +gst_rtsp_transport_free +</SECTION> + +<SECTION> +<FILE>gstrtspbase64</FILE> +<INCLUDE>gst/rtsp/gstrtspbase64.h</INCLUDE> +gst_rtsp_base64_encode +</SECTION> + +<SECTION> +<FILE>gstrtspconnection</FILE> +<INCLUDE>gst/rtsp/gstrtspconnection.h</INCLUDE> +GstRTSPConnection +gst_rtsp_connection_create +gst_rtsp_connection_connect +gst_rtsp_connection_close +gst_rtsp_connection_free +gst_rtsp_connection_read +gst_rtsp_connection_write +gst_rtsp_connection_send +gst_rtsp_connection_receive +gst_rtsp_connection_next_timeout +gst_rtsp_connection_reset_timeout +gst_rtsp_connection_flush +gst_rtsp_connection_set_auth </SECTION> <SECTION> +<FILE>gstrtspmessage</FILE> +<INCLUDE>gst/rtsp/gstrtspmessage.h</INCLUDE> +GstRTSPMsgType +gst_rtsp_message_new +gst_rtsp_message_init +gst_rtsp_message_new_request +gst_rtsp_message_init_request +gst_rtsp_message_new_response +gst_rtsp_message_init_response +gst_rtsp_message_init_data +gst_rtsp_message_unset +gst_rtsp_message_free +gst_rtsp_message_add_header +gst_rtsp_message_remove_header +gst_rtsp_message_get_header +gst_rtsp_message_append_headers +gst_rtsp_message_set_body +gst_rtsp_message_take_body +gst_rtsp_message_get_body +gst_rtsp_message_steal_body +gst_rtsp_message_dump +</SECTION> + +<SECTION> +<FILE>gstrtspurl</FILE> +<INCLUDE>gst/rtsp/gstrtspurl.h</INCLUDE> +GST_RTSP_DEFAULT_PORT +GstRTSPUrl +gst_rtsp_url_parse +gst_rtsp_url_free +gst_rtsp_url_get_request_uri +gst_rtsp_url_set_port +gst_rtsp_url_get_port +</SECTION> + +<SECTION> +<FILE>gstrtsprange</FILE> +<INCLUDE>gst/rtsp/gstrtsrange.h</INCLUDE> +GstRTSPRangeUnit +GstRTSPTimeRange +GstRTSPTime +GstRTSPTimeType +gst_rtsp_range_parse +gst_rtsp_range_free +</SECTION> + +# sdp +<SECTION> <FILE>gstsdpmessage</FILE> -<INCLUDE>gst/sdp/sdpmessage.h</INCLUDE> +<INCLUDE>gst/sdp/gstsdpmessage.h</INCLUDE> +GstSDPResult GstSDPOrigin GstSDPConnection GST_SDP_BWTYPE_CT |