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
- addAllocationMeta
- addAllocationParam
- addAllocationPool
- addBufferingRange
- addSchedulingMode
- findAllocationMeta
- getNAllocationMetas
- getNAllocationParams
- getNAllocationPools
- getNBufferingRanges
- getNSchedulingModes
- getStructure
- hasSchedulingMode
- hasSchedulingModeWithFlags
- newAcceptCaps
- newAllocation
- newBuffering
- newCaps
- newContext
- newConvert
- newCustom
- newDrain
- newDuration
- newFormats
- newLatency
- newPosition
- newScheduling
- newSeeking
- newSegment
- newUri
- parseAcceptCaps
- parseAcceptCapsResult
- parseAllocation
- parseBufferingPercent
- parseBufferingRange
- parseBufferingStats
- parseCaps
- parseCapsResult
- parseContext
- parseContextType
- parseConvert
- parseDuration
- parseLatency
- parseNFormats
- parseNthAllocationMeta
- parseNthAllocationParam
- parseNthAllocationPool
- parseNthBufferingRange
- parseNthFormat
- parseNthSchedulingMode
- parsePosition
- parseScheduling
- parseSeeking
- parseSegment
- parseUri
- parseUriRedirection
- parseUriRedirectionPermanent
- removeNthAllocationMeta
- removeNthAllocationParam
- removeNthAllocationPool
- setAcceptCapsResult
- setBufferingPercent
- setBufferingRange
- setBufferingStats
- setCapsResult
- setContext
- setConvert
- setDuration
- setFormatsv
- setLatency
- setNthAllocationParam
- setNthAllocationPool
- setPosition
- setScheduling
- setSeeking
- setSegment
- setUri
- setUriRedirection
- setUriRedirectionPermanent
- writableStructure
- Properties
Queries can be performed on pads (padQuery
) and elements
(elementQuery
). Please note that some queries might need a running
pipeline to work.
Queries can be created using the gst_query_new_*() functions. Query values can be set using gst_query_set_*(), and parsed using gst_query_parse_*() helpers.
The following example shows how to query the duration of a pipeline:
C code
GstQuery *query; gboolean res; query = gst_query_new_duration (GST_FORMAT_TIME); res = gst_element_query (pipeline, query); if (res) { gint64 duration; gst_query_parse_duration (query, NULL, &duration); g_print ("duration = %"GST_TIME_FORMAT, GST_TIME_ARGS (duration)); } else { g_print ("duration query failed..."); } gst_query_unref (query);
- newtype Query = Query (ManagedPtr Query)
- newZeroQuery :: MonadIO m => m Query
- noQuery :: Maybe Query
- data QueryAddAllocationMetaMethodInfo
- queryAddAllocationMeta :: (HasCallStack, MonadIO m) => Query -> GType -> Maybe Structure -> m ()
- data QueryAddAllocationParamMethodInfo
- queryAddAllocationParam :: (HasCallStack, MonadIO m, IsAllocator a) => Query -> Maybe a -> Maybe AllocationParams -> m ()
- data QueryAddAllocationPoolMethodInfo
- queryAddAllocationPool :: (HasCallStack, MonadIO m, IsBufferPool a) => Query -> Maybe a -> Word32 -> Word32 -> Word32 -> m ()
- data QueryAddBufferingRangeMethodInfo
- queryAddBufferingRange :: (HasCallStack, MonadIO m) => Query -> Int64 -> Int64 -> m Bool
- data QueryAddSchedulingModeMethodInfo
- queryAddSchedulingMode :: (HasCallStack, MonadIO m) => Query -> PadMode -> m ()
- data QueryFindAllocationMetaMethodInfo
- queryFindAllocationMeta :: (HasCallStack, MonadIO m) => Query -> GType -> m (Bool, Word32)
- data QueryGetNAllocationMetasMethodInfo
- queryGetNAllocationMetas :: (HasCallStack, MonadIO m) => Query -> m Word32
- data QueryGetNAllocationParamsMethodInfo
- queryGetNAllocationParams :: (HasCallStack, MonadIO m) => Query -> m Word32
- data QueryGetNAllocationPoolsMethodInfo
- queryGetNAllocationPools :: (HasCallStack, MonadIO m) => Query -> m Word32
- data QueryGetNBufferingRangesMethodInfo
- queryGetNBufferingRanges :: (HasCallStack, MonadIO m) => Query -> m Word32
- data QueryGetNSchedulingModesMethodInfo
- queryGetNSchedulingModes :: (HasCallStack, MonadIO m) => Query -> m Word32
- data QueryGetStructureMethodInfo
- queryGetStructure :: (HasCallStack, MonadIO m) => Query -> m Structure
- data QueryHasSchedulingModeMethodInfo
- queryHasSchedulingMode :: (HasCallStack, MonadIO m) => Query -> PadMode -> m Bool
- data QueryHasSchedulingModeWithFlagsMethodInfo
- queryHasSchedulingModeWithFlags :: (HasCallStack, MonadIO m) => Query -> PadMode -> [SchedulingFlags] -> m Bool
- queryNewAcceptCaps :: (HasCallStack, MonadIO m) => Caps -> m Query
- queryNewAllocation :: (HasCallStack, MonadIO m) => Caps -> Bool -> m Query
- queryNewBuffering :: (HasCallStack, MonadIO m) => Format -> m Query
- queryNewCaps :: (HasCallStack, MonadIO m) => Caps -> m Query
- queryNewContext :: (HasCallStack, MonadIO m) => Text -> m Query
- queryNewConvert :: (HasCallStack, MonadIO m) => Format -> Int64 -> Format -> m Query
- queryNewCustom :: (HasCallStack, MonadIO m) => QueryType -> Maybe Structure -> m Query
- queryNewDrain :: (HasCallStack, MonadIO m) => m Query
- queryNewDuration :: (HasCallStack, MonadIO m) => Format -> m Query
- queryNewFormats :: (HasCallStack, MonadIO m) => m Query
- queryNewLatency :: (HasCallStack, MonadIO m) => m Query
- queryNewPosition :: (HasCallStack, MonadIO m) => Format -> m Query
- queryNewScheduling :: (HasCallStack, MonadIO m) => m Query
- queryNewSeeking :: (HasCallStack, MonadIO m) => Format -> m Query
- queryNewSegment :: (HasCallStack, MonadIO m) => Format -> m Query
- queryNewUri :: (HasCallStack, MonadIO m) => m Query
- data QueryParseAcceptCapsMethodInfo
- queryParseAcceptCaps :: (HasCallStack, MonadIO m) => Query -> m Caps
- data QueryParseAcceptCapsResultMethodInfo
- queryParseAcceptCapsResult :: (HasCallStack, MonadIO m) => Query -> Bool -> m ()
- data QueryParseAllocationMethodInfo
- queryParseAllocation :: (HasCallStack, MonadIO m) => Query -> m (Caps, Bool)
- data QueryParseBufferingPercentMethodInfo
- queryParseBufferingPercent :: (HasCallStack, MonadIO m) => Query -> m (Bool, Int32)
- data QueryParseBufferingRangeMethodInfo
- queryParseBufferingRange :: (HasCallStack, MonadIO m) => Query -> m (Format, Int64, Int64, Int64)
- data QueryParseBufferingStatsMethodInfo
- queryParseBufferingStats :: (HasCallStack, MonadIO m) => Query -> m (BufferingMode, Int32, Int32, Int64)
- data QueryParseCapsMethodInfo
- queryParseCaps :: (HasCallStack, MonadIO m) => Query -> m Caps
- data QueryParseCapsResultMethodInfo
- queryParseCapsResult :: (HasCallStack, MonadIO m) => Query -> m Caps
- data QueryParseContextMethodInfo
- queryParseContext :: (HasCallStack, MonadIO m) => Query -> m Context
- data QueryParseContextTypeMethodInfo
- queryParseContextType :: (HasCallStack, MonadIO m) => Query -> m (Bool, Text)
- data QueryParseConvertMethodInfo
- queryParseConvert :: (HasCallStack, MonadIO m) => Query -> m (Format, Int64, Format, Int64)
- data QueryParseDurationMethodInfo
- queryParseDuration :: (HasCallStack, MonadIO m) => Query -> m (Format, Int64)
- data QueryParseLatencyMethodInfo
- queryParseLatency :: (HasCallStack, MonadIO m) => Query -> m (Bool, Word64, Word64)
- data QueryParseNFormatsMethodInfo
- queryParseNFormats :: (HasCallStack, MonadIO m) => Query -> m Word32
- data QueryParseNthAllocationMetaMethodInfo
- queryParseNthAllocationMeta :: (HasCallStack, MonadIO m) => Query -> Word32 -> m (GType, Structure)
- data QueryParseNthAllocationParamMethodInfo
- queryParseNthAllocationParam :: (HasCallStack, MonadIO m) => Query -> Word32 -> m (Allocator, AllocationParams)
- data QueryParseNthAllocationPoolMethodInfo
- queryParseNthAllocationPool :: (HasCallStack, MonadIO m) => Query -> Word32 -> m (BufferPool, Word32, Word32, Word32)
- data QueryParseNthBufferingRangeMethodInfo
- queryParseNthBufferingRange :: (HasCallStack, MonadIO m) => Query -> Word32 -> m (Bool, Int64, Int64)
- data QueryParseNthFormatMethodInfo
- queryParseNthFormat :: (HasCallStack, MonadIO m) => Query -> m (Word32, Format)
- data QueryParseNthSchedulingModeMethodInfo
- queryParseNthSchedulingMode :: (HasCallStack, MonadIO m) => Query -> Word32 -> m PadMode
- data QueryParsePositionMethodInfo
- queryParsePosition :: (HasCallStack, MonadIO m) => Query -> m (Format, Int64)
- data QueryParseSchedulingMethodInfo
- queryParseScheduling :: (HasCallStack, MonadIO m) => Query -> m ([SchedulingFlags], Int32, Int32, Int32)
- data QueryParseSeekingMethodInfo
- queryParseSeeking :: (HasCallStack, MonadIO m) => Query -> m (Format, Bool, Int64, Int64)
- data QueryParseSegmentMethodInfo
- queryParseSegment :: (HasCallStack, MonadIO m) => Query -> m (Double, Format, Int64, Int64)
- data QueryParseUriMethodInfo
- queryParseUri :: (HasCallStack, MonadIO m) => Query -> m Text
- data QueryParseUriRedirectionMethodInfo
- queryParseUriRedirection :: (HasCallStack, MonadIO m) => Query -> m Text
- data QueryParseUriRedirectionPermanentMethodInfo
- queryParseUriRedirectionPermanent :: (HasCallStack, MonadIO m) => Query -> m Bool
- data QueryRemoveNthAllocationMetaMethodInfo
- queryRemoveNthAllocationMeta :: (HasCallStack, MonadIO m) => Query -> Word32 -> m ()
- data QueryRemoveNthAllocationParamMethodInfo
- queryRemoveNthAllocationParam :: (HasCallStack, MonadIO m) => Query -> Word32 -> m ()
- data QueryRemoveNthAllocationPoolMethodInfo
- queryRemoveNthAllocationPool :: (HasCallStack, MonadIO m) => Query -> Word32 -> m ()
- data QuerySetAcceptCapsResultMethodInfo
- querySetAcceptCapsResult :: (HasCallStack, MonadIO m) => Query -> Bool -> m ()
- data QuerySetBufferingPercentMethodInfo
- querySetBufferingPercent :: (HasCallStack, MonadIO m) => Query -> Bool -> Int32 -> m ()
- data QuerySetBufferingRangeMethodInfo
- querySetBufferingRange :: (HasCallStack, MonadIO m) => Query -> Format -> Int64 -> Int64 -> Int64 -> m ()
- data QuerySetBufferingStatsMethodInfo
- querySetBufferingStats :: (HasCallStack, MonadIO m) => Query -> BufferingMode -> Int32 -> Int32 -> Int64 -> m ()
- data QuerySetCapsResultMethodInfo
- querySetCapsResult :: (HasCallStack, MonadIO m) => Query -> Caps -> m ()
- data QuerySetContextMethodInfo
- querySetContext :: (HasCallStack, MonadIO m) => Query -> Context -> m ()
- data QuerySetConvertMethodInfo
- querySetConvert :: (HasCallStack, MonadIO m) => Query -> Format -> Int64 -> Format -> Int64 -> m ()
- data QuerySetDurationMethodInfo
- querySetDuration :: (HasCallStack, MonadIO m) => Query -> Format -> Int64 -> m ()
- data QuerySetFormatsvMethodInfo
- querySetFormatsv :: (HasCallStack, MonadIO m) => Query -> [Format] -> m ()
- data QuerySetLatencyMethodInfo
- querySetLatency :: (HasCallStack, MonadIO m) => Query -> Bool -> Word64 -> Word64 -> m ()
- data QuerySetNthAllocationParamMethodInfo
- querySetNthAllocationParam :: (HasCallStack, MonadIO m, IsAllocator a) => Query -> Word32 -> Maybe a -> Maybe AllocationParams -> m ()
- data QuerySetNthAllocationPoolMethodInfo
- querySetNthAllocationPool :: (HasCallStack, MonadIO m, IsBufferPool a) => Query -> Word32 -> Maybe a -> Word32 -> Word32 -> Word32 -> m ()
- data QuerySetPositionMethodInfo
- querySetPosition :: (HasCallStack, MonadIO m) => Query -> Format -> Int64 -> m ()
- data QuerySetSchedulingMethodInfo
- querySetScheduling :: (HasCallStack, MonadIO m) => Query -> [SchedulingFlags] -> Int32 -> Int32 -> Int32 -> m ()
- data QuerySetSeekingMethodInfo
- querySetSeeking :: (HasCallStack, MonadIO m) => Query -> Format -> Bool -> Int64 -> Int64 -> m ()
- data QuerySetSegmentMethodInfo
- querySetSegment :: (HasCallStack, MonadIO m) => Query -> Double -> Format -> Int64 -> Int64 -> m ()
- data QuerySetUriMethodInfo
- querySetUri :: (HasCallStack, MonadIO m) => Query -> Text -> m ()
- data QuerySetUriRedirectionMethodInfo
- querySetUriRedirection :: (HasCallStack, MonadIO m) => Query -> Text -> m ()
- data QuerySetUriRedirectionPermanentMethodInfo
- querySetUriRedirectionPermanent :: (HasCallStack, MonadIO m) => Query -> Bool -> m ()
- data QueryWritableStructureMethodInfo
- queryWritableStructure :: (HasCallStack, MonadIO m) => Query -> m Structure
- getQueryMiniObject :: MonadIO m => Query -> m MiniObject
- query_miniObject :: AttrLabelProxy "miniObject"
- getQueryType :: MonadIO m => Query -> m QueryType
- query_type :: AttrLabelProxy "type"
- setQueryType :: MonadIO m => Query -> QueryType -> m ()
Exported types
Methods
addAllocationMeta
queryAddAllocationMeta Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> GType |
|
-> Maybe Structure |
|
-> m () |
Add api
with params
as one of the supported metadata API to query
.
addAllocationParam
data QueryAddAllocationParamMethodInfo Source #
((~) * signature (Maybe a -> Maybe AllocationParams -> m ()), MonadIO m, IsAllocator a) => MethodInfo * QueryAddAllocationParamMethodInfo Query signature Source # | |
queryAddAllocationParam Source #
:: (HasCallStack, MonadIO m, IsAllocator a) | |
=> Query |
|
-> Maybe a |
|
-> Maybe AllocationParams |
|
-> m () |
Add allocator
and its params
as a supported memory allocator.
addAllocationPool
data QueryAddAllocationPoolMethodInfo Source #
((~) * signature (Maybe a -> Word32 -> Word32 -> Word32 -> m ()), MonadIO m, IsBufferPool a) => MethodInfo * QueryAddAllocationPoolMethodInfo Query signature Source # | |
queryAddAllocationPool Source #
:: (HasCallStack, MonadIO m, IsBufferPool a) | |
=> Query |
|
-> Maybe a |
|
-> Word32 |
|
-> Word32 |
|
-> Word32 |
|
-> m () |
Set the pool parameters in query
.
addBufferingRange
queryAddBufferingRange Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Int64 |
|
-> Int64 |
|
-> m Bool | Returns: a |
Set the buffering-ranges array field in query
. The current last
start position of the array should be inferior to start
.
addSchedulingMode
data QueryAddSchedulingModeMethodInfo Source #
((~) * signature (PadMode -> m ()), MonadIO m) => MethodInfo * QueryAddSchedulingModeMethodInfo Query signature Source # | |
queryAddSchedulingMode Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> PadMode |
|
-> m () |
Add mode
as one of the supported scheduling modes to query
.
findAllocationMeta
queryFindAllocationMeta Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> GType |
|
-> m (Bool, Word32) | Returns: |
Check if query
has metadata api
set. When this function returns True
,
index
will contain the index where the requested API and the parameters
can be found.
getNAllocationMetas
data QueryGetNAllocationMetasMethodInfo Source #
((~) * signature (m Word32), MonadIO m) => MethodInfo * QueryGetNAllocationMetasMethodInfo Query signature Source # | |
queryGetNAllocationMetas Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m Word32 | Returns: the metadata API array size as a |
Retrieve the number of values currently stored in the meta API array of the query's structure.
getNAllocationParams
data QueryGetNAllocationParamsMethodInfo Source #
((~) * signature (m Word32), MonadIO m) => MethodInfo * QueryGetNAllocationParamsMethodInfo Query signature Source # | |
queryGetNAllocationParams Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m Word32 | Returns: the allocator array size as a |
Retrieve the number of values currently stored in the allocator params array of the query's structure.
If no memory allocator is specified, the downstream element can handle the default memory allocator. The first memory allocator in the query should be generic and allow mapping to system memory, all following allocators should be ordered by preference with the preferred one first.
getNAllocationPools
data QueryGetNAllocationPoolsMethodInfo Source #
((~) * signature (m Word32), MonadIO m) => MethodInfo * QueryGetNAllocationPoolsMethodInfo Query signature Source # | |
queryGetNAllocationPools Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m Word32 | Returns: the pool array size as a |
Retrieve the number of values currently stored in the pool array of the query's structure.
getNBufferingRanges
data QueryGetNBufferingRangesMethodInfo Source #
((~) * signature (m Word32), MonadIO m) => MethodInfo * QueryGetNBufferingRangesMethodInfo Query signature Source # | |
queryGetNBufferingRanges Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m Word32 | Returns: the range array size as a |
Retrieve the number of values currently stored in the buffered-ranges array of the query's structure.
getNSchedulingModes
data QueryGetNSchedulingModesMethodInfo Source #
((~) * signature (m Word32), MonadIO m) => MethodInfo * QueryGetNSchedulingModesMethodInfo Query signature Source # | |
queryGetNSchedulingModes Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m Word32 | Returns: the scheduling mode array size as a |
Retrieve the number of values currently stored in the scheduling mode array of the query's structure.
getStructure
data QueryGetStructureMethodInfo Source #
((~) * signature (m Structure), MonadIO m) => MethodInfo * QueryGetStructureMethodInfo Query signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m Structure | Returns: the |
Get the structure of a query.
hasSchedulingMode
data QueryHasSchedulingModeMethodInfo Source #
((~) * signature (PadMode -> m Bool), MonadIO m) => MethodInfo * QueryHasSchedulingModeMethodInfo Query signature Source # | |
queryHasSchedulingMode Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> PadMode |
|
-> m Bool | Returns: |
Check if query
has scheduling mode set.
<note>
<para>
When checking if upstream supports pull mode, it is usually not
enough to just check for GST_PAD_MODE_PULL with this function, you
also want to check whether the scheduling flags returned by
queryParseScheduling
have the seeking flag set (meaning
random access is supported, not only sequential pulls).
</para>
</note>
hasSchedulingModeWithFlags
data QueryHasSchedulingModeWithFlagsMethodInfo Source #
((~) * signature (PadMode -> [SchedulingFlags] -> m Bool), MonadIO m) => MethodInfo * QueryHasSchedulingModeWithFlagsMethodInfo Query signature Source # | |
queryHasSchedulingModeWithFlags Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> PadMode |
|
-> [SchedulingFlags] |
|
-> m Bool | Returns: |
Check if query
has scheduling mode set and flags
is set in
query scheduling flags.
newAcceptCaps
Constructs a new query object for querying if caps
are accepted.
Free-function: gst_query_unref()
newAllocation
:: (HasCallStack, MonadIO m) | |
=> Caps |
|
-> Bool |
|
-> m Query | Returns: a new |
Constructs a new query object for querying the allocation properties.
Free-function: gst_query_unref()
newBuffering
:: (HasCallStack, MonadIO m) | |
=> Format |
|
-> m Query | Returns: a new |
Constructs a new query object for querying the buffering status of a stream.
Free-function: gst_query_unref()
newCaps
:: (HasCallStack, MonadIO m) | |
=> Caps |
|
-> m Query | Returns: a new |
Constructs a new query object for querying the caps.
The CAPS query should return the allowable caps for a pad in the context of the element's state, its link to other elements, and the devices or files it has opened. These caps must be a subset of the pad template caps. In the NULL state with no links, the CAPS query should ideally return the same caps as the pad template. In rare circumstances, an object property can affect the caps returned by the CAPS query, but this is discouraged.
For most filters, the caps returned by CAPS query is directly affected by the allowed caps on other pads. For demuxers and decoders, the caps returned by the srcpad's getcaps function is directly related to the stream data. Again, the CAPS query should return the most specific caps it reasonably can, since this helps with autoplugging.
The filter
is used to restrict the result caps, only the caps matching
filter
should be returned from the CAPS query. Specifying a filter might
greatly reduce the amount of processing an element needs to do.
Free-function: gst_query_unref()
newContext
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m Query | Returns: a new |
Constructs a new query object for querying the pipeline-local context.
Free-function: gst_query_unref()
Since: 1.2
newConvert
:: (HasCallStack, MonadIO m) | |
=> Format |
|
-> Int64 |
|
-> Format |
|
-> m Query | Returns: a |
Constructs a new convert query object. Use gst_query_unref()
when done with it. A convert query is used to ask for a conversion between
one format and another.
Free-function: gst_query_unref()
newCustom
:: (HasCallStack, MonadIO m) | |
=> QueryType |
|
-> Maybe Structure |
|
-> m Query | Returns: a new |
Constructs a new custom query object. Use gst_query_unref()
when done with it.
Free-function: gst_query_unref()
newDrain
:: (HasCallStack, MonadIO m) | |
=> m Query | Returns: a new |
Constructs a new query object for querying the drain state.
Free-function: gst_query_unref()
newDuration
:: (HasCallStack, MonadIO m) | |
=> Format |
|
-> m Query | Returns: a new |
Constructs a new stream duration query object to query in the given format.
Use gst_query_unref()
when done with it. A duration query will give the
total length of the stream.
Free-function: gst_query_unref()
newFormats
:: (HasCallStack, MonadIO m) | |
=> m Query | Returns: a new |
Constructs a new query object for querying formats of the stream.
Free-function: gst_query_unref()
newLatency
:: (HasCallStack, MonadIO m) | |
=> m Query | Returns: a |
Constructs a new latency query object.
Use gst_query_unref()
when done with it. A latency query is usually performed
by sinks to compensate for additional latency introduced by elements in the
pipeline.
Free-function: gst_query_unref()
newPosition
:: (HasCallStack, MonadIO m) | |
=> Format |
|
-> m Query | Returns: a new |
Constructs a new query stream position query object. Use gst_query_unref()
when done with it. A position query is used to query the current position
of playback in the streams, in some format.
Free-function: gst_query_unref()
newScheduling
:: (HasCallStack, MonadIO m) | |
=> m Query | Returns: a new |
Constructs a new query object for querying the scheduling properties.
Free-function: gst_query_unref()
newSeeking
:: (HasCallStack, MonadIO m) | |
=> Format |
|
-> m Query | Returns: a new |
Constructs a new query object for querying seeking properties of the stream.
Free-function: gst_query_unref()
newSegment
:: (HasCallStack, MonadIO m) | |
=> Format |
|
-> m Query | Returns: a new |
Constructs a new segment query object. Use gst_query_unref()
when done with it. A segment query is used to discover information about the
currently configured segment for playback.
Free-function: gst_query_unref()
newUri
:: (HasCallStack, MonadIO m) | |
=> m Query | Returns: a new |
Constructs a new query URI query object. Use gst_query_unref()
when done with it. An URI query is used to query the current URI
that is used by the source or sink.
Free-function: gst_query_unref()
parseAcceptCaps
data QueryParseAcceptCapsMethodInfo Source #
((~) * signature (m Caps), MonadIO m) => MethodInfo * QueryParseAcceptCapsMethodInfo Query signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m Caps |
Get the caps from query
. The caps remains valid as long as query
remains
valid.
parseAcceptCapsResult
data QueryParseAcceptCapsResultMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * QueryParseAcceptCapsResultMethodInfo Query signature Source # | |
queryParseAcceptCapsResult Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Bool |
|
-> m () |
Parse the result from query
and store in result
.
parseAllocation
data QueryParseAllocationMethodInfo Source #
((~) * signature (m (Caps, Bool)), MonadIO m) => MethodInfo * QueryParseAllocationMethodInfo Query signature Source # | |
Parse an allocation query, writing the requested caps in caps
and
whether a pool is needed in needPool
, if the respective parameters
are non-Nothing
.
Pool details can be retrieved using queryGetNAllocationPools
and
queryParseNthAllocationPool
.
parseBufferingPercent
data QueryParseBufferingPercentMethodInfo Source #
((~) * signature (m (Bool, Int32)), MonadIO m) => MethodInfo * QueryParseBufferingPercentMethodInfo Query signature Source # | |
queryParseBufferingPercent Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m (Bool, Int32) |
Get the percentage of buffered data. This is a value between 0 and 100.
The busy
indicator is True
when the buffering is in progress.
parseBufferingRange
queryParseBufferingRange Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m (Format, Int64, Int64, Int64) |
Parse an available query, writing the format into format
, and
other results into the passed parameters, if the respective parameters
are non-Nothing
parseBufferingStats
data QueryParseBufferingStatsMethodInfo Source #
((~) * signature (m (BufferingMode, Int32, Int32, Int64)), MonadIO m) => MethodInfo * QueryParseBufferingStatsMethodInfo Query signature Source # | |
queryParseBufferingStats Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m (BufferingMode, Int32, Int32, Int64) |
Extracts the buffering stats values from query
.
parseCaps
data QueryParseCapsMethodInfo Source #
((~) * signature (m Caps), MonadIO m) => MethodInfo * QueryParseCapsMethodInfo Query signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m Caps |
Get the filter from the caps query
. The caps remains valid as long as
query
remains valid.
parseCapsResult
data QueryParseCapsResultMethodInfo Source #
((~) * signature (m Caps), MonadIO m) => MethodInfo * QueryParseCapsResultMethodInfo Query signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m Caps |
Get the caps result from query
. The caps remains valid as long as
query
remains valid.
parseContext
data QueryParseContextMethodInfo Source #
((~) * signature (m Context), MonadIO m) => MethodInfo * QueryParseContextMethodInfo Query signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m Context |
Get the context from the context query
. The context remains valid as long as
query
remains valid.
Since: 1.2
parseContextType
data QueryParseContextTypeMethodInfo Source #
((~) * signature (m (Bool, Text)), MonadIO m) => MethodInfo * QueryParseContextTypeMethodInfo Query signature Source # | |
queryParseContextType Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m (Bool, Text) | Returns: a |
Parse a context type from an existing GST_QUERY_CONTEXT query.
Since: 1.2
parseConvert
Parse a convert query answer. Any of srcFormat
, srcValue
, destFormat
,
and destValue
may be Nothing
, in which case that value is omitted.
parseDuration
data QueryParseDurationMethodInfo Source #
((~) * signature (m (Format, Int64)), MonadIO m) => MethodInfo * QueryParseDurationMethodInfo Query signature Source # | |
Parse a duration query answer. Write the format of the duration into format
,
and the value into duration
, if the respective variables are non-Nothing
.
parseLatency
Parse a latency query answer.
parseNFormats
data QueryParseNFormatsMethodInfo Source #
((~) * signature (m Word32), MonadIO m) => MethodInfo * QueryParseNFormatsMethodInfo Query signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m Word32 |
Parse the number of formats in the formats query
.
parseNthAllocationMeta
queryParseNthAllocationMeta Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Word32 |
|
-> m (GType, Structure) | Returns: a |
Parse an available query and get the metadata API
at index
of the metadata API array.
parseNthAllocationParam
data QueryParseNthAllocationParamMethodInfo Source #
((~) * signature (Word32 -> m (Allocator, AllocationParams)), MonadIO m) => MethodInfo * QueryParseNthAllocationParamMethodInfo Query signature Source # | |
queryParseNthAllocationParam Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Word32 |
|
-> m (Allocator, AllocationParams) |
Parse an available query and get the allocator and its params
at index
of the allocator array.
parseNthAllocationPool
data QueryParseNthAllocationPoolMethodInfo Source #
((~) * signature (Word32 -> m (BufferPool, Word32, Word32, Word32)), MonadIO m) => MethodInfo * QueryParseNthAllocationPoolMethodInfo Query signature Source # | |
queryParseNthAllocationPool Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Word32 |
|
-> m (BufferPool, Word32, Word32, Word32) |
Get the pool parameters in query
.
Unref pool
with objectUnref
when it's not needed any more.
parseNthBufferingRange
queryParseNthBufferingRange Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Word32 |
|
-> m (Bool, Int64, Int64) | Returns: a |
Parse an available query and get the start and stop values stored
at the index
of the buffered ranges array.
parseNthFormat
data QueryParseNthFormatMethodInfo Source #
((~) * signature (m (Word32, Format)), MonadIO m) => MethodInfo * QueryParseNthFormatMethodInfo Query signature Source # | |
Parse the format query and retrieve the nth
format from it into
format
. If the list contains less elements than nth
, format
will be
set to GST_FORMAT_UNDEFINED.
parseNthSchedulingMode
data QueryParseNthSchedulingModeMethodInfo Source #
((~) * signature (Word32 -> m PadMode), MonadIO m) => MethodInfo * QueryParseNthSchedulingModeMethodInfo Query signature Source # | |
queryParseNthSchedulingMode Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Word32 |
|
-> m PadMode | Returns: a |
Parse an available query and get the scheduling mode
at index
of the scheduling modes array.
parsePosition
data QueryParsePositionMethodInfo Source #
((~) * signature (m (Format, Int64)), MonadIO m) => MethodInfo * QueryParsePositionMethodInfo Query signature Source # | |
Parse a position query, writing the format into format
, and the position
into cur
, if the respective parameters are non-Nothing
.
parseScheduling
data QueryParseSchedulingMethodInfo Source #
((~) * signature (m ([SchedulingFlags], Int32, Int32, Int32)), MonadIO m) => MethodInfo * QueryParseSchedulingMethodInfo Query signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m ([SchedulingFlags], Int32, Int32, Int32) |
Set the scheduling properties.
parseSeeking
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m (Format, Bool, Int64, Int64) |
Parse a seeking query, writing the format into format
, and
other results into the passed parameters, if the respective parameters
are non-Nothing
parseSegment
Parse a segment query answer. Any of rate
, format
, startValue
, and
stopValue
may be Nothing
, which will cause this value to be omitted.
See querySetSegment
for an explanation of the function arguments.
parseUri
data QueryParseUriMethodInfo Source #
((~) * signature (m Text), MonadIO m) => MethodInfo * QueryParseUriMethodInfo Query signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m Text |
parseUriRedirection
data QueryParseUriRedirectionMethodInfo Source #
((~) * signature (m Text), MonadIO m) => MethodInfo * QueryParseUriRedirectionMethodInfo Query signature Source # | |
queryParseUriRedirection Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m Text |
parseUriRedirectionPermanent
data QueryParseUriRedirectionPermanentMethodInfo Source #
((~) * signature (m Bool), MonadIO m) => MethodInfo * QueryParseUriRedirectionPermanentMethodInfo Query signature Source # | |
queryParseUriRedirectionPermanent Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m Bool |
Parse an URI query, and set permanent
to True
if there is a redirection
and it should be considered permanent. If a redirection is permanent,
applications should update their internal storage of the URI, otherwise
they should make all future requests to the original URI.
Since: 1.4
removeNthAllocationMeta
data QueryRemoveNthAllocationMetaMethodInfo Source #
((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * QueryRemoveNthAllocationMetaMethodInfo Query signature Source # | |
queryRemoveNthAllocationMeta Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Word32 |
|
-> m () |
Remove the metadata API at index
of the metadata API array.
removeNthAllocationParam
data QueryRemoveNthAllocationParamMethodInfo Source #
((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * QueryRemoveNthAllocationParamMethodInfo Query signature Source # | |
queryRemoveNthAllocationParam Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Word32 |
|
-> m () |
Remove the allocation param at index
of the allocation param array.
Since: 1.2
removeNthAllocationPool
data QueryRemoveNthAllocationPoolMethodInfo Source #
((~) * signature (Word32 -> m ()), MonadIO m) => MethodInfo * QueryRemoveNthAllocationPoolMethodInfo Query signature Source # | |
queryRemoveNthAllocationPool Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Word32 |
|
-> m () |
Remove the allocation pool at index
of the allocation pool array.
Since: 1.2
setAcceptCapsResult
data QuerySetAcceptCapsResultMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * QuerySetAcceptCapsResultMethodInfo Query signature Source # | |
querySetAcceptCapsResult Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Bool |
|
-> m () |
Set result
as the result for the query
.
setBufferingPercent
data QuerySetBufferingPercentMethodInfo Source #
((~) * signature (Bool -> Int32 -> m ()), MonadIO m) => MethodInfo * QuerySetBufferingPercentMethodInfo Query signature Source # | |
querySetBufferingPercent Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Bool |
|
-> Int32 |
|
-> m () |
Set the percentage of buffered data. This is a value between 0 and 100.
The busy
indicator is True
when the buffering is in progress.
setBufferingRange
querySetBufferingRange Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Format |
|
-> Int64 |
|
-> Int64 |
|
-> Int64 |
|
-> m () |
Set the available query result fields in query
.
setBufferingStats
data QuerySetBufferingStatsMethodInfo Source #
((~) * signature (BufferingMode -> Int32 -> Int32 -> Int64 -> m ()), MonadIO m) => MethodInfo * QuerySetBufferingStatsMethodInfo Query signature Source # | |
querySetBufferingStats Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> BufferingMode |
|
-> Int32 |
|
-> Int32 |
|
-> Int64 |
|
-> m () |
Configures the buffering stats values in query
.
setCapsResult
data QuerySetCapsResultMethodInfo Source #
((~) * signature (Caps -> m ()), MonadIO m) => MethodInfo * QuerySetCapsResultMethodInfo Query signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Caps |
|
-> m () |
Set the caps
result in query
.
setContext
data QuerySetContextMethodInfo Source #
((~) * signature (Context -> m ()), MonadIO m) => MethodInfo * QuerySetContextMethodInfo Query signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Context |
|
-> m () |
Answer a context query by setting the requested context.
Since: 1.2
setConvert
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Format |
|
-> Int64 |
|
-> Format |
|
-> Int64 |
|
-> m () |
Answer a convert query by setting the requested values.
setDuration
data QuerySetDurationMethodInfo Source #
((~) * signature (Format -> Int64 -> m ()), MonadIO m) => MethodInfo * QuerySetDurationMethodInfo Query signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Format |
|
-> Int64 |
|
-> m () |
Answer a duration query by setting the requested value in the given format.
setFormatsv
data QuerySetFormatsvMethodInfo Source #
((~) * signature ([Format] -> m ()), MonadIO m) => MethodInfo * QuerySetFormatsvMethodInfo Query signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> [Format] |
|
-> m () |
Set the formats query result fields in query
. The number of formats passed
in the formats
array must be equal to nFormats
.
setLatency
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Bool |
|
-> Word64 |
|
-> Word64 |
|
-> m () |
Answer a latency query by setting the requested values in the given format.
setNthAllocationParam
data QuerySetNthAllocationParamMethodInfo Source #
((~) * signature (Word32 -> Maybe a -> Maybe AllocationParams -> m ()), MonadIO m, IsAllocator a) => MethodInfo * QuerySetNthAllocationParamMethodInfo Query signature Source # | |
querySetNthAllocationParam Source #
:: (HasCallStack, MonadIO m, IsAllocator a) | |
=> Query |
|
-> Word32 |
|
-> Maybe a |
|
-> Maybe AllocationParams |
|
-> m () |
Parse an available query and get the allocator and its params
at index
of the allocator array.
setNthAllocationPool
data QuerySetNthAllocationPoolMethodInfo Source #
((~) * signature (Word32 -> Maybe a -> Word32 -> Word32 -> Word32 -> m ()), MonadIO m, IsBufferPool a) => MethodInfo * QuerySetNthAllocationPoolMethodInfo Query signature Source # | |
querySetNthAllocationPool Source #
:: (HasCallStack, MonadIO m, IsBufferPool a) | |
=> Query |
|
-> Word32 |
|
-> Maybe a |
|
-> Word32 |
|
-> Word32 |
|
-> Word32 |
|
-> m () |
Set the pool parameters in query
.
setPosition
data QuerySetPositionMethodInfo Source #
((~) * signature (Format -> Int64 -> m ()), MonadIO m) => MethodInfo * QuerySetPositionMethodInfo Query signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Format |
|
-> Int64 |
|
-> m () |
Answer a position query by setting the requested value in the given format.
setScheduling
data QuerySetSchedulingMethodInfo Source #
((~) * signature ([SchedulingFlags] -> Int32 -> Int32 -> Int32 -> m ()), MonadIO m) => MethodInfo * QuerySetSchedulingMethodInfo Query signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> [SchedulingFlags] |
|
-> Int32 |
|
-> Int32 |
|
-> Int32 |
|
-> m () |
Set the scheduling properties.
setSeeking
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Format |
|
-> Bool |
|
-> Int64 |
|
-> Int64 |
|
-> m () |
Set the seeking query result fields in query
.
setSegment
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Double |
|
-> Format |
|
-> Int64 |
|
-> Int64 |
|
-> m () |
Answer a segment query by setting the requested values. The normal playback segment of a pipeline is 0 to duration at the default rate of 1.0. If a seek was performed on the pipeline to play a different segment, this query will return the range specified in the last seek.
startValue
and stopValue
will respectively contain the configured
playback range start and stop values expressed in format
.
The values are always between 0 and the duration of the media and
startValue
<= stopValue
. rate
will contain the playback rate. For
negative rates, playback will actually happen from stopValue
to
startValue
.
setUri
data QuerySetUriMethodInfo Source #
((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * QuerySetUriMethodInfo Query signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Text |
|
-> m () |
Answer a URI query by setting the requested URI.
setUriRedirection
data QuerySetUriRedirectionMethodInfo Source #
((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * QuerySetUriRedirectionMethodInfo Query signature Source # | |
querySetUriRedirection Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Text |
|
-> m () |
Answer a URI query by setting the requested URI redirection.
Since: 1.2
setUriRedirectionPermanent
data QuerySetUriRedirectionPermanentMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * QuerySetUriRedirectionPermanentMethodInfo Query signature Source # | |
querySetUriRedirectionPermanent Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> Bool |
|
-> m () |
Answer a URI query by setting the requested URI redirection to permanent or not.
Since: 1.4
writableStructure
data QueryWritableStructureMethodInfo Source #
((~) * signature (m Structure), MonadIO m) => MethodInfo * QueryWritableStructureMethodInfo Query signature Source # | |
queryWritableStructure Source #
:: (HasCallStack, MonadIO m) | |
=> Query |
|
-> m Structure | Returns: the |
Get the structure of a query. This method should be called with a writable
query
so that the returned structure is guaranteed to be writable.
Properties
miniObject
getQueryMiniObject :: MonadIO m => Query -> m MiniObject Source #
query_miniObject :: AttrLabelProxy "miniObject" Source #
type
query_type :: AttrLabelProxy "type" Source #