Enums

Details

class GstPbutils.AudioVisualizerShader(value)

Bases: GObject.GEnum

Different types of supported background shading functions.

NONE = 0

no shading

FADE = 1

plain fading

FADE_AND_MOVE_UP = 2

fade and move up

FADE_AND_MOVE_DOWN = 3

fade and move down

FADE_AND_MOVE_LEFT = 4

fade and move left

FADE_AND_MOVE_RIGHT = 5

fade and move right

FADE_AND_MOVE_HORIZ_OUT = 6

fade and move horizontally out

FADE_AND_MOVE_HORIZ_IN = 7

fade and move horizontally in

FADE_AND_MOVE_VERT_OUT = 8

fade and move vertically out

FADE_AND_MOVE_VERT_IN = 9

fade and move vertically in

class GstPbutils.DiscovererResult(value)

Bases: GObject.GEnum

Result values for the discovery process.

OK = 0

The discovery was successful

URI_INVALID = 1

the URI is invalid

ERROR = 2

an error happened and the GLib.Error is set

TIMEOUT = 3

the discovery timed-out

BUSY = 4

the discoverer was already discovering a file

MISSING_PLUGINS = 5

Some plugins are missing for full discovery

class GstPbutils.InstallPluginsReturn(value)

Bases: GObject.GEnum

Result codes returned by GstPbutils.install_plugins_async() and GstPbutils.install_plugins_sync(), and also the result code passed to the GstPbutils.InstallPluginsResultFunc specified with GstPbutils.install_plugins_async().

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

classmethod get_name(ret)[source]
Parameters:

ret (GstPbutils.InstallPluginsReturn) – the return status code

Returns:

a descriptive string for the status code in ret

Return type:

str

Convenience function to return the descriptive string associated with a status code. This function returns English strings and should not be used for user messages. It is here only to assist in debugging.

SUCCESS = 0

all of the requested plugins could be installed

NOT_FOUND = 1

no appropriate installation candidate for any of the requested plugins could be found. Only return this if nothing has been installed. Return GstPbutils.InstallPluginsReturn.PARTIAL_SUCCESS if some (but not all) of the requested plugins could be installed.

CRASHED = 100

the installer had an unclean exit code (ie. death by signal)

INVALID = 101

the helper returned an invalid status code

ERROR = 2

an error occurred during the installation. If this happens, the user has already seen an error message and another one should not be displayed

STARTED_OK = 200

returned by GstPbutils.install_plugins_async() to indicate that everything went fine so far and the provided callback will be called with the result of the installation later

INTERNAL_FAILURE = 201

some internal failure has occurred when trying to start the installer

HELPER_MISSING = 202

the helper script to call the actual installer is not installed

INSTALL_IN_PROGRESS = 203

a previously-started plugin installation is still in progress, try again later

PARTIAL_SUCCESS = 3

some of the requested plugins could be installed, but not all

USER_ABORT = 4

the user has aborted the installation