gst

func AllocatorRegister ¶

func AllocatorRegister(name string, allocator Allocatorrer)

AllocatorRegister registers the memory allocator with name.

The function takes the following parameters:

• name of the allocator.
• allocator: Allocator.

func BufferGetMaxMemory ¶

func BufferGetMaxMemory() uint

BufferGetMaxMemory gets the maximum amount of memory blocks that a buffer can hold. This is a compile time constant that can be queried with the function.

When more memory blocks are added, existing memory blocks will be merged together to make room for the new block.

The function returns the following values:

• guint: maximum amount of memory blocks that a buffer can hold.

func BufferPoolConfigAddOption ¶

func BufferPoolConfigAddOption(config *Structure, option string)

BufferPoolConfigAddOption enables the option in config. This will instruct the bufferpool to enable the specified option on the buffers that it allocates.

The options supported by pool can be retrieved with gst_buffer_pool_get_options().

The function takes the following parameters:

• config: BufferPool configuration.
• option to add.

func BufferPoolConfigGetAllocator ¶

func BufferPoolConfigGetAllocator(config *Structure) (Allocatorrer, *AllocationParams, bool)

BufferPoolConfigGetAllocator gets the allocator and params from config.

The function takes the following parameters:

• config: BufferPool configuration.

The function returns the following values:

• allocator (optional) or NULL.
• params (optional) or NULL.
• ok: TRUE, if the values are set.

func BufferPoolConfigGetOption ¶

func BufferPoolConfigGetOption(config *Structure, index uint) string

BufferPoolConfigGetOption parses an available config and gets the option at index of the options API array.

The function takes the following parameters:

• config: BufferPool configuration.
• index: position in the option array to read.

The function returns the following values:

• utf8 (optional): option at index.

func BufferPoolConfigHasOption ¶

func BufferPoolConfigHasOption(config *Structure, option string) bool

BufferPoolConfigHasOption checks if config contains option.

The function takes the following parameters:

• config: BufferPool configuration.
• option: option.

The function returns the following values:

• ok: TRUE if the options array contains option.

func BufferPoolConfigNOptions ¶

func BufferPoolConfigNOptions(config *Structure) uint

BufferPoolConfigNOptions retrieves the number of values currently stored in the options array of the config structure.

The function takes the following parameters:

• config: BufferPool configuration.

The function returns the following values:

• guint options array size as a #guint.

func BufferPoolConfigSetAllocator ¶

func BufferPoolConfigSetAllocator(config *Structure, allocator Allocatorrer, params *AllocationParams)

BufferPoolConfigSetAllocator sets the allocator and params on config.

One of allocator and params can be NULL, but not both. When allocator is NULL, the default allocator of the pool will use the values in param to perform its allocation. When param is NULL, the pool will use the provided allocator with its default AllocationParams.

A call to gst_buffer_pool_set_config() can update the allocator and params with the values that it is able to do. Some pools are, for example, not able to operate with different allocators or cannot allocate with the values specified in params. Use gst_buffer_pool_get_config() to get the currently used values.

The function takes the following parameters:

• config: BufferPool configuration.
• allocator (optional): Allocator.
• params (optional): AllocationParams.

func BufferPoolConfigSetParams ¶

func BufferPoolConfigSetParams(config *Structure, caps *Caps, size, minBuffers, maxBuffers uint)

BufferPoolConfigSetParams configures config with the given parameters.

The function takes the following parameters:

• config: BufferPool configuration.
• caps (optional) for the buffers.
• size of each buffer, not including prefix and padding.
• minBuffers: minimum amount of buffers to allocate.
• maxBuffers: maximum amount of buffers to allocate or 0 for unlimited.

func BufferPoolConfigValidateParams ¶

func BufferPoolConfigValidateParams(config *Structure, caps *Caps, size, minBuffers, maxBuffers uint) bool

BufferPoolConfigValidateParams validates that changes made to config are still valid in the context of the expected parameters. This function is a helper that can be used to validate changes made by a pool to a config when gst_buffer_pool_set_config() returns FALSE. This expects that caps haven't changed and that min_buffers aren't lower then what we initially expected. This does not check if options or allocator parameters are still valid, won't check if size have changed, since changing the size is valid to adapt padding.

The function takes the following parameters:

• config: BufferPool configuration.
• caps (optional): excepted caps of buffers.
• size: expected size of each buffer, not including prefix and padding.
• minBuffers: expected minimum amount of buffers to allocate.
• maxBuffers: expect maximum amount of buffers to allocate or 0 for unlimited.

The function returns the following values:

• ok: TRUE, if the parameters are valid in this context.

func ClockIDCompareFunc ¶

func ClockIDCompareFunc(id1, id2 unsafe.Pointer) int

ClockIDCompareFunc compares the two ClockID instances. This function can be used as a GCompareFunc when sorting ids.

The function takes the following parameters:

• id1 (optional): ClockID.
• id2 (optional) to compare with.

The function returns the following values:

• gint: negative value if a < b; zero if a = b; positive value if a > b.

func ClockIDUnschedule ¶

func ClockIDUnschedule(id ClockID)

ClockIDUnschedule cancels an outstanding request with id. This can either be an outstanding async notification or a pending sync notification. After this call, id cannot be used anymore to receive sync or async notifications, you need to create a new ClockID.

The function takes the following parameters:

• id to unschedule.

func ClockIDUsesClock ¶

func ClockIDUsesClock(id ClockID, clock Clocker) bool

ClockIDUsesClock: this function returns whether id uses clock as the underlying clock. clock can be NULL, in which case the return value indicates whether the underlying clock has been freed. If this is the case, the id is no longer usable and should be freed.

The function takes the following parameters:

• id to check.
• clock to compare against.

The function returns the following values:

• ok: whether the clock id uses the same underlying Clock clock.

func ClockIDWait ¶

func ClockIDWait(id ClockID) (ClockTimeDiff, ClockReturn)

ClockIDWait performs a blocking wait on id. id should have been created with gst_clock_new_single_shot_id() or gst_clock_new_periodic_id() and should not have been unscheduled with a call to gst_clock_id_unschedule().

If the jitter argument is not NULL and this function returns T_CLOCK_OK or T_CLOCK_EARLY, it will contain the difference against the clock and the time of id when this method was called. Positive values indicate how late id was relative to the clock (in which case this function will return T_CLOCK_EARLY). Negative values indicate how much time was spent waiting on the clock before this function returned.

The function takes the following parameters:

• id to wait on.

The function returns the following values:

• jitter (optional): pointer that will contain the jitter, can be NULL.
• clockReturn: result of the blocking wait. T_CLOCK_EARLY will be returned if the current clock time is past the time of id, T_CLOCK_OK if id was scheduled in time. T_CLOCK_UNSCHEDULED if id was unscheduled with gst_clock_id_unschedule().

func CoreErrorQuark ¶

func CoreErrorQuark() glib.Quark

The function returns the following values:

func DebugAddRingBufferLogger ¶

func DebugAddRingBufferLogger(maxSizePerThread, threadTimeout uint)

DebugAddRingBufferLogger adds a memory ringbuffer based debug logger that stores up to max_size_per_thread bytes of logs per thread and times out threads after thread_timeout seconds of inactivity.

Logs can be fetched with gst_debug_ring_buffer_logger_get_logs() and the logger can be removed again with gst_debug_remove_ring_buffer_logger(). Only one logger at a time is possible.

The function takes the following parameters:

• maxSizePerThread: maximum size of log per thread in bytes.
• threadTimeout: timeout for threads in seconds.

func DebugBinToDotData ¶

func DebugBinToDotData(bin *Bin, details DebugGraphDetails) string

DebugBinToDotData: to aid debugging applications one can use this method to obtain the whole network of gstreamer elements that form the pipeline into a dot file. This data can be processed with graphviz to get an image.

The function takes the following parameters:

• bin: top-level pipeline that should be analyzed.
• details: type of DebugGraphDetails to use.

The function returns the following values:

• utf8: string containing the pipeline in graphviz dot format.

func DebugBinToDotFile ¶

func DebugBinToDotFile(bin *Bin, details DebugGraphDetails, fileName string)

DebugBinToDotFile: to aid debugging applications one can use this method to write out the whole network of gstreamer elements that form the pipeline into a dot file. This file can be processed with graphviz to get an image.

shell  dot -Tpng -oimage.png graph_lowlevel.dot.

The function takes the following parameters:

• bin: top-level pipeline that should be analyzed.
• details: type of DebugGraphDetails to use.
• fileName: output base filename (e.g. "myplayer").

func DebugBinToDotFileWithTs ¶

func DebugBinToDotFileWithTs(bin *Bin, details DebugGraphDetails, fileName string)

DebugBinToDotFileWithTs: this works like gst_debug_bin_to_dot_file(), but adds the current timestamp to the filename, so that it can be used to take multiple snapshots.

The function takes the following parameters:

• bin: top-level pipeline that should be analyzed.
• details: type of DebugGraphDetails to use.
• fileName: output base filename (e.g. "myplayer").

func DebugConstructTermColor ¶

func DebugConstructTermColor(colorinfo uint) string

DebugConstructTermColor constructs a string that can be used for getting the desired color in color terminals. You need to free the string after use.

The function takes the following parameters:

• colorinfo: color info.

The function returns the following values:

• utf8: string containing the color definition.

func DebugConstructWinColor ¶

func DebugConstructWinColor(colorinfo uint) int

DebugConstructWinColor constructs an integer that can be used for getting the desired color in windows' terminals (cmd.exe). As there is no mean to underline, we simply ignore this attribute.

This function returns 0 on non-windows machines.

The function takes the following parameters:

• colorinfo: color info.

The function returns the following values:

• gint: integer containing the color definition.

func DebugGetStackTrace ¶

func DebugGetStackTrace(flags StackTraceFlags) string

The function takes the following parameters:

• flags: set of StackTraceFlags to determine how the stack trace should look like. Pass T_STACK_TRACE_SHOW_NONE to retrieve a minimal backtrace.

The function returns the following values:

• utf8 (optional): stack trace, if libunwind or glibc backtrace are present, else NULL.

func DebugIsActive ¶

func DebugIsActive() bool

DebugIsActive checks if debugging output is activated.

The function returns the following values:

• ok: TRUE, if debugging is activated.

func DebugIsColored ¶

func DebugIsColored() bool

DebugIsColored checks if the debugging output should be colored.

The function returns the following values:

• ok: TRUE, if the debug output should be colored.

func DebugLevelGetName ¶

func DebugLevelGetName(level DebugLevel) string

DebugLevelGetName: get the string representation of a debugging level.

The function takes the following parameters:

• level to get the name for.

The function returns the following values:

• utf8: name.

func DebugLogLiteral ¶

func DebugLogLiteral(category *DebugCategory, level DebugLevel, file, function string, line int, object *coreglib.Object, messageString string)

DebugLogLiteral logs the given message using the currently registered debugging handlers.

The function takes the following parameters:

• category to log.
• level of the message is in.
• file that emitted the message, usually the __FILE__ identifier.
• function that emitted the message.
• line from that the message was emitted, usually __LINE__.
• object (optional) this message relates to, or NULL if none.
• messageString: message string.

func DebugPrintStackTrace ¶

func DebugPrintStackTrace()

DebugPrintStackTrace: if libunwind, glibc backtrace or DbgHelp are present a stack trace is printed.

func DebugRemoveLogFunctionByData ¶

func DebugRemoveLogFunctionByData(data unsafe.Pointer) uint

DebugRemoveLogFunctionByData removes all registered instances of log functions with the given user data.

The function takes the following parameters:

• data (optional): user data of the log function to remove.

The function returns the following values:

• guint: how many instances of the function were removed.

func DebugRemoveRingBufferLogger ¶

func DebugRemoveRingBufferLogger()

DebugRemoveRingBufferLogger removes any previously added ring buffer logger with gst_debug_add_ring_buffer_logger().

func DebugRingBufferLoggerGetLogs ¶

func DebugRingBufferLoggerGetLogs() []string

DebugRingBufferLoggerGetLogs fetches the current logs per thread from the ring buffer logger. See gst_debug_add_ring_buffer_logger() for details.

The function returns the following values:

• utf8s: NULL-terminated array of strings with the debug output per thread.

func DebugSetActive ¶

func DebugSetActive(active bool)

DebugSetActive: if activated, debugging messages are sent to the debugging handlers. It makes sense to deactivate it for speed issues. > This function is not threadsafe. It makes sense to only call it during initialization.

The function takes the following parameters:

• active: whether to use debugging output or not.

func DebugSetColorMode ¶

func DebugSetColorMode(mode DebugColorMode)

DebugSetColorMode changes the coloring mode for debug output.

This function may be called before gst_init().

The function takes the following parameters:

• mode: coloring mode for debug output. See GstDebugColorMode.

func DebugSetColorModeFromString ¶

func DebugSetColorModeFromString(mode string)

DebugSetColorModeFromString changes the coloring mode for debug output.

This function may be called before gst_init().

The function takes the following parameters:

• mode: coloring mode for debug output. One of the following: "on", "auto", "off", "disable", "unix".

func DebugSetColored ¶

func DebugSetColored(colored bool)

DebugSetColored sets or unsets the use of coloured debugging output. Same as gst_debug_set_color_mode () with the argument being being GST_DEBUG_COLOR_MODE_ON or GST_DEBUG_COLOR_MODE_OFF.

This function may be called before gst_init().

The function takes the following parameters:

• colored: whether to use colored output or not.

func DebugSetDefaultThreshold ¶

func DebugSetDefaultThreshold(level DebugLevel)

DebugSetDefaultThreshold sets the default threshold to the given level and updates all categories to use this threshold.

This function may be called before gst_init().

The function takes the following parameters:

• level to set.

func DebugSetThresholdForName ¶

func DebugSetThresholdForName(name string, level DebugLevel)

DebugSetThresholdForName sets all categories which match the given glob style pattern to the given level.

The function takes the following parameters:

• name of the categories to set.
• level to set them to.

func DebugSetThresholdFromString ¶

func DebugSetThresholdFromString(list string, reset bool)

DebugSetThresholdFromString sets the debug logging wanted in the same form as with the GST_DEBUG environment variable. You can use wildcards such as '*', but note that the order matters when you use wild cards, e.g. "foosrc:6,*src:3,*:2" sets everything to log level 2.

The function takes the following parameters:

• list: comma-separated list of "category:level" pairs to be used as debug logging levels.
• reset: TRUE to clear all previously-set debug levels before setting new thresholds FALSE if adding the threshold described by list to the one already set.

func DebugUnsetThresholdForName ¶

func DebugUnsetThresholdForName(name string)

DebugUnsetThresholdForName resets all categories with the given name back to the default level.

The function takes the following parameters:

• name of the categories to set.

func Deinit ¶

func Deinit()

Deinit: clean up any resources created by GStreamer in gst_init().

It is normally not needed to call this function in a normal application as the resources will automatically be freed when the program terminates. This function is therefore mostly used by testsuites and other memory profiling tools.

After this call GStreamer (including this method) should not be used anymore.

func DeviceProviderRegister ¶

func DeviceProviderRegister(plugin *Plugin, name string, rank uint, typ coreglib.Type) bool

DeviceProviderRegister: create a new device providerfactory capable of instantiating objects of the type and add the factory to plugin.

The function takes the following parameters:

• plugin (optional) to register the device provider with, or NULL for a static device provider.
• name of device providers of this type.
• rank of device provider (higher rank means more importance when autoplugging).
• typ: GType of device provider to register.

The function returns the following values:

• ok: TRUE, if the registering succeeded, FALSE on error.

func DynamicTypeFactoryLoad ¶

func DynamicTypeFactoryLoad(factoryname string) coreglib.Type

The function takes the following parameters:

The function returns the following values:

func DynamicTypeRegister ¶

func DynamicTypeRegister(plugin *Plugin, typ coreglib.Type) bool

DynamicTypeRegister registers a new DynamicTypeFactory in the registry.

The function takes the following parameters:

• plugin to register dyn_type for.
• typ to register dynamically.

The function returns the following values:

func ElementRegister ¶

func ElementRegister(plugin *Plugin, name string, rank uint, typ coreglib.Type) bool

ElementRegister: create a new elementfactory capable of instantiating objects of the type and add the factory to plugin.

The function takes the following parameters:

• plugin (optional) to register the element with, or NULL for a static element.
• name of elements of this type.
• rank of element (higher rank means more importance when autoplugging).
• typ: GType of element to register.

The function returns the following values:

• ok: TRUE, if the registering succeeded, FALSE on error.

func ElementStateChangeReturnGetName ¶

func ElementStateChangeReturnGetName(stateRet StateChangeReturn) string

ElementStateChangeReturnGetName gets a string representing the given state change result.

The function takes the following parameters:

• stateRet to get the name of.

The function returns the following values:

• utf8: string with the name of the state result.

func ElementStateGetName ¶

func ElementStateGetName(state State) string

ElementStateGetName gets a string representing the given state.

The function takes the following parameters:

• state to get the name of.

The function returns the following values:

• utf8: string with the name of the state.

func ElementTypeSetSkipDocumentation ¶

func ElementTypeSetSkipDocumentation(typ coreglib.Type)

ElementTypeSetSkipDocumentation marks type as "documentation should be skipped". Can be useful for dynamically registered element to be excluded from plugin documentation system.

Example:

GType my_type;
GTypeInfo my_type_info;

// Fill "my_type_info"
...

my_type = g_type_register_static (GST_TYPE_MY_ELEMENT, "my-type-name",
   &my_type_info, 0);
gst_element_type_set_skip_documentation (my_type);
gst_element_register (plugin, "my-plugin-feature-name", rank, my_type);.

The function takes the following parameters:

• typ of element.

func ErrorGetMessage ¶

func ErrorGetMessage(domain glib.Quark, code int) string

ErrorGetMessage: get a string describing the error message in the current locale.

The function takes the following parameters:

• domain: GStreamer error domain this error belongs to.
• code: error code belonging to the domain.

The function returns the following values:

• utf8: newly allocated string describing the error message (in UTF-8 encoding).

func EventTypeGetName ¶

func EventTypeGetName(typ EventType) string

EventTypeGetName: get a printable name for the given event type. Do not modify or free.

The function takes the following parameters:

• typ: event type.

The function returns the following values:

• utf8: reference to the static name of the event.

func EventTypeToQuark ¶

func EventTypeToQuark(typ EventType) glib.Quark

EventTypeToQuark: get the unique quark for the given event type.

The function takes the following parameters:

• typ: event type.

The function returns the following values:

• quark associated with the event type.

func FilenameToURI ¶

func FilenameToURI(filename string) (string, error)

FilenameToURI: similar to g_filename_to_uri(), but attempts to handle relative file paths as well. Before converting filename into an URI, it will be prefixed by the current working directory if it is a relative path, and then the path will be canonicalised so that it doesn't contain any './' or '../' segments.

On Windows filename should be in UTF-8 encoding.

The function takes the following parameters:

• filename: absolute or relative file name path.

The function returns the following values:

• utf8: newly-allocated URI string, or NULL on error. The caller must free the URI string with g_free() when no longer needed.

func FlagSetRegister ¶

func FlagSetRegister(flagsType coreglib.Type) coreglib.Type

FlagSetRegister: create a new sub-class of T_TYPE_FLAG_SET which will pretty-print the human-readable flags when serializing, for easier debugging.

The function takes the following parameters:

• flagsType of a TYPE_FLAGS type.

The function returns the following values:

func FlowGetName ¶

func FlowGetName(ret FlowReturn) string

FlowGetName gets a string representing the given flow return.

The function takes the following parameters:

• ret to get the name of.

The function returns the following values:

• utf8: static string with the name of the flow return.

func FlowToQuark ¶

func FlowToQuark(ret FlowReturn) glib.Quark

FlowToQuark: get the unique quark for the given GstFlowReturn.

The function takes the following parameters:

• ret to get the quark of.

The function returns the following values:

• quark associated with the flow return or 0 if an invalid return was specified.

func FormatGetName ¶

func FormatGetName(format Format) string

FormatGetName: get a printable name for the given format. Do not modify or free.

The function takes the following parameters:

• format: Format.

The function returns the following values:

• utf8 (optional): reference to the static name of the format or NULL if the format is unknown.

func FormatToQuark ¶

func FormatToQuark(format Format) glib.Quark

FormatToQuark: get the unique quark for the given format.

The function takes the following parameters:

• format: Format.

The function returns the following values:

• quark associated with the format or 0 if the format is unknown.

func FormatsContains ¶

func FormatsContains(formats []Format, format Format) bool

FormatsContains: see if the given format is inside the format array.

The function takes the following parameters:

• formats: format array to search.
• format to find.

The function returns the following values:

• ok: TRUE if the format is found inside the array.

func GetMainExecutablePath ¶

func GetMainExecutablePath() string

GetMainExecutablePath: this helper is mostly helpful for plugins that need to inspect the folder of the main executable to determine their set of features.

When a plugin is initialized from the gst-plugin-scanner external process, the returned path will be the same as from the parent process.

The function returns the following values:

• utf8 (optional): path of the executable that initialized GStreamer, or NULL if it could not be determined.

func GhostPadActivateModeDefault ¶

func GhostPadActivateModeDefault(pad *Pad, parent GstObjector, mode PadMode, active bool) bool

GhostPadActivateModeDefault: invoke the default activate mode function of a ghost pad.

The function takes the following parameters:

• pad to activate or deactivate.
• parent (optional) of pad or NULL.
• mode: requested activation mode.
• active: whether the pad should be active or not.

The function returns the following values:

• ok: TRUE if the operation was successful.

func GhostPadInternalActivateModeDefault ¶

func GhostPadInternalActivateModeDefault(pad *Pad, parent GstObjector, mode PadMode, active bool) bool

GhostPadInternalActivateModeDefault: invoke the default activate mode function of a proxy pad that is owned by a ghost pad.

The function takes the following parameters:

• pad to activate or deactivate.
• parent (optional) of pad or NULL.
• mode: requested activation mode.
• active: whether the pad should be active or not.

The function returns the following values:

• ok: TRUE if the operation was successful.

func Init ¶

func Init()

Init binds to the gst_init() function. Argument parsing is not supported.

func IsCapsFeatures ¶

func IsCapsFeatures(obj unsafe.Pointer) bool

IsCapsFeatures checks if obj is a CapsFeatures.

The function takes the following parameters:

The function returns the following values:

• ok: TRUE if obj is a CapsFeatures FALSE otherwise.

func IsInitialized ¶

func IsInitialized() bool

IsInitialized: use this function to check if GStreamer has been initialized with gst_init() or gst_init_check().

The function returns the following values:

• ok: TRUE if initialization has been done, FALSE otherwise.

func LibraryErrorQuark ¶

func LibraryErrorQuark() glib.Quark

The function returns the following values:

func MessageTypeGetName ¶

func MessageTypeGetName(typ MessageType) string

MessageTypeGetName: get a printable name for the given message type. Do not modify or free.

The function takes the following parameters:

• typ: message type.

The function returns the following values:

• utf8: reference to the static name of the message.

func MessageTypeToQuark ¶

func MessageTypeToQuark(typ MessageType) glib.Quark

MessageTypeToQuark: get the unique quark for the given message type.

The function takes the following parameters:

• typ: message type.

The function returns the following values:

• quark associated with the message type.

func MetaApiTypeGetTags ¶

func MetaApiTypeGetTags(api coreglib.Type) []string

The function takes the following parameters:

• api: API.

The function returns the following values:

• utf8s: array of tags as strings.

func MetaApiTypeHasTag ¶

func MetaApiTypeHasTag(api coreglib.Type, tag glib.Quark) bool

MetaApiTypeHasTag: check if api was registered with tag.

The function takes the following parameters:

• api: API.
• tag to check.

The function returns the following values:

• ok: TRUE if api was registered with tag.

func MetaApiTypeRegister ¶

func MetaApiTypeRegister(api string, tags []string) coreglib.Type

MetaApiTypeRegister: register and return a GType for the api and associate it with tags.

The function takes the following parameters:

• api: API to register.
• tags for api.

The function returns the following values:

• gType: unique GType for api.

func ObjectCheckUniqueness ¶

func ObjectCheckUniqueness(list []GstObjector, name string) bool

ObjectCheckUniqueness checks to see if there is any object named name in list. This function 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 will lock each Object in the list to compare the name, so be careful when passing a list with a locked object.

The function takes the following parameters:

• list of Object to check through.
• name to search for.

The function returns the following values:

• ok: TRUE if a Object named name does not appear in list, FALSE if it does.

  MT safe. Grabs and releases the LOCK of each object in the list.

func PadLinkGetName ¶

func PadLinkGetName(ret PadLinkReturn) string

PadLinkGetName gets a string representing the given pad-link return.

The function takes the following parameters:

• ret to get the name of.

The function returns the following values:

• utf8: static string with the name of the pad-link return.

func PadModeGetName ¶

func PadModeGetName(mode PadMode) string

PadModeGetName: return the name of a pad mode, for use in debug messages mostly.

The function takes the following parameters:

• mode: pad mode.

The function returns the following values:

• utf8: short mnemonic for pad mode mode.

func ParentBufferMetaApiGetType ¶

func ParentBufferMetaApiGetType() coreglib.Type

The function returns the following values:

func ParseErrorQuark ¶

func ParseErrorQuark() glib.Quark

ParseErrorQuark: get the error quark used by the parsing subsystem.

The function returns the following values:

• quark of the parse errors.

func PluginErrorQuark ¶

func PluginErrorQuark() glib.Quark

PluginErrorQuark: get the error quark.

The function returns the following values:

• quark: error quark used in GError messages.

func PluginFeatureListDebug ¶

func PluginFeatureListDebug(list []PluginFeaturer)

PluginFeatureListDebug: debug the plugin feature names in list.

The function takes the following parameters:

• list of plugin features.

func PluginFeatureRankCompareFunc ¶

func PluginFeatureRankCompareFunc(p1, p2 unsafe.Pointer) int

PluginFeatureRankCompareFunc compares the two given PluginFeature instances. This function can be used as a Func when sorting by rank and then by name.

The function takes the following parameters:

• p1 (optional): PluginFeature.
• p2 (optional): PluginFeature.

The function returns the following values:

• gint: negative value if the rank of p1 > the rank of p2 or the ranks are equal but the name of p1 comes before the name of p2; zero if the rank and names are equal; positive value if the rank of p1 < the rank of p2 or the ranks are equal but the name of p2 comes before the name of p1.

func PluginRegisterStaticFull ¶

func PluginRegisterStaticFull(majorVersion, minorVersion int, name, description string, initFullFunc PluginInitFullFunc, version, license, source, pkg, origin string) bool

PluginRegisterStaticFull registers a static plugin, ie. a plugin which is private to an application or library and contained within the application or library (as opposed to being shipped as a separate module file) with a PluginInitFullFunc which allows user data to be passed to the callback function (useful for bindings).

You must make sure that GStreamer has been initialised (with gst_init() or via gst_init_get_option_group()) before calling this function.

The function takes the following parameters:

• majorVersion: major version number of the GStreamer core that the plugin was compiled for, you can just use GST_VERSION_MAJOR here.
• minorVersion: minor version number of the GStreamer core that the plugin was compiled for, you can just use GST_VERSION_MINOR here.
• name: unique name of the plugin (ideally prefixed with an application- or library-specific namespace prefix in order to avoid name conflicts in case a similar plugin with the same name ever gets added to GStreamer).
• description of the plugin.
• initFullFunc: pointer to the init function with user data of this plugin.
• version string of the plugin.
• license: effective license of plugin. Must be one of the approved licenses (see PluginDesc above) or the plugin will not be registered.
• source module plugin belongs to.
• pkg: shipped package plugin belongs to.
• origin: URL to provider of plugin.

The function returns the following values:

• ok: TRUE if the plugin was registered correctly, otherwise FALSE.

func PresetGetAppDir ¶

func PresetGetAppDir() string

PresetGetAppDir gets the directory for application specific presets if set by the application.

The function returns the following values:

• filename (optional): directory or NULL, don't free or modify the string.

func PresetSetAppDir ¶

func PresetSetAppDir(appDir string) bool

PresetSetAppDir sets an extra directory as an absolute path that should be considered when looking for presets. Any presets in the application dir will shadow the system presets.

The function takes the following parameters:

• appDir: application specific preset dir.

The function returns the following values:

• ok: TRUE for success, FALSE if the dir already has been set.

func ProtectionFilterSystemsByAvailableDecryptors ¶

func ProtectionFilterSystemsByAvailableDecryptors(systemIdentifiers []string) []string

ProtectionFilterSystemsByAvailableDecryptors iterates the supplied list of UUIDs and checks the GstRegistry for all the decryptors supporting one of the supplied UUIDs.

The function takes the following parameters:

• systemIdentifiers: A null terminated array of strings that contains the UUID values of each protection system that is to be checked.

The function returns the following values:

• utf8s (optional): A null terminated array containing all the system_identifiers supported by the set of available decryptors, or NULL if no matches were found.

func ProtectionMetaApiGetType ¶

func ProtectionMetaApiGetType() coreglib.Type

The function returns the following values:

func ProtectionSelectSystem ¶

func ProtectionSelectSystem(systemIdentifiers []string) string

ProtectionSelectSystem iterates the supplied list of UUIDs and checks the GstRegistry for an element that supports one of the supplied UUIDs. If more than one element matches, the system ID of the highest ranked element is selected.

The function takes the following parameters:

• systemIdentifiers: null terminated array of strings that contains the UUID values of each protection system that is to be checked.

The function returns the following values:

• utf8 (optional): one of the strings from system_identifiers that indicates the highest ranked element that implements the protection system indicated by that system ID, or NULL if no element has been found.

func ProxyPadGetrangeDefault ¶

func ProxyPadGetrangeDefault(pad *Pad, parent GstObjector, offset uint64, size uint) (*Buffer, FlowReturn)

ProxyPadGetrangeDefault: invoke the default getrange function of the proxy pad.

The function takes the following parameters:

• pad: src Pad, returns T_FLOW_ERROR if not.
• parent of pad.
• offset: start offset of the buffer.
• size: length of the buffer.

The function returns the following values:

• buffer: pointer to hold the Buffer, returns T_FLOW_ERROR if NULL.
• flowReturn from the pad.

func QueryTypeGetName ¶

func QueryTypeGetName(typ QueryType) string

QueryTypeGetName: get a printable name for the given query type. Do not modify or free.

The function takes the following parameters:

• typ: query type.

The function returns the following values:

• utf8: reference to the static name of the query.

func QueryTypeToQuark ¶

func QueryTypeToQuark(typ QueryType) glib.Quark

QueryTypeToQuark: get the unique quark for the given query type.

The function takes the following parameters:

• typ: query type.

The function returns the following values:

• quark associated with the query type.

func ReferenceTimestampMetaApiGetType ¶

func ReferenceTimestampMetaApiGetType() coreglib.Type

The function returns the following values:

func RegistryForkIsEnabled ¶

func RegistryForkIsEnabled() bool

RegistryForkIsEnabled: by default GStreamer will perform scanning and rebuilding of the registry file using a helper child process.

Applications might want to disable this behaviour with the gst_registry_fork_set_enabled() function, in which case new plugins are scanned (and loaded) into the application process.

The function returns the following values:

• ok: TRUE if GStreamer will use the child helper process when rebuilding the registry.

func RegistryForkSetEnabled ¶

func RegistryForkSetEnabled(enabled bool)

RegistryForkSetEnabled applications might want to disable/enable spawning of a child helper process when rebuilding the registry. See gst_registry_fork_is_enabled() for more information.

The function takes the following parameters:

• enabled: whether rebuilding the registry can use a temporary child helper process.

func ResourceErrorQuark ¶

func ResourceErrorQuark() glib.Quark

The function returns the following values:

func SegtrapIsEnabled ¶

func SegtrapIsEnabled() bool

SegtrapIsEnabled: some functions in the GStreamer core might install a custom SIGSEGV handler to better catch and report errors to the application. Currently this feature is enabled by default when loading plugins.

Applications might want to disable this behaviour with the gst_segtrap_set_enabled() function. This is typically done if the application wants to install its own handler without GStreamer interfering.

The function returns the following values:

• ok: TRUE if GStreamer is allowed to install a custom SIGSEGV handler.

func SegtrapSetEnabled ¶

func SegtrapSetEnabled(enabled bool)

SegtrapSetEnabled applications might want to disable/enable the SIGSEGV handling of the GStreamer core. See gst_segtrap_is_enabled() for more information.

The function takes the following parameters:

• enabled: whether a custom SIGSEGV handler should be installed.

func StateChangeGetName ¶

func StateChangeGetName(transition StateChange) string

StateChangeGetName gets a string representing the given state transition.

The function takes the following parameters:

• transition to get the name of.

The function returns the following values:

• utf8: string with the name of the state result.

func StaticCapsGetType ¶

func StaticCapsGetType() coreglib.Type

The function returns the following values:

func StaticPadTemplateGetType ¶

func StaticPadTemplateGetType() coreglib.Type

The function returns the following values:

func StreamErrorQuark ¶

func StreamErrorQuark() glib.Quark

The function returns the following values:

func StreamTypeGetName ¶

func StreamTypeGetName(stype StreamType) string

StreamTypeGetName: get a descriptive string for a given StreamType.

The function takes the following parameters:

• stype: StreamType.

The function returns the following values:

• utf8: string describing the stream type.

func SystemClockSetDefault ¶

func SystemClockSetDefault(newClock Clocker)

SystemClockSetDefault sets the default system clock that can be obtained with gst_system_clock_obtain().

This is mostly used for testing and debugging purposes when you want to have control over the time reported by the default system clock.

MT safe.

The function takes the following parameters:

• newClock (optional): Clock.

func TaskCleanupAll ¶

func TaskCleanupAll()

TaskCleanupAll: wait for all tasks to be stopped. This is mainly used internally to ensure proper cleanup of internal data structures in test suites.

MT safe.

func TocEntryTypeGetNick ¶

func TocEntryTypeGetNick(typ TocEntryType) string

TocEntryTypeGetNick converts type to a string representation.

The function takes the following parameters:

• typ: TocEntryType.

The function returns the following values:

• utf8 returns a human-readable string for type. This string is only for debugging purpose and should not be displayed in a user interface.

func TracerRegister ¶

func TracerRegister(plugin *Plugin, name string, typ coreglib.Type) bool

TracerRegister: create a new tracer-factory capable of instantiating objects of the type and add the factory to plugin.

The function takes the following parameters:

• plugin (optional) or NULL for a static typefind function.
• name for registering.
• typ: GType of tracer to register.

The function returns the following values:

• ok: TRUE, if the registering succeeded, FALSE on error.

func TypeFindGetType ¶

func TypeFindGetType() coreglib.Type

The function returns the following values:

func TypeFindRegister ¶

func TypeFindRegister(plugin *Plugin, name string, rank uint, fn TypeFindFunction, extensions string, possibleCaps *Caps) bool

TypeFindRegister registers a new typefind function to be used for typefinding. After registering this function will be available for typefinding. This function is typically called during an element's plugin initialization.

The function takes the following parameters:

• plugin (optional) or NULL for a static typefind function.
• name for registering.
• rank (or importance) of this typefind function.
• fn to use.
• extensions (optional): optional comma-separated list of extensions that could belong to this type.
• possibleCaps (optional): optionally the caps that could be returned when typefinding succeeds.

The function returns the following values:

• ok: TRUE on success, FALSE otherwise.

func TypeMarkAsPluginApi ¶

func TypeMarkAsPluginApi(typ coreglib.Type, flags PluginAPIFlags)