Cheese.Effect¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`load_effects` ()
class	`load_from_file` (filename)
class	`new` (name, pipeline_desc)
	`disable_preview` ()
	`enable_preview` ()
	`get_name` ()
	`get_pipeline_desc` ()
	`is_preview_connected` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`control-valve`	`Gst.Element`	r/w	If the control valve is active, the effect is connected to a video stream
`name`	`str`	r/w/co	Name of the effect
`pipeline-desc`	`str`	r/w/co	Description of the GStreamer pipeline associated with the effect

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r
unused	`object`	r

Class Details¶

class Cheese.Effect(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Cheese.EffectClass

Use the accessor functions below.

classmethod load_effects()¶

Returns:: a list of Cheese.Effect, or None if no effects could be found
Return type:: [Cheese.Effect]

Load effects from standard directories, including the user’s data directory.

classmethod load_from_file(filename)¶

Parameters:: filename (str) – name of the file containing the effect specification
Returns:: a Cheese.Effect, or None on error
Return type:: Cheese.Effect

Load effect from file.

classmethod new(name, pipeline_desc)¶

Parameters:

name (str) – name of the effect
pipeline_desc (str) – GStreamer pipeline of the new effect

Returns:

a new Cheese.Effect

Return type:

Cheese.Effect

Create a new Cheese.Effect.

disable_preview()¶: Disable the preview of a Cheese.Effect.

enable_preview()¶: Enable the preview of a Cheese.Effect.

get_name()¶

Returns:: the human-readable name of the effect.
Return type:: str

Get the human-readable name of the self.

get_pipeline_desc()¶

Returns:: the Gstreamer pipeline description of the effect.
Return type:: str

Get the Gstreamer pipeline description of the self.

is_preview_connected()¶

Returns:: True if the preview is connected, False otherwise.
Return type:: bool

Get whether the self is connected to a video stream, for previews.

Property Details¶

Cheese.Effect.props.control_valve¶

Name:: control-valve
Type:: Gst.Element
Default Value:: None
Flags:: READABLE, WRITABLE

If the control valve is active, then the effect is currently connected to a video stream, for previews.

Cheese.Effect.props.name¶

Name:: name
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Name of the effect, for display in a UI.

Cheese.Effect.props.pipeline_desc¶

Name:: pipeline-desc
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Description of the GStreamer pipeline associated with the effect.