GI.Gst.Objects.Device

Device are objects representing a device, they contain relevant metadata about the device, such as its class and the Caps representing the media types it can produce or handle.

Device are created by DeviceProvider objects which can be aggregated by DeviceMonitor objects.

Exported types

newtype Device

Constructors

Device (ManagedPtr Device)

Instances

GObject Device

Methods

gobjectType :: Device -> IO GType

IsObject Device

IsObject Device

IsDevice Device

class GObject o => IsDevice o

Instances

(GObject a, UnknownAncestorError Constraint Device a) => IsDevice a

IsDevice Device

toDevice :: (MonadIO m, IsDevice o) => o -> m Device

noDevice :: Maybe Device

Methods

createElement

deviceCreateElement

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> Maybe Text

name: name of new element, or Nothing to automatically create a unique name.

-> m Element

Returns: a new Element configured to use this device

Creates the element with all of the required parameters set to use this device.

Since: 1.4

getCaps

deviceGetCaps

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m Caps

Returns: The Caps supported by this device. Unref with gst_caps_unref() when done.

Getter for the Caps that this device supports.

Since: 1.4

getDeviceClass

deviceGetDeviceClass

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m Text

Returns: The device class. Free with free after use.

Gets the "class" of a device. This is a "/" separated list of classes that represent this device. They are a subset of the classes of the DeviceProvider that produced this device.

Since: 1.4

getDisplayName

deviceGetDisplayName

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m Text

Returns: The device name. Free with free after use.

Gets the user-friendly name of the device.

Since: 1.4

getProperties

deviceGetProperties

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> m Structure

Returns: The extra properties or Nothing when there are none. Free with structureFree after use.

Gets the extra properties of a device.

Since: 1.6

hasClasses

deviceHasClasses

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> Text

classes: a "/"-separated list of device classes to match, only match if all classes are matched

-> m Bool

Returns: True if device matches.

Check if device matches all of the given classes

Since: 1.4

hasClassesv

deviceHasClassesv

Arguments

:: (HasCallStack, MonadIO m, IsDevice a)

=> a

device: a Device

-> [Text]

classes: a Nothing terminated array of classes to match, only match if all classes are matched

-> m Bool

Returns: True if device matches.

Check if factory matches all of the given classes

Since: 1.4

reconfigureElement

deviceReconfigureElement

Arguments

:: (HasCallStack, MonadIO m, IsDevice a, IsElement b)

=> a

device: a Device

-> b

element: a Element

-> m Bool

Returns: True if the element could be reconfigured to use this device, False otherwise.

Tries to reconfigure an existing element to use the device. If this function fails, then one must destroy the element and create a new one using deviceCreateElement.

Note: This should only be implemented for elements can change their device in the PLAYING state.

Since: 1.4

Properties

caps

constructDeviceCaps :: IsDevice o => Caps -> IO (GValueConstruct o)

getDeviceCaps :: (MonadIO m, IsDevice o) => o -> m (Maybe Caps)

deviceClass

constructDeviceDeviceClass :: IsDevice o => Text -> IO (GValueConstruct o)

getDeviceDeviceClass :: (MonadIO m, IsDevice o) => o -> m (Maybe Text)

displayName

constructDeviceDisplayName :: IsDevice o => Text -> IO (GValueConstruct o)

getDeviceDisplayName :: (MonadIO m, IsDevice o) => o -> m (Maybe Text)

properties

constructDeviceProperties :: IsDevice o => Structure -> IO (GValueConstruct o)

getDeviceProperties :: (MonadIO m, IsDevice o) => o -> m (Maybe Structure)

Signals

removed

type C_DeviceRemovedCallback = Ptr () -> Ptr () -> IO ()

type DeviceRemovedCallback = IO ()

afterDeviceRemoved :: (IsDevice a, MonadIO m) => a -> DeviceRemovedCallback -> m SignalHandlerId

genClosure_DeviceRemoved :: DeviceRemovedCallback -> IO Closure

mk_DeviceRemovedCallback :: C_DeviceRemovedCallback -> IO (FunPtr C_DeviceRemovedCallback)

noDeviceRemovedCallback :: Maybe DeviceRemovedCallback

onDeviceRemoved :: (IsDevice a, MonadIO m) => a -> DeviceRemovedCallback -> m SignalHandlerId

wrap_DeviceRemovedCallback :: DeviceRemovedCallback -> Ptr () -> Ptr () -> IO ()