gstpbutils.c.types

C types for gstpbutils1 library

alias GstAudioVisualizerShaderFunc GstDiscovererAudioInfoClass GstDiscovererContainerInfoClass GstDiscovererInfoClass GstDiscovererStreamInfoClass GstDiscovererSubtitleInfoClass GstDiscovererVideoInfoClass GstEncodingTargetClass GstInstallPluginsResultFunc
enum GstAudioVisualizerShader GstDiscovererResult GstDiscovererSerializeFlags GstInstallPluginsReturn GstPbUtilsCapsDescriptionFlags
struct GstAudioVisualizer GstAudioVisualizerClass GstAudioVisualizerPrivate GstDiscoverer GstDiscovererAudioInfo GstDiscovererClass GstDiscovererContainerInfo GstDiscovererInfo GstDiscovererPrivate GstDiscovererStreamInfo GstDiscovererSubtitleInfo GstDiscovererVideoInfo GstEncodingAudioProfile GstEncodingAudioProfileClass GstEncodingContainerProfile GstEncodingContainerProfileClass GstEncodingProfile GstEncodingProfileClass GstEncodingTarget GstEncodingVideoProfile GstEncodingVideoProfileClass GstInstallPluginsContext

Types 36

aliasGstDiscovererAudioInfoClass = GObjectClass
aliasGstDiscovererContainerInfoClass = GObjectClass
aliasGstDiscovererInfoClass = GObjectClass
aliasGstDiscovererStreamInfoClass = GObjectClass
aliasGstDiscovererSubtitleInfoClass = GObjectClass
aliasGstDiscovererVideoInfoClass = GObjectClass
aliasGstEncodingTargetClass = GObjectClass
enumGstAudioVisualizerShader

Different types of supported background shading functions.

None = 0no shading
Fade = 1plain fading
FadeAndMoveUp = 2fade and move up
FadeAndMoveDown = 3fade and move down
FadeAndMoveLeft = 4fade and move left
FadeAndMoveRight = 5fade and move right
FadeAndMoveHorizOut = 6fade and move horizontally out
FadeAndMoveHorizIn = 7fade and move horizontally in
FadeAndMoveVertOut = 8fade and move vertically out
FadeAndMoveVertIn = 9fade and move vertically in
enumGstDiscovererResult

Result values for the discovery process.

Ok = 0The discovery was successful
UriInvalid = 1the URI is invalid
Error = 2an error happened and the GError is set
Timeout = 3the discovery timed-out
Busy = 4the discoverer was already discovering a file
MissingPlugins = 5Some plugins are missing for full discovery
enumGstDiscovererSerializeFlags : uint

You can use these flags to control what is serialized by [gstpbutils.discoverer_info.DiscovererInfo.toVariant]

Basic = 0Serialize only basic information, excluding caps, tags and miscellaneous information
Caps = 1Serialize the caps for each stream
Tags = 2Serialize the tags for each stream
Misc = 4Serialize miscellaneous information for each stream
All = 7Serialize all the available info, including caps, tags and miscellaneous information
enumGstInstallPluginsReturn

Result codes returned by [gstpbutils.global.installPluginsAsync] and [gstpbutils.global.installPluginsSync], and also the result code passed to the #GstInstallPluginsResultFunc specified with [gstpbutils.global.installPluginsAsync].

These codes indicate success or failure of starting an external installer program and to what extent the requested plugins could be installed.

Success = 0all of the requested plugins could be installed
NotFound = 1no appropriate installation candidate for any of the requested plugins could be found. Only return this if nothing has been installed. Return #GSTINSTALLPLUGINSPARTIALSUCCESS if some (but not all) ...
Error = 2an error occurred during the installation. If this happens, the user has already seen an error message and another one should not be displayed
PartialSuccess = 3some of the requested plugins could be installed, but not all
UserAbort = 4the user has aborted the installation
Crashed = 100the installer had an unclean exit code (ie. death by signal)
Invalid = 101the helper returned an invalid status code
StartedOk = 200returned by [gstpbutils.global.installPluginsAsync] to indicate that everything went fine so far and the provided callback will be called with the result of the installation later
InternalFailure = 201some internal failure has occurred when trying to start the installer
HelperMissing = 202the helper script to call the actual installer is not installed
InstallInProgress = 203a previously-started plugin installation is still in progress, try again later
enumGstPbUtilsCapsDescriptionFlags : uint

Flags that are returned by [gstpbutils.global.pbUtilsGetCapsDescriptionFlags] and describe the format of the caps.

Container = 1Caps describe a container format.
Audio = 2Caps describe an audio format, or a container format that can store audio.
Video = 4Caps describe an video format, or a container format that can store video.
Image = 8Caps describe an image format, or a container format that can store image.
Subtitle = 16Caps describe an subtitle format, or a container format that can store subtitles.
Tag = 32Container format is a tags container.
Generic = 64Container format can store any kind of stream type.
Metadata = 128Caps describe a metadata format, or a container format that can store metadata.
structGstAudioVisualizer

A baseclass for scopes (visualizers). It takes care of re-fitting the audio-rate to video-rate and handles renegotiation (downstream video size changes).

It also provides several background shading effects. These effects are applied to a previous picture before the render() implementation can draw a new frame.

Fields
GstElement parent
uint reqSpf
GstVideoInfo vinfo
GstAudioInfo ainfo
GstAudioVisualizerPrivate * priv
structGstAudioVisualizerClass
Fields
GstElementClass parentClass
gboolean function(GstAudioVisualizer * scope_) setup
gboolean function(GstAudioVisualizer * scope_, GstBuffer * audio, GstVideoFrame * video) render
gboolean function(GstAudioVisualizer * scope_, GstQuery * query) decideAllocation
structGstAudioVisualizerPrivate
structGstDiscoverer

The #GstDiscoverer is a utility object which allows to get as much information as possible from one or many URIs.

It provides two APIs, allowing usage in blocking or non-blocking mode.

The blocking mode just requires calling [gstpbutils.discoverer.Discoverer.discoverUri] with the URI one wishes to discover.

The non-blocking mode requires a running #GMainLoop iterating a #GMainContext, where one connects to the various signals, appends the URIs to be processed (through [gstpbutils.discoverer.Discoverer.discoverUriAsync]) and then asks for the discovery to begin (through [gstpbutils.discoverer.Discoverer.start]). By default this will use the GLib default main context unless you have set a custom context using [glib.main_context.MainContext.pushThreadDefault].

All the information is returned in a #GstDiscovererInfo structure.

Fields
GObject parent
GstDiscovererPrivate * priv
void *[4] Reserved
structGstDiscovererAudioInfo

#GstDiscovererStreamInfo specific to audio streams.

structGstDiscovererClass
Fields
GObjectClass parentclass
void function(GstDiscoverer * discoverer) finished
void function(GstDiscoverer * discoverer) starting
void function(GstDiscoverer * discoverer, GstDiscovererInfo * info, const(GError) * err) discovered
void function(GstDiscoverer * discoverer, GstElement * source) sourceSetup
GstDiscovererInfo * function(GstDiscoverer * dc, char * uri) loadSerializeInfo
void *[3] Reserved
structGstDiscovererContainerInfo

#GstDiscovererStreamInfo specific to container streams.

structGstDiscovererInfo

Structure containing the information of a URI analyzed by #GstDiscoverer.

structGstDiscovererPrivate
structGstDiscovererStreamInfo

Base structure for information concerning a media stream. Depending on the stream type, one can find more media-specific information in #GstDiscovererAudioInfo, #GstDiscovererVideoInfo, and #GstDiscovererContainerInfo.

The #GstDiscovererStreamInfo represents the topology of the stream. Siblings can be iterated over with [gstpbutils.discoverer_stream_info.DiscovererStreamInfo.getNext] and [gstpbutils.discoverer_stream_info.DiscovererStreamInfo.getPrevious]. Children (sub-streams) of a stream can be accessed using the #GstDiscovererContainerInfo API.

As a simple example, if you run #GstDiscoverer on an AVI file with one audio and one video stream, you will get a #GstDiscovererContainerInfo corresponding to the AVI container, which in turn will have a #GstDiscovererAudioInfo sub-stream and a #GstDiscovererVideoInfo sub-stream for the audio and video streams respectively.

structGstDiscovererSubtitleInfo

#GstDiscovererStreamInfo specific to subtitle streams (this includes text and image based ones).

structGstDiscovererVideoInfo

#GstDiscovererStreamInfo specific to video streams (this includes images).

structGstEncodingAudioProfile

Variant of #GstEncodingProfile for audio streams.

structGstEncodingAudioProfileClass
structGstEncodingContainerProfile

Encoding profiles for containers. Keeps track of a list of #GstEncodingProfile

structGstEncodingContainerProfileClass
structGstEncodingProfile

The opaque base class object for all encoding profiles. This contains generic information like name, description, format and preset.

structGstEncodingProfileClass
structGstEncodingTarget

Collection of #GstEncodingProfile for a specific target or use-case.

When being stored/loaded, targets come from a specific category, like #GST_ENCODING_CATEGORY_DEVICE.

structGstEncodingVideoProfile

Variant of #GstEncodingProfile for video streams, allows specifying the @pass.

structGstEncodingVideoProfileClass
structGstInstallPluginsContext

Opaque context structure for the plugin installation. Use the provided API to set details on it.

aliasGstAudioVisualizerShaderFunc = void function(GstAudioVisualizer * scope_, const(GstVideoFrame) * s, GstVideoFrame * d)
aliasGstInstallPluginsResultFunc = void function(GstInstallPluginsReturn result, void * userData)