mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-06-08 17:19:25 +00:00
80 lines
2.1 KiB
Plaintext
80 lines
2.1 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
GstTypes
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
various global enums and constants
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION Stability_Level ##### -->
|
|
|
|
|
|
<!-- ##### ENUM GstElementState ##### -->
|
|
<para>
|
|
These contants describe the state a #GstElement is in and transition scheduled for the #GstElement (the pending state).
|
|
</para>
|
|
|
|
@GST_STATE_VOID_PENDING: no transition is schedules for this element
|
|
@GST_STATE_NULL: this is the default state all elements are in, after they have been created and are doing nothing
|
|
@GST_STATE_READY: the element is ready to start doing something
|
|
@GST_STATE_PAUSED: the element is paused for a period of time
|
|
@GST_STATE_PLAYING: the element is doing something
|
|
|
|
<!-- ##### ENUM GstElementStateReturn ##### -->
|
|
<para>
|
|
One of these values is returned from a gst_element_set_state() call.
|
|
As GST_STATE_FAILURE is equal to 0, one can use a boolean comparission
|
|
against the GstElementStateReturn value.
|
|
</para>
|
|
|
|
@GST_STATE_FAILURE: the state of the element could not be changed
|
|
@GST_STATE_SUCCESS: the state of the element has already be changed
|
|
@GST_STATE_ASYNC: the state of the element will change in the near future
|
|
|
|
<!-- ##### ENUM GstResult ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@GST_RESULT_OK:
|
|
@GST_RESULT_NOK:
|
|
@GST_RESULT_NOT_IMPL:
|
|
|
|
<!-- ##### ENUM GstRank ##### -->
|
|
<para>
|
|
Element priority ranks. Defines the order in which the autoplugger (or similar
|
|
rank-picking mechanisms) will choose this element over an alternative one
|
|
with the same function.
|
|
The rank is a unsigned integer ranging from 0 (GST_RANK_NONE) to 256 (GST_RANK_PRIMARY).
|
|
These constants serve as a rough guidiance for defining the rank of a #GstPlugin using
|
|
gst_plugin_feature_set_rank().
|
|
</para>
|
|
|
|
@GST_RANK_NONE: will be chosen last or not at all
|
|
@GST_RANK_MARGINAL: unlikly to be chosen
|
|
@GST_RANK_SECONDARY: likely to be chosen
|
|
@GST_RANK_PRIMARY: will be chosen first
|
|
|
|
<!-- ##### MACRO GST_PADDING ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### MACRO GST_PADDING_INIT ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
|