- public const string ALLOCATOR_SYSMEM
The allocator name for the default system memory allocator
- public const BufferCopyFlags BUFFER_COPY_ALL
Combination of all possible fields that can be copied with
copy_into.
- public const BufferCopyFlags BUFFER_COPY_METADATA
Combination of all possible metadata fields that can be copied with
copy_into.
- public const uint64 BUFFER_OFFSET_NONE
Constant for no-offset return results.
- public const int CAN_INLINE
- public const string CAPS_FEATURE_MEMORY_SYSTEM_MEMORY
- public const ClockTime CLOCK_TIME_NONE
Constant to define an undefined clock time.
- public const string ELEMENT_METADATA_AUTHOR
Name and contact details of the author(s).
- public const string ELEMENT_METADATA_DESCRIPTION
Sentence describing the purpose of the element.
- public const string ELEMENT_METADATA_DOC_URI
Set uri pointing to user documentation.
- public const string ELEMENT_METADATA_ICON_NAME
Elements that bridge to certain other products can include an icon of
that used product.
- public const string ELEMENT_METADATA_KLASS
String describing the type of element, as an unordered list separated
with slashes ('/').
- public const string ELEMENT_METADATA_LONGNAME
The long English name of the element.
- public const int EVENT_NUM_SHIFT
- public const EventTypeFlags EVENT_TYPE_BOTH
- public const uint FLAG_SET_MASK_EXACT
A mask value with all bits set, for use as a GstFlagSet mask where all
flag bits must match exactly
- public const int64 FORMAT_PERCENT_MAX
The PERCENT format is between 0 and this value
- public const int64 FORMAT_PERCENT_SCALE
The value used to scale down the reported PERCENT format value to its
real value.
- public const string FOURCC_FORMAT
Can be used together with GST_FOURCC_ARGS to properly
output a uint32 fourcc value in a printf\()-style text message.
- public const int GROUP_ID_INVALID
A value which is guaranteed to never be returned by
group_id_next.
- public const string LICENSE_UNKNOWN
To be used in GST_PLUGIN_DEFINE if unsure about the licence.
- public const LockFlags LOCK_FLAG_READWRITE
GstLockFlags value alias for GST_LOCK_FLAG_READ | GST_LOCK_FLAG_WRITE
- public const MapFlags MAP_READWRITE
GstMapFlags value alias for GST_MAP_READ | GST_MAP_WRITE
- public const string META_TAG_MEMORY_STR
This metadata stays relevant as long as memory layout is unchanged.
- public const ClockTimeDiff MSECOND
Constant that defines one GStreamer millisecond.
- public const ClockTimeDiff NSECOND
Constant that defines one GStreamer nanosecond
- public const int PARAM_CONDITIONALLY_AVAILABLE
Use this flag on GObject properties of GstObject to indicate that they
might not be available depending on environment such as OS, device, etc, so such properties will be installed conditionally only if
the GstObject is able to support it.
- public const int PARAM_CONTROLLABLE
Use this flag on GObject properties to signal they can make sense to
be.
- public const int PARAM_DOC_SHOW_DEFAULT
Use this flag on GObject properties of GstObject to indicate that
during `gst-inspect` and friends, the default value should be used as default instead of the current value.
- public const int PARAM_MUTABLE_PAUSED
Use this flag on GObject properties of GstElements to indicate that
they can be changed when the element is in the PAUSED or lower state.
- public const int PARAM_MUTABLE_PLAYING
Use this flag on GObject properties of GstElements to indicate that
they can be changed when the element is in the PLAYING or lower state.
- public const int PARAM_MUTABLE_READY
Use this flag on GObject properties of GstElements to indicate that
they can be changed when the element is in the READY or lower state.
- public const int PARAM_USER_SHIFT
Bits based on GST_PARAM_USER_SHIFT can be used by 3rd party
applications.
- public const string PROTECTION_SYSTEM_ID_CAPS_FIELD
The field name in a GstCaps that is used to signal the UUID of the
protection system.
- public const string PROTECTION_UNSPECIFIED_SYSTEM_ID
The protection system value of the unspecified UUID.
- public const string PTR_FORMAT
printf format type used to debug GStreamer types.
- public const int QUERY_NUM_SHIFT
- public const QueryTypeFlags QUERY_TYPE_BOTH
- public const ClockTimeDiff SECOND
Constant that defines one GStreamer second.
- public const string SEGMENT_FORMAT
printf format type used to debug GStreamer segments.
- public const int SEGMENT_INSTANT_FLAGS
- public const int SEQNUM_INVALID
A value which is guaranteed to never be returned by
seqnum_next.
- public const string STIMEP_FORMAT
printf format type used to debug GStreamer signed time value pointers.
- public const string STIME_FORMAT
A string that can be used in printf-like format strings to display a
signed ClockTimeDiff or int64 value in `h:m:s` format.
- public const string TIMEP_FORMAT
printf format type used to debug GStreamer ClockTime pointers.
- public const string TIME_FORMAT
A string that can be used in printf-like format strings to display a
ClockTime value in `h:m:s` format.
- public const int TOC_REPEAT_COUNT_INFINITE
Special value for the repeat_count set in
set_loop or returned by
set_loop to indicate infinite looping.
- public const int URI_NO_PORT
- public const ClockTimeDiff USECOND
Constant that defines one GStreamer microsecond.
- public const int VALUE_EQUAL
Indicates that the first value provided to a comparison function
(gst_value_compare()) is equal to the second one.
- public const int VALUE_GREATER_THAN
Indicates that the first value provided to a comparison function
(gst_value_compare()) is greater than the second one.
- public const int VALUE_LESS_THAN
Indicates that the first value provided to a comparison function
(gst_value_compare()) is lesser than the second one.
- public const int VALUE_UNORDERED
Indicates that the comparison function (gst_value_compare()) can not
determine a order for the two provided values.
- public const int VERSION_MAJOR
The major version of GStreamer at compile time:
- public const int VERSION_MICRO
The micro version of GStreamer at compile time:
- public const int VERSION_MINOR
The minor version of GStreamer at compile time:
- public const int VERSION_NANO
The nano version of GStreamer at compile time: Actual releases have 0,
GIT versions have 1, prerelease versions have 2-...
- public delegate bool BufferForeachMetaFunc (Buffer buffer, out Meta? meta)
- public delegate bool BufferListFunc (out Buffer? buffer, uint idx)
A function that will be called from
@foreach.
- public delegate bool BusFunc (Bus bus, Message message)
Specifies the type of function passed to gst_bus_add_watch
or add_watch, which is called from the mainloop when a message is
available on the bus.
- public delegate BusSyncReply BusSyncHandler (Bus bus, Message message)
Handler will be invoked synchronously, when a new message has been
injected into the bus.
- public delegate bool CapsFilterMapFunc (CapsFeatures features, Structure structure)
- public delegate bool CapsForeachFunc (CapsFeatures features, Structure structure)
A function that will be called in
@foreach.
- public delegate bool CapsMapFunc (CapsFeatures features, Structure structure)
- public delegate bool ClockCallback (Clock clock, ClockTime time, ClockID id)
The function prototype of the callback.
- public delegate bool ControlSourceGetValue (ControlSource self, ClockTime timestamp, out double value)
Function for returning a value for a given timestamp.
- public delegate bool ControlSourceGetValueArray (ControlSource self, ClockTime timestamp, ClockTime interval, double[] values)
Function for returning an array of values starting at a given
timestamp.
- public delegate bool CustomMetaTransformFunction (Buffer transbuf, CustomMeta meta, Buffer buffer, Quark type, void* data)
Function called for each meta in buffer as a
result of performing a transformation on transbuf.
- public delegate void DebugFuncPtr ()
we define this to avoid a compiler warning regarding a cast from a
function pointer to a void pointer (see https://bugzilla.
- public delegate void ElementCallAsyncFunc (Element element)
- public delegate bool ElementForeachPadFunc (Element element, Pad pad)
- public delegate void IteratorCopyFunction (Iterator it, Iterator copy)
This function will be called when creating a copy of it
and should create a copy of all custom iterator fields or increase their reference counts.
- public delegate bool IteratorFoldFunction (Value item, ref Value ret)
A function to be passed to
fold.
- public delegate void IteratorForeachFunction (Value item)
A function that is called by
@foreach for every element.
- public delegate void IteratorFreeFunction (Iterator it)
This function will be called when the iterator is freed.
- public delegate IteratorItem IteratorItemFunction (Iterator it, Value item)
The function that will be called after the next item of the iterator
has been retrieved.
- public delegate IteratorResult IteratorNextFunction (Iterator it, ref Value result)
The function that will be called when the next element of the iterator
should be retrieved.
- public delegate void IteratorResyncFunction (Iterator it)
This function will be called whenever a concurrent update happened to
the iterated datastructure.
- public delegate void LogFunction (DebugCategory category, DebugLevel level, string file, string function, int line, Object object, DebugMessage message)
Function prototype for a logging function that can be registered with
add_log_function.
- public delegate Memory MemoryCopyFunction (Memory mem, ssize_t offset, ssize_t size)
Copy size bytes from mem starting at
offset and return them wrapped in a new GstMemory object.
- public delegate bool MemoryIsSpanFunction (Memory mem1, Memory mem2, size_t offset)
Check if mem1 and mem2 occupy contiguous
memory and return the offset of mem1 in the parent buffer in offset.
- public delegate void* MemoryMapFullFunction (Memory mem, MapInfo info, size_t maxsize)
Get the memory of mem that can be accessed according to
the mode specified in info's flags.
- public delegate void* MemoryMapFunction (Memory mem, size_t maxsize, MapFlags flags)
Get the memory of mem that can be accessed according to
the mode specified in flags.
- public delegate Memory MemoryShareFunction (Memory mem, ssize_t offset, ssize_t size)
Share size bytes from mem starting at
offset and return them wrapped in a new GstMemory object.
- public delegate void MemoryUnmapFullFunction (Memory mem, MapInfo info)
Release the pointer previously retrieved with
map with info.
- public delegate void MemoryUnmapFunction (Memory mem)
Release the pointer previously retrieved with
map.
- public delegate void MetaFreeFunction (Meta meta, Buffer buffer)
Function called when meta is freed in buffer
.
- public delegate bool MetaInitFunction (Meta meta, void* @params, Buffer buffer)
Function called when meta is initialized in buffer
.
- public delegate bool MetaTransformFunction (Buffer transbuf, Meta meta, Buffer buffer, Quark type, void* data)
Function called for each meta in buffer as a
result of performing a transformation on transbuf.
- public delegate MiniObject MiniObjectCopyFunction (MiniObject obj)
Function prototype for methods to create copies of instances.
- public delegate bool MiniObjectDisposeFunction (MiniObject obj)
Function prototype for when a miniobject has lost its last refcount.
- public delegate void MiniObjectFreeFunction (MiniObject obj)
Virtual function prototype for methods to free resources used by
mini-objects.
- public delegate void MiniObjectNotify (MiniObject obj)
A MiniObjectNotify function can be added
to a mini object as a callback that gets triggered when unref drops the last
ref and obj is about to be freed.
- public delegate bool PadActivateFunction (Pad pad, Object parent)
This function is called when the pad is activated during the element
READY to PAUSED state change.
- public delegate bool PadActivateModeFunction (Pad pad, Object parent, PadMode mode, bool active)
The prototype of the push and pull activate functions.
- public delegate FlowReturn PadChainFunction (Pad pad, Object? parent, owned Buffer buffer)
A function that will be called on sinkpads when chaining buffers.
- public delegate FlowReturn PadChainListFunction (Pad pad, Object? parent, owned BufferList list)
A function that will be called on sinkpads when chaining buffer lists.
- public delegate FlowReturn PadEventFullFunction (Pad pad, Object? parent, owned Event event)
Function signature to handle an event for the pad.
- public delegate bool PadEventFunction (Pad pad, Object? parent, owned Event event)
Function signature to handle an event for the pad.
- public delegate bool PadForwardFunction (Pad pad)
A forward function is called for all internally linked pads, see
forward.
- public delegate FlowReturn PadGetRangeFunction (Pad pad, Object? parent, uint64 offset, uint length, Buffer buffer)
This function will be called on source pads when a peer element
request a buffer at the specified offset and length.
- public delegate Iterator PadIterIntLinkFunction (Pad pad, Object? parent)
The signature of the internal pad link iterator function.
- public delegate PadLinkReturn PadLinkFunction (Pad pad, Object? parent, Pad peer)
Function signature to handle a new link on the pad.
- public delegate PadProbeReturn PadProbeCallback (Pad pad, PadProbeInfo info)
- public delegate bool PadQueryFunction (Pad pad, Object? parent, Query query)
The signature of the query function.
- public delegate bool PadStickyEventsForeachFunction (Pad pad, Event? event)
- public delegate void PadUnlinkFunction (Pad pad, Object? parent)
Function signature to handle a unlinking the pad prom its peer.
- public delegate bool PluginFeatureFilter (PluginFeature feature)
A function that can be used with e.g.
feature_filter to get a list of pluginfeature that match certain
criteria.
- public delegate bool PluginFilter (Plugin plugin)
A function that can be used with e.g.
plugin_filter to get a list of plugins that match certain criteria.
- public delegate bool PluginInitFullFunc (Plugin plugin)
A plugin should provide a pointer to a function of either
PluginInitFunc or this type in the plugin_desc struct.
- public delegate bool PluginInitFunc (Plugin plugin)
A plugin should provide a pointer to a function of this type in the
plugin_desc struct.
- public delegate void PromiseChangeFunc (Promise promise)
- public delegate bool StructureFilterMapFunc (Quark field_id, ref Value value)
- public delegate bool StructureForeachFunc (Quark field_id, Value value)
A function that will be called in
@foreach.
- public delegate bool StructureMapFunc (Quark field_id, ref Value value)
- public delegate void TagForeachFunc (TagList list, string tag)
A function that will be called in
@foreach.
- public delegate void TagMergeFunc (out Value dest, Value src)
A function for merging multiple values of a tag used when registering
tags.
- public delegate void TaskFunction ()
A function that will repeatedly be called in the thread created by a
Task.
- public delegate void TaskPoolFunction ()
- public delegate void TaskThreadFunc (Task task, Thread thread)
Custom GstTask thread callback functions that can be installed.
- public delegate void TypeFindFunction (TypeFind find)
A function that will be called by typefinding.
- public delegate uint64 TypeFindGetLengthVFunc (void* data)
- public delegate uint8 TypeFindPeekVFunc (void* data, int64 offset, uint size)
- public delegate void TypeFindSuggestVFunc (void* data, uint probability, Caps caps)
- public delegate int ValueCompareFunc (Value value1, Value value2)
Used together with
compare to compare Value items.
- public delegate bool ValueDeserializeFunc (ref Value dest, string s)
Used by
deserialize to parse a non-binary form into the Value.
- public delegate bool ValueDeserializeWithPSpecFunc (Value dest, string s, ParamSpec pspec)
- public delegate string ValueSerializeFunc (Value value1)
Used by serialize
to obtain a non-binary form of the Value.
- public uint STIME_ARGS (ClockTimeDiff t)
- public uint TIME_ARGS (ClockTime t)
- public uint buffer_get_max_memory ()
Gets the maximum amount of memory blocks that a buffer can hold.
- public bool buffer_list_replace (ref BufferList? old_list, BufferList? new_list)
- public bool buffer_list_take (ref BufferList old_list, owned BufferList? new_list)
- public CapsFeatures? caps_features_from_string (string features)
- public Caps? caps_from_string (string string)
Converts caps from a string representation.
- public bool context_replace (ref Context old_context, Context? new_context)
- public Quark core_error_quark ()
- public void deinit ()
Clean up any resources created by GStreamer in
init.
- public bool dynamic_type_register (Plugin plugin, Type type)
- public string error_get_message (Quark domain, int code)
Get a string describing the error message in the current locale.
- public EventTypeFlags event_type_get_flags (EventType type)
- public unowned string event_type_get_name (EventType type)
- public Quark event_type_to_quark (EventType type)
- public string filename_to_uri (string filename) throws Error
Similar to to_uri, but attempts to handle
relative file paths as well.
- public Quark flow_to_quark (FlowReturn ret)
Get the unique quark for the given GstFlowReturn.
- public Format format_get_by_nick (string nick)
- public unowned FormatDefinition? format_get_details (Format format)
- public unowned string? format_get_name (Format format)
- public Iterator format_iterate_definitions ()
- public Format format_register (string nick, string description)
- public Quark format_to_quark (Format format)
- public unowned string? get_main_executable_path ()
This helper is mostly helpful for plugins that need to inspect the
folder of the main executable to determine their set of features.
- public void init (ref unowned string[]? argv)
Initializes the GStreamer library, setting up internal path lists,
registering built-in elements, and loading standard plugins.
- public bool init_check (ref unowned string[]? argv) throws Error
Initializes the GStreamer library, setting up internal path lists,
registering built-in elements, and loading standard plugins.
- public OptionGroup? init_get_option_group ()
Returns a OptionGroup with GStreamer's
argument specifications.
- public bool is_caps_features (void* obj)
- public bool is_initialized ()
Use this function to check if GStreamer has been initialized with
init or init_check.
- public Quark library_error_quark ()
- public bool message_take (ref Message old_message, owned Message? new_message)
- public unowned string message_type_get_name (MessageType type)
- public Quark message_type_to_quark (MessageType type)
- public unowned string[] meta_api_type_get_tags (Type api)
- public bool meta_api_type_has_tag (Type api, Quark tag)
- public Type meta_api_type_register (string api, string[] tags)
- public unowned MetaInfo? meta_get_info (string impl)
- public unowned MetaInfo? meta_register (Type api, string impl, size_t size, MetaInitFunction init_func, MetaFreeFunction free_func, MetaTransformFunction transform_func)
- public unowned MetaInfo? meta_register_custom (string name, string[] tags, owned CustomMetaTransformFunction? transform_func)
- public bool mini_object_replace (ref MiniObject? olddata, MiniObject? newdata)
Atomically modifies a pointer to point to a new mini-object.
- public bool mini_object_take (ref MiniObject olddata, MiniObject newdata)
Modifies a pointer to point to a new mini-object.
- public unowned string pad_mode_get_name (PadMode mode)
- public ParamSpec param_spec_array (string name, string nick, string blurb, ParamSpec element_spec, ParamFlags flags)
This function creates a GstArray GParamSpec for use by
objects/elements that want to expose properties of GstArray type.
- public ParamSpec? param_spec_fraction (string name, string nick, string blurb, int min_num, int min_denom, int max_num, int max_denom, int default_num, int default_denom, ParamFlags flags)
This function creates a fraction GParamSpec for use by
objects/elements that want to expose properties of fraction type.
- public unowned MetaInfo? parent_buffer_meta_get_info ()
- public Element parse_bin_from_description (string bin_description, bool ghost_unlinked_pads, ParseContext? context = null, ParseFlags flags = NONE) throws Error
This is a convenience wrapper around gst_parse_launch to
create a Bin from a gst-launch-style pipeline description.
- public Quark parse_error_quark ()
- public Element parse_launch (string pipeline_description, ParseContext? context = null, ParseFlags flags = NONE) throws Error
Create a new pipeline based on command line syntax.
- public Element parse_launchv (string[] argv, ParseContext? context = null, ParseFlags flags = NONE) throws Error
Create a new element based on command line syntax.
- public Quark plugin_error_quark ()
- public unowned string? preset_get_app_dir ()
- public bool preset_set_app_dir (string app_dir)
- public string[]? protection_filter_systems_by_available_decryptors (string[] system_identifiers)
Iterates the supplied list of UUIDs and checks the GstRegistry for all
the decryptors supporting one of the supplied UUIDs.
- public unowned MetaInfo? protection_meta_get_info ()
- public unowned string? protection_select_system (string[] system_identifiers)
Iterates the supplied list of UUIDs and checks the GstRegistry for an
element that supports one of the supplied UUIDs.
- public bool query_take (ref Query? old_query, owned Query? new_query)
Modifies a pointer to a Query
to point to a different Query.
- public QueryTypeFlags query_type_get_flags (QueryType type)
- public unowned string query_type_get_name (QueryType type)
- public Quark query_type_to_quark (QueryType type)
- public unowned MetaInfo? reference_timestamp_meta_get_info ()
- public Quark resource_error_quark ()
- public bool segtrap_is_enabled ()
Some functions in the GStreamer core might install a custom SIGSEGV
handler to better catch and report errors to the application.
- public void segtrap_set_enabled (bool enabled)
Applications might want to disable/enable the SIGSEGV handling of the
GStreamer core.
- public unowned string state_change_get_name (StateChange transition)
- public Quark stream_error_quark ()
- public unowned string stream_type_get_name (StreamType stype)
- public bool structure_take (ref Structure? oldstr_ptr, owned Structure? newstr)
Atomically modifies a pointer to point to a new structure.
- public unowned string toc_entry_type_get_nick (TocEntryType type)
- public List<Tracer> tracing_get_active_tracers ()
Get a list of all active tracer objects owned by the tracing framework
for the entirety of the run-time of the process or till deinit is called.
- public void tracing_register_hook (Tracer tracer, string detail, Callback func)
Register func to be called when the trace hook
detail is getting invoked.
- public bool type_find_register (Plugin? plugin, string name, uint rank, owned TypeFindFunction func, string? extensions, Caps? possible_caps)
- public bool type_is_plugin_api (Type type, out PluginAPIFlags? flags)
Checks if type is plugin API.
- public void type_mark_as_plugin_api (Type type, PluginAPIFlags flags)
Marks type as plugin API.
- public bool update_registry ()
Forces GStreamer to re-scan its plugin paths and update the default
plugin registry.
- public void version (out uint major, out uint minor, out uint micro, out uint nano)
Gets the version number of the GStreamer library.
- public string version_string ()
This function returns a string that is useful for describing this
version of GStreamer to the outside world: user agent strings, logging, ...