gi-gst-1.0.18: GStreamer bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.Gst.Structs.TocEntry

Contents

Description

No description available in the introspection data.

Synopsis

Exported types

newtype TocEntry Source #

Memory-managed wrapper type.

Constructors

TocEntry (ManagedPtr TocEntry) 
Instances
BoxedObject TocEntry Source # 
Instance details

Defined in GI.Gst.Structs.TocEntry

Methods

boxedType :: TocEntry -> IO GType #

noTocEntry :: Maybe TocEntry Source #

A convenience alias for Nothing :: Maybe TocEntry.

Methods

appendSubEntry

tocEntryAppendSubEntry Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntry

entry: A TocEntry instance

-> TocEntry

subentry: A TocEntry

-> m () 

Appends the TocEntry subentry to entry.

getEntryType

tocEntryGetEntryType Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntry

entry: a TocEntry

-> m TocEntryType

Returns: entry's entry type

No description available in the introspection data.

getLoop

tocEntryGetLoop Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntry

entry: TocEntry to get values from.

-> m (Bool, TocLoopType, Int32)

Returns: True if all non-Nothing storage pointers were filled with appropriate values, False otherwise.

Get loopType and repeatCount values from the entry and write them into appropriate storages. Loops are e.g. used by sampled instruments. GStreamer is not automatically applying the loop. The application can process this meta data and use it e.g. to send a seek-event to loop a section.

Since: 1.4

getParent

tocEntryGetParent Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntry

entry: A TocEntry instance

-> m (Maybe TocEntry)

Returns: The parent TocEntry of entry

Gets the parent TocEntry of entry.

getStartStopTimes

tocEntryGetStartStopTimes Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntry

entry: TocEntry to get values from.

-> m (Bool, Int64, Int64)

Returns: True if all non-Nothing storage pointers were filled with appropriate values, False otherwise.

Get start and stop values from the entry and write them into appropriate storages.

getSubEntries

tocEntryGetSubEntries Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntry

entry: A TocEntry instance

-> m [TocEntry]

Returns: A List of TocEntry of entry

Gets the sub-entries of entry.

getTags

tocEntryGetTags Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntry

entry: A TocEntry instance

-> m TagList

Returns: A TagList for entry

Gets the tags for entry.

getToc

tocEntryGetToc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntry

entry: A TocEntry instance

-> m Toc

Returns: The parent Toc of entry

Gets the parent Toc of entry.

getUid

tocEntryGetUid Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntry

entry: A TocEntry instance

-> m Text

Returns: The UID of entry

Gets the UID of entry.

isAlternative

tocEntryIsAlternative Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntry

entry: a TocEntry

-> m Bool

Returns: True if entry's type is an alternative type, otherwise False

No description available in the introspection data.

isSequence

tocEntryIsSequence Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntry

entry: a TocEntry

-> m Bool

Returns: True if entry's type is a sequence type, otherwise False

No description available in the introspection data.

mergeTags

tocEntryMergeTags Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntry

entry: A TocEntry instance

-> Maybe TagList

tags: A TagList or Nothing

-> TagMergeMode

mode: A TagMergeMode

-> m () 

Merge tags into the existing tags of entry using mode.

new

tocEntryNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntryType

type: entry type.

-> Text

uid: unique ID (UID) in the whole TOC.

-> m TocEntry

Returns: newly allocated TocEntry structure, free it with gst_toc_entry_unref().

Create new TocEntry structure.

setLoop

tocEntrySetLoop Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntry

entry: TocEntry to set values.

-> TocLoopType

loopType: loop_type value to set.

-> Int32

repeatCount: repeat_count value to set.

-> m () 

Set loopType and repeatCount values for the entry.

Since: 1.4

setStartStopTimes

tocEntrySetStartStopTimes Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntry

entry: TocEntry to set values.

-> Int64

start: start value to set.

-> Int64

stop: stop value to set.

-> m () 

Set start and stop values for the entry.

setTags

tocEntrySetTags Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> TocEntry

entry: A TocEntry instance

-> Maybe TagList

tags: A TagList or Nothing

-> m () 

Set a TagList with tags for the complete entry.