Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
- Exported types
- Methods
- addValue
- copyValue
- foreach
- getBoolean
- getBooleanIndex
- getDate
- getDateIndex
- getDateTime
- getDateTimeIndex
- getDouble
- getDoubleIndex
- getFloat
- getFloatIndex
- getInt
- getInt64
- getInt64Index
- getIntIndex
- getPointer
- getPointerIndex
- getSample
- getSampleIndex
- getScope
- getString
- getStringIndex
- getTagSize
- getUint
- getUint64
- getUint64Index
- getUintIndex
- getValueIndex
- insert
- isEmpty
- isEqual
- merge
- nTags
- newEmpty
- newFromString
- nthTagName
- peekStringIndex
- removeTag
- setScope
- toString
- Properties
List of tags and values used to describe media metadata.
Strings in structures must be ASCII or UTF-8 encoded. Other encodings are
not allowed. Strings must not be empty or Nothing
.
- newtype TagList = TagList (ManagedPtr TagList)
- newZeroTagList :: MonadIO m => m TagList
- noTagList :: Maybe TagList
- data TagListAddValueMethodInfo
- tagListAddValue :: (HasCallStack, MonadIO m) => TagList -> TagMergeMode -> Text -> GValue -> m ()
- tagListCopyValue :: (HasCallStack, MonadIO m) => TagList -> Text -> m (Bool, GValue)
- data TagListForeachMethodInfo
- tagListForeach :: (HasCallStack, MonadIO m) => TagList -> TagForeachFunc -> m ()
- data TagListGetBooleanMethodInfo
- tagListGetBoolean :: (HasCallStack, MonadIO m) => TagList -> Text -> m (Bool, Bool)
- data TagListGetBooleanIndexMethodInfo
- tagListGetBooleanIndex :: (HasCallStack, MonadIO m) => TagList -> Text -> Word32 -> m (Bool, Bool)
- data TagListGetDateMethodInfo
- tagListGetDate :: (HasCallStack, MonadIO m) => TagList -> Text -> m (Bool, Date)
- data TagListGetDateIndexMethodInfo
- tagListGetDateIndex :: (HasCallStack, MonadIO m) => TagList -> Text -> Word32 -> m (Bool, Date)
- data TagListGetDateTimeMethodInfo
- tagListGetDateTime :: (HasCallStack, MonadIO m) => TagList -> Text -> m (Bool, DateTime)
- data TagListGetDateTimeIndexMethodInfo
- tagListGetDateTimeIndex :: (HasCallStack, MonadIO m) => TagList -> Text -> Word32 -> m (Bool, DateTime)
- data TagListGetDoubleMethodInfo
- tagListGetDouble :: (HasCallStack, MonadIO m) => TagList -> Text -> m (Bool, Double)
- data TagListGetDoubleIndexMethodInfo
- tagListGetDoubleIndex :: (HasCallStack, MonadIO m) => TagList -> Text -> Word32 -> m (Bool, Double)
- data TagListGetFloatMethodInfo
- tagListGetFloat :: (HasCallStack, MonadIO m) => TagList -> Text -> m (Bool, Float)
- data TagListGetFloatIndexMethodInfo
- tagListGetFloatIndex :: (HasCallStack, MonadIO m) => TagList -> Text -> Word32 -> m (Bool, Float)
- data TagListGetIntMethodInfo
- tagListGetInt :: (HasCallStack, MonadIO m) => TagList -> Text -> m (Bool, Int32)
- data TagListGetInt64MethodInfo
- tagListGetInt64 :: (HasCallStack, MonadIO m) => TagList -> Text -> Int64 -> m Bool
- data TagListGetInt64IndexMethodInfo
- tagListGetInt64Index :: (HasCallStack, MonadIO m) => TagList -> Text -> Word32 -> m (Bool, Int64)
- data TagListGetIntIndexMethodInfo
- tagListGetIntIndex :: (HasCallStack, MonadIO m) => TagList -> Text -> Word32 -> m (Bool, Int32)
- data TagListGetPointerMethodInfo
- tagListGetPointer :: (HasCallStack, MonadIO m) => TagList -> Text -> m (Bool, Ptr ())
- data TagListGetPointerIndexMethodInfo
- tagListGetPointerIndex :: (HasCallStack, MonadIO m) => TagList -> Text -> Word32 -> m (Bool, Ptr ())
- data TagListGetSampleMethodInfo
- tagListGetSample :: (HasCallStack, MonadIO m) => TagList -> Text -> m (Bool, Sample)
- data TagListGetSampleIndexMethodInfo
- tagListGetSampleIndex :: (HasCallStack, MonadIO m) => TagList -> Text -> Word32 -> m (Bool, Sample)
- data TagListGetScopeMethodInfo
- tagListGetScope :: (HasCallStack, MonadIO m) => TagList -> m TagScope
- data TagListGetStringMethodInfo
- tagListGetString :: (HasCallStack, MonadIO m) => TagList -> Text -> m (Bool, Text)
- data TagListGetStringIndexMethodInfo
- tagListGetStringIndex :: (HasCallStack, MonadIO m) => TagList -> Text -> Word32 -> m (Bool, Text)
- data TagListGetTagSizeMethodInfo
- tagListGetTagSize :: (HasCallStack, MonadIO m) => TagList -> Text -> m Word32
- data TagListGetUintMethodInfo
- tagListGetUint :: (HasCallStack, MonadIO m) => TagList -> Text -> m (Bool, Word32)
- data TagListGetUint64MethodInfo
- tagListGetUint64 :: (HasCallStack, MonadIO m) => TagList -> Text -> m (Bool, Word64)
- data TagListGetUint64IndexMethodInfo
- tagListGetUint64Index :: (HasCallStack, MonadIO m) => TagList -> Text -> Word32 -> m (Bool, Word64)
- data TagListGetUintIndexMethodInfo
- tagListGetUintIndex :: (HasCallStack, MonadIO m) => TagList -> Text -> Word32 -> m (Bool, Word32)
- data TagListGetValueIndexMethodInfo
- tagListGetValueIndex :: (HasCallStack, MonadIO m) => TagList -> Text -> Word32 -> m (Maybe GValue)
- data TagListInsertMethodInfo
- tagListInsert :: (HasCallStack, MonadIO m) => TagList -> TagList -> TagMergeMode -> m ()
- data TagListIsEmptyMethodInfo
- tagListIsEmpty :: (HasCallStack, MonadIO m) => TagList -> m Bool
- data TagListIsEqualMethodInfo
- tagListIsEqual :: (HasCallStack, MonadIO m) => TagList -> TagList -> m Bool
- data TagListMergeMethodInfo
- tagListMerge :: (HasCallStack, MonadIO m) => TagList -> Maybe TagList -> TagMergeMode -> m (Maybe TagList)
- data TagListNTagsMethodInfo
- tagListNTags :: (HasCallStack, MonadIO m) => TagList -> m Int32
- tagListNewEmpty :: (HasCallStack, MonadIO m) => m TagList
- tagListNewFromString :: (HasCallStack, MonadIO m) => Text -> m (Maybe TagList)
- data TagListNthTagNameMethodInfo
- tagListNthTagName :: (HasCallStack, MonadIO m) => TagList -> Word32 -> m Text
- data TagListPeekStringIndexMethodInfo
- tagListPeekStringIndex :: (HasCallStack, MonadIO m) => TagList -> Text -> Word32 -> m (Bool, Text)
- data TagListRemoveTagMethodInfo
- tagListRemoveTag :: (HasCallStack, MonadIO m) => TagList -> Text -> m ()
- data TagListSetScopeMethodInfo
- tagListSetScope :: (HasCallStack, MonadIO m) => TagList -> TagScope -> m ()
- data TagListToStringMethodInfo
- tagListToString :: (HasCallStack, MonadIO m) => TagList -> m (Maybe Text)
- getTagListMiniObject :: MonadIO m => TagList -> m MiniObject
- tagList_miniObject :: AttrLabelProxy "miniObject"
Exported types
Methods
addValue
data TagListAddValueMethodInfo Source #
((~) * signature (TagMergeMode -> Text -> GValue -> m ()), MonadIO m) => MethodInfo * TagListAddValueMethodInfo TagList signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> TagMergeMode |
|
-> Text |
|
-> GValue |
|
-> m () |
Sets the GValue for a given tag using the specified mode.
copyValue
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> m (Bool, GValue) | Returns: |
Copies the contents for the given tag into the value,
merging multiple values into one if multiple values are associated
with the tag.
You must valueUnset
the value after use.
foreach
data TagListForeachMethodInfo Source #
((~) * signature (TagForeachFunc -> m ()), MonadIO m) => MethodInfo * TagListForeachMethodInfo TagList signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> TagForeachFunc |
|
-> m () |
Calls the given function for each tag inside the tag list. Note that if there is no tag, the function won't be called at all.
getBoolean
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> m (Bool, Bool) | Returns: |
Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag.
getBooleanIndex
tagListGetBooleanIndex Source #
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> Word32 |
|
-> m (Bool, Bool) | Returns: |
Gets the value that is at the given index for the given tag in the given list.
getDate
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> m (Bool, Date) | Returns: |
Copies the first date for the given tag in the taglist into the variable
pointed to by value
. Free the date with dateFree
when it is no longer
needed.
Free-function: g_date_free
getDateIndex
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> Word32 |
|
-> m (Bool, Date) | Returns: |
Gets the date that is at the given index for the given tag in the given
list and copies it into the variable pointed to by value
. Free the date
with dateFree
when it is no longer needed.
Free-function: g_date_free
getDateTime
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> m (Bool, DateTime) | Returns: |
Copies the first datetime for the given tag in the taglist into the variable
pointed to by value
. Unref the date with dateTimeUnref
when
it is no longer needed.
Free-function: gst_date_time_unref
getDateTimeIndex
tagListGetDateTimeIndex Source #
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> Word32 |
|
-> m (Bool, DateTime) | Returns: |
Gets the datetime that is at the given index for the given tag in the given
list and copies it into the variable pointed to by value
. Unref the datetime
with dateTimeUnref
when it is no longer needed.
Free-function: gst_date_time_unref
getDouble
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> m (Bool, Double) | Returns: |
Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag.
getDoubleIndex
tagListGetDoubleIndex Source #
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> Word32 |
|
-> m (Bool, Double) | Returns: |
Gets the value that is at the given index for the given tag in the given list.
getFloat
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> m (Bool, Float) | Returns: |
Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag.
getFloatIndex
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> Word32 |
|
-> m (Bool, Float) | Returns: |
Gets the value that is at the given index for the given tag in the given list.
getInt
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> m (Bool, Int32) | Returns: |
Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag.
getInt64
tagListGetInt64 :: (HasCallStack, MonadIO m) => TagList -> Text -> Int64 -> m Bool Source #
No description available in the introspection data.
getInt64Index
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> Word32 |
|
-> m (Bool, Int64) | Returns: |
Gets the value that is at the given index for the given tag in the given list.
getIntIndex
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> Word32 |
|
-> m (Bool, Int32) | Returns: |
Gets the value that is at the given index for the given tag in the given list.
getPointer
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> m (Bool, Ptr ()) | Returns: |
Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag.
getPointerIndex
tagListGetPointerIndex Source #
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> Word32 |
|
-> m (Bool, Ptr ()) | Returns: |
Gets the value that is at the given index for the given tag in the given list.
getSample
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> m (Bool, Sample) | Returns: |
Copies the first sample for the given tag in the taglist into the variable
pointed to by sample
. Free the sample with gst_sample_unref()
when it is
no longer needed. You can retrieve the buffer from the sample using
sampleGetBuffer
and the associated caps (if any) with
sampleGetCaps
.
Free-function: gst_sample_unref
getSampleIndex
tagListGetSampleIndex Source #
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> Word32 |
|
-> m (Bool, Sample) | Returns: |
Gets the sample that is at the given index for the given tag in the given
list and copies it into the variable pointed to by sample
. Free the sample
with gst_sample_unref()
when it is no longer needed. You can retrieve the
buffer from the sample using sampleGetBuffer
and the associated
caps (if any) with sampleGetCaps
.
Free-function: gst_sample_unref
getScope
data TagListGetScopeMethodInfo Source #
((~) * signature (m TagScope), MonadIO m) => MethodInfo * TagListGetScopeMethodInfo TagList signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> m TagScope | Returns: The scope of |
Gets the scope of list
.
getString
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> m (Bool, Text) | Returns: |
Copies the contents for the given tag into the value, possibly merging multiple values into one if multiple values are associated with the tag.
Use gst_tag_list_get_string_index (list, tag, 0, value) if you want to retrieve the first string associated with this tag unmodified.
The resulting string in value
will be in UTF-8 encoding and should be
freed by the caller using g_free when no longer needed. The
returned string is also guaranteed to be non-Nothing
and non-empty.
Free-function: g_free
getStringIndex
tagListGetStringIndex Source #
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> Word32 |
|
-> m (Bool, Text) | Returns: |
Gets the value that is at the given index for the given tag in the given list.
The resulting string in value
will be in UTF-8 encoding and should be
freed by the caller using g_free when no longer needed. The
returned string is also guaranteed to be non-Nothing
and non-empty.
Free-function: g_free
getTagSize
data TagListGetTagSizeMethodInfo Source #
((~) * signature (Text -> m Word32), MonadIO m) => MethodInfo * TagListGetTagSizeMethodInfo TagList signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> m Word32 | Returns: The number of tags stored |
Checks how many value are stored in this tag list for the given tag.
getUint
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> m (Bool, Word32) | Returns: |
Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag.
getUint64
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> m (Bool, Word64) | Returns: |
Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag.
getUint64Index
tagListGetUint64Index Source #
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> Word32 |
|
-> m (Bool, Word64) | Returns: |
Gets the value that is at the given index for the given tag in the given list.
getUintIndex
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> Word32 |
|
-> m (Bool, Word32) | Returns: |
Gets the value that is at the given index for the given tag in the given list.
getValueIndex
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> Word32 |
|
-> m (Maybe GValue) | Returns: The GValue for the specified
entry or |
Gets the value that is at the given index for the given tag in the given list.
insert
data TagListInsertMethodInfo Source #
((~) * signature (TagList -> TagMergeMode -> m ()), MonadIO m) => MethodInfo * TagListInsertMethodInfo TagList signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> TagList |
|
-> TagMergeMode |
|
-> m () |
Inserts the tags of the from
list into the first list using the given mode.
isEmpty
data TagListIsEmptyMethodInfo Source #
((~) * signature (m Bool), MonadIO m) => MethodInfo * TagListIsEmptyMethodInfo TagList signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> m Bool |
Checks if the given taglist is empty.
isEqual
data TagListIsEqualMethodInfo Source #
((~) * signature (TagList -> m Bool), MonadIO m) => MethodInfo * TagListIsEqualMethodInfo TagList signature Source # | |
Checks if the two given taglists are equal.
merge
data TagListMergeMethodInfo Source #
((~) * signature (Maybe TagList -> TagMergeMode -> m (Maybe TagList)), MonadIO m) => MethodInfo * TagListMergeMethodInfo TagList signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Maybe TagList |
|
-> TagMergeMode |
|
-> m (Maybe TagList) | Returns: the new list |
nTags
data TagListNTagsMethodInfo Source #
((~) * signature (m Int32), MonadIO m) => MethodInfo * TagListNTagsMethodInfo TagList signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> m Int32 | Returns: The number of tags in |
Get the number of tags in list
.
newEmpty
:: (HasCallStack, MonadIO m) | |
=> m TagList | Returns: An empty tag list |
Creates a new empty GstTagList.
Free-function: gst_tag_list_unref
newFromString
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m (Maybe TagList) |
Deserializes a tag list.
nthTagName
data TagListNthTagNameMethodInfo Source #
((~) * signature (Word32 -> m Text), MonadIO m) => MethodInfo * TagListNthTagNameMethodInfo TagList signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Word32 |
|
-> m Text | Returns: The name of the tag at |
Get the name of the tag in list
at index
.
peekStringIndex
tagListPeekStringIndex Source #
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> Word32 |
|
-> m (Bool, Text) | Returns: |
Peeks at the value that is at the given index for the given tag in the given list.
The resulting string in value
will be in UTF-8 encoding and doesn't need
to be freed by the caller. The returned string is also guaranteed to
be non-Nothing
and non-empty.
removeTag
data TagListRemoveTagMethodInfo Source #
((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * TagListRemoveTagMethodInfo TagList signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> Text |
|
-> m () |
Removes the given tag from the taglist.
setScope
data TagListSetScopeMethodInfo Source #
((~) * signature (TagScope -> m ()), MonadIO m) => MethodInfo * TagListSetScopeMethodInfo TagList signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> TagScope |
|
-> m () |
Sets the scope of list
to scope
. By default the scope
of a taglist is stream scope.
toString
data TagListToStringMethodInfo Source #
((~) * signature (m (Maybe Text)), MonadIO m) => MethodInfo * TagListToStringMethodInfo TagList signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> TagList |
|
-> m (Maybe Text) | Returns: a newly-allocated string, or |
Serializes a tag list to a string.
Properties
miniObject
getTagListMiniObject :: MonadIO m => TagList -> m MiniObject Source #
tagList_miniObject :: AttrLabelProxy "miniObject" Source #