Cheese.CameraDevice

g Cheese.CameraDevice Cheese.CameraDevice GObject.GInterface GObject.GInterface Gio.Initable Gio.Initable GObject.GInterface->Gio.Initable GObject.Object GObject.Object GObject.Object->Cheese.CameraDevice Gio.Initable->Cheese.CameraDevice

Subclasses:

None

Methods

Inherited:

GObject.Object (37), Gio.Initable (2)

Structs:

GObject.ObjectClass (5)

class

new (device)

class

supported_format_caps ()

get_best_format ()

get_caps_for_format (format)

get_format_list ()

get_name ()

get_path ()

get_src ()

Virtual Methods

Inherited:

GObject.Object (7), Gio.Initable (1)

Properties

Name

Type

Flags

Short Description

device

Gst.Device

r/w/co

The GStreamer device object of the video capture device

name

str

r/w/co

Human-readable name of the video capture device

path

str

r/w/co

Path of the video capture device

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.CameraDevice(**kwargs)
Bases:

GObject.Object, Gio.Initable

Abstract:

No

Structure:

Cheese.CameraDeviceClass

Use the accessor functions below.

classmethod new(device)
Parameters:

device (Gst.Device) – The GStreamer the device, as supplied by Gst.DeviceMonitor

Raises:

GLib.Error

Returns:

a new Cheese.CameraDevice, or None

Return type:

Cheese.CameraDevice

Tries to create a new Cheese.CameraDevice with the supplied device. If construction fails, None is returned, and error is set.

classmethod supported_format_caps()
Returns:

the Gst.Caps

Return type:

Gst.Caps

Get the Gst.Caps that are supported for all Cheese.CameraDevice

get_best_format()
Returns:

the highest-resolution supported Cheese.VideoFormat

Return type:

Cheese.VideoFormat

Get the Cheese.VideoFormat with the highest resolution with a width greater than 640 pixels and a framerate of greater than 15 FPS for this self. If no such format is found, get the highest available resolution instead.

get_caps_for_format(format)
Parameters:

format (Cheese.VideoFormat) – a Cheese.VideoFormat

Returns:

the Gst.Caps for the given format

Return type:

Gst.Caps

Get the Gst.Caps for the given format on the self.

get_format_list()
Returns:

list of Cheese.VideoFormat

Return type:

[Cheese.VideoFormat]

Get the sorted list of Cheese.VideoFormat that the self supports.

get_name()
Returns:

the human-readable name of the video capture device

Return type:

str

Get a human-readable name for the device, as reported by udev, which is suitable for display to a user.

get_path()
Returns:

the path of the video capture device

Return type:

str

Get path for the device, as reported by udev.

get_src()
Returns:

the source GStreamer element

Return type:

Gst.Element

Get the source GStreamer element for the self.

Property Details

Cheese.CameraDevice.props.device
Name:

device

Type:

Gst.Device

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

GStreamer device object of the video capture device.

Cheese.CameraDevice.props.name
Name:

name

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

Human-readable name of the video capture device, for display to the user.

Cheese.CameraDevice.props.path
Name:

path

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

Path of the video capture device.