Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Gst.Objects.ValueArray

Contents

Exported types
Methods

Description

A fundamental type that describes an ordered list of Value

Synopsis

newtype ValueArray = ValueArray (ManagedPtr ValueArray)
class (BoxedPtr o, TypedObject o, IsDescendantOf ValueArray o) => IsValueArray o
toValueArray :: (MonadIO m, IsValueArray o) => o -> m ValueArray
valueArrayAppendAndTakeValue :: (HasCallStack, MonadIO m) => GValue -> GValue -> m ()
valueArrayAppendValue :: (HasCallStack, MonadIO m) => GValue -> GValue -> m ()
valueArrayGetSize :: (HasCallStack, MonadIO m) => GValue -> m Word32
valueArrayGetValue :: (HasCallStack, MonadIO m) => GValue -> Word32 -> m GValue
valueArrayInit :: (HasCallStack, MonadIO m) => GValue -> Word32 -> m GValue
valueArrayPrependValue :: (HasCallStack, MonadIO m) => GValue -> GValue -> m ()

Exported types

newtype ValueArray Source #

Memory-managed wrapper type.

Constructors

ValueArray (ManagedPtr ValueArray)

Instances

Instances details

Eq ValueArray Source #
Instance details Defined in GI.Gst.Objects.ValueArray Methods (==) :: ValueArray -> ValueArray -> Bool # (/=) :: ValueArray -> ValueArray -> Bool #
BoxedPtr ValueArray Source #
Instance details Defined in GI.Gst.Objects.ValueArray Methods boxedPtrCopy :: ValueArray -> IO ValueArray boxedPtrFree :: ValueArray -> IO ()
ManagedPtrNewtype ValueArray Source #
Instance details Defined in GI.Gst.Objects.ValueArray Methods toManagedPtr :: ValueArray -> ManagedPtr ValueArray
TypedObject ValueArray Source #
Instance details Defined in GI.Gst.Objects.ValueArray Methods glibType :: IO GType
HasParentTypes ValueArray Source #
Instance details Defined in GI.Gst.Objects.ValueArray
type ParentTypes ValueArray Source #
Instance details Defined in GI.Gst.Objects.ValueArray type ParentTypes ValueArray = '[] :: [Type]

class (BoxedPtr o, TypedObject o, IsDescendantOf ValueArray o) => IsValueArray o Source #

Type class for types which can be safely cast to ValueArray, for instance with toValueArray.

Instances

Instances details

(BoxedPtr o, TypedObject o, IsDescendantOf ValueArray o) => IsValueArray o Source #
Instance details Defined in GI.Gst.Objects.ValueArray

toValueArray :: (MonadIO m, IsValueArray o) => o -> m ValueArray Source #

Cast to ValueArray, for types for which this is known to be safe. For general casts, use castTo.

Methods

appendAndTakeValue

valueArrayAppendAndTakeValue Source #

Arguments

:: (HasCallStack, MonadIO m)
=> GValue	`value`: a `Value` of type `GST_TYPE_ARRAY`
-> GValue	`appendValue`: the value to append
-> m ()

Appends appendValue to the GstValueArray in value.

Since: 1.2

appendValue

valueArrayAppendValue Source #

Arguments

:: (HasCallStack, MonadIO m)
=> GValue	`value`: a `Value` of type `GST_TYPE_ARRAY`
-> GValue	`appendValue`: the value to append
-> m ()

Appends appendValue to the GstValueArray in value.

getSize

valueArrayGetSize Source #

Arguments

:: (HasCallStack, MonadIO m)
=> GValue	`value`: a `Value` of type `GST_TYPE_ARRAY`
-> m Word32	Returns: the number of values

Gets the number of values contained in value.

getValue

valueArrayGetValue Source #

Arguments

:: (HasCallStack, MonadIO m)
=> GValue	`value`: a `Value` of type `GST_TYPE_ARRAY`
-> Word32	`index`: index of value to get from the array
-> m GValue	Returns: the value at the given index

Gets the value that is a member of the array contained in value and has the index index.

init

valueArrayInit Source #

Arguments

:: (HasCallStack, MonadIO m)
=> GValue	`value`: A zero-filled (uninitialized) `Value` structure
-> Word32	`prealloc`: The number of entries to pre-allocate in the array
-> m GValue	Returns: The `Value` structure that has been passed in

Initializes and pre-allocates a Value of type GST_TYPE_ARRAY.

Since: 1.18

prependValue

valueArrayPrependValue Source #

Arguments

:: (HasCallStack, MonadIO m)
=> GValue	`value`: a `Value` of type `GST_TYPE_ARRAY`
-> GValue	`prependValue`: the value to prepend
-> m ()

Prepends prependValue to the GstValueArray in value.