mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-18 22:36:33 +00:00
docs: Fix typos in function/object descriptions
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=720029
This commit is contained in:
parent
e8ecf3c407
commit
53ae1b2c9c
76 changed files with 162 additions and 161 deletions
|
@ -214,7 +214,7 @@ videotestsrc ! xvimagesink
|
||||||
- sink pushes RECONFIGURE event upstream
|
- sink pushes RECONFIGURE event upstream
|
||||||
- src receives the RECONFIGURE event and marks renegotiation
|
- src receives the RECONFIGURE event and marks renegotiation
|
||||||
- On the next buffer push, the source renegotiates the caps and the
|
- On the next buffer push, the source renegotiates the caps and the
|
||||||
bufferpool. The sink will put the new new prefered format high in the list
|
bufferpool. The sink will put the new new preferred format high in the list
|
||||||
of caps it returns from its caps query.
|
of caps it returns from its caps query.
|
||||||
|
|
||||||
videotestsrc ! queue ! xvimagesink
|
videotestsrc ! queue ! xvimagesink
|
||||||
|
|
|
@ -212,7 +212,7 @@ the buffer (see part-negotiation.txt).
|
||||||
|
|
||||||
When an element pad receives a CAPS event, it has to check if it understand the
|
When an element pad receives a CAPS event, it has to check if it understand the
|
||||||
media type. The element must refuse following buffers if the media type
|
media type. The element must refuse following buffers if the media type
|
||||||
preceeding it was not accepted.
|
preceding it was not accepted.
|
||||||
|
|
||||||
Both gst_pad_push() and gst_pad_pull_range() have a return value indicating whether
|
Both gst_pad_push() and gst_pad_pull_range() have a return value indicating whether
|
||||||
the operation succeeded. An error code means that no more data should be sent
|
the operation succeeded. An error code means that no more data should be sent
|
||||||
|
|
|
@ -38,15 +38,15 @@ The main reason for adding these extra progress notifications is twofold:
|
||||||
have at least DNS resolving and server connections and requests be well
|
have at least DNS resolving and server connections and requests be well
|
||||||
defined.
|
defined.
|
||||||
|
|
||||||
2) To make the state changes non-blocking and cancelable.
|
2) To make the state changes non-blocking and cancellable.
|
||||||
|
|
||||||
Currently state changes such as going to the READY or PAUSED state often do
|
Currently state changes such as going to the READY or PAUSED state often do
|
||||||
blocking calls such as resolving DNS or connecting to a remote server. These
|
blocking calls such as resolving DNS or connecting to a remote server. These
|
||||||
operations often block the main thread and are often not cancelable, causing
|
operations often block the main thread and are often not cancellable, causing
|
||||||
application lockups.
|
application lockups.
|
||||||
|
|
||||||
We would like to make the state change function, instead, start a separate
|
We would like to make the state change function, instead, start a separate
|
||||||
thread that performs the blocking operations in a cancelable way. When going
|
thread that performs the blocking operations in a cancellable way. When going
|
||||||
back to the NULL state, all pending operations would be canceled immediately.
|
back to the NULL state, all pending operations would be canceled immediately.
|
||||||
|
|
||||||
For downward state changes, we want to let the application implement its own
|
For downward state changes, we want to let the application implement its own
|
||||||
|
@ -143,7 +143,7 @@ Messages
|
||||||
|
|
||||||
- "code", G_TYPE_STRING
|
- "code", G_TYPE_STRING
|
||||||
|
|
||||||
A generic extensible string that can be used to programatically determine the
|
A generic extensible string that can be used to programmatically determine the
|
||||||
action that is in progress. Some standard predefined codes will be
|
action that is in progress. Some standard predefined codes will be
|
||||||
defined.
|
defined.
|
||||||
|
|
||||||
|
@ -176,7 +176,7 @@ Implementation
|
||||||
Elements should not do blocking operations from the state change function.
|
Elements should not do blocking operations from the state change function.
|
||||||
Instead, elements should post an appropriate progress message with the right
|
Instead, elements should post an appropriate progress message with the right
|
||||||
code and of type GST_PROGRESS_TYPE_START and then start a thread to perform
|
code and of type GST_PROGRESS_TYPE_START and then start a thread to perform
|
||||||
the blocking calls in a cancelable manner.
|
the blocking calls in a cancellable manner.
|
||||||
|
|
||||||
It is highly recommended to only start async operations from the READY to PAUSED
|
It is highly recommended to only start async operations from the READY to PAUSED
|
||||||
state and onwards and not from the NULL to READY state. The reason for this is
|
state and onwards and not from the NULL to READY state. The reason for this is
|
||||||
|
|
|
@ -73,7 +73,7 @@ This value is monotonically increasing at the rate of the clock.
|
||||||
Timestamps
|
Timestamps
|
||||||
~~~~~~~~~~
|
~~~~~~~~~~
|
||||||
|
|
||||||
The GstBuffer timestamps and the preceeding SEGMENT event (See
|
The GstBuffer timestamps and the preceding SEGMENT event (See
|
||||||
part-streams.txt) define a transformation of the buffer timestamps to
|
part-streams.txt) define a transformation of the buffer timestamps to
|
||||||
running_time as follows:
|
running_time as follows:
|
||||||
|
|
||||||
|
@ -82,7 +82,7 @@ The following notation is used:
|
||||||
B: GstBuffer
|
B: GstBuffer
|
||||||
- B.timestamp = buffer timestamp (GST_BUFFER_PTS or GST_BUFFER_DTS)
|
- B.timestamp = buffer timestamp (GST_BUFFER_PTS or GST_BUFFER_DTS)
|
||||||
|
|
||||||
S: SEGMENT event preceeding the buffers.
|
S: SEGMENT event preceding the buffers.
|
||||||
- S.start: start field in the SEGMENT event. This is the lowest allowed
|
- S.start: start field in the SEGMENT event. This is the lowest allowed
|
||||||
timestamp.
|
timestamp.
|
||||||
- S.stop: stop field in the SEGMENT event. This is the highers allowed
|
- S.stop: stop field in the SEGMENT event. This is the highers allowed
|
||||||
|
@ -130,7 +130,7 @@ As we have seen, we can get a running_time:
|
||||||
|
|
||||||
C.running_time = absolute_time - base_time
|
C.running_time = absolute_time - base_time
|
||||||
|
|
||||||
- using the buffer timestamp and the preceeding SEGMENT event as (assuming
|
- using the buffer timestamp and the preceding SEGMENT event as (assuming
|
||||||
positive playback rate):
|
positive playback rate):
|
||||||
|
|
||||||
B.running_time = (B.timestamp - (S.start + S.offset)) / ABS (S.rate) + S.base
|
B.running_time = (B.timestamp - (S.start + S.offset)) / ABS (S.rate) + S.base
|
||||||
|
@ -187,7 +187,7 @@ Additional fields in the SEGMENT are used:
|
||||||
- S.time: time field in the SEGMENT event. This the stream-time of S.start
|
- S.time: time field in the SEGMENT event. This the stream-time of S.start
|
||||||
- S.applied_rate: The rate already applied to the stream.
|
- S.applied_rate: The rate already applied to the stream.
|
||||||
|
|
||||||
Stream time is calculated using the buffer times and the preceeding SEGMENT
|
Stream time is calculated using the buffer times and the preceding SEGMENT
|
||||||
event as follows:
|
event as follows:
|
||||||
|
|
||||||
stream_time = (B.timestamp - S.start) * ABS (S.applied_rate) + S.time
|
stream_time = (B.timestamp - S.start) * ABS (S.applied_rate) + S.time
|
||||||
|
|
|
@ -152,7 +152,7 @@ information.
|
||||||
|
|
||||||
When the SKIP flag is set, frames can be dropped in the elements. If S is the
|
When the SKIP flag is set, frames can be dropped in the elements. If S is the
|
||||||
speedup factor, a good algorithm for implementing frame skipping is to send audio in
|
speedup factor, a good algorithm for implementing frame skipping is to send audio in
|
||||||
chunks of Nms (usualy 300ms is good) and then skip ((S-1) * Nns) of audio data.
|
chunks of Nms (usually 300ms is good) and then skip ((S-1) * Nns) of audio data.
|
||||||
For the video we send only the keyframes in the (S * Nns) interval. In this
|
For the video we send only the keyframes in the (S * Nns) interval. In this
|
||||||
case, the demuxer would scale the timestamps and would set an applied rate of S.
|
case, the demuxer would scale the timestamps and would set an applied rate of S.
|
||||||
|
|
||||||
|
|
|
@ -207,7 +207,7 @@
|
||||||
the file on the server.
|
the file on the server.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
In this case, buffering messages will be emited as usual when the
|
In this case, buffering messages will be emitted as usual when the
|
||||||
requested range is not within the downloaded area + buffersize. The
|
requested range is not within the downloaded area + buffersize. The
|
||||||
buffering message will also contain an indication that incremental
|
buffering message will also contain an indication that incremental
|
||||||
download is being performed. This flag can be used to let the application
|
download is being performed. This flag can be used to let the application
|
||||||
|
@ -233,7 +233,7 @@
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
This mode is suitable for all live streams. As with the incremental
|
This mode is suitable for all live streams. As with the incremental
|
||||||
download mode, buffering messages are emited along with an indication
|
download mode, buffering messages are emitted along with an indication
|
||||||
that timeshifting download is in progress.
|
that timeshifting download is in progress.
|
||||||
</para>
|
</para>
|
||||||
</sect1>
|
</sect1>
|
||||||
|
@ -246,7 +246,7 @@
|
||||||
a queue (such as a jitterbuffer) or by other means (in the audiosink).
|
a queue (such as a jitterbuffer) or by other means (in the audiosink).
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
Buffering messages can be emited in those live pipelines as well and
|
Buffering messages can be emitted in those live pipelines as well and
|
||||||
serve as an indication to the user of the latency buffering. The
|
serve as an indication to the user of the latency buffering. The
|
||||||
application usually does not react to these buffering messages with a
|
application usually does not react to these buffering messages with a
|
||||||
state change.
|
state change.
|
||||||
|
|
|
@ -131,7 +131,7 @@
|
||||||
<title>Buffer stream-time</title>
|
<title>Buffer stream-time</title>
|
||||||
<para>
|
<para>
|
||||||
The buffer stream-time, also known as the position in the stream,
|
The buffer stream-time, also known as the position in the stream,
|
||||||
is calculated from the buffer timestamps and the preceeding SEGMENT
|
is calculated from the buffer timestamps and the preceding SEGMENT
|
||||||
event. It represents the time inside the media as a value between
|
event. It represents the time inside the media as a value between
|
||||||
0 and the total duration of the media.
|
0 and the total duration of the media.
|
||||||
</para>
|
</para>
|
||||||
|
|
|
@ -76,7 +76,7 @@ Plugin development
|
||||||
loop based
|
loop based
|
||||||
buffers
|
buffers
|
||||||
metadata
|
metadata
|
||||||
subbufers
|
subbuffers
|
||||||
adding pads
|
adding pads
|
||||||
libraries
|
libraries
|
||||||
plugin registry
|
plugin registry
|
||||||
|
|
|
@ -125,7 +125,7 @@
|
||||||
<sect2>
|
<sect2>
|
||||||
<title>Parser/Decoder/Encoder elements </title>
|
<title>Parser/Decoder/Encoder elements </title>
|
||||||
<para>
|
<para>
|
||||||
Parser/Decoder elements must use the incomming timestamps and transfer
|
Parser/Decoder elements must use the incoming timestamps and transfer
|
||||||
those to the resulting output buffers. They are allowed to interpolate
|
those to the resulting output buffers. They are allowed to interpolate
|
||||||
or reconstruct timestamps on missing input buffers when they can.
|
or reconstruct timestamps on missing input buffers when they can.
|
||||||
</para>
|
</para>
|
||||||
|
@ -137,7 +137,7 @@
|
||||||
Demuxer elements can usually set the timestamps stored inside the media
|
Demuxer elements can usually set the timestamps stored inside the media
|
||||||
file onto the outgoing buffers. They need to make sure that outgoing
|
file onto the outgoing buffers. They need to make sure that outgoing
|
||||||
buffers that are to be played at the same time have the same
|
buffers that are to be played at the same time have the same
|
||||||
running-time. Demuxers also need to take into account the incomming
|
running-time. Demuxers also need to take into account the incoming
|
||||||
timestamps on buffers and use that to calculate an offset on the outgoing
|
timestamps on buffers and use that to calculate an offset on the outgoing
|
||||||
buffer timestamps.
|
buffer timestamps.
|
||||||
</para>
|
</para>
|
||||||
|
@ -146,8 +146,8 @@
|
||||||
<sect2>
|
<sect2>
|
||||||
<title>Muxer elements</title>
|
<title>Muxer elements</title>
|
||||||
<para>
|
<para>
|
||||||
Muxer elements should use the incomming buffer running-time to mux the
|
Muxer elements should use the incoming buffer running-time to mux the
|
||||||
different streams together. They should copy the incomming running-time
|
different streams together. They should copy the incoming running-time
|
||||||
to the outgoing buffers.
|
to the outgoing buffers.
|
||||||
</para>
|
</para>
|
||||||
</sect2>
|
</sect2>
|
||||||
|
|
|
@ -463,7 +463,7 @@ gst_my_filter_chain (GstPad *pad,
|
||||||
to reconfigure its caps by doing a new query for the allowed caps and then
|
to reconfigure its caps by doing a new query for the allowed caps and then
|
||||||
choosing a new caps. The element that sends out the RECONFIGURE event
|
choosing a new caps. The element that sends out the RECONFIGURE event
|
||||||
would influence the selection of the new caps by returning the new
|
would influence the selection of the new caps by returning the new
|
||||||
prefered caps from its GST_QUERY_CAPS query function. The RECONFIGURE
|
preferred caps from its GST_QUERY_CAPS query function. The RECONFIGURE
|
||||||
event will set the GST_PAD_FLAG_NEED_RECONFIGURE on all pads that it
|
event will set the GST_PAD_FLAG_NEED_RECONFIGURE on all pads that it
|
||||||
travels over.
|
travels over.
|
||||||
</para>
|
</para>
|
||||||
|
@ -477,7 +477,7 @@ gst_my_filter_chain (GstPad *pad,
|
||||||
Elements that want to propose a new format upstream need to first
|
Elements that want to propose a new format upstream need to first
|
||||||
check if the new caps are acceptable upstream with an ACCEPT_CAPS
|
check if the new caps are acceptable upstream with an ACCEPT_CAPS
|
||||||
query. Then they would send a RECONFIGURE event and be prepared to
|
query. Then they would send a RECONFIGURE event and be prepared to
|
||||||
answer the CAPS query with the new prefered format. It should be
|
answer the CAPS query with the new preferred format. It should be
|
||||||
noted that when there is no upstream element that can (or wants)
|
noted that when there is no upstream element that can (or wants)
|
||||||
to renegotiate, the element needs to deal with the currently
|
to renegotiate, the element needs to deal with the currently
|
||||||
configured format.
|
configured format.
|
||||||
|
|
|
@ -34,7 +34,7 @@ G_BEGIN_DECLS
|
||||||
*
|
*
|
||||||
* Opaque atomic data queue.
|
* Opaque atomic data queue.
|
||||||
*
|
*
|
||||||
* Use the acessor functions to get the stored values.
|
* Use the accessor functions to get the stored values.
|
||||||
*/
|
*/
|
||||||
typedef struct _GstAtomicQueue GstAtomicQueue;
|
typedef struct _GstAtomicQueue GstAtomicQueue;
|
||||||
|
|
||||||
|
|
|
@ -408,7 +408,7 @@ gst_bin_class_init (GstBinClass * klass)
|
||||||
* @bin: the #GstBin
|
* @bin: the #GstBin
|
||||||
*
|
*
|
||||||
* Will be emitted when the bin needs to perform latency calculations. This
|
* Will be emitted when the bin needs to perform latency calculations. This
|
||||||
* signal is only emited for toplevel bins or when async-handling is
|
* signal is only emitted for toplevel bins or when async-handling is
|
||||||
* enabled.
|
* enabled.
|
||||||
*
|
*
|
||||||
* Only one signal handler is invoked. If no signals are connected, the
|
* Only one signal handler is invoked. If no signals are connected, the
|
||||||
|
|
|
@ -71,7 +71,7 @@
|
||||||
* produced so far. For compressed data, it could be the byte offset in a
|
* produced so far. For compressed data, it could be the byte offset in a
|
||||||
* source or destination file. Likewise, the end offset will be the offset of
|
* source or destination file. Likewise, the end offset will be the offset of
|
||||||
* the end of the buffer. These can only be meaningfully interpreted if you
|
* the end of the buffer. These can only be meaningfully interpreted if you
|
||||||
* know the media type of the buffer (the preceeding CAPS event). Either or both
|
* know the media type of the buffer (the preceding CAPS event). Either or both
|
||||||
* can be set to #GST_BUFFER_OFFSET_NONE.
|
* can be set to #GST_BUFFER_OFFSET_NONE.
|
||||||
*
|
*
|
||||||
* gst_buffer_ref() is used to increase the refcount of a buffer. This must be
|
* gst_buffer_ref() is used to increase the refcount of a buffer. This must be
|
||||||
|
@ -1281,7 +1281,7 @@ gst_buffer_get_sizes_range (GstBuffer * buffer, guint idx, gint length,
|
||||||
/**
|
/**
|
||||||
* gst_buffer_resize:
|
* gst_buffer_resize:
|
||||||
* @buffer: a #GstBuffer.
|
* @buffer: a #GstBuffer.
|
||||||
* @offset: the offset adjustement
|
* @offset: the offset adjustment
|
||||||
* @size: the new size or -1 to just adjust the offset
|
* @size: the new size or -1 to just adjust the offset
|
||||||
*
|
*
|
||||||
* Set the offset and total size of the memory blocks in @buffer.
|
* Set the offset and total size of the memory blocks in @buffer.
|
||||||
|
@ -1310,7 +1310,7 @@ gst_buffer_set_size (GstBuffer * buffer, gssize size)
|
||||||
* @buffer: a #GstBuffer.
|
* @buffer: a #GstBuffer.
|
||||||
* @idx: an index
|
* @idx: an index
|
||||||
* @length: a length
|
* @length: a length
|
||||||
* @offset: the offset adjustement
|
* @offset: the offset adjustment
|
||||||
* @size: the new size or -1 to just adjust the offset
|
* @size: the new size or -1 to just adjust the offset
|
||||||
*
|
*
|
||||||
* Set the total size of the @length memory blocks starting at @idx in
|
* Set the total size of the @length memory blocks starting at @idx in
|
||||||
|
@ -1997,7 +1997,7 @@ gst_buffer_remove_meta (GstBuffer * buffer, GstMeta * meta)
|
||||||
* Retrieve the next #GstMeta after @current. If @state points
|
* Retrieve the next #GstMeta after @current. If @state points
|
||||||
* to %NULL, the first metadata is returned.
|
* to %NULL, the first metadata is returned.
|
||||||
*
|
*
|
||||||
* @state will be updated with an opage state pointer
|
* @state will be updated with an opaque state pointer
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): The next #GstMeta or %NULL when there are
|
* Returns: (transfer none): The next #GstMeta or %NULL when there are
|
||||||
* no more items.
|
* no more items.
|
||||||
|
|
|
@ -319,7 +319,7 @@ void gst_buffer_extract_dup (GstBuffer *buffer, gsize offset,
|
||||||
*
|
*
|
||||||
* Increases the refcount of the given buffer by one.
|
* Increases the refcount of the given buffer by one.
|
||||||
*
|
*
|
||||||
* Note that the refcount affects the writeability
|
* Note that the refcount affects the writability
|
||||||
* of @buf and its metadata, see gst_buffer_is_writable().
|
* of @buf and its metadata, see gst_buffer_is_writable().
|
||||||
* It is important to note that keeping additional references to
|
* It is important to note that keeping additional references to
|
||||||
* GstBuffer instances can potentially increase the number
|
* GstBuffer instances can potentially increase the number
|
||||||
|
|
|
@ -66,7 +66,7 @@ typedef gboolean (*GstBufferListFunc) (GstBuffer **buffer, guint idx,
|
||||||
*
|
*
|
||||||
* Increases the refcount of the given buffer list by one.
|
* Increases the refcount of the given buffer list by one.
|
||||||
*
|
*
|
||||||
* Note that the refcount affects the writeability of @list and its data, see
|
* Note that the refcount affects the writability of @list and its data, see
|
||||||
* gst_buffer_list_make_writable(). It is important to note that keeping
|
* gst_buffer_list_make_writable(). It is important to note that keeping
|
||||||
* additional references to GstBufferList instances can potentially increase
|
* additional references to GstBufferList instances can potentially increase
|
||||||
* the number of memcpy operations in a pipeline.
|
* the number of memcpy operations in a pipeline.
|
||||||
|
|
|
@ -650,7 +650,7 @@ gst_caps_append_structure_full (GstCaps * caps, GstStructure * structure,
|
||||||
* @caps: the #GstCaps to remove from
|
* @caps: the #GstCaps to remove from
|
||||||
* @idx: Index of the structure to remove
|
* @idx: Index of the structure to remove
|
||||||
*
|
*
|
||||||
* removes the stucture with the given index from the list of structures
|
* removes the structure with the given index from the list of structures
|
||||||
* contained in @caps.
|
* contained in @caps.
|
||||||
*/
|
*/
|
||||||
void
|
void
|
||||||
|
|
|
@ -411,7 +411,7 @@ gst_caps_features_free (GstCapsFeatures * features)
|
||||||
* |[
|
* |[
|
||||||
* GST_LOG ("features is %" GST_PTR_FORMAT, features);
|
* GST_LOG ("features is %" GST_PTR_FORMAT, features);
|
||||||
* ]|
|
* ]|
|
||||||
* This prints the features in human readble form.
|
* This prints the features in human readable form.
|
||||||
*
|
*
|
||||||
* Free-function: g_free
|
* Free-function: g_free
|
||||||
*
|
*
|
||||||
|
|
|
@ -100,7 +100,7 @@ gst_child_proxy_default_get_child_by_name (GstChildProxy * parent,
|
||||||
/**
|
/**
|
||||||
* gst_child_proxy_get_child_by_name:
|
* gst_child_proxy_get_child_by_name:
|
||||||
* @parent: the parent object to get the child from
|
* @parent: the parent object to get the child from
|
||||||
* @name: the childs name
|
* @name: the child's name
|
||||||
*
|
*
|
||||||
* Looks up a child element by the given name.
|
* Looks up a child element by the given name.
|
||||||
*
|
*
|
||||||
|
@ -125,7 +125,7 @@ gst_child_proxy_get_child_by_name (GstChildProxy * parent, const gchar * name)
|
||||||
/**
|
/**
|
||||||
* gst_child_proxy_get_child_by_index:
|
* gst_child_proxy_get_child_by_index:
|
||||||
* @parent: the parent object to get the child from
|
* @parent: the parent object to get the child from
|
||||||
* @index: the childs position in the child list
|
* @index: the child's position in the child list
|
||||||
*
|
*
|
||||||
* Fetches a child by its number.
|
* Fetches a child by its number.
|
||||||
*
|
*
|
||||||
|
|
|
@ -33,7 +33,7 @@
|
||||||
* If a subsystem is disabled, most of this changes are done in an API
|
* If a subsystem is disabled, most of this changes are done in an API
|
||||||
* compatible way, so you don't need to adapt your code in most cases. It is
|
* compatible way, so you don't need to adapt your code in most cases. It is
|
||||||
* never done in an ABI compatible way though. So if you want to disable a
|
* never done in an ABI compatible way though. So if you want to disable a
|
||||||
* suybsystem, you have to rebuild all programs depending on GStreamer, too.
|
* subsystem, you have to rebuild all programs depending on GStreamer, too.
|
||||||
*
|
*
|
||||||
* If a subsystem is disabled in GStreamer, a value is defined in
|
* If a subsystem is disabled in GStreamer, a value is defined in
|
||||||
* <gst/gst.h>. You can check this if you do subsystem-specific stuff.
|
* <gst/gst.h>. You can check this if you do subsystem-specific stuff.
|
||||||
|
@ -81,14 +81,14 @@
|
||||||
/**
|
/**
|
||||||
* GST_DISABLE_PARSE:
|
* GST_DISABLE_PARSE:
|
||||||
*
|
*
|
||||||
* Configures the inclusion of the gst-lauch parser
|
* Configures the inclusion of the gst-launch parser
|
||||||
*/
|
*/
|
||||||
@GST_DISABLE_PARSE_DEFINE@
|
@GST_DISABLE_PARSE_DEFINE@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GST_DISABLE_TRACE:
|
* GST_DISABLE_TRACE:
|
||||||
*
|
*
|
||||||
* Configures the inclusion of a resource tracing facillity
|
* Configures the inclusion of a resource tracing facility
|
||||||
* (seems to be unused)
|
* (seems to be unused)
|
||||||
*/
|
*/
|
||||||
@GST_DISABLE_TRACE_DEFINE@
|
@GST_DISABLE_TRACE_DEFINE@
|
||||||
|
|
|
@ -587,7 +587,7 @@ __gst_date_time_compare (const GstDateTime * dt1, const GstDateTime * dt2)
|
||||||
*
|
*
|
||||||
* Note that @tzoffset is a float and was chosen so for being able to handle
|
* Note that @tzoffset is a float and was chosen so for being able to handle
|
||||||
* some fractional timezones, while it still keeps the readability of
|
* some fractional timezones, while it still keeps the readability of
|
||||||
* represeting it in hours for most timezones.
|
* representing it in hours for most timezones.
|
||||||
*
|
*
|
||||||
* If value is -1 then all over value will be ignored. For example
|
* If value is -1 then all over value will be ignored. For example
|
||||||
* if @month == -1, then #GstDateTime will created only for @year. If
|
* if @month == -1, then #GstDateTime will created only for @year. If
|
||||||
|
|
|
@ -32,7 +32,7 @@ G_BEGIN_DECLS
|
||||||
* information. It currently supports ranges from 0001-01-01 to
|
* information. It currently supports ranges from 0001-01-01 to
|
||||||
* 9999-12-31 in the Gregorian proleptic calendar.
|
* 9999-12-31 in the Gregorian proleptic calendar.
|
||||||
*
|
*
|
||||||
* Use the acessor functions to get the stored values.
|
* Use the accessor functions to get the stored values.
|
||||||
*/
|
*/
|
||||||
typedef struct _GstDateTime GstDateTime;
|
typedef struct _GstDateTime GstDateTime;
|
||||||
|
|
||||||
|
|
|
@ -72,7 +72,7 @@
|
||||||
* #GST_ELEMENT_FLAG_REQUIRE_CLOCK() flag is set, a clock should be set on the
|
* #GST_ELEMENT_FLAG_REQUIRE_CLOCK() flag is set, a clock should be set on the
|
||||||
* element with gst_element_set_clock().
|
* element with gst_element_set_clock().
|
||||||
*
|
*
|
||||||
* Note that clock slection and distribution is normally handled by the
|
* Note that clock selection and distribution is normally handled by the
|
||||||
* toplevel #GstPipeline so the clock functions are only to be used in very
|
* toplevel #GstPipeline so the clock functions are only to be used in very
|
||||||
* specific situations.
|
* specific situations.
|
||||||
*
|
*
|
||||||
|
@ -1535,7 +1535,7 @@ gst_element_default_send_event (GstElement * element, GstEvent * event)
|
||||||
* event handler, the event will be pushed on a random linked sink pad for
|
* event handler, the event will be pushed on a random linked sink pad for
|
||||||
* upstream events or a random linked source pad for downstream events.
|
* upstream events or a random linked source pad for downstream events.
|
||||||
*
|
*
|
||||||
* This function takes owership of the provided event so you should
|
* This function takes ownership of the provided event so you should
|
||||||
* gst_event_ref() it if you want to reuse the event after this call.
|
* gst_event_ref() it if you want to reuse the event after this call.
|
||||||
*
|
*
|
||||||
* MT safe.
|
* MT safe.
|
||||||
|
|
|
@ -212,7 +212,7 @@ typedef enum {
|
||||||
* </para></listitem>
|
* </para></listitem>
|
||||||
* <listitem><para>
|
* <listitem><para>
|
||||||
* The pipeline selects a #GstClock and distributes this to all the children
|
* The pipeline selects a #GstClock and distributes this to all the children
|
||||||
* before setting them to PLAYING. This means that it is only alowed to
|
* before setting them to PLAYING. This means that it is only allowed to
|
||||||
* synchronize on the #GstClock in the PLAYING state.
|
* synchronize on the #GstClock in the PLAYING state.
|
||||||
* </para></listitem>
|
* </para></listitem>
|
||||||
* <listitem><para>
|
* <listitem><para>
|
||||||
|
|
|
@ -27,7 +27,7 @@
|
||||||
* @see_also: #GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
|
* @see_also: #GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate.
|
||||||
*
|
*
|
||||||
* #GstElementFactory is used to create instances of elements. A
|
* #GstElementFactory is used to create instances of elements. A
|
||||||
* GstElementfactory can be added to a #GstPlugin as it is also a
|
* GstElementFactory can be added to a #GstPlugin as it is also a
|
||||||
* #GstPluginFeature.
|
* #GstPluginFeature.
|
||||||
*
|
*
|
||||||
* Use the gst_element_factory_find() and gst_element_factory_create()
|
* Use the gst_element_factory_find() and gst_element_factory_create()
|
||||||
|
@ -818,7 +818,7 @@ gst_element_factory_list_get_elements (GstElementFactoryListType type,
|
||||||
* whose pad templates caps can intersect with @caps will be returned.
|
* whose pad templates caps can intersect with @caps will be returned.
|
||||||
*
|
*
|
||||||
* Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
|
* Returns: (transfer full) (element-type Gst.ElementFactory): a #GList of
|
||||||
* #GstElementFactory elements that match the given requisits.
|
* #GstElementFactory elements that match the given requisites.
|
||||||
* Use #gst_plugin_feature_list_free after usage.
|
* Use #gst_plugin_feature_list_free after usage.
|
||||||
*/
|
*/
|
||||||
GList *
|
GList *
|
||||||
|
|
|
@ -23,7 +23,7 @@
|
||||||
* @see_also: #GstMessage
|
* @see_also: #GstMessage
|
||||||
*
|
*
|
||||||
* GStreamer elements can throw non-fatal warnings and fatal errors.
|
* GStreamer elements can throw non-fatal warnings and fatal errors.
|
||||||
* Higher-level elements and applications can programatically filter
|
* Higher-level elements and applications can programmatically filter
|
||||||
* the ones they are interested in or can recover from,
|
* the ones they are interested in or can recover from,
|
||||||
* and have a default handler handle the rest of them.
|
* and have a default handler handle the rest of them.
|
||||||
*
|
*
|
||||||
|
|
|
@ -481,7 +481,7 @@ gst_event_new_flush_start (void)
|
||||||
* pads accept data again.
|
* pads accept data again.
|
||||||
*
|
*
|
||||||
* Elements can process this event synchronized with the dataflow since
|
* Elements can process this event synchronized with the dataflow since
|
||||||
* the preceeding FLUSH_START event stopped the dataflow.
|
* the preceding FLUSH_START event stopped the dataflow.
|
||||||
*
|
*
|
||||||
* This event is typically generated to complete a seek and to resume
|
* This event is typically generated to complete a seek and to resume
|
||||||
* dataflow.
|
* dataflow.
|
||||||
|
@ -934,7 +934,7 @@ gst_event_parse_buffer_size (GstEvent * event, GstFormat * format,
|
||||||
* increasing value.
|
* increasing value.
|
||||||
*
|
*
|
||||||
* The upstream element can use the @diff and @timestamp values to decide
|
* The upstream element can use the @diff and @timestamp values to decide
|
||||||
* whether to process more buffers. For possitive @diff, all buffers with
|
* whether to process more buffers. For positive @diff, all buffers with
|
||||||
* timestamp <= @timestamp + @diff will certainly arrive late in the sink
|
* timestamp <= @timestamp + @diff will certainly arrive late in the sink
|
||||||
* as well. A (negative) @diff value so that @timestamp + @diff would yield a
|
* as well. A (negative) @diff value so that @timestamp + @diff would yield a
|
||||||
* result smaller than 0 is not allowed.
|
* result smaller than 0 is not allowed.
|
||||||
|
@ -1097,9 +1097,9 @@ gst_event_new_seek (gdouble rate, GstFormat format, GstSeekFlags flags,
|
||||||
* @format: (out): result location for the stream format
|
* @format: (out): result location for the stream format
|
||||||
* @flags: (out): result location for the #GstSeekFlags
|
* @flags: (out): result location for the #GstSeekFlags
|
||||||
* @start_type: (out): result location for the #GstSeekType of the start position
|
* @start_type: (out): result location for the #GstSeekType of the start position
|
||||||
* @start: (out): result location for the start postion expressed in @format
|
* @start: (out): result location for the start position expressed in @format
|
||||||
* @stop_type: (out): result location for the #GstSeekType of the stop position
|
* @stop_type: (out): result location for the #GstSeekType of the stop position
|
||||||
* @stop: (out): result location for the stop postion expressed in @format
|
* @stop: (out): result location for the stop position expressed in @format
|
||||||
*
|
*
|
||||||
* Parses a seek @event and stores the results in the given result locations.
|
* Parses a seek @event and stores the results in the given result locations.
|
||||||
*/
|
*/
|
||||||
|
@ -1298,7 +1298,7 @@ gst_event_parse_step (GstEvent * event, GstFormat * format, guint64 * amount,
|
||||||
/**
|
/**
|
||||||
* gst_event_new_reconfigure:
|
* gst_event_new_reconfigure:
|
||||||
|
|
||||||
* Create a new reconfigure event. The purpose of the reconfingure event is
|
* Create a new reconfigure event. The purpose of the reconfigure event is
|
||||||
* to travel upstream and make elements renegotiate their caps or reconfigure
|
* to travel upstream and make elements renegotiate their caps or reconfigure
|
||||||
* their buffer pools. This is useful when changing properties on elements
|
* their buffer pools. This is useful when changing properties on elements
|
||||||
* or changing the topology of the pipeline.
|
* or changing the topology of the pipeline.
|
||||||
|
|
|
@ -34,10 +34,10 @@ G_BEGIN_DECLS
|
||||||
* GstDebugLevel:
|
* GstDebugLevel:
|
||||||
* @GST_LEVEL_NONE: No debugging level specified or desired. Used to deactivate
|
* @GST_LEVEL_NONE: No debugging level specified or desired. Used to deactivate
|
||||||
* debugging output.
|
* debugging output.
|
||||||
* @GST_LEVEL_ERROR: Error messages are to be used only when an error occured
|
* @GST_LEVEL_ERROR: Error messages are to be used only when an error occurred
|
||||||
* that stops the application from keeping working correctly.
|
* that stops the application from keeping working correctly.
|
||||||
* An examples is gst_element_error, which outputs a message with this priority.
|
* An examples is gst_element_error, which outputs a message with this priority.
|
||||||
* It does not mean that the application is terminating as with g_errror.
|
* It does not mean that the application is terminating as with g_error.
|
||||||
* @GST_LEVEL_WARNING: Warning messages are to inform about abnormal behaviour
|
* @GST_LEVEL_WARNING: Warning messages are to inform about abnormal behaviour
|
||||||
* that could lead to problems or weird behaviour later on. An example of this
|
* that could lead to problems or weird behaviour later on. An example of this
|
||||||
* would be clocking issues ("your computer is pretty slow") or broken input
|
* would be clocking issues ("your computer is pretty slow") or broken input
|
||||||
|
|
|
@ -34,7 +34,7 @@
|
||||||
*
|
*
|
||||||
* In general, whenever calling a GstIterator function results in your code
|
* In general, whenever calling a GstIterator function results in your code
|
||||||
* receiving a refcounted object, the refcount for that object will have been
|
* receiving a refcounted object, the refcount for that object will have been
|
||||||
* increased. Your code is responsible for unrefing that object after use.
|
* increased. Your code is responsible for unreffing that object after use.
|
||||||
*
|
*
|
||||||
* The basic use pattern of an iterator is as follows:
|
* The basic use pattern of an iterator is as follows:
|
||||||
*
|
*
|
||||||
|
|
|
@ -384,7 +384,7 @@ gst_message_new_eos (GstObject * src)
|
||||||
*
|
*
|
||||||
* Create a new error message. The message will copy @error and
|
* Create a new error message. The message will copy @error and
|
||||||
* @debug. This message is posted by element when a fatal event
|
* @debug. This message is posted by element when a fatal event
|
||||||
* occured. The pipeline will probably (partially) stop. The application
|
* occurred. The pipeline will probably (partially) stop. The application
|
||||||
* receiving this message should stop the pipeline.
|
* receiving this message should stop the pipeline.
|
||||||
*
|
*
|
||||||
* Returns: (transfer full): the new error message.
|
* Returns: (transfer full): the new error message.
|
||||||
|
@ -649,7 +649,7 @@ gst_message_new_clock_lost (GstObject * src, GstClock * clock)
|
||||||
* @clock: (transfer none): the new selected clock
|
* @clock: (transfer none): the new selected clock
|
||||||
*
|
*
|
||||||
* Create a new clock message. This message is posted whenever the
|
* Create a new clock message. This message is posted whenever the
|
||||||
* pipeline selectes a new clock for the pipeline.
|
* pipeline selects a new clock for the pipeline.
|
||||||
*
|
*
|
||||||
* Returns: (transfer full): The new new clock message.
|
* Returns: (transfer full): The new new clock message.
|
||||||
*
|
*
|
||||||
|
@ -912,7 +912,7 @@ gst_message_new_latency (GstObject * src)
|
||||||
* changed. A typical use case would be an audio server that wants to pause the
|
* changed. A typical use case would be an audio server that wants to pause the
|
||||||
* pipeline because a higher priority stream is being played.
|
* pipeline because a higher priority stream is being played.
|
||||||
*
|
*
|
||||||
* Returns: (transfer full): the new requst state message.
|
* Returns: (transfer full): the new request state message.
|
||||||
*
|
*
|
||||||
* MT safe.
|
* MT safe.
|
||||||
*/
|
*/
|
||||||
|
@ -1684,7 +1684,7 @@ gst_message_parse_step_done (GstMessage * message, GstFormat * format,
|
||||||
*
|
*
|
||||||
* @active is set to TRUE when the element has activated the step operation and
|
* @active is set to TRUE when the element has activated the step operation and
|
||||||
* is now ready to start executing the step in the streaming thread. After this
|
* is now ready to start executing the step in the streaming thread. After this
|
||||||
* message is emited, the application can queue a new step operation in the
|
* message is emitted, the application can queue a new step operation in the
|
||||||
* element.
|
* element.
|
||||||
*
|
*
|
||||||
* Returns: (transfer full): The new step_start message.
|
* Returns: (transfer full): The new step_start message.
|
||||||
|
@ -2064,7 +2064,7 @@ gst_message_new_toc (GstObject * src, GstToc * toc, gboolean updated)
|
||||||
* @toc: (out) (transfer full): return location for the TOC.
|
* @toc: (out) (transfer full): return location for the TOC.
|
||||||
* @updated: (out): return location for the updated flag.
|
* @updated: (out): return location for the updated flag.
|
||||||
*
|
*
|
||||||
* Extract thef TOC from the #GstMessage. The TOC returned in the
|
* Extract the TOC from the #GstMessage. The TOC returned in the
|
||||||
* output argument is a copy; the caller must free it with
|
* output argument is a copy; the caller must free it with
|
||||||
* gst_toc_unref() when done.
|
* gst_toc_unref() when done.
|
||||||
*
|
*
|
||||||
|
|
|
@ -33,11 +33,11 @@ typedef struct _GstMessage GstMessage;
|
||||||
* only receive this message in the PLAYING state and every time it sets a
|
* only receive this message in the PLAYING state and every time it sets a
|
||||||
* pipeline to PLAYING that is in the EOS state. The application can perform a
|
* pipeline to PLAYING that is in the EOS state. The application can perform a
|
||||||
* flushing seek in the pipeline, which will undo the EOS state again.
|
* flushing seek in the pipeline, which will undo the EOS state again.
|
||||||
* @GST_MESSAGE_ERROR: an error occured. When the application receives an error
|
* @GST_MESSAGE_ERROR: an error occurred. When the application receives an error
|
||||||
* message it should stop playback of the pipeline and not assume that more
|
* message it should stop playback of the pipeline and not assume that more
|
||||||
* data will be played.
|
* data will be played.
|
||||||
* @GST_MESSAGE_WARNING: a warning occured.
|
* @GST_MESSAGE_WARNING: a warning occurred.
|
||||||
* @GST_MESSAGE_INFO: an info message occured
|
* @GST_MESSAGE_INFO: an info message occurred
|
||||||
* @GST_MESSAGE_TAG: a tag was found.
|
* @GST_MESSAGE_TAG: a tag was found.
|
||||||
* @GST_MESSAGE_BUFFERING: the pipeline is buffering. When the application
|
* @GST_MESSAGE_BUFFERING: the pipeline is buffering. When the application
|
||||||
* receives a buffering message in the PLAYING state for a non-live pipeline it
|
* receives a buffering message in the PLAYING state for a non-live pipeline it
|
||||||
|
@ -260,7 +260,7 @@ typedef enum {
|
||||||
* posted on the bus.
|
* posted on the bus.
|
||||||
*
|
*
|
||||||
* The type of a %GST_MESSAGE_PROGRESS. The progress messages inform the
|
* The type of a %GST_MESSAGE_PROGRESS. The progress messages inform the
|
||||||
* application of the status of assynchronous tasks.
|
* application of the status of asynchronous tasks.
|
||||||
*/
|
*/
|
||||||
typedef enum {
|
typedef enum {
|
||||||
GST_PROGRESS_TYPE_START = 0,
|
GST_PROGRESS_TYPE_START = 0,
|
||||||
|
|
|
@ -175,8 +175,8 @@ typedef gboolean (*GstMetaTransformFunction) (GstBuffer *transbuf,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GstMetaInfo:
|
* GstMetaInfo:
|
||||||
* @api: tag indentifying the metadata structure and api
|
* @api: tag identifying the metadata structure and api
|
||||||
* @type: type indentifying the implementor of the api
|
* @type: type identifying the implementor of the api
|
||||||
* @size: size of the metadata
|
* @size: size of the metadata
|
||||||
* @init_func: function for initializing the metadata
|
* @init_func: function for initializing the metadata
|
||||||
* @free_func: function for freeing the metadata
|
* @free_func: function for freeing the metadata
|
||||||
|
|
|
@ -336,7 +336,7 @@ gst_mini_object_make_writable (GstMiniObject * mini_object)
|
||||||
*
|
*
|
||||||
* Increase the reference count of the mini-object.
|
* Increase the reference count of the mini-object.
|
||||||
*
|
*
|
||||||
* Note that the refcount affects the writeability
|
* Note that the refcount affects the writability
|
||||||
* of @mini-object, see gst_mini_object_is_writable(). It is
|
* of @mini-object, see gst_mini_object_is_writable(). It is
|
||||||
* important to note that keeping additional references to
|
* important to note that keeping additional references to
|
||||||
* GstMiniObject instances can potentially increase the number
|
* GstMiniObject instances can potentially increase the number
|
||||||
|
@ -645,7 +645,7 @@ gst_mini_object_weak_unref (GstMiniObject * object,
|
||||||
* needs to be freed
|
* needs to be freed
|
||||||
*
|
*
|
||||||
* This sets an opaque, named pointer on a miniobject.
|
* This sets an opaque, named pointer on a miniobject.
|
||||||
* The name is specified through a #GQuark (retrived e.g. via
|
* The name is specified through a #GQuark (retrieved e.g. via
|
||||||
* g_quark_from_static_string()), and the pointer
|
* g_quark_from_static_string()), and the pointer
|
||||||
* can be gotten back from the @object with gst_mini_object_get_qdata()
|
* can be gotten back from the @object with gst_mini_object_get_qdata()
|
||||||
* until the @object is disposed.
|
* until the @object is disposed.
|
||||||
|
|
|
@ -62,7 +62,7 @@ typedef gboolean (*GstMiniObjectDisposeFunction) (GstMiniObject *obj);
|
||||||
* GstMiniObjectFreeFunction:
|
* GstMiniObjectFreeFunction:
|
||||||
* @obj: MiniObject to free
|
* @obj: MiniObject to free
|
||||||
*
|
*
|
||||||
* Virtual function prototype for methods to free ressources used by
|
* Virtual function prototype for methods to free resources used by
|
||||||
* mini-objects.
|
* mini-objects.
|
||||||
*/
|
*/
|
||||||
typedef void (*GstMiniObjectFreeFunction) (GstMiniObject *obj);
|
typedef void (*GstMiniObjectFreeFunction) (GstMiniObject *obj);
|
||||||
|
@ -114,7 +114,7 @@ typedef void (*GstMiniObjectNotify) (gpointer user_data, GstMiniObject * obj);
|
||||||
* @obj: MiniObject to unset flag in.
|
* @obj: MiniObject to unset flag in.
|
||||||
* @flag: Flag to set, must be a single bit in guint32.
|
* @flag: Flag to set, must be a single bit in guint32.
|
||||||
*
|
*
|
||||||
* This macro usets the given bits.
|
* This macro unsets the given bits.
|
||||||
*/
|
*/
|
||||||
#define GST_MINI_OBJECT_FLAG_UNSET(obj,flag) (GST_MINI_OBJECT_FLAGS (obj) &= ~(flag))
|
#define GST_MINI_OBJECT_FLAG_UNSET(obj,flag) (GST_MINI_OBJECT_FLAGS (obj) &= ~(flag))
|
||||||
|
|
||||||
|
|
|
@ -813,7 +813,7 @@ gst_object_has_ancestor (GstObject * object, GstObject * ancestor)
|
||||||
* does not do any locking of any kind. You might want to protect the
|
* does not do any locking of any kind. You might want to protect the
|
||||||
* provided list with the lock of the owner of the list. This function
|
* provided list with the lock of the owner of the list. This function
|
||||||
* will lock each #GstObject in the list to compare the name, so be
|
* will lock each #GstObject in the list to compare the name, so be
|
||||||
* carefull when passing a list with a locked object.
|
* careful when passing a list with a locked object.
|
||||||
*
|
*
|
||||||
* Returns: TRUE if a #GstObject named @name does not appear in @list,
|
* Returns: TRUE if a #GstObject named @name does not appear in @list,
|
||||||
* FALSE if it does.
|
* FALSE if it does.
|
||||||
|
|
|
@ -145,7 +145,7 @@ typedef enum
|
||||||
* @obj: a #GstObject
|
* @obj: a #GstObject
|
||||||
* @flag: Flag to set
|
* @flag: Flag to set
|
||||||
*
|
*
|
||||||
* This macro usets the given bits.
|
* This macro unsets the given bits.
|
||||||
*/
|
*/
|
||||||
#define GST_OBJECT_FLAG_UNSET(obj,flag) (GST_OBJECT_FLAGS (obj) &= ~(flag))
|
#define GST_OBJECT_FLAG_UNSET(obj,flag) (GST_OBJECT_FLAGS (obj) &= ~(flag))
|
||||||
|
|
||||||
|
|
|
@ -3813,7 +3813,7 @@ no_function:
|
||||||
* The function returns #GST_FLOW_FLUSHING if the pad was flushing.
|
* The function returns #GST_FLOW_FLUSHING if the pad was flushing.
|
||||||
*
|
*
|
||||||
* If the buffer type is not acceptable for @pad (as negotiated with a
|
* If the buffer type is not acceptable for @pad (as negotiated with a
|
||||||
* preceeding GST_EVENT_CAPS event), this function returns
|
* preceding GST_EVENT_CAPS event), this function returns
|
||||||
* #GST_FLOW_NOT_NEGOTIATED.
|
* #GST_FLOW_NOT_NEGOTIATED.
|
||||||
*
|
*
|
||||||
* The function proceeds calling the chain function installed on @pad (see
|
* The function proceeds calling the chain function installed on @pad (see
|
||||||
|
@ -4278,7 +4278,7 @@ get_range_failed:
|
||||||
* When this function returns any other result value than #GST_FLOW_OK, @buffer
|
* When this function returns any other result value than #GST_FLOW_OK, @buffer
|
||||||
* will be unchanged.
|
* will be unchanged.
|
||||||
*
|
*
|
||||||
* This is a lowlevel function. Usualy gst_pad_pull_range() is used.
|
* This is a lowlevel function. Usually gst_pad_pull_range() is used.
|
||||||
*
|
*
|
||||||
* Returns: a #GstFlowReturn from the pad.
|
* Returns: a #GstFlowReturn from the pad.
|
||||||
*
|
*
|
||||||
|
@ -4764,7 +4764,7 @@ idle_probe_stopped:
|
||||||
* mainly used by elements to send events to their peer
|
* mainly used by elements to send events to their peer
|
||||||
* elements.
|
* elements.
|
||||||
*
|
*
|
||||||
* This function takes owership of the provided event so you should
|
* This function takes ownership of the provided event so you should
|
||||||
* gst_event_ref() it if you want to reuse the event after this call.
|
* gst_event_ref() it if you want to reuse the event after this call.
|
||||||
*
|
*
|
||||||
* Returns: TRUE if the event was handled.
|
* Returns: TRUE if the event was handled.
|
||||||
|
@ -5132,7 +5132,7 @@ precheck_failed:
|
||||||
* plugin doesn't need to bother itself with this information; the core handles
|
* plugin doesn't need to bother itself with this information; the core handles
|
||||||
* all necessary locks and checks.
|
* all necessary locks and checks.
|
||||||
*
|
*
|
||||||
* This function takes owership of the provided event so you should
|
* This function takes ownership of the provided event so you should
|
||||||
* gst_event_ref() it if you want to reuse the event after this call.
|
* gst_event_ref() it if you want to reuse the event after this call.
|
||||||
*
|
*
|
||||||
* Returns: TRUE if the event was handled.
|
* Returns: TRUE if the event was handled.
|
||||||
|
|
|
@ -133,7 +133,7 @@ typedef enum {
|
||||||
* @GST_FLOW_FLUSHING: Pad is flushing.
|
* @GST_FLOW_FLUSHING: Pad is flushing.
|
||||||
* @GST_FLOW_EOS: Pad is EOS.
|
* @GST_FLOW_EOS: Pad is EOS.
|
||||||
* @GST_FLOW_NOT_NEGOTIATED: Pad is not negotiated.
|
* @GST_FLOW_NOT_NEGOTIATED: Pad is not negotiated.
|
||||||
* @GST_FLOW_ERROR: Some (fatal) error occured. Element generating
|
* @GST_FLOW_ERROR: Some (fatal) error occurred. Element generating
|
||||||
* this error should post an error message with more
|
* this error should post an error message with more
|
||||||
* details.
|
* details.
|
||||||
* @GST_FLOW_NOT_SUPPORTED: This operation is not supported.
|
* @GST_FLOW_NOT_SUPPORTED: This operation is not supported.
|
||||||
|
|
|
@ -204,7 +204,7 @@ _gst_parse_escape (const gchar * str)
|
||||||
* @error: pointer to a #GError
|
* @error: pointer to a #GError
|
||||||
*
|
*
|
||||||
* Create a new element based on command line syntax.
|
* Create a new element based on command line syntax.
|
||||||
* @error will contain an error message if an erroneuos pipeline is specified.
|
* @error will contain an error message if an erroneous pipeline is specified.
|
||||||
* An error does not mean that the pipeline could not be constructed.
|
* An error does not mean that the pipeline could not be constructed.
|
||||||
*
|
*
|
||||||
* Returns: (transfer floating): a new element on success and %NULL on failure.
|
* Returns: (transfer floating): a new element on success and %NULL on failure.
|
||||||
|
|
|
@ -37,7 +37,7 @@ GQuark gst_parse_error_quark (void);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GstParseError:
|
* GstParseError:
|
||||||
* @GST_PARSE_ERROR_SYNTAX: A syntax error occured.
|
* @GST_PARSE_ERROR_SYNTAX: A syntax error occurred.
|
||||||
* @GST_PARSE_ERROR_NO_SUCH_ELEMENT: The description contained an unknown element
|
* @GST_PARSE_ERROR_NO_SUCH_ELEMENT: The description contained an unknown element
|
||||||
* @GST_PARSE_ERROR_NO_SUCH_PROPERTY: An element did not have a specified property
|
* @GST_PARSE_ERROR_NO_SUCH_PROPERTY: An element did not have a specified property
|
||||||
* @GST_PARSE_ERROR_LINK: There was an error linking two pads.
|
* @GST_PARSE_ERROR_LINK: There was an error linking two pads.
|
||||||
|
|
|
@ -39,7 +39,7 @@
|
||||||
* Once you have a handle to a #GstPlugin (e.g. from the #GstRegistry), you
|
* Once you have a handle to a #GstPlugin (e.g. from the #GstRegistry), you
|
||||||
* can add any object that subclasses #GstPluginFeature.
|
* can add any object that subclasses #GstPluginFeature.
|
||||||
*
|
*
|
||||||
* Usually plugins are always automaticlly loaded so you don't need to call
|
* Usually plugins are always automatically loaded so you don't need to call
|
||||||
* gst_plugin_load() explicitly to bring it into memory. There are options to
|
* gst_plugin_load() explicitly to bring it into memory. There are options to
|
||||||
* statically link plugins to an app or even use GStreamer without a plugin
|
* statically link plugins to an app or even use GStreamer without a plugin
|
||||||
* repository in which case gst_plugin_load() can be needed to bring the plugin
|
* repository in which case gst_plugin_load() can be needed to bring the plugin
|
||||||
|
|
|
@ -277,7 +277,7 @@ G_END_DECLS
|
||||||
/**
|
/**
|
||||||
* GST_LICENSE_UNKNOWN:
|
* GST_LICENSE_UNKNOWN:
|
||||||
*
|
*
|
||||||
* To be used in GST_PLUGIN_DEFINE if usure about the licence.
|
* To be used in GST_PLUGIN_DEFINE if unsure about the licence.
|
||||||
*/
|
*/
|
||||||
#define GST_LICENSE_UNKNOWN "unknown"
|
#define GST_LICENSE_UNKNOWN "unknown"
|
||||||
|
|
||||||
|
|
|
@ -24,7 +24,7 @@
|
||||||
/**
|
/**
|
||||||
* SECTION:gstpoll
|
* SECTION:gstpoll
|
||||||
* @short_description: Keep track of file descriptors and make it possible
|
* @short_description: Keep track of file descriptors and make it possible
|
||||||
* to wait on them in a cancelable way
|
* to wait on them in a cancellable way
|
||||||
*
|
*
|
||||||
* A #GstPoll keeps track of file descriptors much like fd_set (used with
|
* A #GstPoll keeps track of file descriptors much like fd_set (used with
|
||||||
* select()) or a struct pollfd array (used with poll()). Once created with
|
* select()) or a struct pollfd array (used with poll()). Once created with
|
||||||
|
|
|
@ -940,7 +940,7 @@ no_presets:
|
||||||
* Get a copy of preset names as a NULL terminated string array.
|
* Get a copy of preset names as a NULL terminated string array.
|
||||||
*
|
*
|
||||||
* Returns: (transfer full) (array zero-terminated=1) (element-type gchar*):
|
* Returns: (transfer full) (array zero-terminated=1) (element-type gchar*):
|
||||||
* list with names, ue g_strfreev() after usage.
|
* list with names, use g_strfreev() after usage.
|
||||||
*/
|
*/
|
||||||
gchar **
|
gchar **
|
||||||
gst_preset_get_preset_names (GstPreset * preset)
|
gst_preset_get_preset_names (GstPreset * preset)
|
||||||
|
|
|
@ -727,7 +727,7 @@ gst_query_get_structure (GstQuery * query)
|
||||||
* @query: a #GstQuery
|
* @query: a #GstQuery
|
||||||
*
|
*
|
||||||
* Get the structure of a query. This method should be called with a writable
|
* Get the structure of a query. This method should be called with a writable
|
||||||
* @query so that the returned structure is guranteed to be writable.
|
* @query so that the returned structure is guaranteed to be writable.
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): the #GstStructure of the query. The structure is
|
* Returns: (transfer none): the #GstStructure of the query. The structure is
|
||||||
* still owned by the query and will therefore be freed when the query
|
* still owned by the query and will therefore be freed when the query
|
||||||
|
@ -1136,7 +1136,7 @@ gst_query_set_buffering_stats (GstQuery * query, GstBufferingMode mode,
|
||||||
* @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
|
* @query: A valid #GstQuery of type GST_QUERY_BUFFERING.
|
||||||
* @mode: (out) (allow-none): a buffering mode, or NULL
|
* @mode: (out) (allow-none): a buffering mode, or NULL
|
||||||
* @avg_in: (out) (allow-none): the average input rate, or NULL
|
* @avg_in: (out) (allow-none): the average input rate, or NULL
|
||||||
* @avg_out: (out) (allow-none): the average output rat, or NULLe
|
* @avg_out: (out) (allow-none): the average output rat, or NULL
|
||||||
* @buffering_left: (out) (allow-none): amount of buffering time left in
|
* @buffering_left: (out) (allow-none): amount of buffering time left in
|
||||||
* milliseconds, or NULL
|
* milliseconds, or NULL
|
||||||
*
|
*
|
||||||
|
@ -1175,7 +1175,7 @@ gst_query_parse_buffering_stats (GstQuery * query,
|
||||||
* @start: the start to set
|
* @start: the start to set
|
||||||
* @stop: the stop to set
|
* @stop: the stop to set
|
||||||
* @estimated_total: estimated total amount of download time remaining in
|
* @estimated_total: estimated total amount of download time remaining in
|
||||||
* miliseconds
|
* milliseconds
|
||||||
*
|
*
|
||||||
* Set the available query result fields in @query.
|
* Set the available query result fields in @query.
|
||||||
*/
|
*/
|
||||||
|
@ -1204,7 +1204,7 @@ gst_query_set_buffering_range (GstQuery * query, GstFormat format,
|
||||||
* @start: (out) (allow-none): the start to set, or NULL
|
* @start: (out) (allow-none): the start to set, or NULL
|
||||||
* @stop: (out) (allow-none): the stop to set, or NULL
|
* @stop: (out) (allow-none): the stop to set, or NULL
|
||||||
* @estimated_total: (out) (allow-none): estimated total amount of download
|
* @estimated_total: (out) (allow-none): estimated total amount of download
|
||||||
* time remaining in miliseconds, or NULL
|
* time remaining in milliseconds, or NULL
|
||||||
*
|
*
|
||||||
* Parse an available query, writing the format into @format, and
|
* Parse an available query, writing the format into @format, and
|
||||||
* other results into the passed parameters, if the respective parameters
|
* other results into the passed parameters, if the respective parameters
|
||||||
|
@ -1954,7 +1954,7 @@ gst_query_get_n_allocation_params (GstQuery * query)
|
||||||
* @allocator: (out) (transfer full) (allow-none): variable to hold the result
|
* @allocator: (out) (transfer full) (allow-none): variable to hold the result
|
||||||
* @params: (out) (allow-none): parameters for the allocator
|
* @params: (out) (allow-none): parameters for the allocator
|
||||||
*
|
*
|
||||||
* Parse an available query and get the alloctor and its params
|
* Parse an available query and get the allocator and its params
|
||||||
* at @index of the allocator array.
|
* at @index of the allocator array.
|
||||||
*/
|
*/
|
||||||
void
|
void
|
||||||
|
@ -1988,7 +1988,7 @@ gst_query_parse_nth_allocation_param (GstQuery * query, guint index,
|
||||||
* @allocator: (transfer none) (allow-none): new allocator to set
|
* @allocator: (transfer none) (allow-none): new allocator to set
|
||||||
* @params: (transfer none) (allow-none): parameters for the allocator
|
* @params: (transfer none) (allow-none): parameters for the allocator
|
||||||
*
|
*
|
||||||
* Parse an available query and get the alloctor and its params
|
* Parse an available query and get the allocator and its params
|
||||||
* at @index of the allocator array.
|
* at @index of the allocator array.
|
||||||
*/
|
*/
|
||||||
void
|
void
|
||||||
|
@ -2129,7 +2129,7 @@ gst_query_parse_scheduling (GstQuery * query, GstSchedulingFlags * flags,
|
||||||
* @query: a GST_QUERY_SCHEDULING type query #GstQuery
|
* @query: a GST_QUERY_SCHEDULING type query #GstQuery
|
||||||
* @mode: a #GstPadMode
|
* @mode: a #GstPadMode
|
||||||
*
|
*
|
||||||
* Add @mode as aone of the supported scheduling modes to @query.
|
* Add @mode as one of the supported scheduling modes to @query.
|
||||||
*/
|
*/
|
||||||
void
|
void
|
||||||
gst_query_add_scheduling_mode (GstQuery * query, GstPadMode mode)
|
gst_query_add_scheduling_mode (GstQuery * query, GstPadMode mode)
|
||||||
|
|
|
@ -1807,7 +1807,7 @@ gst_update_registry (void)
|
||||||
* gst_registry_get_feature_list_cookie:
|
* gst_registry_get_feature_list_cookie:
|
||||||
* @registry: the registry
|
* @registry: the registry
|
||||||
*
|
*
|
||||||
* Returns the registrys feature list cookie. This changes
|
* Returns the registry's feature list cookie. This changes
|
||||||
* every time a feature is added or removed from the registry.
|
* every time a feature is added or removed from the registry.
|
||||||
*
|
*
|
||||||
* Returns: the feature list cookie.
|
* Returns: the feature list cookie.
|
||||||
|
|
|
@ -460,7 +460,7 @@ gst_segment_to_stream_time (const GstSegment * segment, GstFormat format,
|
||||||
* segment. Position is a value between @segment start and stop time.
|
* segment. Position is a value between @segment start and stop time.
|
||||||
*
|
*
|
||||||
* This function is typically used by elements that need to synchronize to the
|
* This function is typically used by elements that need to synchronize to the
|
||||||
* global clock in a pipeline. The runnning time is a constantly increasing value
|
* global clock in a pipeline. The running time is a constantly increasing value
|
||||||
* starting from 0. When gst_segment_init() is called, this value will reset to
|
* starting from 0. When gst_segment_init() is called, this value will reset to
|
||||||
* 0.
|
* 0.
|
||||||
*
|
*
|
||||||
|
|
|
@ -56,7 +56,7 @@ typedef enum {
|
||||||
* @GST_SEEK_FLAG_KEY_UNIT: seek to the nearest keyframe. This might be
|
* @GST_SEEK_FLAG_KEY_UNIT: seek to the nearest keyframe. This might be
|
||||||
* faster but less accurate.
|
* faster but less accurate.
|
||||||
* @GST_SEEK_FLAG_SEGMENT: perform a segment seek.
|
* @GST_SEEK_FLAG_SEGMENT: perform a segment seek.
|
||||||
* @GST_SEEK_FLAG_SKIP: when doing fast foward or fast reverse playback, allow
|
* @GST_SEEK_FLAG_SKIP: when doing fast forward or fast reverse playback, allow
|
||||||
* elements to skip frames instead of generating all
|
* elements to skip frames instead of generating all
|
||||||
* frames.
|
* frames.
|
||||||
* @GST_SEEK_FLAG_SNAP_BEFORE: go to a location before the requested position,
|
* @GST_SEEK_FLAG_SNAP_BEFORE: go to a location before the requested position,
|
||||||
|
@ -81,7 +81,7 @@ typedef enum {
|
||||||
* complete scan of the file in those cases.
|
* complete scan of the file in those cases.
|
||||||
*
|
*
|
||||||
* When performing a segment seek: after the playback of the segment completes,
|
* When performing a segment seek: after the playback of the segment completes,
|
||||||
* no EOS will be emmited by the element that performed the seek, but a
|
* no EOS will be emitted by the element that performed the seek, but a
|
||||||
* #GST_MESSAGE_SEGMENT_DONE message will be posted on the bus by the element.
|
* #GST_MESSAGE_SEGMENT_DONE message will be posted on the bus by the element.
|
||||||
* When this message is posted, it is possible to send a new seek event to
|
* When this message is posted, it is possible to send a new seek event to
|
||||||
* continue playback. With this seek method it is possible to perform seamless
|
* continue playback. With this seek method it is possible to perform seamless
|
||||||
|
|
|
@ -1821,7 +1821,7 @@ priv_gst_structure_append_to_gstring (const GstStructure * structure,
|
||||||
* |[
|
* |[
|
||||||
* GST_LOG ("structure is %" GST_PTR_FORMAT, structure);
|
* GST_LOG ("structure is %" GST_PTR_FORMAT, structure);
|
||||||
* ]|
|
* ]|
|
||||||
* This prints the structure in human readble form.
|
* This prints the structure in human readable form.
|
||||||
*
|
*
|
||||||
* The current implementation of serialization will lead to unexpected results
|
* The current implementation of serialization will lead to unexpected results
|
||||||
* when there are nested #GstCaps / #GstStructure deeper than one level.
|
* when there are nested #GstCaps / #GstStructure deeper than one level.
|
||||||
|
@ -3115,7 +3115,7 @@ gst_structure_intersect_field2 (GQuark id, const GValue * val1, gpointer data)
|
||||||
* @struct1: a #GstStructure
|
* @struct1: a #GstStructure
|
||||||
* @struct2: a #GstStructure
|
* @struct2: a #GstStructure
|
||||||
*
|
*
|
||||||
* Interesects @struct1 and @struct2 and returns the intersection.
|
* Intersects @struct1 and @struct2 and returns the intersection.
|
||||||
*
|
*
|
||||||
* Returns: Intersection of @struct1 and @struct2
|
* Returns: Intersection of @struct1 and @struct2
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -471,7 +471,7 @@ gst_tag_lookup (const gchar * tag_name)
|
||||||
*
|
*
|
||||||
* Important: if you do not supply a merge function the implication will be
|
* Important: if you do not supply a merge function the implication will be
|
||||||
* that there can only be one single value for this tag in a tag list and
|
* that there can only be one single value for this tag in a tag list and
|
||||||
* any additional values will silenty be discarded when being added (unless
|
* any additional values will silently be discarded when being added (unless
|
||||||
* #GST_TAG_MERGE_REPLACE, #GST_TAG_MERGE_REPLACE_ALL, or
|
* #GST_TAG_MERGE_REPLACE, #GST_TAG_MERGE_REPLACE_ALL, or
|
||||||
* #GST_TAG_MERGE_PREPEND is used as merge mode, in which case the new
|
* #GST_TAG_MERGE_PREPEND is used as merge mode, in which case the new
|
||||||
* value will replace the old one in the list).
|
* value will replace the old one in the list).
|
||||||
|
@ -1905,7 +1905,7 @@ gst_tag_list_get_date_index (const GstTagList * list,
|
||||||
* Free-function: gst_date_time_unref
|
* Free-function: gst_date_time_unref
|
||||||
*
|
*
|
||||||
* Returns: TRUE, if a datetime was copied, FALSE if the tag didn't exist in
|
* Returns: TRUE, if a datetime was copied, FALSE if the tag didn't exist in
|
||||||
* thegiven list or if it was #NULL.
|
* the given list or if it was #NULL.
|
||||||
*/
|
*/
|
||||||
gboolean
|
gboolean
|
||||||
gst_tag_list_get_date_time (const GstTagList * list, const gchar * tag,
|
gst_tag_list_get_date_time (const GstTagList * list, const gchar * tag,
|
||||||
|
@ -2003,7 +2003,7 @@ gst_tag_list_get_sample (const GstTagList * list, const gchar * tag,
|
||||||
* pointer variable to store the result into
|
* pointer variable to store the result into
|
||||||
*
|
*
|
||||||
* Gets the sample that is at the given index for the given tag in the given
|
* Gets the sample that is at the given index for the given tag in the given
|
||||||
* list and copies it into the variable pointed to by @smple. Free the sample
|
* list and copies it into the variable pointed to by @sample. Free the sample
|
||||||
* with gst_sample_unref() when it is no longer needed. You can retrieve the
|
* with gst_sample_unref() when it is no longer needed. You can retrieve the
|
||||||
* buffer from the sample using gst_sample_get_buffer() and the associated
|
* buffer from the sample using gst_sample_get_buffer() and the associated
|
||||||
* caps (if any) with gst_sample_get_caps().
|
* caps (if any) with gst_sample_get_caps().
|
||||||
|
|
|
@ -155,8 +155,8 @@ gst_toc_setter_get_toc (GstTocSetter * setter)
|
||||||
* @setter: a #GstTocSetter.
|
* @setter: a #GstTocSetter.
|
||||||
* @toc: (allow-none): a #GstToc to set.
|
* @toc: (allow-none): a #GstToc to set.
|
||||||
*
|
*
|
||||||
* Set the given TOC on the setter. Previously setted TOC will be
|
* Set the given TOC on the setter. Previously set TOC will be
|
||||||
* unrefed before setting a new one.
|
* unreffed before setting a new one.
|
||||||
*/
|
*/
|
||||||
void
|
void
|
||||||
gst_toc_setter_set_toc (GstTocSetter * setter, GstToc * toc)
|
gst_toc_setter_set_toc (GstTocSetter * setter, GstToc * toc)
|
||||||
|
|
|
@ -36,7 +36,7 @@ typedef struct _GstTypeFind GstTypeFind;
|
||||||
/**
|
/**
|
||||||
* GstTypeFindFunction:
|
* GstTypeFindFunction:
|
||||||
* @find: A #GstTypeFind structure
|
* @find: A #GstTypeFind structure
|
||||||
* @user_data: optionnal data to pass to the function
|
* @user_data: optional data to pass to the function
|
||||||
*
|
*
|
||||||
* A function that will be called by typefinding.
|
* A function that will be called by typefinding.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -117,7 +117,7 @@ gst_util_set_value_from_string (GValue * value, const gchar * value_str)
|
||||||
* @name: the name of the argument to set
|
* @name: the name of the argument to set
|
||||||
* @value: the string value to set
|
* @value: the string value to set
|
||||||
*
|
*
|
||||||
* Convertes the string value to the type of the objects argument and
|
* Converts the string value to the type of the objects argument and
|
||||||
* sets the argument with it.
|
* sets the argument with it.
|
||||||
*
|
*
|
||||||
* Note that this function silently returns if @object has no property named
|
* Note that this function silently returns if @object has no property named
|
||||||
|
@ -2441,7 +2441,7 @@ query_accept_caps_func (GstPad * pad, QueryAcceptCapsData * data)
|
||||||
*
|
*
|
||||||
* This function is useful as a default accept caps query function for an element
|
* This function is useful as a default accept caps query function for an element
|
||||||
* that can handle any stream format, but requires caps that are acceptable for
|
* that can handle any stream format, but requires caps that are acceptable for
|
||||||
* all oposite pads.
|
* all opposite pads.
|
||||||
*
|
*
|
||||||
* Returns: TRUE if @query could be executed
|
* Returns: TRUE if @query could be executed
|
||||||
*/
|
*/
|
||||||
|
@ -2500,7 +2500,7 @@ query_caps_func (GstPad * pad, QueryCapsData * data)
|
||||||
* @pad: a #GstPad to proxy.
|
* @pad: a #GstPad to proxy.
|
||||||
* @query: a CAPS #GstQuery.
|
* @query: a CAPS #GstQuery.
|
||||||
*
|
*
|
||||||
* Calls gst_pad_query_caps() for all internally linked pads fof @pad and returns
|
* Calls gst_pad_query_caps() for all internally linked pads of @pad and returns
|
||||||
* the intersection of the results.
|
* the intersection of the results.
|
||||||
*
|
*
|
||||||
* This function is useful as a default caps query function for an element
|
* This function is useful as a default caps query function for an element
|
||||||
|
@ -2740,7 +2740,7 @@ gst_pad_peer_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
|
||||||
* When called on sinkpads @filter contains the caps that
|
* When called on sinkpads @filter contains the caps that
|
||||||
* upstream could produce in the order preferred by upstream. When
|
* upstream could produce in the order preferred by upstream. When
|
||||||
* called on srcpads @filter contains the caps accepted by
|
* called on srcpads @filter contains the caps accepted by
|
||||||
* downstream in the preffered order. @filter might be %NULL but
|
* downstream in the preferred order. @filter might be %NULL but
|
||||||
* if it is not %NULL the returned caps will be a subset of @filter.
|
* if it is not %NULL the returned caps will be a subset of @filter.
|
||||||
*
|
*
|
||||||
* Note that this function does not return writable #GstCaps, use
|
* Note that this function does not return writable #GstCaps, use
|
||||||
|
@ -2787,7 +2787,7 @@ gst_pad_query_caps (GstPad * pad, GstCaps * filter)
|
||||||
* When called on srcpads @filter contains the caps that
|
* When called on srcpads @filter contains the caps that
|
||||||
* upstream could produce in the order preferred by upstream. When
|
* upstream could produce in the order preferred by upstream. When
|
||||||
* called on sinkpads @filter contains the caps accepted by
|
* called on sinkpads @filter contains the caps accepted by
|
||||||
* downstream in the preffered order. @filter might be %NULL but
|
* downstream in the preferred order. @filter might be %NULL but
|
||||||
* if it is not %NULL the returned caps will be a subset of @filter.
|
* if it is not %NULL the returned caps will be a subset of @filter.
|
||||||
*
|
*
|
||||||
* Returns: the caps of the peer pad with incremented ref-count. When there is
|
* Returns: the caps of the peer pad with incremented ref-count. When there is
|
||||||
|
@ -3765,7 +3765,7 @@ gst_pad_create_stream_id (GstPad * pad, GstElement * parent,
|
||||||
* The returned stream-id string should be treated as an opaque string, its
|
* The returned stream-id string should be treated as an opaque string, its
|
||||||
* contents should not be interpreted.
|
* contents should not be interpreted.
|
||||||
*
|
*
|
||||||
* Returns: a newly-allocated copy of the stream-idfor @pad, or %NULL.
|
* Returns: a newly-allocated copy of the stream-id for @pad, or %NULL.
|
||||||
* g_free() the returned string when no longer needed.
|
* g_free() the returned string when no longer needed.
|
||||||
*
|
*
|
||||||
* Since: 1.2
|
* Since: 1.2
|
||||||
|
|
|
@ -1052,7 +1052,7 @@ gst_value_get_int_range_min (const GValue * value)
|
||||||
*
|
*
|
||||||
* Gets the maximum of the range specified by @value.
|
* Gets the maximum of the range specified by @value.
|
||||||
*
|
*
|
||||||
* Returns: the maxumum of the range
|
* Returns: the maximum of the range
|
||||||
*/
|
*/
|
||||||
gint
|
gint
|
||||||
gst_value_get_int_range_max (const GValue * value)
|
gst_value_get_int_range_max (const GValue * value)
|
||||||
|
@ -1304,7 +1304,7 @@ gst_value_get_int64_range_min (const GValue * value)
|
||||||
*
|
*
|
||||||
* Gets the maximum of the range specified by @value.
|
* Gets the maximum of the range specified by @value.
|
||||||
*
|
*
|
||||||
* Returns: the maxumum of the range
|
* Returns: the maximum of the range
|
||||||
*/
|
*/
|
||||||
gint64
|
gint64
|
||||||
gst_value_get_int64_range_max (const GValue * value)
|
gst_value_get_int64_range_max (const GValue * value)
|
||||||
|
@ -1495,7 +1495,7 @@ gst_value_get_double_range_min (const GValue * value)
|
||||||
*
|
*
|
||||||
* Gets the maximum of the range specified by @value.
|
* Gets the maximum of the range specified by @value.
|
||||||
*
|
*
|
||||||
* Returns: the maxumum of the range
|
* Returns: the maximum of the range
|
||||||
*/
|
*/
|
||||||
gdouble
|
gdouble
|
||||||
gst_value_get_double_range_max (const GValue * value)
|
gst_value_get_double_range_max (const GValue * value)
|
||||||
|
@ -4600,7 +4600,7 @@ gst_value_can_union (const GValue * value1, const GValue * value2)
|
||||||
*
|
*
|
||||||
* Creates a GValue corresponding to the union of @value1 and @value2.
|
* Creates a GValue corresponding to the union of @value1 and @value2.
|
||||||
*
|
*
|
||||||
* Returns: TRUE if the union suceeded.
|
* Returns: TRUE if the union succeeded.
|
||||||
*/
|
*/
|
||||||
gboolean
|
gboolean
|
||||||
gst_value_union (GValue * dest, const GValue * value1, const GValue * value2)
|
gst_value_union (GValue * dest, const GValue * value1, const GValue * value2)
|
||||||
|
|
|
@ -219,7 +219,7 @@ G_BEGIN_DECLS
|
||||||
/**
|
/**
|
||||||
* GST_TYPE_DOUBLE_RANGE:
|
* GST_TYPE_DOUBLE_RANGE:
|
||||||
*
|
*
|
||||||
* a #GValue type that represents a floating point range with double precission
|
* a #GValue type that represents a floating point range with double precision
|
||||||
*
|
*
|
||||||
* Returns: the #GType of GstIntRange
|
* Returns: the #GType of GstIntRange
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -184,7 +184,7 @@
|
||||||
* buffer time metadata (which will be taken from upstream as much as
|
* buffer time metadata (which will be taken from upstream as much as
|
||||||
* possible). Internally keeping track of frame durations and respective
|
* possible). Internally keeping track of frame durations and respective
|
||||||
* sizes that have been pushed provides GstBaseParse with an estimated
|
* sizes that have been pushed provides GstBaseParse with an estimated
|
||||||
* bitrate. A default @convert (used if not overriden) will then use these
|
* bitrate. A default @convert (used if not overridden) will then use these
|
||||||
* rates to perform obvious conversions. These rates are also used to
|
* rates to perform obvious conversions. These rates are also used to
|
||||||
* update (estimated) duration at regular frame intervals.
|
* update (estimated) duration at regular frame intervals.
|
||||||
* </para></listitem>
|
* </para></listitem>
|
||||||
|
@ -3563,7 +3563,7 @@ gst_base_parse_set_pts_interpolation (GstBaseParse * parse,
|
||||||
* By default, the base class might try to infer PTS from DTS and vice
|
* By default, the base class might try to infer PTS from DTS and vice
|
||||||
* versa. While this is generally correct for audio data, it may not
|
* versa. While this is generally correct for audio data, it may not
|
||||||
* be otherwise. Sub-classes implementing such formats should disable
|
* be otherwise. Sub-classes implementing such formats should disable
|
||||||
* timestamp infering.
|
* timestamp inferring.
|
||||||
*/
|
*/
|
||||||
void
|
void
|
||||||
gst_base_parse_set_infer_ts (GstBaseParse * parse, gboolean infer_ts)
|
gst_base_parse_set_infer_ts (GstBaseParse * parse, gboolean infer_ts)
|
||||||
|
|
|
@ -94,7 +94,7 @@ G_BEGIN_DECLS
|
||||||
* that regular segment clipping can still be performed (as opposed to
|
* that regular segment clipping can still be performed (as opposed to
|
||||||
* any custom one having been done).
|
* any custom one having been done).
|
||||||
* @GST_BASE_PARSE_FRAME_FLAG_DROP: indicates to @finish_frame that the
|
* @GST_BASE_PARSE_FRAME_FLAG_DROP: indicates to @finish_frame that the
|
||||||
* the frame should be dropped (and might be handled internall by subclass)
|
* the frame should be dropped (and might be handled internally by subclass)
|
||||||
* @GST_BASE_PARSE_FRAME_FLAG_QUEUE: indicates to @finish_frame that the
|
* @GST_BASE_PARSE_FRAME_FLAG_QUEUE: indicates to @finish_frame that the
|
||||||
* the frame should be queued for now and processed fully later
|
* the frame should be queued for now and processed fully later
|
||||||
* when the first non-queued frame is finished
|
* when the first non-queued frame is finished
|
||||||
|
|
|
@ -105,7 +105,7 @@
|
||||||
* #GstBaseSinkClass.start() and #GstBaseSinkClass.stop() calls.
|
* #GstBaseSinkClass.start() and #GstBaseSinkClass.stop() calls.
|
||||||
*
|
*
|
||||||
* The #GstBaseSinkClass.event() virtual method will be called when an event is
|
* The #GstBaseSinkClass.event() virtual method will be called when an event is
|
||||||
* received by #GstBaseSink. Normally this method should only be overriden by
|
* received by #GstBaseSink. Normally this method should only be overridden by
|
||||||
* very specific elements (such as file sinks) which need to handle the
|
* very specific elements (such as file sinks) which need to handle the
|
||||||
* newsegment event specially.
|
* newsegment event specially.
|
||||||
*
|
*
|
||||||
|
@ -483,7 +483,7 @@ gst_base_sink_class_init (GstBaseSinkClass * klass)
|
||||||
*
|
*
|
||||||
* The last buffer that arrived in the sink and was used for preroll or for
|
* The last buffer that arrived in the sink and was used for preroll or for
|
||||||
* rendering. This property can be used to generate thumbnails. This property
|
* rendering. This property can be used to generate thumbnails. This property
|
||||||
* can be NULL when the sink has not yet received a bufer.
|
* can be NULL when the sink has not yet received a buffer.
|
||||||
*/
|
*/
|
||||||
g_object_class_install_property (gobject_class, PROP_LAST_SAMPLE,
|
g_object_class_install_property (gobject_class, PROP_LAST_SAMPLE,
|
||||||
g_param_spec_boxed ("last-sample", "Last Sample",
|
g_param_spec_boxed ("last-sample", "Last Sample",
|
||||||
|
@ -691,7 +691,7 @@ gst_base_sink_finalize (GObject * object)
|
||||||
*
|
*
|
||||||
* Configures @sink to synchronize on the clock or not. When
|
* Configures @sink to synchronize on the clock or not. When
|
||||||
* @sync is FALSE, incoming samples will be played as fast as
|
* @sync is FALSE, incoming samples will be played as fast as
|
||||||
* possible. If @sync is TRUE, the timestamps of the incomming
|
* possible. If @sync is TRUE, the timestamps of the incoming
|
||||||
* buffers will be used to schedule the exact render time of its
|
* buffers will be used to schedule the exact render time of its
|
||||||
* contents.
|
* contents.
|
||||||
*/
|
*/
|
||||||
|
@ -814,7 +814,7 @@ gst_base_sink_is_qos_enabled (GstBaseSink * sink)
|
||||||
* @sink: the sink
|
* @sink: the sink
|
||||||
* @enabled: the new async value.
|
* @enabled: the new async value.
|
||||||
*
|
*
|
||||||
* Configures @sink to perform all state changes asynchronusly. When async is
|
* Configures @sink to perform all state changes asynchronously. When async is
|
||||||
* disabled, the sink will immediately go to PAUSED instead of waiting for a
|
* disabled, the sink will immediately go to PAUSED instead of waiting for a
|
||||||
* preroll buffer. This feature is useful if the sink does not synchronize
|
* preroll buffer. This feature is useful if the sink does not synchronize
|
||||||
* against the clock or when it is dealing with sparse streams.
|
* against the clock or when it is dealing with sparse streams.
|
||||||
|
@ -1041,7 +1041,7 @@ gst_base_sink_get_latency (GstBaseSink * sink)
|
||||||
*
|
*
|
||||||
* If both @live and @upstream_live are TRUE, the sink will want to compensate
|
* If both @live and @upstream_live are TRUE, the sink will want to compensate
|
||||||
* for the latency introduced by the upstream elements by setting the
|
* for the latency introduced by the upstream elements by setting the
|
||||||
* @min_latency to a strictly possitive value.
|
* @min_latency to a strictly positive value.
|
||||||
*
|
*
|
||||||
* This function is mostly used by subclasses.
|
* This function is mostly used by subclasses.
|
||||||
*
|
*
|
||||||
|
@ -2031,7 +2031,7 @@ gst_base_sink_adjust_time (GstBaseSink * basesink, GstClockTime time)
|
||||||
* This function will block until @time is reached. It is usually called by
|
* This function will block until @time is reached. It is usually called by
|
||||||
* subclasses that use their own internal synchronisation.
|
* subclasses that use their own internal synchronisation.
|
||||||
*
|
*
|
||||||
* If @time is not valid, no sycnhronisation is done and #GST_CLOCK_BADTIME is
|
* If @time is not valid, no synchronisation is done and #GST_CLOCK_BADTIME is
|
||||||
* returned. Likewise, if synchronisation is disabled in the element or there
|
* returned. Likewise, if synchronisation is disabled in the element or there
|
||||||
* is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
|
* is no clock, no synchronisation is done and #GST_CLOCK_BADTIME is returned.
|
||||||
*
|
*
|
||||||
|
|
|
@ -137,7 +137,7 @@ struct _GstBaseSink {
|
||||||
* @preroll: Called to present the preroll buffer if desired.
|
* @preroll: Called to present the preroll buffer if desired.
|
||||||
* @render: Called when a buffer should be presented or output, at the
|
* @render: Called when a buffer should be presented or output, at the
|
||||||
* correct moment if the #GstBaseSink has been set to sync to the clock.
|
* correct moment if the #GstBaseSink has been set to sync to the clock.
|
||||||
* @render_list: Same as @render but used whith buffer lists instead of
|
* @render_list: Same as @render but used with buffer lists instead of
|
||||||
* buffers.
|
* buffers.
|
||||||
*
|
*
|
||||||
* Subclasses can override any of the available virtual methods or not, as
|
* Subclasses can override any of the available virtual methods or not, as
|
||||||
|
|
|
@ -795,7 +795,7 @@ gst_base_src_get_do_timestamp (GstBaseSrc * src)
|
||||||
* @src: The source
|
* @src: The source
|
||||||
* @start: The new start value for the segment
|
* @start: The new start value for the segment
|
||||||
* @stop: Stop value for the new segment
|
* @stop: Stop value for the new segment
|
||||||
* @time: The new time value for the start of the new segent
|
* @time: The new time value for the start of the new segment
|
||||||
*
|
*
|
||||||
* Prepare a new seamless segment for emission downstream. This function must
|
* Prepare a new seamless segment for emission downstream. This function must
|
||||||
* only be called by derived sub-classes, and only from the create() function,
|
* only be called by derived sub-classes, and only from the create() function,
|
||||||
|
|
|
@ -2642,7 +2642,7 @@ gst_base_transform_set_gap_aware (GstBaseTransform * trans, gboolean gap_aware)
|
||||||
* transform_caps vmethod.
|
* transform_caps vmethod.
|
||||||
*
|
*
|
||||||
* If set to %FALSE, the element must order the caps returned from the
|
* If set to %FALSE, the element must order the caps returned from the
|
||||||
* transform_caps function in such a way that the prefered format is
|
* transform_caps function in such a way that the preferred format is
|
||||||
* first in the list. This can be interesting for transforms that can do
|
* first in the list. This can be interesting for transforms that can do
|
||||||
* passthrough transforms but prefer to do something else, like a
|
* passthrough transforms but prefer to do something else, like a
|
||||||
* capsfilter.
|
* capsfilter.
|
||||||
|
|
|
@ -129,7 +129,7 @@ struct _GstBaseTransform {
|
||||||
* downstream allocation query. This function is only called
|
* downstream allocation query. This function is only called
|
||||||
* when not operating in passthrough mode. The default
|
* when not operating in passthrough mode. The default
|
||||||
* implementation will remove all memory dependent metadata.
|
* implementation will remove all memory dependent metadata.
|
||||||
* If there is ia @filter_meta method implementation, it will
|
* If there is a @filter_meta method implementation, it will
|
||||||
* be called for all metadata API in the downstream query,
|
* be called for all metadata API in the downstream query,
|
||||||
* otherwise the metadata API is removed.
|
* otherwise the metadata API is removed.
|
||||||
* @filter_meta: Return TRUE if the metadata API should be proposed in the
|
* @filter_meta: Return TRUE if the metadata API should be proposed in the
|
||||||
|
|
|
@ -986,7 +986,7 @@ GST_BYTE_READER_SKIP_STRING (32);
|
||||||
* gst_byte_reader_peek_string:
|
* gst_byte_reader_peek_string:
|
||||||
* @reader: a #GstByteReader instance
|
* @reader: a #GstByteReader instance
|
||||||
* @str: (out) (transfer none) (array zero-terminated=1): address of a
|
* @str: (out) (transfer none) (array zero-terminated=1): address of a
|
||||||
* #gchar pointer varieble in which to store the result
|
* #gchar pointer variable in which to store the result
|
||||||
*
|
*
|
||||||
* Returns a constant pointer to the current data position if there is
|
* Returns a constant pointer to the current data position if there is
|
||||||
* a NUL-terminated string in the data (this could be just a NUL terminator).
|
* a NUL-terminated string in the data (this could be just a NUL terminator).
|
||||||
|
@ -1002,7 +1002,7 @@ GST_BYTE_READER_SKIP_STRING (32);
|
||||||
* gst_byte_reader_peek_string_utf8:
|
* gst_byte_reader_peek_string_utf8:
|
||||||
* @reader: a #GstByteReader instance
|
* @reader: a #GstByteReader instance
|
||||||
* @str: (out) (transfer none) (array zero-terminated=1): address of a
|
* @str: (out) (transfer none) (array zero-terminated=1): address of a
|
||||||
* #gchar pointer varieble in which to store the result
|
* #gchar pointer variable in which to store the result
|
||||||
*
|
*
|
||||||
* Returns a constant pointer to the current data position if there is
|
* Returns a constant pointer to the current data position if there is
|
||||||
* a NUL-terminated string in the data (this could be just a NUL terminator).
|
* a NUL-terminated string in the data (this could be just a NUL terminator).
|
||||||
|
@ -1035,7 +1035,7 @@ gst_byte_reader_peek_string_utf8 (const GstByteReader * reader,
|
||||||
* gst_byte_reader_get_string_utf8:
|
* gst_byte_reader_get_string_utf8:
|
||||||
* @reader: a #GstByteReader instance
|
* @reader: a #GstByteReader instance
|
||||||
* @str: (out) (transfer none) (array zero-terminated=1): address of a
|
* @str: (out) (transfer none) (array zero-terminated=1): address of a
|
||||||
* #gchar pointer varieble in which to store the result
|
* #gchar pointer variable in which to store the result
|
||||||
*
|
*
|
||||||
* Returns a constant pointer to the current data position if there is
|
* Returns a constant pointer to the current data position if there is
|
||||||
* a NUL-terminated string in the data (this could be just a NUL terminator),
|
* a NUL-terminated string in the data (this could be just a NUL terminator),
|
||||||
|
@ -1091,7 +1091,7 @@ gst_byte_reader_dup_string_utf##bits (GstByteReader * reader, type ** str) \
|
||||||
* gst_byte_reader_dup_string_utf8:
|
* gst_byte_reader_dup_string_utf8:
|
||||||
* @reader: a #GstByteReader instance
|
* @reader: a #GstByteReader instance
|
||||||
* @str: (out) (transfer full) (array zero-terminated=1): address of a
|
* @str: (out) (transfer full) (array zero-terminated=1): address of a
|
||||||
* #gchar pointer varieble in which to store the result
|
* #gchar pointer variable in which to store the result
|
||||||
*
|
*
|
||||||
* Free-function: g_free
|
* Free-function: g_free
|
||||||
*
|
*
|
||||||
|
@ -1111,7 +1111,7 @@ GST_BYTE_READER_DUP_STRING (8, gchar);
|
||||||
* gst_byte_reader_dup_string_utf16:
|
* gst_byte_reader_dup_string_utf16:
|
||||||
* @reader: a #GstByteReader instance
|
* @reader: a #GstByteReader instance
|
||||||
* @str: (out) (transfer full) (array zero-terminated=1): address of a
|
* @str: (out) (transfer full) (array zero-terminated=1): address of a
|
||||||
* #guint16 pointer varieble in which to store the result
|
* #guint16 pointer variable in which to store the result
|
||||||
*
|
*
|
||||||
* Free-function: g_free
|
* Free-function: g_free
|
||||||
*
|
*
|
||||||
|
@ -1137,7 +1137,7 @@ GST_BYTE_READER_DUP_STRING (16, guint16);
|
||||||
* gst_byte_reader_dup_string_utf32:
|
* gst_byte_reader_dup_string_utf32:
|
||||||
* @reader: a #GstByteReader instance
|
* @reader: a #GstByteReader instance
|
||||||
* @str: (out) (transfer full) (array zero-terminated=1): address of a
|
* @str: (out) (transfer full) (array zero-terminated=1): address of a
|
||||||
* #guint32 pointer varieble in which to store the result
|
* #guint32 pointer variable in which to store the result
|
||||||
*
|
*
|
||||||
* Free-function: g_free
|
* Free-function: g_free
|
||||||
*
|
*
|
||||||
|
|
|
@ -258,8 +258,9 @@ void gst_byte_writer_put_data_unchecked (GstByteWriter *writer, const guint8 *da
|
||||||
/**
|
/**
|
||||||
* gst_byte_writer_fill_unchecked:
|
* gst_byte_writer_fill_unchecked:
|
||||||
* @writer: #GstByteWriter instance
|
* @writer: #GstByteWriter instance
|
||||||
* @value: Value to be writen
|
* @value: Value to be written
|
||||||
* @size: Number of bytes to be writen
|
* @size: Number of bytes to be written
|
||||||
|
|
||||||
*
|
*
|
||||||
* Writes @size bytes containing @value to @writer without
|
* Writes @size bytes containing @value to @writer without
|
||||||
* checking if there is enough free space available in the byte writer.
|
* checking if there is enough free space available in the byte writer.
|
||||||
|
|
|
@ -661,8 +661,8 @@ CREATE_WRITE_STRING_FUNC (32, guint32);
|
||||||
/**
|
/**
|
||||||
* gst_byte_writer_fill:
|
* gst_byte_writer_fill:
|
||||||
* @writer: #GstByteWriter instance
|
* @writer: #GstByteWriter instance
|
||||||
* @value: Value to be writen
|
* @value: Value to be written
|
||||||
* @size: Number of bytes to be writen
|
* @size: Number of bytes to be written
|
||||||
*
|
*
|
||||||
* Writes @size bytes containing @value to @writer.
|
* Writes @size bytes containing @value to @writer.
|
||||||
*
|
*
|
||||||
|
|
|
@ -134,7 +134,7 @@ struct _GstCollectData
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GstCollectPadsFunction:
|
* GstCollectPadsFunction:
|
||||||
* @pads: the #GstCollectPads that trigered the callback
|
* @pads: the #GstCollectPads that triggered the callback
|
||||||
* @user_data: user data passed to gst_collect_pads_set_function()
|
* @user_data: user data passed to gst_collect_pads_set_function()
|
||||||
*
|
*
|
||||||
* A function that will be called when all pads have received data.
|
* A function that will be called when all pads have received data.
|
||||||
|
@ -145,7 +145,7 @@ typedef GstFlowReturn (*GstCollectPadsFunction) (GstCollectPads *pads, gpointer
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GstCollectPadsBufferFunction:
|
* GstCollectPadsBufferFunction:
|
||||||
* @pads: the #GstCollectPads that trigered the callback
|
* @pads: the #GstCollectPads that triggered the callback
|
||||||
* @data: the #GstCollectData of pad that has received the buffer
|
* @data: the #GstCollectData of pad that has received the buffer
|
||||||
* @buffer: (transfer full): the #GstBuffer
|
* @buffer: (transfer full): the #GstBuffer
|
||||||
* @user_data: user data passed to gst_collect_pads_set_buffer_function()
|
* @user_data: user data passed to gst_collect_pads_set_buffer_function()
|
||||||
|
@ -172,7 +172,7 @@ typedef GstFlowReturn (*GstCollectPadsBufferFunction) (GstCollectPads *pads, Gst
|
||||||
*
|
*
|
||||||
* Returns: Integer less than zero when first timestamp is deemed older than the second one.
|
* Returns: Integer less than zero when first timestamp is deemed older than the second one.
|
||||||
* Zero if the timestamps are deemed equally old.
|
* Zero if the timestamps are deemed equally old.
|
||||||
* Integer greate than zero when second timestamp is deemed older than the first one.
|
* Integer greater than zero when second timestamp is deemed older than the first one.
|
||||||
*/
|
*/
|
||||||
typedef gint (*GstCollectPadsCompareFunction) (GstCollectPads *pads,
|
typedef gint (*GstCollectPadsCompareFunction) (GstCollectPads *pads,
|
||||||
GstCollectData * data1, GstClockTime timestamp1,
|
GstCollectData * data1, GstClockTime timestamp1,
|
||||||
|
@ -181,7 +181,7 @@ typedef gint (*GstCollectPadsCompareFunction) (GstCollectPads *pads,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GstCollectPadsEventFunction:
|
* GstCollectPadsEventFunction:
|
||||||
* @pads: the #GstCollectPads that trigered the callback
|
* @pads: the #GstCollectPads that triggered the callback
|
||||||
* @pad: the #GstPad that received an event
|
* @pad: the #GstPad that received an event
|
||||||
* @event: the #GstEvent received
|
* @event: the #GstEvent received
|
||||||
* @user_data: user data passed to gst_collect_pads_set_event_function()
|
* @user_data: user data passed to gst_collect_pads_set_event_function()
|
||||||
|
@ -199,7 +199,7 @@ typedef gboolean (*GstCollectPadsEventFunction) (GstCollectPads *pads, Gs
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GstCollectPadsQueryFunction:
|
* GstCollectPadsQueryFunction:
|
||||||
* @pads: the #GstCollectPads that trigered the callback
|
* @pads: the #GstCollectPads that triggered the callback
|
||||||
* @pad: the #GstPad that received an event
|
* @pad: the #GstPad that received an event
|
||||||
* @query: the #GstEvent received
|
* @query: the #GstEvent received
|
||||||
* @user_data: user data passed to gst_collect_pads_set_query_function()
|
* @user_data: user data passed to gst_collect_pads_set_query_function()
|
||||||
|
@ -222,7 +222,7 @@ typedef gboolean (*GstCollectPadsQueryFunction) (GstCollectPads *pads, Gs
|
||||||
* @user_data: user data
|
* @user_data: user data
|
||||||
*
|
*
|
||||||
* A function that will be called when @inbuffer is received on the pad managed
|
* A function that will be called when @inbuffer is received on the pad managed
|
||||||
* by @data in the collecpad object @pads.
|
* by @data in the collectpad object @pads.
|
||||||
*
|
*
|
||||||
* The function should use the segment of @data and the negotiated media type on
|
* The function should use the segment of @data and the negotiated media type on
|
||||||
* the pad to perform clipping of @inbuffer.
|
* the pad to perform clipping of @inbuffer.
|
||||||
|
|
|
@ -731,10 +731,10 @@ done:
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* gst_data_queue_limits_changed:
|
* gst_data_queue_limits_changed:
|
||||||
* @queue: The #GstDataQueue
|
* @queue: The #GstDataQueue
|
||||||
*
|
*
|
||||||
* Inform the queue that the limits for the fullness check have changed and that
|
* Inform the queue that the limits for the fullness check have changed and that
|
||||||
* any blocking gst_data_queue_push() should be unblocked to recheck the limts.
|
* any blocking gst_data_queue_push() should be unblocked to recheck the limits.
|
||||||
*
|
*
|
||||||
* Since: 1.2
|
* Since: 1.2
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -25,7 +25,7 @@
|
||||||
*
|
*
|
||||||
* #GstQueueArray is an object that provides standard queue functionality
|
* #GstQueueArray is an object that provides standard queue functionality
|
||||||
* based on an array instead of linked lists. This reduces the overhead
|
* based on an array instead of linked lists. This reduces the overhead
|
||||||
* caused by memory managment by a large factor.
|
* caused by memory management by a large factor.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -460,7 +460,7 @@ buffer_event_function (GstPad * pad, GstObject * noparent, GstEvent * event)
|
||||||
* gst_check_element_push_buffer_list:
|
* gst_check_element_push_buffer_list:
|
||||||
* @element_name: name of the element that needs to be created
|
* @element_name: name of the element that needs to be created
|
||||||
* @buffer_in: (element-type GstBuffer) (transfer full): a list of buffers that needs to be
|
* @buffer_in: (element-type GstBuffer) (transfer full): a list of buffers that needs to be
|
||||||
* puched to the element
|
* pushed to the element
|
||||||
* @buffer_out: (element-type GstBuffer) (transfer full): a list of buffers that we expect from
|
* @buffer_out: (element-type GstBuffer) (transfer full): a list of buffers that we expect from
|
||||||
* the element
|
* the element
|
||||||
* @last_flow_return: the last buffer push needs to give this GstFlowReturn
|
* @last_flow_return: the last buffer push needs to give this GstFlowReturn
|
||||||
|
@ -730,7 +730,7 @@ _gst_check_run_test_func (const gchar * func_name)
|
||||||
* @format: The #GstFormat of the default segment to send
|
* @format: The #GstFormat of the default segment to send
|
||||||
* @stream_id: A unique identifier for the stream
|
* @stream_id: A unique identifier for the stream
|
||||||
*
|
*
|
||||||
* Push stream-start, caps and segment event, which concist of the minimum
|
* Push stream-start, caps and segment event, which consist of the minimum
|
||||||
* required events to allow streaming. Caps is optional to allow raw src
|
* required events to allow streaming. Caps is optional to allow raw src
|
||||||
* testing.
|
* testing.
|
||||||
*/
|
*/
|
||||||
|
@ -756,7 +756,7 @@ gst_check_setup_events_with_stream_id (GstPad * srcpad, GstElement * element,
|
||||||
* @caps: (allow-none): #GstCaps in case caps event must be sent
|
* @caps: (allow-none): #GstCaps in case caps event must be sent
|
||||||
* @format: The #GstFormat of the default segment to send
|
* @format: The #GstFormat of the default segment to send
|
||||||
*
|
*
|
||||||
* Push stream-start, caps and segment event, which concist of the minimum
|
* Push stream-start, caps and segment event, which consist of the minimum
|
||||||
* required events to allow streaming. Caps is optional to allow raw src
|
* required events to allow streaming. Caps is optional to allow raw src
|
||||||
* testing. If @element has more than one src or sink pad, use
|
* testing. If @element has more than one src or sink pad, use
|
||||||
* gst_check_setup_events_with_stream_id() instead.
|
* gst_check_setup_events_with_stream_id() instead.
|
||||||
|
|
|
@ -856,7 +856,7 @@ gst_test_clock_wait_for_pending_id_count (GstTestClock * test_clock,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* gst_test_clock_process_next_clock_id:
|
* gst_test_clock_process_next_clock_id:
|
||||||
* @test_clock: a #GstTestClock for which to retrive the next pending clock
|
* @test_clock: a #GstTestClock for which to retrieve the next pending clock
|
||||||
* notification
|
* notification
|
||||||
*
|
*
|
||||||
* MT safe.
|
* MT safe.
|
||||||
|
|
|
@ -210,7 +210,7 @@ short_packet:
|
||||||
*
|
*
|
||||||
* MT safe.
|
* MT safe.
|
||||||
*
|
*
|
||||||
* Returns: TRUE if successful, FALSE in case an error occured.
|
* Returns: TRUE if successful, FALSE in case an error occurred.
|
||||||
*/
|
*/
|
||||||
gboolean
|
gboolean
|
||||||
gst_net_time_packet_send (const GstNetTimePacket * packet,
|
gst_net_time_packet_send (const GstNetTimePacket * packet,
|
||||||
|
|
|
@ -25,14 +25,14 @@
|
||||||
* @see_also: #GstFdSink
|
* @see_also: #GstFdSink
|
||||||
*
|
*
|
||||||
* Read data from a unix file descriptor.
|
* Read data from a unix file descriptor.
|
||||||
*
|
*
|
||||||
* To generate data, enter some data on the console folowed by enter.
|
* To generate data, enter some data on the console followed by enter.
|
||||||
* The above mentioned pipeline should dump data packets to the console.
|
* The above mentioned pipeline should dump data packets to the console.
|
||||||
*
|
*
|
||||||
* If the #GstFdSrc:timeout property is set to a value bigger than 0, fdsrc will
|
* If the #GstFdSrc:timeout property is set to a value bigger than 0, fdsrc will
|
||||||
* generate an element message named
|
* generate an element message named
|
||||||
* <classname>"GstFdSrcTimeout"</classname>
|
* <classname>"GstFdSrcTimeout"</classname>
|
||||||
* if no data was recieved in the given timeout.
|
* if no data was received in the given timeout.
|
||||||
* The message's structure contains one field:
|
* The message's structure contains one field:
|
||||||
* <itemizedlist>
|
* <itemizedlist>
|
||||||
* <listitem>
|
* <listitem>
|
||||||
|
@ -43,7 +43,7 @@
|
||||||
* </para>
|
* </para>
|
||||||
* </listitem>
|
* </listitem>
|
||||||
* </itemizedlist>
|
* </itemizedlist>
|
||||||
*
|
*
|
||||||
* <refsect2>
|
* <refsect2>
|
||||||
* <title>Example launch line</title>
|
* <title>Example launch line</title>
|
||||||
* |[
|
* |[
|
||||||
|
@ -51,7 +51,7 @@
|
||||||
* ]| A simple pipeline to read from the standard input and dump the data
|
* ]| A simple pipeline to read from the standard input and dump the data
|
||||||
* with a fakesink as hex ascii block.
|
* with a fakesink as hex ascii block.
|
||||||
* </refsect2>
|
* </refsect2>
|
||||||
*
|
*
|
||||||
* Last reviewed on 2008-06-20 (0.10.21)
|
* Last reviewed on 2008-06-20 (0.10.21)
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -194,7 +194,7 @@ gst_identity_class_init (GstIdentityClass * klass)
|
||||||
* GstIdentity:signal-handoffs
|
* GstIdentity:signal-handoffs
|
||||||
*
|
*
|
||||||
* If set to #TRUE, the identity will emit a handoff signal when handling a buffer.
|
* If set to #TRUE, the identity will emit a handoff signal when handling a buffer.
|
||||||
* When set to #FALSE, no signal will be emited, which might improve performance.
|
* When set to #FALSE, no signal will be emitted, which might improve performance.
|
||||||
*/
|
*/
|
||||||
g_object_class_install_property (gobject_class, PROP_SIGNAL_HANDOFFS,
|
g_object_class_install_property (gobject_class, PROP_SIGNAL_HANDOFFS,
|
||||||
g_param_spec_boolean ("signal-handoffs",
|
g_param_spec_boolean ("signal-handoffs",
|
||||||
|
|
|
@ -303,7 +303,7 @@ gst_multi_queue_class_init (GstMultiQueueClass * klass)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GstMultiQueue::underrun:
|
* GstMultiQueue::underrun:
|
||||||
* @multiqueue: the multqueue instance
|
* @multiqueue: the multiqueue instance
|
||||||
*
|
*
|
||||||
* This signal is emitted from the streaming thread when there is
|
* This signal is emitted from the streaming thread when there is
|
||||||
* no data in any of the queues inside the multiqueue instance (underrun).
|
* no data in any of the queues inside the multiqueue instance (underrun).
|
||||||
|
@ -371,7 +371,7 @@ gst_multi_queue_class_init (GstMultiQueueClass * klass)
|
||||||
* GstMultiQueue:use-buffering
|
* GstMultiQueue:use-buffering
|
||||||
*
|
*
|
||||||
* Enable the buffering option in multiqueue so that BUFFERING messages are
|
* Enable the buffering option in multiqueue so that BUFFERING messages are
|
||||||
* emited based on low-/high-percent thresholds.
|
* emitted based on low-/high-percent thresholds.
|
||||||
*/
|
*/
|
||||||
g_object_class_install_property (gobject_class, PROP_USE_BUFFERING,
|
g_object_class_install_property (gobject_class, PROP_USE_BUFFERING,
|
||||||
g_param_spec_boolean ("use-buffering", "Use buffering",
|
g_param_spec_boolean ("use-buffering", "Use buffering",
|
||||||
|
|
|
@ -377,7 +377,7 @@ gst_queue_class_init (GstQueueClass * klass)
|
||||||
* Flushing the queue on EOS might be useful when capturing and encoding
|
* Flushing the queue on EOS might be useful when capturing and encoding
|
||||||
* from a live source, to finish up the recording quickly in cases when
|
* from a live source, to finish up the recording quickly in cases when
|
||||||
* the encoder is slow. Note that this might mean some data from the end of
|
* the encoder is slow. Note that this might mean some data from the end of
|
||||||
* the recoding data might be lost though (never more than the configured
|
* the recording data might be lost though (never more than the configured
|
||||||
* max. sizes though).
|
* max. sizes though).
|
||||||
*
|
*
|
||||||
* Since: 1.2
|
* Since: 1.2
|
||||||
|
|
|
@ -22,7 +22,7 @@
|
||||||
* SECTION:element-typefind
|
* SECTION:element-typefind
|
||||||
*
|
*
|
||||||
* Determines the media-type of a stream. It applies typefind functions in the
|
* Determines the media-type of a stream. It applies typefind functions in the
|
||||||
* order of their rank. One the type has been deteted it sets its src pad caps
|
* order of their rank. Once the type has been detected it sets its src pad caps
|
||||||
* to the found media type.
|
* to the found media type.
|
||||||
*
|
*
|
||||||
* Whenever a type is found the #GstTypeFindElement::have-type signal is
|
* Whenever a type is found the #GstTypeFindElement::have-type signal is
|
||||||
|
|
|
@ -32,7 +32,7 @@
|
||||||
* If a subsystem is disabled, most of this changes are done in an API
|
* If a subsystem is disabled, most of this changes are done in an API
|
||||||
* compatible way, so you don't need to adapt your code in most cases. It is
|
* compatible way, so you don't need to adapt your code in most cases. It is
|
||||||
* never done in an ABI compatible way though. So if you want to disable a
|
* never done in an ABI compatible way though. So if you want to disable a
|
||||||
* suybsystem, you have to rebuild all programs depending on GStreamer, too.
|
* subsystem, you have to rebuild all programs depending on GStreamer, too.
|
||||||
*
|
*
|
||||||
* If a subsystem is disabled in GStreamer, a value is defined in
|
* If a subsystem is disabled in GStreamer, a value is defined in
|
||||||
* <gst/gst.h>. You can check this if you do subsystem-specific stuff.
|
* <gst/gst.h>. You can check this if you do subsystem-specific stuff.
|
||||||
|
|
Loading…
Reference in a new issue