gi-gst-1.0.25: GStreamer bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Gst.Objects.ValueList

Description

A fundamental type that describes an unordered list of Value

Synopsis

Exported types

newtype ValueList Source #

Memory-managed wrapper type.

Instances

Instances details
Eq ValueList Source # 
Instance details

Defined in GI.Gst.Objects.ValueList

BoxedPtr ValueList Source # 
Instance details

Defined in GI.Gst.Objects.ValueList

ManagedPtrNewtype ValueList Source # 
Instance details

Defined in GI.Gst.Objects.ValueList

TypedObject ValueList Source # 
Instance details

Defined in GI.Gst.Objects.ValueList

Methods

glibType :: IO GType #

HasParentTypes ValueList Source # 
Instance details

Defined in GI.Gst.Objects.ValueList

type ParentTypes ValueList Source # 
Instance details

Defined in GI.Gst.Objects.ValueList

type ParentTypes ValueList = '[] :: [Type]

class (BoxedPtr o, TypedObject o, IsDescendantOf ValueList o) => IsValueList o Source #

Type class for types which can be safely cast to ValueList, for instance with toValueList.

Instances

Instances details
(BoxedPtr o, TypedObject o, IsDescendantOf ValueList o) => IsValueList o Source # 
Instance details

Defined in GI.Gst.Objects.ValueList

toValueList :: (MonadIO m, IsValueList o) => o -> m ValueList Source #

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

Methods

appendAndTakeValue

valueListAppendAndTakeValue Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> GValue

value: a Value of type GST_TYPE_LIST

-> GValue

appendValue: the value to append

-> m () 

Appends appendValue to the GstValueList in value.

Since: 1.2

appendValue

valueListAppendValue Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> GValue

value: a Value of type GST_TYPE_LIST

-> GValue

appendValue: the value to append

-> m () 

Appends appendValue to the GstValueList in value.

concat

valueListConcat Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> GValue

value1: a Value

-> GValue

value2: a Value

-> m GValue 

Concatenates copies of value1 and value2 into a list. Values that are not of type GST_TYPE_LIST are treated as if they were lists of length 1. dest will be initialized to the type GST_TYPE_LIST.

getSize

valueListGetSize Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> GValue

value: a Value of type GST_TYPE_LIST

-> m Word32

Returns: the number of values

Gets the number of values contained in value.

getValue

valueListGetValue Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> GValue

value: a Value of type GST_TYPE_LIST

-> Word32

index: index of value to get from the list

-> m GValue

Returns: the value at the given index

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

init

valueListInit Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> GValue

value: A zero-filled (uninitialized) Value structure

-> Word32

prealloc: The number of entries to pre-allocate in the list

-> m GValue

Returns: The Value structure that has been passed in

Initializes and pre-allocates a Value of type GST_TYPE_LIST.

Since: 1.18

merge

valueListMerge Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> GValue

value1: a Value

-> GValue

value2: a Value

-> m GValue 

Merges copies of value1 and value2. Values that are not of type GST_TYPE_LIST are treated as if they were lists of length 1.

The result will be put into dest and will either be a list that will not contain any duplicates, or a non-list type (if value1 and value2 were equal).

prependValue

valueListPrependValue Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> GValue

value: a Value of type GST_TYPE_LIST

-> GValue

prependValue: the value to prepend

-> m () 

Prepends prependValue to the GstValueList in value.