diff options
author | Olivier CrĂȘte <olivier.crete@collabora.co.uk> | 2010-11-01 17:36:44 -0400 |
---|---|---|
committer | Olivier CrĂȘte <olivier.crete@collabora.co.uk> | 2010-11-01 17:36:44 -0400 |
commit | f7fb339ef66ec9f1325701d1f2ef4207afd52b34 (patch) | |
tree | 04894bfb1b05f4f26cc4139756729926d86ba352 /docs/plugins | |
parent | 717f494dfbdc4ab64c03440f2a384cad8f4e4651 (diff) | |
download | farstream-f7fb339ef66ec9f1325701d1f2ef4207afd52b34.tar.gz |
docs: Add docs for the shm transmitter
Diffstat (limited to 'docs/plugins')
-rw-r--r-- | docs/plugins/Makefile.am | 7 | ||||
-rw-r--r-- | docs/plugins/farsight2-plugins-docs.sgml | 1 | ||||
-rw-r--r-- | docs/plugins/farsight2-plugins-sections.txt | 54 |
3 files changed, 59 insertions, 3 deletions
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index 30b26d81..5905d5d4 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -58,6 +58,7 @@ SCANOBJ_DEPS = \ $(top_builddir)/transmitters/multicast/libmulticast-transmitter.la \ $(top_builddir)/transmitters/rawudp/librawudp-transmitter.la \ $(top_builddir)/transmitters/nice/libnice-transmitter.la \ + $(top_builddir)/transmitters/shm/libshm-transmitter.la \ $(top_builddir)/gst/fsrtpconference/libfsrtpconference_doc.la \ $(top_builddir)/gst/fsmsnconference/libfsmsnconference_doc.la \ $(top_builddir)/gst/funnel/libfsfunnel.la \ @@ -93,7 +94,9 @@ EXTRA_HFILES = \ $(top_srcdir)/transmitters/multicast/fs-multicast-transmitter.h \ $(top_srcdir)/transmitters/multicast/fs-multicast-stream-transmitter.h \ $(top_srcdir)/transmitters/nice/fs-nice-transmitter.h \ - $(top_srcdir)/transmitters/nice/fs-nice-stream-transmitter.h + $(top_srcdir)/transmitters/nice/fs-nice-stream-transmitter.h \ + $(top_srcdir)/transmitters/shm/fs-shm-transmitter.h \ + $(top_srcdir)/transmitters/shm/fs-shm-stream-transmitter.h # Images to copy into HTML directory. HTML_IMAGES = @@ -131,7 +134,7 @@ GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC) #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt DOC_OVERRIDES = -FS_PLUGIN_PATH=$(top_builddir)/transmitters/rawudp/.libs:$(top_builddir)/transmitters/multicast/.libs:$(top_builddir)/transmitters/nice/.libs +FS_PLUGIN_PATH=$(top_builddir)/transmitters/rawudp/.libs:$(top_builddir)/transmitters/multicast/.libs:$(top_builddir)/transmitters/nice/.libs:$(top_builddir)/transmitters/shm/.libs update-all: scanobj-trans-build.stamp update diff --git a/docs/plugins/farsight2-plugins-docs.sgml b/docs/plugins/farsight2-plugins-docs.sgml index 73da5e16..72afa9c6 100644 --- a/docs/plugins/farsight2-plugins-docs.sgml +++ b/docs/plugins/farsight2-plugins-docs.sgml @@ -31,6 +31,7 @@ <xi:include href="xml/fs-rawudp-stream-transmitter.xml"/> <xi:include href="xml/fs-multicast-stream-transmitter.xml"/> <xi:include href="xml/fs-nice-stream-transmitter.xml"/> + <xi:include href="xml/fs-shm-stream-transmitter.xml"/> </chapter> </part> diff --git a/docs/plugins/farsight2-plugins-sections.txt b/docs/plugins/farsight2-plugins-sections.txt index 1d232d3e..c6bb8d6e 100644 --- a/docs/plugins/farsight2-plugins-sections.txt +++ b/docs/plugins/farsight2-plugins-sections.txt @@ -44,7 +44,8 @@ FS_IS_RTP_CONFERENCE_CLASS FS_RTP_CONFERENCE_GET_CLASS <SUBSECTION Private> fs_codec_to_gst_caps -fs_codec_to_gst_caps_with_ptime +fs_rtp_conference_is_internal_thread +codecs_copy_with_new_ptime </SECTION> <SECTION> @@ -173,6 +174,8 @@ fs_rtp_session_new fs_rtp_session_new_recv_pad fs_rtp_session_request_pt_map fs_rtp_session_ssrc_validated +fs_rtp_session_has_disposed_enter +fs_rtp_session_has_disposed_exit </SECTION> <SECTION> @@ -263,6 +266,55 @@ FS_NICE_STREAM_TRANSMITTER_GET_CLASS <SECTION> +<FILE>fs-shm-transmitter</FILE> +<TITLE>FsShmTransmitter</TITLE> +FsShmTransmitter +<SUBSECTION Standard> +FsShmTransmitterClass +FS_SHM_TRANSMITTER_CAST +FS_SHM_TRANSMITTER +FS_IS_SHM_TRANSMITTER +FS_TYPE_SHM_TRANSMITTER +fs_shm_transmitter_get_type +FS_SHM_TRANSMITTER_CLASS +FS_IS_SHM_TRANSMITTER_CLASS +FS_SHM_TRANSMITTER_GET_CLASS +<SUBSECTION Private> +FsShmTransmitterPrivate +ShmSink +ShmSrc +connected +fs_shm_transmitter_check_shm_sink +fs_shm_transmitter_check_shm_src +fs_shm_transmitter_get_shm_sink +fs_shm_transmitter_get_shm_src +fs_shm_transmitter_sink_set_sending +got_buffer +ready +</SECTION> + + +<SECTION> +<FILE>fs-shm-stream-transmitter</FILE> +<TITLE>FsShmStreamTransmitter</TITLE> +FsShmStreamTransmitter +<SUBSECTION Standard> +FS_SHM_STREAM_TRANSMITTER_CAST +FsShmStreamTransmitterPrivate +fs_shm_stream_transmitter_register_type +fs_shm_stream_transmitter_newv +FsShmStreamTransmitterClass +FS_SHM_STREAM_TRANSMITTER +FS_IS_SHM_STREAM_TRANSMITTER +FS_TYPE_SHM_STREAM_TRANSMITTER +fs_shm_stream_transmitter_get_type +FS_SHM_STREAM_TRANSMITTER_CLASS +FS_IS_SHM_STREAM_TRANSMITTER_CLASS +FS_SHM_STREAM_TRANSMITTER_GET_CLASS +</SECTION> + + +<SECTION> <FILE>fs-msn-conference</FILE> <TITLE>FsMsnConference</TITLE> FsMsnConference |