Gst

Description:

Content:

Namespaces:

Interfaces:

ChildProxy - This interface abstracts handling of property sets for elements with children.
Preset - This interface offers methods to query and manipulate parameter preset sets.
TagSetter - Element interface that allows setting of media metadata.
TocSetter - Element interface that allows setting of the TOC.
URIHandler - The URIHandler is an interface that is implemented by Source and Sink Element to unify handling of URI.

Classes:

AllocationParams - Parameters to control the allocation of memory
Allocator - Memory is usually created by allocators with a alloc method call.
AtomicQueue - The AtomicQueue object implements a queue that can be used from multiple threads without performing any blocking operations.
Bin - Bin is an element that can contain other Element, allowing them to be managed as a group.
Bitmask - A fundamental type that describes a 64-bit bitmask
Buffer - Buffers are the basic unit of data transfer in GStreamer.
BufferList - Buffer lists are an object containing a list of buffers.
BufferPool - A BufferPool is an object that can be used to pre-allocate and recycle buffers of the same size and with the same properties.
Bus - The Bus is an object responsible for delivering Message packets in a first-in first-out way from the streaming threads (see Task) to the application.
Caps - Caps (capabilities) are lightweight refcounted objects describing media types.
CapsFeatures - CapsFeatures can optionally be set on a Caps to add requirements for additional features for a specific Structure.
Clock - GStreamer uses a global clock to synchronize the plugins in a pipeline.
Context - Context is a container object used to store contexts like a device context, a display server connection and similar concepts that should be shared between multiple elements.
ControlBinding - A base class for value mapping objects that attaches control sources to Object properties.
ControlSource - The ControlSource is a base class for control value sources that could be used to get timestamp-value pairs.
DateTime - Struct to store date, time and timezone information altogether.
DebugMessage
Device - Device are objects representing a device, they contain relevant metadata about the device, such as its class and the Caps representing the media types it can produce or handle.
DeviceMonitor - Applications should create a DeviceMonitor when they want to probe, list and monitor devices of a specific type.
DeviceProvider - A DeviceProvider subclass is provided by a plugin that handles devices if there is a way to programmatically list connected devices.
DeviceProviderFactory - DeviceProviderFactory is used to create instances of device providers.
DoubleRange - A fundamental type that describes a double range
DynamicTypeFactory - DynamicTypeFactory is used to represent a type that can be automatically loaded the first time it is used.
Element - GstElement is the abstract base class needed to construct an element that can be used in a GStreamer pipeline.
ElementFactory - ElementFactory is used to create instances of elements.
Event - The event class provides factory methods to construct events for sending and functions to query (parse) received events.
FlagSet - A fundamental type that describes a 32-bit flag bitfield, with 32-bit mask indicating which of the bits in the field are explicitly set.
Fraction - A fundamental type that describes a fraction of an integer numerator over an integer denominator
FractionRange - A fundamental type that describes a FractionRange range
GhostPad - GhostPads are useful when organizing pipelines with Bin like elements.
Int64Range - A fundamental type that describes a int64 range
IntRange - A fundamental type that describes a int range
Iterator - A GstIterator is used to retrieve multiple objects from another object in a threadsafe way.
Memory - GstMemory is a lightweight refcounted object that wraps a region of memory.
Message - Messages are implemented as a subclass of MiniObject with a generic Structure as the content.
MiniObject - MiniObject is a simple structure that can be used to implement refcounted types.
Object - Object provides a root for the object hierarchy tree filed in by the GStreamer library.
Pad - A Element is linked to other elements via "pads", which are extremely light-weight generic link points.
PadTemplate - Padtemplates describe the possible media types a pad or an elementfactory can handle.
ParamArray - A fundamental type that describes a ParamSpec for arrays of values
ParamFraction - A fundamental type that describes a ParamSpec for fractional properties
ParseContext - Opaque structure.
Pipeline - A Pipeline is a special Bin used as the toplevel container for the filter graph.
Plugin - GStreamer is extensible, so Element instances can be loaded at runtime.
PluginFeature - This is a base class for anything that can be added to a Plugin.
Poll - A Poll keeps track of file descriptors much like fd_set (used with select ()) or a struct pollfd array (used with poll ()).
Promise - The Promise object implements the container for values that may be available later.
ProxyPad
Query - Queries can be performed on pads ( query) and elements (query).
Registry - One registry holds the metadata of a set of plugins.
Sample - A Sample is a small object containing data, a type, timing and extra arbitrary information.
Segment - This helper structure holds the relevant values for tracking the region of interest in a media file, called a segment.
SharedTaskPool - The SharedTaskPool object.
Stream - A high-level object representing a single stream.
StreamCollection - A collection of Stream that are available.
Structure - A Structure is a collection of key/value pairs.
SystemClock - The GStreamer core provides a GstSystemClock based on the system time.
TagList - List of tags and values used to describe media metadata.
Task - Task is used by Element and Pad to provide the data passing threads in a Pipeline.
TaskPool - This object provides an abstraction for creating threads.
Toc - Toc functions are used to create/free Toc and TocEntry structures.
TocEntry
Tracer - Tracing modules will subclass Tracer and register through register.
TracerFactory - Use get_list to get a list of tracer factories known to GStreamer.
TracerRecord - Tracing modules will create instances of this class to announce the data they will log and create a log formatter.
TypeFindFactory - These functions allow querying information about registered typefind functions.
Uri - A Uri object can be used to parse and split a URI string into its constituent parts.
ValueArray - A fundamental type that describes an ordered list of Value
ValueList - A fundamental type that describes an unordered list of Value

Structs:

BufferPoolAcquireParams - Parameters passed to the acquire_buffer function to control the allocation of the buffer.
ClockEntry - All pending timeouts or periodic notifies are converted into an entry.
ClockID - A datatype to hold the handle to an outstanding sync or async clock callback.
ClockTime - A datatype to hold a time, measured in nanoseconds.
ClockTimeDiff - A datatype to hold a time difference, measured in nanoseconds.
CustomMeta - Extra custom metadata.
DebugCategory - This is the struct that describes the categories.
ElementFactoryListType - A type defining the type of an element factory.
FormatDefinition - A format definition
MapInfo - A structure containing the result of a map operation such as map.
Meta - The Meta structure should be included as the first member of a Buffer metadata structure.
MetaInfo - The MetaInfo provides information about a specific metadata structure.
MetaTransformCopy - Extra data passed to a "gst-copy" transform MetaTransformFunction.
PadProbeInfo - Info passed in the PadProbeCallback.
ParentBufferMeta - The ParentBufferMeta is a Meta which can be attached to a Buffer to hold a reference to another buffer that is only released when the child Buffer is released.
PluginDesc - A plugin should export a variable of this type called plugin_desc.
PollFD - A file descriptor object.
ProtectionMeta - Metadata type that holds information about a sample from a protection-protected track, including the information needed to decrypt it (if it is encrypted).
ReferenceTimestampMeta - ReferenceTimestampMeta can be used to attach alternative timestamps and possibly durations to a Buffer.
StaticCaps - Data structure to initialize Caps from a string description usually used in conjunction with GST_STATIC_CAPS and @get to instantiate a Caps.
StaticPadTemplate - Structure describing the StaticPadTemplate.
TimedValue - Structure for storing a timestamp and a value.
TypeFind - The following functions allow you to detect the media type of an unknown stream.
ValueTable - VTable for the Value type.

Enums:

AllocatorFlags - Flags for allocators.
BinFlags - GstBinFlags are a set of flags specific to bins.
BufferCopyFlags - A set of flags that can be provided to the copy_into function to specify which items should be copied.
BufferFlags - A set of buffer flags used to describe properties of a Buffer.
BufferPoolAcquireFlags - Additional flags to control the allocation of a buffer
BufferingMode - The different types of buffering methods.
BusFlags - The standard flags that a bus may have.
BusSyncReply - The result values for a GstBusSyncHandler.
CapsFlags - Extra flags for a caps.
CapsIntersectMode - Modes of caps intersection
ClockEntryType - The type of the clock entry
ClockFlags - The capabilities of this clock
ClockReturn - The return value of a clock operation.
ClockType - The different kind of clocks.
DebugColorFlags - These are some terminal style flags you can use when creating your debugging categories to make them stand out in debugging output.
DebugColorMode
DebugGraphDetails - Available details for pipeline graphs produced by BIN_TO_DOT_FILE and BIN_TO_DOT_FILE_WITH_TS.
DebugLevel - The level defines the importance of a debugging message.
ElementFlags - The standard flags that an element may have.
EventType - EventType lists the standard event types that can be sent in a pipeline.
EventTypeFlags - EventTypeFlags indicate the aspects of the different EventType values.
FlowReturn - The result of passing data to a pad.
Format - Standard predefined formats
GapFlags - The different flags that can be set on GAP events.
IteratorItem - The result of a IteratorItemFunction.
IteratorResult - The result of next.
LockFlags - Flags used when locking miniobjects
MapFlags - Flags used when mapping memory
MemoryFlags - Flags for wrapped memory.
MessageType - The different message types that are available.
MetaFlags - Extra metadata flags.
MiniObjectFlags - Flags for the mini object
ObjectFlags - The standard flags that an gstobject may have.
PadDirection - The direction of a pad.
PadFlags - Pad state flags
PadLinkCheck - The amount of checking to be done when linking pads.
PadLinkReturn - Result values from gst_pad_link and friends.
PadMode - The status of a GstPad.
PadPresence - Indicates when this pad will become available.
PadProbeReturn - Different return values for the PadProbeCallback.
PadProbeType - The different probing types that can occur.
PadTemplateFlags - Flags for the padtemplate
ParseFlags - Parsing options.
PipelineFlags - Pipeline flags
PluginAPIFlags
PluginDependencyFlags - Flags used in connection with add_dependency.
PluginFlags - The plugin loading state
ProgressType - The type of a gst_message_progress.
PromiseResult - The result of a Promise
QOSType - The different types of QoS events that can be given to the Event.qos method.
QueryType - Standard predefined Query types
QueryTypeFlags - QueryTypeFlags indicate the aspects of the different QueryType values.
Rank - Element priority ranks.
SchedulingFlags - The different scheduling flags.
SearchMode - The different search modes.
SeekFlags - Flags to be used with seek or Event.seek.
SeekType - The different types of seek events.
SegmentFlags - Flags for the GstSegment structure.
SerializeFlags
StackTraceFlags
State - The possible states an element can be in.
StateChange - These are the different state changes an element goes through.
StateChangeReturn - The possible return values from a state change function such as set_state.
StreamFlags
StreamStatusType - The type of a gst_message_stream_status.
StreamType - StreamType describes a high level classification set for flows of data in Stream objects.
StructureChangeType - The type of a gst_message_structure_change.
TagFlag - Extra tag flags used when registering tags.
TagMergeMode - The different tag merging modes are basically replace, overwrite and append, but they can be seen from two directions.
TagScope - GstTagScope specifies if a taglist applies to the complete medium or only to one single stream.
TaskState - The different states a task can be in
TocEntryType - The different types of TOC entries (see TocEntry).
TocLoopType - How a TocEntry should be repeated.
TocScope - The scope of a TOC.
TracerValueFlags - Flag that describe the value.
TracerValueScope - Tracing record will contain fields that contain a measured value or extra meta-data.
TypeFindProbability - The probability of the typefind function.
URIType - The different types of URI direction.

Error domains:

CoreError - Core errors are errors inside the core GStreamer library.
LibraryError - Library errors are for errors from the library being used by elements (initializing, finalizing, settings, ...)
ParseError - The different parsing errors that can occur.
PluginError - The plugin loading errors
ResourceError - Resource errors are for any resource used by an element: memory, files, network connections, process space, ... They're typically used by source and sink elements.
StreamError - Stream errors are for anything related to the stream being processed: format errors, media type errors, ... They're typically used by decoders, demuxers, converters, ...
URIError - Different URI-related errors that can occur.

Constants:

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
The same thing as UPSTREAM | DOWNSTREAM.
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
The same thing as UPSTREAM | DOWNSTREAM.
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
Value for Uri.
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 ( compare) is equal to the second one.
public const int VALUE_GREATER_THAN
Indicates that the first value provided to a comparison function ( compare) is greater than the second one.
public const int VALUE_LESS_THAN
Indicates that the first value provided to a comparison function ( compare) is lesser than the second one.
public const int VALUE_UNORDERED
Indicates that the comparison function ( 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-...

Delegates:

public delegate bool BufferForeachMetaFunc (Buffer buffer, out Meta? meta)
A function that will be called from foreach_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)
A function that will be called in filter_and_map_in_place.
public delegate bool CapsForeachFunc (CapsFeatures features, Structure structure)
A function that will be called in @foreach.
public delegate bool CapsMapFunc (CapsFeatures features, Structure structure)
A function that will be called in map_in_place.
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 that yields 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)
Callback prototype used in call_async
public delegate bool ElementForeachPadFunc (Element element, Pad pad)
Function called for each pad when using foreach_sink_pad, foreach_src_pad, or foreach_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)
Callback used by add_probe.
public delegate bool PadQueryFunction (Pad pad, Object? parent, Query query)
The signature of the query function.
public delegate bool PadStickyEventsForeachFunction (Pad pad, Event? event)
Callback used by sticky_events_foreach.
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.
public delegate bool PluginFilter (Plugin plugin)
A function that can be used with e.
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)
A function that will be called in filter_and_map_in_place.
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)
A function that will be called in map_in_place.
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 ()
Task function, see push.
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)
Used by deserialize_with_pspec to parse a non-binary form into the Value.
public delegate string ValueSerializeFunc (Value value1)
Used by serialize to obtain a non-binary form of the Value.

Functions:

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)
Modifies a pointer to a BufferList to point to a different BufferList.
public bool buffer_list_take (ref BufferList old_list, owned BufferList? new_list)
Modifies a pointer to a BufferList to point to a different BufferList.
public CapsFeatures? caps_features_from_string (string features)
Creates a CapsFeatures from a string representation.
public Caps? caps_from_string (string string)
Converts caps from a string representation.
public bool context_replace (ref Context old_context, Context? new_context)
Modifies a pointer to a Context to point to a different 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)
Registers a new DynamicTypeFactory in the registry
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)
Checks if obj is a CapsFeatures
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)
Modifies a pointer to a Message to point to a different 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, ...