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

((~) * info (ResolveDeviceMethod t Device), MethodInfo * info Device p) => IsLabel t (Device -> p)

Methods

fromLabel :: Proxy# Symbol t -> Device -> p

((~) * info (ResolveDeviceMethod t Device), MethodInfo * info Device p) => IsLabelProxy t (Device -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Device -> p

HasAttributeList * Device

type AttributeList Device

type AttributeList Device

type SignalList Device

type SignalList Device

class GObject o => IsDevice o

Instances

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

IsDevice Device

toDevice :: IsDevice o => o -> IO Device

noDevice :: Maybe Device

Methods

createElement

data DeviceCreateElementMethodInfo

Instances

((~) * signature (Maybe Text -> m Element), MonadIO m, IsDevice a) => MethodInfo * DeviceCreateElementMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DeviceCreateElementMethodInfo a -> signature -> s

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

data DeviceGetCapsMethodInfo

Instances

((~) * signature (m Caps), MonadIO m, IsDevice a) => MethodInfo * DeviceGetCapsMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DeviceGetCapsMethodInfo a -> signature -> s

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

data DeviceGetDeviceClassMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsDevice a) => MethodInfo * DeviceGetDeviceClassMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DeviceGetDeviceClassMethodInfo a -> signature -> s

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

data DeviceGetDisplayNameMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsDevice a) => MethodInfo * DeviceGetDisplayNameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DeviceGetDisplayNameMethodInfo a -> signature -> s

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

data DeviceGetPropertiesMethodInfo

Instances

((~) * signature (m Structure), MonadIO m, IsDevice a) => MethodInfo * DeviceGetPropertiesMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DeviceGetPropertiesMethodInfo a -> signature -> s

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

data DeviceHasClassesMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m, IsDevice a) => MethodInfo * DeviceHasClassesMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DeviceHasClassesMethodInfo a -> signature -> s

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

data DeviceHasClassesvMethodInfo

Instances

((~) * signature ([Text] -> m Bool), MonadIO m, IsDevice a) => MethodInfo * DeviceHasClassesvMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DeviceHasClassesvMethodInfo a -> signature -> s

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

data DeviceReconfigureElementMethodInfo

Instances

((~) * signature (b -> m Bool), MonadIO m, IsDevice a, IsElement b) => MethodInfo * DeviceReconfigureElementMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DeviceReconfigureElementMethodInfo a -> signature -> s

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

data DeviceCapsPropertyInfo

Instances

AttrInfo DeviceCapsPropertyInfo

Associated Types

type AttrAllowedOps DeviceCapsPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint DeviceCapsPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint DeviceCapsPropertyInfo :: * -> Constraint

type AttrGetType DeviceCapsPropertyInfo :: *

type AttrLabel DeviceCapsPropertyInfo :: Symbol

type AttrOrigin DeviceCapsPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint DeviceCapsPropertyInfo o => Proxy * DeviceCapsPropertyInfo -> o -> IO (AttrGetType DeviceCapsPropertyInfo)

attrSet :: (AttrBaseTypeConstraint DeviceCapsPropertyInfo o, AttrSetTypeConstraint DeviceCapsPropertyInfo b) => Proxy * DeviceCapsPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint DeviceCapsPropertyInfo o => Proxy * DeviceCapsPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint DeviceCapsPropertyInfo o, AttrSetTypeConstraint DeviceCapsPropertyInfo b) => Proxy * DeviceCapsPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin DeviceCapsPropertyInfo

type AttrOrigin DeviceCapsPropertyInfo = Device

type AttrLabel DeviceCapsPropertyInfo

type AttrLabel DeviceCapsPropertyInfo = "caps"

type AttrGetType DeviceCapsPropertyInfo

type AttrGetType DeviceCapsPropertyInfo = Maybe Caps

type AttrBaseTypeConstraint DeviceCapsPropertyInfo

type AttrBaseTypeConstraint DeviceCapsPropertyInfo = IsDevice

type AttrSetTypeConstraint DeviceCapsPropertyInfo

type AttrSetTypeConstraint DeviceCapsPropertyInfo = * ~ Caps

type AttrAllowedOps DeviceCapsPropertyInfo

type AttrAllowedOps DeviceCapsPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

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

deviceCaps :: AttrLabelProxy "caps"

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

deviceClass

data DeviceDeviceClassPropertyInfo

Instances

AttrInfo DeviceDeviceClassPropertyInfo

Associated Types

type AttrAllowedOps DeviceDeviceClassPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint DeviceDeviceClassPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint DeviceDeviceClassPropertyInfo :: * -> Constraint

type AttrGetType DeviceDeviceClassPropertyInfo :: *

type AttrLabel DeviceDeviceClassPropertyInfo :: Symbol

type AttrOrigin DeviceDeviceClassPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint DeviceDeviceClassPropertyInfo o => Proxy * DeviceDeviceClassPropertyInfo -> o -> IO (AttrGetType DeviceDeviceClassPropertyInfo)

attrSet :: (AttrBaseTypeConstraint DeviceDeviceClassPropertyInfo o, AttrSetTypeConstraint DeviceDeviceClassPropertyInfo b) => Proxy * DeviceDeviceClassPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint DeviceDeviceClassPropertyInfo o => Proxy * DeviceDeviceClassPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint DeviceDeviceClassPropertyInfo o, AttrSetTypeConstraint DeviceDeviceClassPropertyInfo b) => Proxy * DeviceDeviceClassPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin DeviceDeviceClassPropertyInfo

type AttrOrigin DeviceDeviceClassPropertyInfo = Device

type AttrLabel DeviceDeviceClassPropertyInfo

type AttrLabel DeviceDeviceClassPropertyInfo = "device-class"

type AttrGetType DeviceDeviceClassPropertyInfo

type AttrGetType DeviceDeviceClassPropertyInfo = Maybe Text

type AttrBaseTypeConstraint DeviceDeviceClassPropertyInfo

type AttrBaseTypeConstraint DeviceDeviceClassPropertyInfo = IsDevice

type AttrSetTypeConstraint DeviceDeviceClassPropertyInfo

type AttrSetTypeConstraint DeviceDeviceClassPropertyInfo = * ~ Text

type AttrAllowedOps DeviceDeviceClassPropertyInfo

type AttrAllowedOps DeviceDeviceClassPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

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

deviceDeviceClass :: AttrLabelProxy "deviceClass"

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

displayName

data DeviceDisplayNamePropertyInfo

Instances

AttrInfo DeviceDisplayNamePropertyInfo

Associated Types

type AttrAllowedOps DeviceDisplayNamePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint DeviceDisplayNamePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint DeviceDisplayNamePropertyInfo :: * -> Constraint

type AttrGetType DeviceDisplayNamePropertyInfo :: *

type AttrLabel DeviceDisplayNamePropertyInfo :: Symbol

type AttrOrigin DeviceDisplayNamePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint DeviceDisplayNamePropertyInfo o => Proxy * DeviceDisplayNamePropertyInfo -> o -> IO (AttrGetType DeviceDisplayNamePropertyInfo)

attrSet :: (AttrBaseTypeConstraint DeviceDisplayNamePropertyInfo o, AttrSetTypeConstraint DeviceDisplayNamePropertyInfo b) => Proxy * DeviceDisplayNamePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint DeviceDisplayNamePropertyInfo o => Proxy * DeviceDisplayNamePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint DeviceDisplayNamePropertyInfo o, AttrSetTypeConstraint DeviceDisplayNamePropertyInfo b) => Proxy * DeviceDisplayNamePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin DeviceDisplayNamePropertyInfo

type AttrOrigin DeviceDisplayNamePropertyInfo = Device

type AttrLabel DeviceDisplayNamePropertyInfo

type AttrLabel DeviceDisplayNamePropertyInfo = "display-name"

type AttrGetType DeviceDisplayNamePropertyInfo

type AttrGetType DeviceDisplayNamePropertyInfo = Maybe Text

type AttrBaseTypeConstraint DeviceDisplayNamePropertyInfo

type AttrBaseTypeConstraint DeviceDisplayNamePropertyInfo = IsDevice

type AttrSetTypeConstraint DeviceDisplayNamePropertyInfo

type AttrSetTypeConstraint DeviceDisplayNamePropertyInfo = * ~ Text

type AttrAllowedOps DeviceDisplayNamePropertyInfo

type AttrAllowedOps DeviceDisplayNamePropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

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

deviceDisplayName :: AttrLabelProxy "displayName"

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

properties

data DevicePropertiesPropertyInfo

Instances

AttrInfo DevicePropertiesPropertyInfo

Associated Types

type AttrAllowedOps DevicePropertiesPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint DevicePropertiesPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint DevicePropertiesPropertyInfo :: * -> Constraint

type AttrGetType DevicePropertiesPropertyInfo :: *

type AttrLabel DevicePropertiesPropertyInfo :: Symbol

type AttrOrigin DevicePropertiesPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint DevicePropertiesPropertyInfo o => Proxy * DevicePropertiesPropertyInfo -> o -> IO (AttrGetType DevicePropertiesPropertyInfo)

attrSet :: (AttrBaseTypeConstraint DevicePropertiesPropertyInfo o, AttrSetTypeConstraint DevicePropertiesPropertyInfo b) => Proxy * DevicePropertiesPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint DevicePropertiesPropertyInfo o => Proxy * DevicePropertiesPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint DevicePropertiesPropertyInfo o, AttrSetTypeConstraint DevicePropertiesPropertyInfo b) => Proxy * DevicePropertiesPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin DevicePropertiesPropertyInfo

type AttrOrigin DevicePropertiesPropertyInfo = Device

type AttrLabel DevicePropertiesPropertyInfo

type AttrLabel DevicePropertiesPropertyInfo = "properties"

type AttrGetType DevicePropertiesPropertyInfo

type AttrGetType DevicePropertiesPropertyInfo = Maybe Structure

type AttrBaseTypeConstraint DevicePropertiesPropertyInfo

type AttrBaseTypeConstraint DevicePropertiesPropertyInfo = IsDevice

type AttrSetTypeConstraint DevicePropertiesPropertyInfo

type AttrSetTypeConstraint DevicePropertiesPropertyInfo = * ~ Structure

type AttrAllowedOps DevicePropertiesPropertyInfo

type AttrAllowedOps DevicePropertiesPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

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

deviceProperties :: AttrLabelProxy "properties"

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

Signals

removed

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

type DeviceRemovedCallback = IO ()

data DeviceRemovedSignalInfo

Instances

SignalInfo DeviceRemovedSignalInfo

Associated Types

type HaskellCallbackType DeviceRemovedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o DeviceRemovedSignalInfo -> o -> HaskellCallbackType DeviceRemovedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType DeviceRemovedSignalInfo

type HaskellCallbackType DeviceRemovedSignalInfo = DeviceRemovedCallback

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 ()