Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
A high-level object representing a single stream. It might be backed, or
not, by an actual flow of data in a pipeline (tPad
).
A Stream
does not care about data changes (such as decoding, encoding,
parsing,...) as long as the underlying data flow corresponds to the same
high-level flow (ex: a certain audio track).
A Stream
contains all the information pertinent to a stream, such as
stream-id, tags, caps, type, ...
Elements can subclass a Stream
for internal usage (to contain information
pertinent to streams of data).
Since: 1.10
Synopsis
- newtype Stream = Stream (ManagedPtr Stream)
- class (GObject o, IsDescendantOf Stream o) => IsStream o
- toStream :: (MonadIO m, IsStream o) => o -> m Stream
- streamGetCaps :: (HasCallStack, MonadIO m, IsStream a) => a -> m (Maybe Caps)
- streamGetStreamFlags :: (HasCallStack, MonadIO m, IsStream a) => a -> m [StreamFlags]
- streamGetStreamId :: (HasCallStack, MonadIO m, IsStream a) => a -> m (Maybe Text)
- streamGetStreamType :: (HasCallStack, MonadIO m, IsStream a) => a -> m [StreamType]
- streamGetTags :: (HasCallStack, MonadIO m, IsStream a) => a -> m (Maybe TagList)
- streamNew :: (HasCallStack, MonadIO m) => Maybe Text -> Maybe Caps -> [StreamType] -> [StreamFlags] -> m Stream
- streamSetCaps :: (HasCallStack, MonadIO m, IsStream a) => a -> Maybe Caps -> m ()
- streamSetStreamFlags :: (HasCallStack, MonadIO m, IsStream a) => a -> [StreamFlags] -> m ()
- streamSetStreamType :: (HasCallStack, MonadIO m, IsStream a) => a -> [StreamType] -> m ()
- streamSetTags :: (HasCallStack, MonadIO m, IsStream a) => a -> Maybe TagList -> m ()
- clearStreamCaps :: (MonadIO m, IsStream o) => o -> m ()
- constructStreamCaps :: (IsStream o, MonadIO m) => Caps -> m (GValueConstruct o)
- getStreamCaps :: (MonadIO m, IsStream o) => o -> m (Maybe Caps)
- setStreamCaps :: (MonadIO m, IsStream o) => o -> Caps -> m ()
- constructStreamStreamFlags :: (IsStream o, MonadIO m) => [StreamFlags] -> m (GValueConstruct o)
- getStreamStreamFlags :: (MonadIO m, IsStream o) => o -> m [StreamFlags]
- setStreamStreamFlags :: (MonadIO m, IsStream o) => o -> [StreamFlags] -> m ()
- constructStreamStreamId :: (IsStream o, MonadIO m) => Text -> m (GValueConstruct o)
- getStreamStreamId :: (MonadIO m, IsStream o) => o -> m (Maybe Text)
- constructStreamStreamType :: (IsStream o, MonadIO m) => [StreamType] -> m (GValueConstruct o)
- getStreamStreamType :: (MonadIO m, IsStream o) => o -> m [StreamType]
- setStreamStreamType :: (MonadIO m, IsStream o) => o -> [StreamType] -> m ()
- clearStreamTags :: (MonadIO m, IsStream o) => o -> m ()
- constructStreamTags :: (IsStream o, MonadIO m) => TagList -> m (GValueConstruct o)
- getStreamTags :: (MonadIO m, IsStream o) => o -> m (Maybe TagList)
- setStreamTags :: (MonadIO m, IsStream o) => o -> TagList -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq Stream Source # | |
GObject Stream Source # | |
Defined in GI.Gst.Objects.Stream | |
ManagedPtrNewtype Stream Source # | |
Defined in GI.Gst.Objects.Stream toManagedPtr :: Stream -> ManagedPtr Stream | |
TypedObject Stream Source # | |
Defined in GI.Gst.Objects.Stream | |
HasParentTypes Stream Source # | |
Defined in GI.Gst.Objects.Stream | |
IsGValue (Maybe Stream) Source # | Convert |
Defined in GI.Gst.Objects.Stream gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Stream -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Stream) | |
type ParentTypes Stream Source # | |
Defined in GI.Gst.Objects.Stream |
class (GObject o, IsDescendantOf Stream o) => IsStream o Source #
Instances
(GObject o, IsDescendantOf Stream o) => IsStream o Source # | |
Defined in GI.Gst.Objects.Stream |
Methods
Click to display all available methods, including inherited ones
Methods
addControlBinding, bindProperty, bindPropertyFull, defaultError, forceFloating, freezeNotify, getv, hasActiveControlBindings, hasAncestor, hasAsAncestor, hasAsParent, isFloating, notify, notifyByPspec, ref, refSink, removeControlBinding, runDispose, stealData, stealQdata, suggestNextSync, syncValues, thawNotify, unparent, unref, watchClosure.
Getters
getCaps, getControlBinding, getControlRate, getData, getGValueArray, getName, getParent, getPathString, getProperty, getQdata, getStreamFlags, getStreamId, getStreamType, getTags, getValue.
Setters
setCaps, setControlBindingDisabled, setControlBindingsDisabled, setControlRate, setData, setDataFull, setName, setParent, setProperty, setStreamFlags, setStreamType, setTags.
getCaps
:: (HasCallStack, MonadIO m, IsStream a) | |
=> a |
|
-> m (Maybe Caps) | Returns: The |
Retrieve the caps for stream
, if any
Since: 1.10
getStreamFlags
:: (HasCallStack, MonadIO m, IsStream a) | |
=> a |
|
-> m [StreamFlags] | Returns: The |
Retrieve the current stream flags for stream
Since: 1.10
getStreamId
:: (HasCallStack, MonadIO m, IsStream a) | |
=> a |
|
-> m (Maybe Text) | Returns: the stream ID of |
Returns the stream ID of stream
.
Since: 1.10
getStreamType
:: (HasCallStack, MonadIO m, IsStream a) | |
=> a |
|
-> m [StreamType] | Returns: The |
Retrieve the stream type for stream
Since: 1.10
getTags
:: (HasCallStack, MonadIO m, IsStream a) | |
=> a |
|
-> m (Maybe TagList) | Returns: The |
Retrieve the tags for stream
, if any
Since: 1.10
new
:: (HasCallStack, MonadIO m) | |
=> Maybe Text |
|
-> Maybe Caps |
|
-> [StreamType] |
|
-> [StreamFlags] |
|
-> m Stream | Returns: The new |
Create a new Stream
for the given streamId
, caps
, type
and flags
Since: 1.10
setCaps
Set the caps for the Stream
Since: 1.10
setStreamFlags
:: (HasCallStack, MonadIO m, IsStream a) | |
=> a |
|
-> [StreamFlags] |
|
-> m () |
Set the flags
for the stream
.
Since: 1.10
setStreamType
:: (HasCallStack, MonadIO m, IsStream a) | |
=> a |
|
-> [StreamType] |
|
-> m () |
Set the stream type of stream
Since: 1.10
setTags
Set the tags for the Stream
Since: 1.10
Properties
caps
clearStreamCaps :: (MonadIO m, IsStream o) => o -> m () Source #
Set the value of the “caps
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#caps
constructStreamCaps :: (IsStream o, MonadIO m) => Caps -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “caps
” property. This is rarely needed directly, but it is used by new
.
getStreamCaps :: (MonadIO m, IsStream o) => o -> m (Maybe Caps) Source #
Get the value of the “caps
” property.
When overloading is enabled, this is equivalent to
get
stream #caps
setStreamCaps :: (MonadIO m, IsStream o) => o -> Caps -> m () Source #
Set the value of the “caps
” property.
When overloading is enabled, this is equivalent to
set
stream [ #caps:=
value ]
streamFlags
No description available in the introspection data.
constructStreamStreamFlags :: (IsStream o, MonadIO m) => [StreamFlags] -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “stream-flags
” property. This is rarely needed directly, but it is used by new
.
getStreamStreamFlags :: (MonadIO m, IsStream o) => o -> m [StreamFlags] Source #
Get the value of the “stream-flags
” property.
When overloading is enabled, this is equivalent to
get
stream #streamFlags
setStreamStreamFlags :: (MonadIO m, IsStream o) => o -> [StreamFlags] -> m () Source #
Set the value of the “stream-flags
” property.
When overloading is enabled, this is equivalent to
set
stream [ #streamFlags:=
value ]
streamId
The unique identifier of the Stream
. Can only be set at construction
time.
constructStreamStreamId :: (IsStream o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “stream-id
” property. This is rarely needed directly, but it is used by new
.
getStreamStreamId :: (MonadIO m, IsStream o) => o -> m (Maybe Text) Source #
Get the value of the “stream-id
” property.
When overloading is enabled, this is equivalent to
get
stream #streamId
streamType
The StreamType
of the Stream
. Can only be set at construction time.
constructStreamStreamType :: (IsStream o, MonadIO m) => [StreamType] -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “stream-type
” property. This is rarely needed directly, but it is used by new
.
getStreamStreamType :: (MonadIO m, IsStream o) => o -> m [StreamType] Source #
Get the value of the “stream-type
” property.
When overloading is enabled, this is equivalent to
get
stream #streamType
setStreamStreamType :: (MonadIO m, IsStream o) => o -> [StreamType] -> m () Source #
Set the value of the “stream-type
” property.
When overloading is enabled, this is equivalent to
set
stream [ #streamType:=
value ]
tags
clearStreamTags :: (MonadIO m, IsStream o) => o -> m () Source #
Set the value of the “tags
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#tags
constructStreamTags :: (IsStream o, MonadIO m) => TagList -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “tags
” property. This is rarely needed directly, but it is used by new
.
getStreamTags :: (MonadIO m, IsStream o) => o -> m (Maybe TagList) Source #
Get the value of the “tags
” property.
When overloading is enabled, this is equivalent to
get
stream #tags
setStreamTags :: (MonadIO m, IsStream o) => o -> TagList -> m () Source #
Set the value of the “tags
” property.
When overloading is enabled, this is equivalent to
set
stream [ #tags:=
value ]