diff options
author | Wim Taymans <wim.taymans@collabora.co.uk> | 2013-07-11 16:57:14 +0200 |
---|---|---|
committer | Wim Taymans <wim.taymans@collabora.co.uk> | 2013-07-11 16:57:14 +0200 |
commit | 0b3644a21be28b5747acede5982b9d653dea26d9 (patch) | |
tree | 668db35a9d00125e81b7ec2e9774848776551833 /docs | |
parent | 8b4c9570fa1dcce2e0fd0b4e0db531e1f82394a5 (diff) |
docs: improve docs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/README | 10 | ||||
-rw-r--r-- | docs/libs/gst-rtsp-server-docs.sgml | 6 | ||||
-rw-r--r-- | docs/libs/gst-rtsp-server-sections.txt | 55 |
3 files changed, 46 insertions, 25 deletions
diff --git a/docs/README b/docs/README index 943382e..f2e878b 100644 --- a/docs/README +++ b/docs/README @@ -93,8 +93,8 @@ can build simple server applications with it. g_main_loop_run (loop); } - The server manages two other objects: GstRTSPSessionPool and - GstRTSPMountPoints. + The server manages four other objects: GstRTSPSessionPool, + GstRTSPMountPoints, GstRTSPAuth and GstRTSPThreadPool. The GstRTSPSessionPool is an object that keeps track of all the active sessions in the server. A session will usually be kept for each client that performed a @@ -109,6 +109,12 @@ can build simple server applications with it. request URL to a specific stream and its configuration. We explain in the next topic how to configure this object. + GstRTSPAuth is an object that authenticates users and authorizes actions + performed by users. + + GstRTSPThreadPool manages the threads used for client connections and media + pipelines. + * Making url mount points diff --git a/docs/libs/gst-rtsp-server-docs.sgml b/docs/libs/gst-rtsp-server-docs.sgml index 716d8b2..4035cc8 100644 --- a/docs/libs/gst-rtsp-server-docs.sgml +++ b/docs/libs/gst-rtsp-server-docs.sgml @@ -19,11 +19,15 @@ <xi:include href="xml/rtsp-mount-points.xml"/> <xi:include href="xml/rtsp-media-factory.xml"/> <xi:include href="xml/rtsp-media-factory-uri.xml"/> + <xi:include href="xml/rtsp-media.xml"/> + <xi:include href="xml/rtsp-stream.xml"/> <xi:include href="xml/rtsp-session-pool.xml"/> <xi:include href="xml/rtsp-session.xml"/> - <xi:include href="xml/rtsp-media.xml"/> + <xi:include href="xml/rtsp-session-media.xml"/> + <xi:include href="xml/rtsp-stream-transport.xml"/> <xi:include href="xml/rtsp-sdp.xml"/> <xi:include href="xml/rtsp-address-pool.xml"/> + <xi:include href="xml/rtsp-thread-pool.xml"/> <xi:include href="xml/rtsp-auth.xml"/> <xi:include href="xml/rtsp-token.xml"/> <xi:include href="xml/rtsp-permissions.xml"/> diff --git a/docs/libs/gst-rtsp-server-sections.txt b/docs/libs/gst-rtsp-server-sections.txt index edfe53e..3e6d6be 100644 --- a/docs/libs/gst-rtsp-server-sections.txt +++ b/docs/libs/gst-rtsp-server-sections.txt @@ -1,6 +1,8 @@ <SECTION> <FILE>rtsp-address-pool</FILE> <TITLE>GstRTSPAddressPool</TITLE> + +<SUBSECTION Address> GST_RTSP_ADDRESS_POOL_ANY_IPV4 GST_RTSP_ADDRESS_POOL_ANY_IPV6 GstRTSPAddress @@ -8,6 +10,7 @@ GstRTSPAddressFlags gst_rtsp_address_copy gst_rtsp_address_free +<SUBSECTION AddressPool> GstRTSPAddressPool GstRTSPAddressPoolClass gst_rtsp_address_pool_new @@ -45,10 +48,12 @@ gst_rtsp_auth_remove_basic gst_rtsp_auth_setup gst_rtsp_auth_check +<SUBSECTION AuthChecks> GST_RTSP_AUTH_CHECK_URL GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_ACCESS GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_CONSTRUCT +<SUBSECTION AuthPermissions> GST_RTSP_MEDIA_FACTORY_ROLE GST_RTSP_MEDIA_FACTORY_PERM_ACCESS GST_RTSP_MEDIA_FACTORY_PERM_CONSTRUCT @@ -68,9 +73,11 @@ gst_rtsp_auth_get_type <SECTION> <FILE>rtsp-client</FILE> <TITLE>GstRTSPClient</TITLE> +<SUBSECTION ClientState> GstRTSPClientState gst_rtsp_client_state_get_current +<SUBSECTION Client> GstRTSPClient GstRTSPClientClass @@ -82,24 +89,25 @@ gst_rtsp_client_set_session_pool gst_rtsp_client_get_mount_points gst_rtsp_client_set_mount_points -gst_rtsp_client_get_use_client_settings -gst_rtsp_client_set_use_client_settings - gst_rtsp_client_get_auth gst_rtsp_client_set_auth gst_rtsp_client_get_thread_pool gst_rtsp_client_set_thread_pool +gst_rtsp_client_get_use_client_settings +gst_rtsp_client_set_use_client_settings + gst_rtsp_client_get_connection gst_rtsp_client_set_connection +gst_rtsp_client_attach + GstRTSPClientSendFunc gst_rtsp_client_set_send_func gst_rtsp_client_handle_message gst_rtsp_client_send_request -gst_rtsp_client_attach GstRTSPClientSessionFilterFunc gst_rtsp_client_session_filter @@ -190,29 +198,30 @@ GstRTSPMediaFactoryClass gst_rtsp_media_factory_new -gst_rtsp_media_factory_construct -gst_rtsp_media_factory_create_element - -gst_rtsp_media_factory_get_address_pool -gst_rtsp_media_factory_set_address_pool - -gst_rtsp_media_factory_get_buffer_size -gst_rtsp_media_factory_set_buffer_size - gst_rtsp_media_factory_get_launch gst_rtsp_media_factory_set_launch gst_rtsp_media_factory_get_permissions gst_rtsp_media_factory_set_permissions -gst_rtsp_media_factory_get_protocols -gst_rtsp_media_factory_set_protocols +gst_rtsp_media_factory_set_shared +gst_rtsp_media_factory_is_shared gst_rtsp_media_factory_is_eos_shutdown gst_rtsp_media_factory_set_eos_shutdown -gst_rtsp_media_factory_set_shared -gst_rtsp_media_factory_is_shared +gst_rtsp_media_factory_get_protocols +gst_rtsp_media_factory_set_protocols + +gst_rtsp_media_factory_get_address_pool +gst_rtsp_media_factory_set_address_pool + +gst_rtsp_media_factory_get_buffer_size +gst_rtsp_media_factory_set_buffer_size + +gst_rtsp_media_factory_construct +gst_rtsp_media_factory_create_element + <SUBSECTION Standard> GST_RTSP_MEDIA_FACTORY_CAST GST_RTSP_MEDIA_FACTORY_CLASS_CAST @@ -316,11 +325,14 @@ gst_rtsp_server_set_address gst_rtsp_server_get_service gst_rtsp_server_set_service -gst_rtsp_server_get_bound_port - gst_rtsp_server_get_backlog gst_rtsp_server_set_backlog +gst_rtsp_server_get_tls_certificate +gst_rtsp_server_set_tls_certificate + +gst_rtsp_server_get_bound_port + gst_rtsp_server_get_mount_points gst_rtsp_server_set_mount_points @@ -333,9 +345,6 @@ gst_rtsp_server_set_thread_pool gst_rtsp_server_get_auth gst_rtsp_server_set_auth -gst_rtsp_server_get_tls_certificate -gst_rtsp_server_set_tls_certificate - gst_rtsp_server_get_use_client_settings gst_rtsp_server_set_use_client_settings @@ -562,6 +571,7 @@ gst_rtsp_stream_transport_get_type <SECTION> <FILE>rtsp-thread-pool</FILE> <TITLE>GstRTSPThreadPool</TITLE> +<SUBSECTION Thread> GstRTSPThreadType GstRTSPThread @@ -571,6 +581,7 @@ gst_rtsp_thread_unref gst_rtsp_thread_reuse gst_rtsp_thread_stop +<SUBSECTION ThreadPool> GstRTSPThreadPool GstRTSPThreadPoolClass gst_rtsp_thread_pool_new |