mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-01-10 17:35:59 +00:00
more docs fixes, add new api to the docs
Original commit message from CVS: * docs/gst/Makefile.am: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/gst/gstreamer.types: * gst/gstinfo.h: more docs fixes, add new api to the docs
This commit is contained in:
Stefan Kost
parent
eb8cc5ab32
commit
32d6280888
6 changed files with 125 additions and 8 deletions
|
|
@ -1,3 +1,12 @@
|
|||
2005-11-21 Stefan Kost <ensonic@users.sf.net>
|
||||
|
||||
* docs/gst/Makefile.am:
|
||||
* docs/gst/gstreamer-docs.sgml:
|
||||
* docs/gst/gstreamer-sections.txt:
|
||||
* docs/gst/gstreamer.types:
|
||||
* gst/gstinfo.h:
|
||||
more docs fixes, add new api to the docs
|
||||
|
||||
2005-11-21 Andy Wingo <wingo@pobox.com>
|
||||
|
||||
* gst/gstbin.c (gst_bin_remove_func): Wim claims I can remove this
|
||||
|
|
|
|||
|
|
@ -56,7 +56,8 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c
|
|||
# $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la
|
||||
SCANOBJ_DEPS = \
|
||||
$(top_builddir)/gst/elements/libgstelements.la \
|
||||
$(top_builddir)/gst/base/libgstbase-@GST_MAJORMINOR@.la
|
||||
$(top_builddir)/gst/base/libgstbase-@GST_MAJORMINOR@.la \
|
||||
$(top_builddir)/gst/net/libgstnet-tempname-@GST_MAJORMINOR@.la
|
||||
|
||||
# Header files to ignore when scanning. Use base file name, no paths
|
||||
IGNORE_HFILES= \
|
||||
|
|
|
|||
|
|
@ -39,6 +39,7 @@
|
|||
<!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
|
||||
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
|
||||
<!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
|
||||
<!ENTITY GstSegment SYSTEM "xml/gstsegment.xml">
|
||||
<!ENTITY GstStructure SYSTEM "xml/gststructure.xml">
|
||||
<!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
|
||||
<!ENTITY GstTagList SYSTEM "xml/gsttaglist.xml">
|
||||
|
|
@ -60,6 +61,10 @@
|
|||
<!ENTITY GstCollectPads SYSTEM "xml/gstcollectpads.xml">
|
||||
<!ENTITY GstPushSrc SYSTEM "xml/gstpushsrc.xml">
|
||||
|
||||
<!ENTITY GstNetClientClock SYSTEM "xml/gstnetclientclock.xml">
|
||||
<!ENTITY GstNetTimePacket SYSTEM "xml/gstnettimepacket.xml">
|
||||
<!ENTITY GstNetTimeProvider SYSTEM "xml/gstnettimeprovider.xml">
|
||||
|
||||
<!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
|
||||
<!ENTITY GstFakeSink SYSTEM "xml/gstfakesink.xml">
|
||||
<!ENTITY GstFileSrc SYSTEM "xml/gstfilesrc.xml">
|
||||
|
|
@ -149,6 +154,7 @@ Windows. It is released under the GNU Library General Public License
|
|||
&GstQuery;
|
||||
&GstQueue;
|
||||
&GstRegistry;
|
||||
&GstSegment;
|
||||
&GstStructure;
|
||||
&GstSystemClock;
|
||||
&GstTagList;
|
||||
|
|
@ -238,7 +244,19 @@ Windows. It is released under the GNU Library General Public License
|
|||
|
||||
</chapter>
|
||||
|
||||
|
||||
|
||||
<chapter id="gstreamer-net">
|
||||
<title>GStreamer Network Classes</title>
|
||||
<para>
|
||||
libgstnet-&GST_MAJORMINOR;.so provides network elements and objects.
|
||||
</para>
|
||||
|
||||
&GstNetClientClock;
|
||||
&GstNetTimePacket;
|
||||
&GstNetTimeProvider;
|
||||
</chapter>
|
||||
|
||||
|
||||
<chapter id="gstreamer-hierarchy">
|
||||
<title>Object Hierarchy</title>
|
||||
&gstreamer-tree-index;
|
||||
|
|
|
|||
|
|
@ -620,6 +620,8 @@ GstEventType
|
|||
GST_EVENT_TRACE_NAME
|
||||
GST_EVENT_TYPE
|
||||
GST_EVENT_TYPE_NAME
|
||||
GST_EVENT_TYPE_BOTH
|
||||
GST_EVENT_TYPE_SHIFT
|
||||
GST_EVENT_TIMESTAMP
|
||||
GST_EVENT_SRC
|
||||
GST_EVENT_IS_DOWNSTREAM
|
||||
|
|
@ -627,18 +629,15 @@ GST_EVENT_IS_SERIALIZED
|
|||
GST_EVENT_IS_UPSTREAM
|
||||
GstSeekType
|
||||
GstSeekFlags
|
||||
GstEventTypeFlags
|
||||
|
||||
GST_EVENT_MAKE_TYPE
|
||||
GST_EVDIR_BOTH
|
||||
GST_EVDIR_DS
|
||||
GST_EVDIR_US
|
||||
|
||||
gst_event_copy
|
||||
gst_event_get_structure
|
||||
gst_event_new_buffersize
|
||||
gst_event_new_custom
|
||||
gst_event_new_eos
|
||||
gst_event_new_filler
|
||||
gst_event_new_flush_start
|
||||
gst_event_new_flush_stop
|
||||
gst_event_new_navigation
|
||||
|
|
@ -652,6 +651,7 @@ gst_event_parse_qos
|
|||
gst_event_parse_seek
|
||||
gst_event_parse_tag
|
||||
gst_event_ref
|
||||
gst_event_type_get_flags
|
||||
gst_event_type_get_name
|
||||
gst_event_type_to_quark
|
||||
gst_event_unref
|
||||
|
|
@ -667,13 +667,13 @@ GST_TYPE_EVENT
|
|||
GST_TYPE_EVENT_TYPE
|
||||
GST_TYPE_SEEK_TYPE
|
||||
GST_TYPE_SEEK_FLAGS
|
||||
GST_TYPE_EVENT_TYPE_FLAGS
|
||||
<SUBSECTION Private>
|
||||
GST_EVSER
|
||||
GST_EVSHIFT
|
||||
gst_event_get_type
|
||||
gst_event_type_get_type
|
||||
gst_seek_type_get_type
|
||||
gst_seek_flags_get_type
|
||||
gst_event_type_flags_get_type
|
||||
</SECTION>
|
||||
|
||||
|
||||
|
|
@ -1651,6 +1651,23 @@ gst_registry_get_type
|
|||
</SECTION>
|
||||
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstsegment</FILE>
|
||||
<TITLE>GstSegment</TITLE>
|
||||
GstSegment
|
||||
gst_segment_clip
|
||||
gst_segment_init
|
||||
gst_segment_set_duration
|
||||
gst_segment_set_last_stop
|
||||
gst_segment_set_newsegment
|
||||
gst_segment_set_seek
|
||||
gst_segment_to_running_time
|
||||
gst_segment_to_stream_time
|
||||
<SUBSECTION Standard>
|
||||
<SUBSECTION Private>
|
||||
</SECTION>
|
||||
|
||||
|
||||
<SECTION>
|
||||
<FILE>gststructure</FILE>
|
||||
<TITLE>GstStructure</TITLE>
|
||||
|
|
@ -2369,6 +2386,55 @@ GST_PUSH_SRC_GET_CLASS
|
|||
gst_push_src_get_type
|
||||
</SECTION>
|
||||
|
||||
# net
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstnetclientclock</FILE>
|
||||
<TITLE>GstNetClientClock</TITLE>
|
||||
<INCLUDE>gst/net/gstnet.h</INCLUDE>
|
||||
GstNetClientClock
|
||||
gst_net_client_clock_new
|
||||
<SUBSECTION Standard>
|
||||
GstNetClientClockClass
|
||||
GST_NET_CLIENT_CLOCK
|
||||
GST_IS_NET_CLIENT_CLOCK
|
||||
GST_TYPE_NET_CLIENT_CLOCK
|
||||
GST_NET_CLIENT_CLOCK_CLASS
|
||||
GST_IS_NET_CLIENT_CLOCK_CLASS
|
||||
<SUBSECTION Private>
|
||||
gst_net_client_clock_get_type
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstnettimepacket</FILE>
|
||||
<TITLE>GstNetTimePacket</TITLE>
|
||||
<INCLUDE>gst/net/gstnet.h</INCLUDE>
|
||||
GstNetTimePacket
|
||||
GST_NET_TIME_PACKET_SIZE
|
||||
gst_net_time_packet_new
|
||||
gst_net_time_packet_receive
|
||||
gst_net_time_packet_send
|
||||
gst_net_time_packet_serialize
|
||||
<SUBSECTION Standard>
|
||||
<SUBSECTION Private>
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstnettimeprovider</FILE>
|
||||
<TITLE>GstNetTimeProvider</TITLE>
|
||||
<INCLUDE>gst/net/gstnet.h</INCLUDE>
|
||||
GstNetTimeProvider
|
||||
gst_net_time_provider_new
|
||||
<SUBSECTION Standard>
|
||||
GstNetTimeProviderClass
|
||||
GST_NET_TIME_PROVIDER
|
||||
GST_IS_NET_TIME_PROVIDER
|
||||
GST_TYPE_NET_TIME_PROVIDER
|
||||
GST_NET_TIME_PROVIDER_CLASS
|
||||
GST_IS_NET_TIME_PROVIDER_CLASS
|
||||
<SUBSECTION Private>
|
||||
gst_net_time_provider_get_type
|
||||
</SECTION>
|
||||
|
||||
# elements
|
||||
|
||||
|
|
|
|||
|
|
@ -50,6 +50,13 @@ gst_base_transform_get_type
|
|||
gst_collect_pads_get_type
|
||||
gst_push_src_get_type
|
||||
|
||||
% net
|
||||
|
||||
#include <gst/net/gstnet.h>
|
||||
|
||||
gst_net_client_clock_get_type
|
||||
gst_net_time_provider_get_type
|
||||
|
||||
% elements
|
||||
|
||||
#include <gst/elements/gstfakesrc.h>
|
||||
|
|
|
|||
|
|
@ -209,6 +209,22 @@ struct _GstDebugCategory {
|
|||
|
||||
|
||||
typedef struct _GstDebugMessage GstDebugMessage;
|
||||
|
||||
/**
|
||||
* GstLogFunction:
|
||||
* @category: a #GstDebugCategory
|
||||
* @level: a #GstDebugLevel
|
||||
* @file: file name
|
||||
* @function: function name
|
||||
* @line: line number
|
||||
* @object: a #GObject
|
||||
* @message: the message
|
||||
* @data: user data for the log function
|
||||
*
|
||||
* Function prototype for a logging function that can be registered with
|
||||
* gst_debug_add_log_function().
|
||||
* Use G_GNUC_NO_INSTRUMENT on that function.
|
||||
*/
|
||||
typedef void (*GstLogFunction) (GstDebugCategory * category,
|
||||
GstDebugLevel level,
|
||||
const gchar * file,
|
||||
|
|
|
|||
Loading…
Reference in a new issue