Skip to content

GitLab

Commit 41aca727 authored by Stefan Kost's avatar Stefan Kost
Browse files
Options

inlined two more docs factored gstpadtemplate out of gstpad 

Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/.cvsignore:
* docs/gst/tmpl/gstpad.sgml:
* docs/gst/tmpl/gstpadtemplate.sgml:
* gst/Makefile.am:
* gst/gstpad.c: (gst_pad_class_init), (gst_pad_dispose),
(gst_pad_finalize), (gst_pad_set_pad_template):
* gst/gstpad.h:
* gst/gstpadtemplate.c: (gst_pad_template_get_type),
(gst_pad_template_class_init), (gst_pad_template_init),
(gst_pad_template_dispose), (name_is_valid),
(gst_static_pad_template_get), (gst_pad_template_new),
(gst_static_pad_template_get_caps), (gst_pad_template_get_caps),
(gst_pad_template_pad_created):
* gst/gstpadtemplate.h:
inlined two more docs
factored gstpadtemplate out of gstpad
parent 4ed6212a
Hide whitespace changes
Inline Side-by-side
Showing with 701 additions and 1855 deletions
ChangeLog
View file @ 41aca727
2005-09-25 Stefan Kost <ensonic@users.sf.net>
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/.cvsignore:
* docs/gst/tmpl/gstpad.sgml:
* docs/gst/tmpl/gstpadtemplate.sgml:
* gst/Makefile.am:
* gst/gstpad.c: (gst_pad_class_init), (gst_pad_dispose),
(gst_pad_finalize), (gst_pad_set_pad_template):
* gst/gstpad.h:
* gst/gstpadtemplate.c: (gst_pad_template_get_type),
(gst_pad_template_class_init), (gst_pad_template_init),
(gst_pad_template_dispose), (name_is_valid),
(gst_static_pad_template_get), (gst_pad_template_new),
(gst_static_pad_template_get_caps), (gst_pad_template_get_caps),
(gst_pad_template_pad_created):
* gst/gstpadtemplate.h:
inlined two more docs
factored gstpadtemplate out of gstpad
2005-09-24 Tim-Philipp Müller <tim at centricular dot net>
* check/gst/gstbin.c: (test_children_state_change_order_flagged_sink),
......
docs/gst/gstreamer-sections.txt
View file @ 41aca727
......@@ -1137,7 +1137,6 @@ GstPadDispatcherFunction
GstPadDirection
GstPadFlags
GstPadLinkReturn
GstPadPresence
GstFlowReturn
GstActivateMode
......@@ -1297,7 +1296,6 @@ GST_PAD_SET_FLUSHING
GST_PAD_TASK
GST_PAD_UNSET_FLUSHING
GST_PAD_ACCEPTCAPSFUNC
GST_PAD_ACTIVATEFUNC
GST_PAD_ACTIVATEPULLFUNC
......@@ -1331,10 +1329,12 @@ GST_PAD_TEMPLATE_PRESENCE
GST_PAD_TEMPLATE_CAPS
GST_PAD_TEMPLATE_IS_FIXED
GstPadTemplateFlags
GstPadPresence
gst_pad_template_new
gst_static_pad_template_get
gst_static_pad_template_get_caps
gst_pad_template_get_caps
<SUBSECTION Standard>
GstPadTemplateClass
GST_PAD_TEMPLATE
......@@ -1344,9 +1344,11 @@ GST_IS_PAD_TEMPLATE_CLASS
GST_STATIC_PAD_TEMPLATE
GST_TYPE_PAD_TEMPLATE
GST_TYPE_PAD_TEMPLATE_FLAGS
<SUBSECTION Private>
gst_pad_template_get_type
gst_pad_template_flags_get_type
gst_pad_template_pad_created
</SECTION>
......
docs/gst/tmpl/.gitignore
View file @ 41aca727
......@@ -38,6 +38,8 @@ gstmemchunk.sgml
gstmessage.sgml
gstminiobject.sgml
gstobject.sgml
gstpad.sgml
gstpadtemplate.sgml
gstparse.sgml
gstpluginfeature.sgml
gstpushsrc.sgml
......
docs/gst/tmpl/gstpad.sgml deleted 100644 → 0
View file @ 4ed6212a
<!-- ##### SECTION Title ##### -->
GstPad
<!-- ##### SECTION Short_Description ##### -->
Object contained by elements that allows links to other elements
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GstElement is linked to other elements via "pads", which are extremely
light-weight generic link points.
After two pads are retrieved from an element with gst_element_get_pad(),
the pads can be link with gst_pad_link(). (For quick links,
you can also use gst_element_link(), which will make the obvious
link for you if it's straightforward.)
</para>
<para>
Pads are typically created from a #GstPadTemplate with
gst_pad_new_from_template().
</para>
<para>
Pads have #GstCaps attached to it to describe the media type they
are capable of dealing with.
gst_pad_get_caps() and gst_pad_try_set_caps() are used to
manipulate the caps of the pads.
Pads created from a pad template cannot set capabilities that are
incompatible with the pad template capabilities.
</para>
<para>
Pads without pad templates can be created with gst_pad_new(),
which takes a direction and a name as an argument. If the name is NULL,
then a guaranteed unique name will be assigned to it.
</para>
<para>
gst_pad_get_parent() will retrieve the #GstElement that owns the pad.
</para>
<para>
A #GstElement creating a pad will typically use the various
gst_pad_set_*_function() calls to register callbacks for various events
on the pads.
</para>
<para>
GstElements will use gst_pad_push() and gst_pad_pull() to push out
or pull in a buffer.
gst_pad_select() and gst_pad_selectv() are used by plugins to wait for the
first incoming buffer or event on any of the given set of pads.
</para>
<para>
To send a #GstEvent on a pad, use gst_pad_send_event().
</para>
<para>
Last reviewed on December 13th, 2002 (0.5.0.1)
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstPadTemplate, #GstElement, #GstEvent
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstPad ##### -->
<para>
</para>
@stream_rec_lock:
@task:
@preroll_lock:
@preroll_cond:
@block_cond:
@block_callback:
@block_data:
@caps:
@getcapsfunc:
@setcapsfunc:
@acceptcapsfunc:
@fixatecapsfunc:
@activatefunc:
@activatepushfunc:
@activatepullfunc:
@linkfunc:
@unlinkfunc:
@peer:
@sched_private:
@chainfunc:
@checkgetrangefunc:
@getrangefunc:
@eventfunc:
@mode:
@querytypefunc:
@queryfunc:
@intlinkfunc:
@bufferallocfunc:
@do_buffer_signals:
@do_event_signals:
<!-- ##### SIGNAL GstPad::have-data ##### -->
<para>
</para>
@gstpad: the object which received the signal.
@arg1:
@Returns:
<!-- ##### SIGNAL GstPad::linked ##### -->
<para>
</para>
@gstpad: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GstPad::request-link ##### -->
<para>
</para>
@gstpad: the object which received the signal.
<!-- ##### SIGNAL GstPad::unlinked ##### -->
<para>
</para>
@gstpad: the object which received the signal.
@arg1:
<!-- ##### ARG GstPad:caps ##### -->
<para>
</para>
<!-- ##### ARG GstPad:direction ##### -->
<para>
</para>
<!-- ##### ARG GstPad:template ##### -->
<para>
</para>
<!-- ##### MACRO GST_PAD_LINK_FAILED ##### -->
<para>
Macro to test if the given #GstPadLinkReturn value indicates a
failed negotiation step (REFUSED/DELAYED).
</para>
@ret: the #GstPadLinkReturn value
<!-- ##### MACRO GST_PAD_LINK_SUCCESSFUL ##### -->
<para>
Macro to test if the given #GstPadLinkReturn value indicates a
successfull negotiation step (OK/DONE).
</para>
@ret: the #GstPadLinkReturn value
<!-- ##### USER_FUNCTION GstPadActivateFunction ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### USER_FUNCTION GstPadActivateModeFunction ##### -->
<para>
</para>
@pad:
@active:
@Returns:
<!-- ##### USER_FUNCTION GstPadBlockCallback ##### -->
<para>
</para>
@pad:
@blocked:
@user_data:
<!-- ##### USER_FUNCTION GstPadChainFunction ##### -->
<para>
A function that will be called when chaining buffers.
</para>
@pad: the #GstPad that performed the chain.
@buffer:
@Returns:
<!-- # Unused Parameters # -->
@data:
@buf: the #GstBuffer that is chained.
<!-- ##### USER_FUNCTION GstPadEventFunction ##### -->
<para>
Function signature to handle an event for the pad.
</para>
@pad: the #GstPad to handle the event.
@event: the #GstEvent to handle.
@Returns: TRUE if the pad could handle the event.
<!-- ##### USER_FUNCTION GstPadCheckGetRangeFunction ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### USER_FUNCTION GstPadGetRangeFunction ##### -->
<para>
</para>
@pad:
@offset:
@length:
@buffer:
@Returns:
<!-- ##### USER_FUNCTION GstPadQueryFunction ##### -->
<para>
The signature of the query function.
</para>
@pad: the #GstPad to query.
@query:
@Returns: TRUE if the query could be performed.
<!-- # Unused Parameters # -->
@type: the #GstPadQueryType.
@format: a pointer to the target #GstFormat.
@value: a pointer to the target value.
<!-- ##### USER_FUNCTION GstPadIntLinkFunction ##### -->
<para>
The signature of the internal pad link function.
</para>
@pad: The #GstPad to query.
@Returns: a newly allocated #GList of pads that are linked to
the given pad on the inside of the parent element.
The caller must call g_list_free() on it after use.
<!-- ##### USER_FUNCTION GstPadQueryTypeFunction ##### -->
<para>
The signature of the query types function.
</para>
@pad: a #GstPad to query
@Returns: an array of query types
<!-- ##### USER_FUNCTION GstPadLinkFunction ##### -->
<para>
Function signature to handle a new link on the pad.
</para>
@pad: the #GstPad that is linked.
@peer:
@Returns: the result of the link with the specified caps.
<!-- # Unused Parameters # -->
@caps: the peer's #GstCaps.
<!-- ##### USER_FUNCTION GstPadUnlinkFunction ##### -->
<para>
</para>
@pad:
<!-- ##### USER_FUNCTION GstPadAcceptCapsFunction ##### -->
<para>
</para>
@pad:
@caps:
@Returns:
<!-- ##### USER_FUNCTION GstPadFixateCapsFunction ##### -->
<para>
</para>
@pad:
@caps:
<!-- ##### USER_FUNCTION GstPadGetCapsFunction ##### -->
<para>
Returns a copy of the capabilities of the specified pad. By default this
function will return the pad template capabilities, but can optionally
be overridden.
</para>
@pad: the #GstPad to get the capabilities of.
@Returns: a newly allocated copy #GstCaps of the pad.
<!-- # Unused Parameters # -->
@caps: the peer's #GstCaps, can be used to filter the capabilities.
<!-- ##### USER_FUNCTION GstPadSetCapsFunction ##### -->
<para>
</para>
@pad:
@caps:
@Returns:
<!-- ##### USER_FUNCTION GstPadBufferAllocFunction ##### -->
<para>
</para>
@pad:
@offset:
@size:
@caps:
@buf:
@Returns:
<!-- ##### USER_FUNCTION GstPadDispatcherFunction ##### -->
<para>
A dispatcher function is called for all internally linked pads, see
gst_pad_dispatcher().
</para>
@pad: the #GstPad that is dispatched.
@data: the gpointer to optional user data.
@Returns: TRUE if the dispatching procedure has to be stopped.
<!-- ##### ENUM GstPadDirection ##### -->
<para>
The direction of a pad.
</para>
@GST_PAD_UNKNOWN: direction is unknown.
@GST_PAD_SRC: the pad is a source pad.
@GST_PAD_SINK: the pad is a sink pad.
<!-- ##### ENUM GstPadFlags ##### -->
<para>
</para>
@GST_PAD_BLOCKED:
@GST_PAD_FLUSHING:
@GST_PAD_IN_GETCAPS:
@GST_PAD_IN_SETCAPS:
@GST_PAD_FLAG_LAST:
<!-- ##### ENUM GstPadLinkReturn ##### -->
@GST_PAD_LINK_OK:
@GST_PAD_LINK_WRONG_HIERARCHY:
@GST_PAD_LINK_WAS_LINKED:
@GST_PAD_LINK_WRONG_DIRECTION:
@GST_PAD_LINK_NOFORMAT:
@GST_PAD_LINK_NOSCHED:
@GST_PAD_LINK_REFUSED:
<!-- ##### ENUM GstPadPresence ##### -->
<para>
Indicates when this pad will become available.
</para>
@GST_PAD_ALWAYS: the pad is always available
@GST_PAD_SOMETIMES: the pad will become available depending on the media stream
@GST_PAD_REQUEST: the pad is only available on request with
gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
<!-- ##### ENUM GstFlowReturn ##### -->
<para>
</para>
@GST_FLOW_RESEND:
@GST_FLOW_OK:
@GST_FLOW_NOT_LINKED:
@GST_FLOW_WRONG_STATE:
@GST_FLOW_UNEXPECTED:
@GST_FLOW_NOT_NEGOTIATED:
@GST_FLOW_ERROR:
@GST_FLOW_NOT_SUPPORTED:
<!-- ##### ENUM GstActivateMode ##### -->
<para>
</para>
@GST_ACTIVATE_NONE:
@GST_ACTIVATE_PUSH:
@GST_ACTIVATE_PULL:
<!-- ##### MACRO GST_PREROLL_BROADCAST ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_PREROLL_GET_COND ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_PREROLL_GET_LOCK ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_PREROLL_LOCK ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_PREROLL_SIGNAL ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_PREROLL_TIMED_WAIT ##### -->
<para>
</para>
@pad:
@timeval:
<!-- ##### MACRO GST_PREROLL_TRYLOCK ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_PREROLL_UNLOCK ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_PREROLL_WAIT ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_STREAM_GET_LOCK ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_STREAM_LOCK ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_STREAM_LOCK_FULL ##### -->
<para>
</para>
@pad:
@t:
<!-- ##### MACRO GST_STREAM_TRYLOCK ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_STREAM_UNLOCK ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_STREAM_UNLOCK_FULL ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_FLOW_IS_FATAL ##### -->
<para>
</para>
@ret:
<!-- ##### FUNCTION gst_pad_new ##### -->
<para>
</para>
@name:
@direction:
@Returns:
<!-- ##### FUNCTION gst_pad_new_from_template ##### -->
<para>
</para>
@templ:
@name:
@Returns:
<!-- ##### MACRO gst_pad_get_name ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_get_direction ##### -->
<para>
</para>
@pad: