gi-gst-1.0.11: GStreamer bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gst.Callbacks

Contents

Description

 

Synopsis

Signals

BufferForeachMetaFunc

dynamic_BufferForeachMetaFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_BufferForeachMetaFunc 
-> Buffer

buffer: a Buffer

-> Ptr ()

userData: user data passed to bufferForeachMeta

-> m (Bool, Maybe Meta)

Returns: False when bufferForeachMeta should stop

BufferListFunc

dynamic_BufferListFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_BufferListFunc 
-> Word32

idx: the index of buffer

-> Ptr ()

userData: user data passed to bufferListForeach

-> m (Bool, Maybe Buffer)

Returns: False when bufferListForeach should stop

BusFunc

type C_BusFunc = Ptr Bus -> Ptr Message -> Ptr () -> IO CInt Source #

dynamic_BusFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsBus a) 
=> FunPtr C_BusFunc 
-> a

bus: the Bus that sent the message

-> Message

message: the Message

-> Ptr ()

userData: user data that has been given, when registering the handler

-> m Bool

Returns: False if the event source should be removed.

BusSyncHandler

dynamic_BusSyncHandler Source #

Arguments

:: (HasCallStack, MonadIO m, IsBus a) 
=> FunPtr C_BusSyncHandler 
-> a

bus: the Bus that sent the message

-> Message

message: the Message

-> Ptr ()

userData: user data that has been given, when registering the handler

-> m BusSyncReply

Returns: BusSyncReply stating what to do with the message

CapsFilterMapFunc

dynamic_CapsFilterMapFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_CapsFilterMapFunc 
-> CapsFeatures

features: the CapsFeatures

-> Structure

structure: the Structure

-> Ptr ()

userData: user data

-> m Bool

Returns: True if the features and structure should be preserved, False if it should be removed.

CapsForeachFunc

dynamic_CapsForeachFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_CapsForeachFunc 
-> CapsFeatures

features: the CapsFeatures

-> Structure

structure: the Structure

-> Ptr ()

userData: user data

-> m Bool

Returns: True if the foreach operation should continue, False if the foreach operation should stop with False.

CapsMapFunc

dynamic_CapsMapFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_CapsMapFunc 
-> CapsFeatures

features: the CapsFeatures

-> Structure

structure: the Structure

-> Ptr ()

userData: user data

-> m Bool

Returns: True if the map operation should continue, False if the map operation should stop with False.

ClockCallback

type C_ClockCallback = Ptr Clock -> Word64 -> Ptr () -> Ptr () -> IO CInt Source #

dynamic_ClockCallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsClock a) 
=> FunPtr C_ClockCallback 
-> a

clock: The clock that triggered the callback

-> Word64

time: The time it was triggered

-> Ptr ()

id: The GstClockID that expired

-> Ptr ()

userData: user data passed in the clockIdWaitAsync function

-> m Bool

Returns: True or False (currently unused)

ControlBindingConvert

ControlSourceGetValue

dynamic_ControlSourceGetValue Source #

Arguments

:: (HasCallStack, MonadIO m, IsControlSource a) 
=> FunPtr C_ControlSourceGetValue 
-> a

self: the ControlSource instance

-> Word64

timestamp: timestamp for which a value should be calculated

-> Double

value: a value which will be set to the result.

-> m Bool

Returns: True if the value was successfully calculated.

ControlSourceGetValueArray

dynamic_ControlSourceGetValueArray Source #

Arguments

:: (HasCallStack, MonadIO m, IsControlSource a) 
=> FunPtr C_ControlSourceGetValueArray 
-> a

self: the ControlSource instance

-> Word64

timestamp: timestamp for which a value should be calculated

-> Word64

interval: the time spacing between subsequent values

-> Word32

nValues: the number of values

-> Double

values: array to put control-values in

-> m Bool

Returns: True if the values were successfully calculated.

DebugFuncPtr

ElementCallAsyncFunc

IteratorCopyFunction

dynamic_IteratorCopyFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_IteratorCopyFunction 
-> Iterator

it: The original iterator

-> Iterator

copy: The copied iterator

-> m () 

IteratorFoldFunction

dynamic_IteratorFoldFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_IteratorFoldFunction 
-> GValue

item: the item to fold

-> GValue

ret: a Value collecting the result

-> Ptr ()

userData: data passed to iteratorFold

-> m Bool

Returns: True if the fold should continue, False if it should stop.

IteratorForeachFunction

dynamic_IteratorForeachFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_IteratorForeachFunction 
-> GValue

item: The item

-> Ptr ()

userData: User data

-> m () 

IteratorFreeFunction

IteratorItemFunction

dynamic_IteratorItemFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_IteratorItemFunction 
-> Iterator

it: the iterator

-> GValue

item: the item being retrieved.

-> m IteratorItem

Returns: the result of the operation.

IteratorNextFunction

dynamic_IteratorNextFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_IteratorNextFunction 
-> Iterator

it: the iterator

-> GValue

result: a pointer to hold the next item

-> m IteratorResult

Returns: the result of the operation.

IteratorResyncFunction

LogFunction

dynamic_LogFunction Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) 
=> FunPtr C_LogFunction 
-> DebugCategory

category: a DebugCategory

-> DebugLevel

level: a DebugLevel

-> Text

file: file name

-> Text

function: function name

-> Int32

line: line number

-> a

object: a Object

-> DebugMessage

message: the message

-> Ptr ()

userData: user data for the log function

-> m () 

MemoryCopyFunction

dynamic_MemoryCopyFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_MemoryCopyFunction 
-> Memory

mem: a Memory

-> Int64

offset: an offset

-> Int64

size: a size or -1

-> m Memory

Returns: a new Memory object wrapping a copy of the requested region in mem.

MemoryIsSpanFunction

dynamic_MemoryIsSpanFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_MemoryIsSpanFunction 
-> Memory

mem1: a Memory

-> Memory

mem2: a Memory

-> Word64

offset: a result offset

-> m Bool

Returns: True if mem1 and mem2 are in contiguous memory.

MemoryMapFullFunction

dynamic_MemoryMapFullFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_MemoryMapFullFunction 
-> Memory

mem: a Memory

-> MapInfo

info: the MapInfo to map with

-> Word64

maxsize: size to map

-> m (Ptr ())

Returns: a pointer to memory of which at least maxsize bytes can be accessed according to the access pattern in info's flags.

MemoryMapFunction

dynamic_MemoryMapFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_MemoryMapFunction 
-> Memory

mem: a Memory

-> Word64

maxsize: size to map

-> [MapFlags]

flags: access mode for the memory

-> m (Ptr ())

Returns: a pointer to memory of which at least maxsize bytes can be accessed according to the access pattern in flags.

MemoryShareFunction

dynamic_MemoryShareFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_MemoryShareFunction 
-> Memory

mem: a Memory

-> Int64

offset: an offset

-> Int64

size: a size or -1

-> m Memory

Returns: a new Memory object sharing the requested region in mem.

MemoryUnmapFullFunction

MemoryUnmapFunction

MetaFreeFunction

dynamic_MetaFreeFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_MetaFreeFunction 
-> Meta

meta: a Meta

-> Buffer

buffer: a Buffer

-> m () 

MetaInitFunction

dynamic_MetaInitFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_MetaInitFunction 
-> Meta

meta: a Meta

-> Ptr ()

params: parameters passed to the init function

-> Buffer

buffer: a Buffer

-> m Bool 

MetaTransformFunction

dynamic_MetaTransformFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_MetaTransformFunction 
-> Buffer

transbuf: a Buffer

-> Meta

meta: a Meta

-> Buffer

buffer: a Buffer

-> Word32

type: the transform type

-> Ptr ()

data: transform specific data.

-> m Bool

Returns: True if the transform could be performed

MiniObjectDisposeFunction

dynamic_MiniObjectDisposeFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_MiniObjectDisposeFunction 
-> MiniObject

obj: MiniObject to dispose

-> m Bool

Returns: True if the object should be cleaned up.

MiniObjectFreeFunction

dynamic_MiniObjectFreeFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_MiniObjectFreeFunction 
-> MiniObject

obj: MiniObject to free

-> m () 

MiniObjectNotify

dynamic_MiniObjectNotify Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_MiniObjectNotify 
-> Ptr ()

userData: data that was provided when the notify was added

-> MiniObject

obj: the mini object

-> m () 

PadActivateFunction

dynamic_PadActivateFunction Source #

Arguments

:: (HasCallStack, MonadIO m, IsPad a, IsObject b) 
=> FunPtr C_PadActivateFunction 
-> a

pad: a Pad

-> b

parent: the parent of pad

-> m Bool

Returns: True if the pad could be activated.

PadActivateModeFunction

dynamic_PadActivateModeFunction Source #

Arguments

:: (HasCallStack, MonadIO m, IsPad a, IsObject b) 
=> FunPtr C_PadActivateModeFunction 
-> a

pad: a Pad

-> b

parent: the parent of pad

-> PadMode

mode: the requested activation mode of pad

-> Bool

active: activate or deactivate the pad.

-> m Bool

Returns: True if the pad could be activated or deactivated.

PadChainFunction

dynamic_PadChainFunction Source #

Arguments

:: (HasCallStack, MonadIO m, IsPad a, IsObject b) 
=> FunPtr C_PadChainFunction 
-> a

pad: the sink Pad that performed the chain.

-> Maybe b

parent: the parent of pad. If the GST_PAD_FLAG_NEED_PARENT flag is set, parent is guaranteed to be not-Nothing and remain valid during the execution of this function.

-> Buffer

buffer: the Buffer that is chained, not Nothing.

-> m FlowReturn

Returns: GST_FLOW_OK for success

PadChainListFunction

dynamic_PadChainListFunction Source #

Arguments

:: (HasCallStack, MonadIO m, IsPad a, IsObject b) 
=> FunPtr C_PadChainListFunction 
-> a

pad: the sink Pad that performed the chain.

-> Maybe b

parent: the parent of pad. If the GST_PAD_FLAG_NEED_PARENT flag is set, parent is guaranteed to be not-Nothing and remain valid during the execution of this function.

-> BufferList

list: the BufferList that is chained, not Nothing.

-> m FlowReturn

Returns: GST_FLOW_OK for success

PadEventFullFunction

dynamic_PadEventFullFunction Source #

Arguments

:: (HasCallStack, MonadIO m, IsPad a, IsObject b) 
=> FunPtr C_PadEventFullFunction 
-> a

pad: the Pad to handle the event.

-> Maybe b

parent: the parent of pad. If the GST_PAD_FLAG_NEED_PARENT flag is set, parent is guaranteed to be not-Nothing and remain valid during the execution of this function.

-> Event

event: the Event to handle.

-> m FlowReturn

Returns: FlowReturnOk if the event was handled properly, or any other FlowReturn dependent on downstream state.

PadEventFunction

dynamic_PadEventFunction Source #

Arguments

:: (HasCallStack, MonadIO m, IsPad a, IsObject b) 
=> FunPtr C_PadEventFunction 
-> a

pad: the Pad to handle the event.

-> Maybe b

parent: the parent of pad. If the GST_PAD_FLAG_NEED_PARENT flag is set, parent is guaranteed to be not-Nothing and remain valid during the execution of this function.

-> Event

event: the Event to handle.

-> m Bool

Returns: True if the pad could handle the event.

PadForwardFunction

dynamic_PadForwardFunction Source #

Arguments

:: (HasCallStack, MonadIO m, IsPad a) 
=> FunPtr C_PadForwardFunction 
-> a

pad: the Pad that is forwarded.

-> Ptr ()

userData: the gpointer to optional user data.

-> m Bool

Returns: True if the dispatching procedure has to be stopped.

PadGetRangeFunction

dynamic_PadGetRangeFunction Source #

Arguments

:: (HasCallStack, MonadIO m, IsPad a, IsObject b) 
=> FunPtr C_PadGetRangeFunction 
-> a

pad: the src Pad to perform the getrange on.

-> Maybe b

parent: the parent of pad. If the GST_PAD_FLAG_NEED_PARENT flag is set, parent is guaranteed to be not-Nothing and remain valid during the execution of this function.

-> Word64

offset: the offset of the range

-> Word32

length: the length of the range

-> Buffer

buffer: a memory location to hold the result buffer, cannot be Nothing.

-> m FlowReturn

Returns: GST_FLOW_OK for success and a valid buffer in buffer. Any other return value leaves buffer undefined.

PadIterIntLinkFunction

dynamic_PadIterIntLinkFunction Source #

Arguments

:: (HasCallStack, MonadIO m, IsPad a, IsObject b) 
=> FunPtr C_PadIterIntLinkFunction 
-> a

pad: The Pad to query.

-> Maybe b

parent: the parent of pad. If the GST_PAD_FLAG_NEED_PARENT flag is set, parent is guaranteed to be not-Nothing and remain valid during the execution of this function.

-> m Iterator

Returns: a new Iterator that will iterate over all pads that are linked to the given pad on the inside of the parent element.

the caller must call iteratorFree after usage.

PadLinkFunction

dynamic_PadLinkFunction Source #

Arguments

:: (HasCallStack, MonadIO m, IsPad a, IsObject b, IsPad c) 
=> FunPtr C_PadLinkFunction 
-> a

pad: the Pad that is linked.

-> Maybe b

parent: the parent of pad. If the GST_PAD_FLAG_NEED_PARENT flag is set, parent is guaranteed to be not-Nothing and remain valid during the execution of this function.

-> c

peer: the peer Pad of the link

-> m PadLinkReturn

Returns: the result of the link with the specified peer.

PadProbeCallback

dynamic_PadProbeCallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsPad a) 
=> FunPtr C_PadProbeCallback 
-> a

pad: the Pad that is blocked

-> PadProbeInfo

info: PadProbeInfo

-> Ptr ()

userData: the gpointer to optional user data.

-> m PadProbeReturn

Returns: a PadProbeReturn

PadQueryFunction

dynamic_PadQueryFunction Source #

Arguments

:: (HasCallStack, MonadIO m, IsPad a, IsObject b) 
=> FunPtr C_PadQueryFunction 
-> a

pad: the Pad to query.

-> Maybe b

parent: the parent of pad. If the GST_PAD_FLAG_NEED_PARENT flag is set, parent is guaranteed to be not-Nothing and remain valid during the execution of this function.

-> Query

query: the Query object to execute

-> m Bool

Returns: True if the query could be performed.

PadStickyEventsForeachFunction

dynamic_PadStickyEventsForeachFunction Source #

Arguments

:: (HasCallStack, MonadIO m, IsPad a) 
=> FunPtr C_PadStickyEventsForeachFunction 
-> a

pad: the Pad.

-> Maybe Event

event: a sticky Event.

-> Ptr ()

userData: the gpointer to optional user data.

-> m Bool

Returns: True if the iteration should continue

PadUnlinkFunction

dynamic_PadUnlinkFunction Source #

Arguments

:: (HasCallStack, MonadIO m, IsPad a, IsObject b) 
=> FunPtr C_PadUnlinkFunction 
-> a

pad: the Pad that is linked.

-> Maybe b

parent: the parent of pad. If the GST_PAD_FLAG_NEED_PARENT flag is set, parent is guaranteed to be not-Nothing and remain valid during the execution of this function.

-> m () 

PluginFeatureFilter

dynamic_PluginFeatureFilter Source #

Arguments

:: (HasCallStack, MonadIO m, IsPluginFeature a) 
=> FunPtr C_PluginFeatureFilter 
-> a

feature: the pluginfeature to check

-> Ptr ()

userData: the user_data that has been passed on e.g. registryFeatureFilter

-> m Bool

Returns: True for a positive match, False otherwise

PluginFilter

dynamic_PluginFilter Source #

Arguments

:: (HasCallStack, MonadIO m, IsPlugin a) 
=> FunPtr C_PluginFilter 
-> a

plugin: the plugin to check

-> Ptr ()

userData: the user_data that has been passed on e.g. registryPluginFilter

-> m Bool

Returns: True for a positive match, False otherwise

PluginInitFullFunc

dynamic_PluginInitFullFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsPlugin a) 
=> FunPtr C_PluginInitFullFunc 
-> a

plugin: The plugin object

-> Ptr ()

userData: extra data

-> m Bool

Returns: True if plugin initialised successfully

PluginInitFunc

dynamic_PluginInitFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsPlugin a) 
=> FunPtr C_PluginInitFunc 
-> a

plugin: The plugin object

-> m Bool

Returns: True if plugin initialised successfully

StructureFilterMapFunc

dynamic_StructureFilterMapFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_StructureFilterMapFunc 
-> Word32

fieldId: the GQuark of the field name

-> GValue

value: the Value of the field

-> Ptr ()

userData: user data

-> m Bool

Returns: True if the field should be preserved, False if it should be removed.

StructureForeachFunc

dynamic_StructureForeachFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_StructureForeachFunc 
-> Word32

fieldId: the GQuark of the field name

-> GValue

value: the Value of the field

-> Ptr ()

userData: user data

-> m Bool

Returns: True if the foreach operation should continue, False if the foreach operation should stop with False.

StructureMapFunc

dynamic_StructureMapFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_StructureMapFunc 
-> Word32

fieldId: the GQuark of the field name

-> GValue

value: the Value of the field

-> Ptr ()

userData: user data

-> m Bool

Returns: True if the map operation should continue, False if the map operation should stop with False.

TagForeachFunc

dynamic_TagForeachFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_TagForeachFunc 
-> TagList

list: the TagList

-> Text

tag: a name of a tag in list

-> Ptr ()

userData: user data

-> m () 

TagMergeFunc

dynamic_TagMergeFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_TagMergeFunc 
-> GValue

dest: the destination Value

-> GValue

src: the source Value

-> m () 

TaskFunction

type C_TaskFunction = Ptr () -> IO () Source #

dynamic_TaskFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_TaskFunction 
-> Ptr ()

userData: user data passed to the function

-> m () 

TaskPoolFunction

type C_TaskPoolFunction = Ptr () -> IO () Source #

dynamic_TaskPoolFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_TaskPoolFunction 
-> Ptr ()

userData: user data for the task function

-> m () 

TaskThreadFunc

type C_TaskThreadFunc = Ptr Task -> Ptr Thread -> Ptr () -> IO () Source #

dynamic_TaskThreadFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTask a) 
=> FunPtr C_TaskThreadFunc 
-> a

task: The Task

-> Thread

thread: The Thread

-> Ptr ()

userData: user data

-> m () 

TypeFindFunction

dynamic_TypeFindFunction Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_TypeFindFunction 
-> TypeFind

find: A TypeFind structure

-> Ptr ()

userData: optional data to pass to the function

-> m () 

TypeFindGetLengthFieldCallback

TypeFindPeekFieldCallback

TypeFindSuggestFieldCallback

ValueCompareFunc

dynamic_ValueCompareFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_ValueCompareFunc 
-> GValue

value1: first value for comparison

-> GValue

value2: second value for comparison

-> m Int32

Returns: one of GST_VALUE_LESS_THAN, GST_VALUE_EQUAL, GST_VALUE_GREATER_THAN or GST_VALUE_UNORDERED

ValueDeserializeFunc

dynamic_ValueDeserializeFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_ValueDeserializeFunc 
-> GValue

dest: a Value

-> Text

s: a string

-> m Bool

Returns: True for success

ValueSerializeFunc

dynamic_ValueSerializeFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_ValueSerializeFunc 
-> GValue

value1: a Value

-> m Text

Returns: the string representation of the value