mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-27 04:01:08 +00:00
documentation updates
Original commit message from CVS: documentation updates
This commit is contained in:
parent
90355128b5
commit
27d784dc03
14 changed files with 371 additions and 124 deletions
|
@ -212,18 +212,22 @@ cothread_state
|
||||||
cothread_context
|
cothread_context
|
||||||
cothread_func
|
cothread_func
|
||||||
COTHREAD_STARTED
|
COTHREAD_STARTED
|
||||||
cothread_init
|
COTHREAD_DESTROYED
|
||||||
|
cothread_context_init
|
||||||
|
cothread_context_free
|
||||||
cothread_create
|
cothread_create
|
||||||
|
cothread_free
|
||||||
cothread_setfunc
|
cothread_setfunc
|
||||||
|
cothread_stop
|
||||||
cothread_switch
|
cothread_switch
|
||||||
cothread_getcurrent
|
|
||||||
cothread_main
|
|
||||||
cothread_set_data
|
cothread_set_data
|
||||||
cothread_get_data
|
cothread_get_data
|
||||||
cothread_unlock
|
|
||||||
cothread_current_main
|
|
||||||
cothread_lock
|
cothread_lock
|
||||||
cothread_trylock
|
cothread_trylock
|
||||||
|
cothread_unlock
|
||||||
|
cothread_main
|
||||||
|
cothread_current_main
|
||||||
|
cothread_current
|
||||||
<SUBSECTION Standard>
|
<SUBSECTION Standard>
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
|
@ -291,18 +295,23 @@ GST_DISABLE_LOADSAVE_REGISTRY
|
||||||
<SECTION>
|
<SECTION>
|
||||||
<FILE>gstscheduler</FILE>
|
<FILE>gstscheduler</FILE>
|
||||||
<TITLE>GstScheduler</TITLE>
|
<TITLE>GstScheduler</TITLE>
|
||||||
GST_SCHED_PARENT
|
GST_SCHEDULER_PARENT
|
||||||
|
GST_SCHEDULER_STATE
|
||||||
|
gst_scheduler_setup
|
||||||
|
gst_scheduler_reset
|
||||||
gst_scheduler_add_element
|
gst_scheduler_add_element
|
||||||
gst_scheduler_remove_element
|
gst_scheduler_remove_element
|
||||||
gst_scheduler_enable_element
|
gst_scheduler_state_transition
|
||||||
gst_scheduler_disable_element
|
gst_scheduler_lock_element
|
||||||
|
gst_scheduler_unlock_element
|
||||||
|
gst_scheduler_yield
|
||||||
|
gst_scheduler_interrupt
|
||||||
|
gst_scheduler_error
|
||||||
gst_scheduler_pad_connect
|
gst_scheduler_pad_connect
|
||||||
gst_scheduler_pad_disconnect
|
gst_scheduler_pad_disconnect
|
||||||
gst_scheduler_pad_select
|
gst_scheduler_pad_select
|
||||||
gst_scheduler_iterate
|
gst_scheduler_iterate
|
||||||
gst_scheduler_show
|
gst_scheduler_show
|
||||||
gst_scheduler_lock_element
|
|
||||||
gst_scheduler_unlock_element
|
|
||||||
<SUBSECTION Standard>
|
<SUBSECTION Standard>
|
||||||
GstScheduler
|
GstScheduler
|
||||||
GstSchedulerClass
|
GstSchedulerClass
|
||||||
|
@ -355,8 +364,8 @@ gst_bin_get_type
|
||||||
GST_TYPE_BIN
|
GST_TYPE_BIN
|
||||||
GST_BIN
|
GST_BIN
|
||||||
GST_BIN_CLASS
|
GST_BIN_CLASS
|
||||||
GST_BIN_FAST
|
GST_BIN_CAST
|
||||||
GST_BIN_CLASS_FAST
|
GST_BIN_CLASS_CAST
|
||||||
GST_IS_BIN
|
GST_IS_BIN
|
||||||
GST_IS_BIN_CLASS
|
GST_IS_BIN_CLASS
|
||||||
gst_bin_details
|
gst_bin_details
|
||||||
|
@ -492,7 +501,7 @@ GST_STATE_PAUSED_TO_PLAYING
|
||||||
GST_STATE_READY_TO_NULL
|
GST_STATE_READY_TO_NULL
|
||||||
GstElementFlags
|
GstElementFlags
|
||||||
GST_ELEMENT_IS_THREAD_SUGGESTED
|
GST_ELEMENT_IS_THREAD_SUGGESTED
|
||||||
GST_ELEMENT_IS_COTHREAD_STOPPING
|
GST_ELEMENT_IS_DECOUPLED
|
||||||
GST_ELEMENT_IS_EOS
|
GST_ELEMENT_IS_EOS
|
||||||
GST_ELEMENT_IS_EVENT_AWARE
|
GST_ELEMENT_IS_EVENT_AWARE
|
||||||
GST_ELEMENT_PARENT
|
GST_ELEMENT_PARENT
|
||||||
|
@ -529,15 +538,15 @@ gst_element_wait_state_change
|
||||||
gst_element_statename
|
gst_element_statename
|
||||||
gst_element_error
|
gst_element_error
|
||||||
gst_element_get_factory
|
gst_element_get_factory
|
||||||
gst_element_signal_eos
|
gst_element_set_eos
|
||||||
gst_element_restore_thyself
|
gst_element_restore_thyself
|
||||||
<SUBSECTION Standard>
|
<SUBSECTION Standard>
|
||||||
GstElementClass
|
GstElementClass
|
||||||
GST_TYPE_ELEMENT
|
GST_TYPE_ELEMENT
|
||||||
GST_ELEMENT
|
GST_ELEMENT
|
||||||
GST_ELEMENT_CLASS
|
GST_ELEMENT_CLASS
|
||||||
GST_ELEMENT_FAST
|
GST_ELEMENT_CAST
|
||||||
GST_ELEMENT_CLASS_FAST
|
GST_ELEMENT_CLASS_CAST
|
||||||
GST_IS_ELEMENT
|
GST_IS_ELEMENT
|
||||||
GST_IS_ELEMENT_CLASS
|
GST_IS_ELEMENT_CLASS
|
||||||
gst_element_get_type
|
gst_element_get_type
|
||||||
|
@ -666,8 +675,8 @@ GST_OBJECT
|
||||||
GST_OBJECT_CLASS
|
GST_OBJECT_CLASS
|
||||||
GST_IS_OBJECT
|
GST_IS_OBJECT
|
||||||
GST_IS_OBJECT_CLASS
|
GST_IS_OBJECT_CLASS
|
||||||
GST_OBJECT_FAST
|
GST_OBJECT_CAST
|
||||||
GST_OBJECT_CLASS_FAST
|
GST_OBJECT_CLASS_CAST
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
<SECTION>
|
<SECTION>
|
||||||
|
@ -779,8 +788,8 @@ GstPadClass
|
||||||
GST_TYPE_PAD
|
GST_TYPE_PAD
|
||||||
GST_PAD
|
GST_PAD
|
||||||
GST_PAD_CLASS
|
GST_PAD_CLASS
|
||||||
GST_PAD_FAST
|
GST_PAD_CAST
|
||||||
GST_PAD_CLASS_FAST
|
GST_PAD_CLASS_CAST
|
||||||
GST_IS_PAD
|
GST_IS_PAD
|
||||||
GST_IS_PAD_CLASS
|
GST_IS_PAD_CLASS
|
||||||
GST_IS_PAD_FAST
|
GST_IS_PAD_FAST
|
||||||
|
@ -790,8 +799,8 @@ GstRealPadClass
|
||||||
GST_TYPE_REAL_PAD
|
GST_TYPE_REAL_PAD
|
||||||
GST_REAL_PAD
|
GST_REAL_PAD
|
||||||
GST_REAL_PAD_CLASS
|
GST_REAL_PAD_CLASS
|
||||||
GST_REAL_PAD_FAST
|
GST_REAL_PAD_CAST
|
||||||
GST_REAL_PAD_CLASS_FAST
|
GST_REAL_PAD_CLASS_CAST
|
||||||
GST_IS_REAL_PAD
|
GST_IS_REAL_PAD
|
||||||
GST_IS_REAL_PAD_CLASS
|
GST_IS_REAL_PAD_CLASS
|
||||||
GST_IS_REAL_PAD_FAST
|
GST_IS_REAL_PAD_FAST
|
||||||
|
@ -801,8 +810,8 @@ GstGhostPadClass
|
||||||
GST_TYPE_GHOST_PAD
|
GST_TYPE_GHOST_PAD
|
||||||
GST_GHOST_PAD
|
GST_GHOST_PAD
|
||||||
GST_GHOST_PAD_CLASS
|
GST_GHOST_PAD_CLASS
|
||||||
GST_GHOST_PAD_FAST
|
GST_GHOST_PAD_CAST
|
||||||
GST_GHOST_PAD_CLASS_FAST
|
GST_GHOST_PAD_CLASS_CAST
|
||||||
GST_IS_GHOST_PAD
|
GST_IS_GHOST_PAD
|
||||||
GST_IS_GHOST_PAD_CLASS
|
GST_IS_GHOST_PAD_CLASS
|
||||||
GST_IS_GHOST_PAD_FAST
|
GST_IS_GHOST_PAD_FAST
|
||||||
|
@ -1252,21 +1261,6 @@ GST_IS_FDSRC
|
||||||
GST_IS_FDSRC_CLASS
|
GST_IS_FDSRC_CLASS
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
<SECTION>
|
|
||||||
<FILE>gsthttpsrc</FILE>
|
|
||||||
<TITLE>GstHttpSrc</TITLE>
|
|
||||||
<SUBSECTION Standard>
|
|
||||||
GstHttpSrc
|
|
||||||
GstHttpSrcFlags
|
|
||||||
gst_httpsrc_get_type
|
|
||||||
GstHttpSrcClass
|
|
||||||
GST_TYPE_HTTPSRC
|
|
||||||
GST_HTTPSRC
|
|
||||||
GST_HTTPSRC_CLASS
|
|
||||||
GST_IS_HTTPSRC
|
|
||||||
GST_IS_HTTPSRC_CLASS
|
|
||||||
</SECTION>
|
|
||||||
|
|
||||||
<SECTION>
|
<SECTION>
|
||||||
<FILE>gstidentity</FILE>
|
<FILE>gstidentity</FILE>
|
||||||
<TITLE>GstIdentity</TITLE>
|
<TITLE>GstIdentity</TITLE>
|
||||||
|
|
|
@ -1,4 +1,31 @@
|
||||||
GtkObject
|
GtkObject
|
||||||
|
GtkWidget
|
||||||
|
GtkRange
|
||||||
|
GtkScrollbar
|
||||||
|
GtkVScrollbar
|
||||||
|
GtkHScrollbar
|
||||||
|
GtkScale
|
||||||
|
GtkHScale
|
||||||
|
GtkVScale
|
||||||
|
GtkContainer
|
||||||
|
GtkBin
|
||||||
|
GtkScrolledWindow
|
||||||
|
GtkButton
|
||||||
|
GtkToggleButton
|
||||||
|
GtkCheckButton
|
||||||
|
GtkRadioButton
|
||||||
|
GtkPaned
|
||||||
|
GtkVPaned
|
||||||
|
GtkHPaned
|
||||||
|
GtkBox
|
||||||
|
GtkHBox
|
||||||
|
GtkCombo
|
||||||
|
GtkCList
|
||||||
|
GtkEditable
|
||||||
|
GtkEntry
|
||||||
|
GtkSpinButton
|
||||||
|
GtkData
|
||||||
|
GtkAdjustment
|
||||||
GObject
|
GObject
|
||||||
GstObject
|
GstObject
|
||||||
GstXml
|
GstXml
|
||||||
|
@ -11,7 +38,6 @@ GtkObject
|
||||||
GstFakeSrc
|
GstFakeSrc
|
||||||
GstFakeSink
|
GstFakeSink
|
||||||
GstFileSrc
|
GstFileSrc
|
||||||
GstHttpSrc
|
|
||||||
GstFdSrc
|
GstFdSrc
|
||||||
GstFdSink
|
GstFdSink
|
||||||
GstPipefilter
|
GstPipefilter
|
||||||
|
|
|
@ -21,8 +21,6 @@ gst_fakesrc_get_type
|
||||||
gst_fakesink_get_type
|
gst_fakesink_get_type
|
||||||
|
|
||||||
gst_filesrc_get_type
|
gst_filesrc_get_type
|
||||||
gst_disksrc_get_type
|
|
||||||
@GST_HTTPSRC_GET_TYPE@
|
|
||||||
gst_fdsrc_get_type
|
gst_fdsrc_get_type
|
||||||
|
|
||||||
gst_fdsink_get_type
|
gst_fdsink_get_type
|
||||||
|
|
|
@ -69,13 +69,29 @@ Indicates the cothread is started.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION cothread_init ##### -->
|
<!-- ##### MACRO COTHREAD_DESTROYED ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
Indicates the cothread is destroyed.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION cothread_context_init ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@Returns:
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION cothread_context_free ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@ctx:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION cothread_create ##### -->
|
<!-- ##### FUNCTION cothread_create ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
@ -85,6 +101,14 @@ Indicates the cothread is started.
|
||||||
@Returns:
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION cothread_free ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@thread:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION cothread_setfunc ##### -->
|
<!-- ##### FUNCTION cothread_setfunc ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
@ -96,7 +120,7 @@ Indicates the cothread is started.
|
||||||
@argv:
|
@argv:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION cothread_switch ##### -->
|
<!-- ##### FUNCTION cothread_stop ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
@ -104,21 +128,12 @@ Indicates the cothread is started.
|
||||||
@thread:
|
@thread:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION cothread_getcurrent ##### -->
|
<!-- ##### FUNCTION cothread_switch ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@Returns:
|
@thread:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION cothread_main ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@ctx:
|
|
||||||
@Returns:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION cothread_set_data ##### -->
|
<!-- ##### FUNCTION cothread_set_data ##### -->
|
||||||
|
@ -141,22 +156,6 @@ Indicates the cothread is started.
|
||||||
@Returns:
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION cothread_unlock ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@thread:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION cothread_current_main ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@Returns:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION cothread_lock ##### -->
|
<!-- ##### FUNCTION cothread_lock ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
@ -174,3 +173,36 @@ Indicates the cothread is started.
|
||||||
@Returns:
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION cothread_unlock ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@thread:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION cothread_main ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@ctx:
|
||||||
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION cothread_current_main ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION cothread_current ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -253,10 +253,6 @@ The function called when the buffer data has to be freed
|
||||||
@GST_BUFFER_READONLY: the buffer is read only
|
@GST_BUFFER_READONLY: the buffer is read only
|
||||||
@GST_BUFFER_ORIGINAL: this buffer not a copy
|
@GST_BUFFER_ORIGINAL: this buffer not a copy
|
||||||
@GST_BUFFER_DONTFREE: do not try to free the data when this buffer is unref-ed
|
@GST_BUFFER_DONTFREE: do not try to free the data when this buffer is unref-ed
|
||||||
@GST_BUFFER_FLUSH: this buffer is not related to previous buffers. This flag is mainly
|
|
||||||
used when data in a stream has been skipped
|
|
||||||
@GST_BUFFER_EOS: this buffer is the last one in the stream
|
|
||||||
@GST_BUFFER_DISCONTINUOUS: The buffer has a discontinuity
|
|
||||||
|
|
||||||
<!-- ##### STRUCT GstBuffer ##### -->
|
<!-- ##### STRUCT GstBuffer ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
|
@ -135,10 +135,10 @@ This enum defines the standard flags that an element may have.
|
||||||
@GST_ELEMENT_DECOUPLED:
|
@GST_ELEMENT_DECOUPLED:
|
||||||
@GST_ELEMENT_THREAD_SUGGESTED:
|
@GST_ELEMENT_THREAD_SUGGESTED:
|
||||||
@GST_ELEMENT_NO_SEEK:
|
@GST_ELEMENT_NO_SEEK:
|
||||||
@GST_ELEMENT_NO_ENTRY:
|
@GST_ELEMENT_INFINITE_LOOP:
|
||||||
|
@GST_ELEMENT_SCHEDULER_PRIVATE1:
|
||||||
|
@GST_ELEMENT_SCHEDULER_PRIVATE2:
|
||||||
@GST_ELEMENT_NEW_LOOPFUNC:
|
@GST_ELEMENT_NEW_LOOPFUNC:
|
||||||
@GST_ELEMENT_COTHREAD_STOPPING:
|
|
||||||
@GST_ELEMENT_USE_COTHREAD:
|
|
||||||
@GST_ELEMENT_EVENT_AWARE:
|
@GST_ELEMENT_EVENT_AWARE:
|
||||||
@GST_ELEMENT_FLAG_LAST:
|
@GST_ELEMENT_FLAG_LAST:
|
||||||
|
|
||||||
|
@ -150,9 +150,9 @@ Queries whether the Element should be placed in a thread.
|
||||||
@obj: The element to query
|
@obj: The element to query
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### MACRO GST_ELEMENT_IS_COTHREAD_STOPPING ##### -->
|
<!-- ##### MACRO GST_ELEMENT_IS_DECOUPLED ##### -->
|
||||||
<para>
|
<para>
|
||||||
Queries whether the cothread holding this element needs to be stopped.
|
Queries if the Element is decoupled.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@obj: The element to query
|
@obj: The element to query
|
||||||
|
@ -475,6 +475,7 @@ instead.
|
||||||
|
|
||||||
@element:
|
@element:
|
||||||
@error:
|
@error:
|
||||||
|
@Varargs:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_element_get_factory ##### -->
|
<!-- ##### FUNCTION gst_element_get_factory ##### -->
|
||||||
|
@ -486,7 +487,7 @@ instead.
|
||||||
@Returns:
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_element_signal_eos ##### -->
|
<!-- ##### FUNCTION gst_element_set_eos ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
@ -538,6 +539,14 @@ Is trigered whenever an error occured
|
||||||
@gstelement: the object which received the signal.
|
@gstelement: the object which received the signal.
|
||||||
@arg1: the error message
|
@arg1: the error message
|
||||||
|
|
||||||
|
<!-- ##### SIGNAL GstElement::event ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@gstelement: the object which received the signal.
|
||||||
|
@arg1:
|
||||||
|
|
||||||
<!-- ##### SIGNAL GstElement::eos ##### -->
|
<!-- ##### SIGNAL GstElement::eos ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
|
|
@ -38,6 +38,8 @@ The different major types of events.
|
||||||
@GST_EVENT_EMPTY: an empty event.
|
@GST_EVENT_EMPTY: an empty event.
|
||||||
@GST_EVENT_SEEK: a seek event.
|
@GST_EVENT_SEEK: a seek event.
|
||||||
@GST_EVENT_DISCONTINUOUS: a discontinuous event to indicate the stream has a discontinuity.
|
@GST_EVENT_DISCONTINUOUS: a discontinuous event to indicate the stream has a discontinuity.
|
||||||
|
@GST_EVENT_INFO:
|
||||||
|
@GST_EVENT_ERROR:
|
||||||
|
|
||||||
<!-- ##### MACRO GST_EVENT_TYPE ##### -->
|
<!-- ##### MACRO GST_EVENT_TYPE ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
@ -96,6 +98,7 @@ The event data structure.
|
||||||
@data: The parent data type.
|
@data: The parent data type.
|
||||||
@type: The event type.
|
@type: The event type.
|
||||||
@timestamp: The event timestamp.
|
@timestamp: The event timestamp.
|
||||||
|
@src:
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_event_new ##### -->
|
<!-- ##### FUNCTION gst_event_new ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
|
@ -14,7 +14,12 @@ GstFileSrc
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<!-- ##### ARG GstFileSrc:location ##### -->
|
<!-- ##### ARG GstFileSrc:fd ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<!-- ##### ARG GstFileSrc:offset ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
@ -24,7 +29,7 @@ GstFileSrc
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<!-- ##### ARG GstFileSrc:fd ##### -->
|
<!-- ##### ARG GstFileSrc:location ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
@ -34,11 +39,6 @@ GstFileSrc
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<!-- ##### ARG GstFileSrc:offset ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### ARG GstFileSrc:mmapsize ##### -->
|
<!-- ##### ARG GstFileSrc:mmapsize ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
|
|
@ -14,14 +14,3 @@ Reads data from a URL.
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<!-- ##### ARG GstHttpSrc:location ##### -->
|
|
||||||
<para>
|
|
||||||
Specify the location of the file. The location must be a fully qualified URL.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<!-- ##### ARG GstHttpSrc:bytesperread ##### -->
|
|
||||||
<para>
|
|
||||||
Specify how many bytes to read at a time.
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
|
|
|
@ -37,6 +37,11 @@ Pass data without modification.
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
<!-- ##### ARG GstIdentity:error-after ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
<!-- ##### ARG GstIdentity:silent ##### -->
|
<!-- ##### ARG GstIdentity:silent ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
|
|
@ -696,13 +696,13 @@ Destroy the pad.
|
||||||
@pad:
|
@pad:
|
||||||
@caps:
|
@caps:
|
||||||
@direction:
|
@direction:
|
||||||
@threadstate:
|
@sched:
|
||||||
|
@sched_private:
|
||||||
@peer:
|
@peer:
|
||||||
@bufpen:
|
@bufpen:
|
||||||
@regiontype:
|
@regiontype:
|
||||||
@offset:
|
@offset:
|
||||||
@len:
|
@len:
|
||||||
@sched:
|
|
||||||
@chainfunc:
|
@chainfunc:
|
||||||
@chainhandler:
|
@chainhandler:
|
||||||
@getfunc:
|
@getfunc:
|
||||||
|
|
|
@ -41,3 +41,8 @@ Specify the maximum number of buffers in the queue before the queue
|
||||||
blocks.
|
blocks.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
<!-- ##### ARG GstQueue:may-deadlock ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
|
|
@ -137,6 +137,27 @@ Generic connection between elements.
|
||||||
GstConnection
|
GstConnection
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### SECTION ./tmpl/gstdisksrc.sgml:Long_Description ##### -->
|
||||||
|
<para>
|
||||||
|
Asynchonously read buffers from a file.
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### SECTION ./tmpl/gstdisksrc.sgml:See_Also ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### SECTION ./tmpl/gstdisksrc.sgml:Short_Description ##### -->
|
||||||
|
Asynchronous read from a file (disksrc)
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### SECTION ./tmpl/gstdisksrc.sgml:Title ##### -->
|
||||||
|
GstDiskSrc
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Long_Description ##### -->
|
<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Long_Description ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
@ -200,6 +221,26 @@ GstFilter
|
||||||
GstGetbits
|
GstGetbits
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### SECTION ./tmpl/gsthttpsrc.sgml:Long_Description ##### -->
|
||||||
|
<para>
|
||||||
|
Reads data from a URL.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### SECTION ./tmpl/gsthttpsrc.sgml:See_Also ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### SECTION ./tmpl/gsthttpsrc.sgml:Short_Description ##### -->
|
||||||
|
Reads data from a URL. (httpsrc)
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### SECTION ./tmpl/gsthttpsrc.sgml:Title ##### -->
|
||||||
|
GstHttpSrc
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### SECTION ./tmpl/gstmeta.sgml:Long_Description ##### -->
|
<!-- ##### SECTION ./tmpl/gstmeta.sgml:Long_Description ##### -->
|
||||||
<para>
|
<para>
|
||||||
The point of the metadata is to provide some context for each buffer. In
|
The point of the metadata is to provide some context for each buffer. In
|
||||||
|
@ -770,6 +811,13 @@ to the current function, i.e. "('element')"
|
||||||
|
|
||||||
@klass:
|
@klass:
|
||||||
|
|
||||||
|
<!-- ##### MACRO GST_ELEMENT_IS_COTHREAD_STOPPING ##### -->
|
||||||
|
<para>
|
||||||
|
Queries whether the cothread holding this element needs to be stopped.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@obj: The element to query
|
||||||
|
|
||||||
<!-- ##### MACRO GST_ELEMENT_IS_MULTI_IN ##### -->
|
<!-- ##### MACRO GST_ELEMENT_IS_MULTI_IN ##### -->
|
||||||
<para>
|
<para>
|
||||||
Query whether this object has multiple input pads.
|
Query whether this object has multiple input pads.
|
||||||
|
@ -1534,6 +1582,14 @@ Fast macro to unlock a given element.
|
||||||
@sched: The scheduler.
|
@sched: The scheduler.
|
||||||
@element: The element to unlock.
|
@element: The element to unlock.
|
||||||
|
|
||||||
|
<!-- ##### MACRO GST_SCHED_PARENT ##### -->
|
||||||
|
<para>
|
||||||
|
Get the parent #GstElement of this scheduler.
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@sched: the scheduler to query.
|
||||||
|
|
||||||
<!-- ##### MACRO GST_SHOW_INFO ##### -->
|
<!-- ##### MACRO GST_SHOW_INFO ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
@ -2486,6 +2542,30 @@ The filename to write to.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### ARG GstDiskSrc:bytesperread ##### -->
|
||||||
|
<para>
|
||||||
|
Specify how many bytes to read at a time.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### ARG GstDiskSrc:filesize ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### ARG GstDiskSrc:location ##### -->
|
||||||
|
<para>
|
||||||
|
Specify the location of the file to read.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### ARG GstDiskSrc:offset ##### -->
|
||||||
|
<para>
|
||||||
|
Get/set the current offset in the file.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### ARG GstDiskSrc:size ##### -->
|
<!-- ##### ARG GstDiskSrc:size ##### -->
|
||||||
<para>
|
<para>
|
||||||
Get the size of the file.
|
Get the size of the file.
|
||||||
|
@ -2498,6 +2578,23 @@ Get the size of the file.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### ENUM GstDiskSrcFlags ##### -->
|
||||||
|
<para>
|
||||||
|
<informaltable pgwide=1 frame="none" role="enum">
|
||||||
|
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||||
|
<tbody>
|
||||||
|
<row>
|
||||||
|
<entry>GST_DISKSRC_OPEN</entry>
|
||||||
|
<entry>the disksrc is open for reading</entry>
|
||||||
|
</row>
|
||||||
|
|
||||||
|
</tbody></tgroup></informaltable>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@GST_DISKSRC_OPEN:
|
||||||
|
@GST_DISKSRC_FLAG_LAST:
|
||||||
|
|
||||||
<!-- ##### SIGNAL GstElement::ghost-pad-removed ##### -->
|
<!-- ##### SIGNAL GstElement::ghost-pad-removed ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
@ -2619,6 +2716,19 @@ GstElementDetails struct for the element.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### ARG GstHttpSrc:bytesperread ##### -->
|
||||||
|
<para>
|
||||||
|
Specify how many bytes to read at a time.
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### ARG GstHttpSrc:location ##### -->
|
||||||
|
<para>
|
||||||
|
Specify the location of the file. The location must be a fully qualified URL.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### STRUCT GstHttpSrcClass ##### -->
|
<!-- ##### STRUCT GstHttpSrcClass ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
@ -3078,6 +3188,19 @@ must be defined to activate the tracing functionality.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION cothread_getcurrent ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@Returns:
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION cothread_init ##### -->
|
||||||
|
<para>
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@Returns:
|
||||||
|
|
||||||
<!-- ##### FUNCTION g2g_object_class_find_property ##### -->
|
<!-- ##### FUNCTION g2g_object_class_find_property ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
@ -4229,6 +4352,13 @@ must be defined to activate the tracing functionality.
|
||||||
@parent:
|
@parent:
|
||||||
@Returns:
|
@Returns:
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION gst_element_signal_eos ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@element:
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_elementfactory_add_sink ##### -->
|
<!-- ##### FUNCTION gst_elementfactory_add_sink ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
@ -4996,6 +5126,22 @@ Call the EOS function of the pad
|
||||||
|
|
||||||
@sched:
|
@sched:
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION gst_scheduler_disable_element ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@sched:
|
||||||
|
@element:
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION gst_scheduler_enable_element ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@sched:
|
||||||
|
@element:
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_schedulerfactory_get_type ##### -->
|
<!-- ##### FUNCTION gst_schedulerfactory_get_type ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
|
|
|
@ -14,13 +14,36 @@ This is a base class for custom schedulers.
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<!-- ##### MACRO GST_SCHED_PARENT ##### -->
|
<!-- ##### MACRO GST_SCHEDULER_PARENT ##### -->
|
||||||
|
<para>
|
||||||
|
Get the parent object of this scheduler.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@sched: the scheduler to get the parent of.
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### MACRO GST_SCHEDULER_STATE ##### -->
|
||||||
|
<para>
|
||||||
|
Get the state of the scheduler.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@sched: the scheduler to get the state of.
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION gst_scheduler_setup ##### -->
|
||||||
<para>
|
<para>
|
||||||
Get the parent #GstElement of this scheduler.
|
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
@sched: the scheduler to query.
|
@sched:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION gst_scheduler_reset ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@sched:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_scheduler_add_element ##### -->
|
<!-- ##### FUNCTION gst_scheduler_add_element ##### -->
|
||||||
|
@ -41,7 +64,18 @@ Get the parent #GstElement of this scheduler.
|
||||||
@element:
|
@element:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_scheduler_enable_element ##### -->
|
<!-- ##### FUNCTION gst_scheduler_state_transition ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@sched:
|
||||||
|
@element:
|
||||||
|
@transition:
|
||||||
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION gst_scheduler_lock_element ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
@ -50,7 +84,35 @@ Get the parent #GstElement of this scheduler.
|
||||||
@element:
|
@element:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_scheduler_disable_element ##### -->
|
<!-- ##### FUNCTION gst_scheduler_unlock_element ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@sched:
|
||||||
|
@element:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION gst_scheduler_yield ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@sched:
|
||||||
|
@element:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION gst_scheduler_interrupt ##### -->
|
||||||
|
<para>
|
||||||
|
|
||||||
|
</para>
|
||||||
|
|
||||||
|
@sched:
|
||||||
|
@element:
|
||||||
|
@Returns:
|
||||||
|
|
||||||
|
|
||||||
|
<!-- ##### FUNCTION gst_scheduler_error ##### -->
|
||||||
<para>
|
<para>
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
|
@ -106,21 +168,3 @@ Get the parent #GstElement of this scheduler.
|
||||||
@sched:
|
@sched:
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_scheduler_lock_element ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@sched:
|
|
||||||
@element:
|
|
||||||
|
|
||||||
|
|
||||||
<!-- ##### FUNCTION gst_scheduler_unlock_element ##### -->
|
|
||||||
<para>
|
|
||||||
|
|
||||||
</para>
|
|
||||||
|
|
||||||
@sched:
|
|
||||||
@element:
|
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue