Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
A collection of Stream
that are available.
A StreamCollection
will be provided by elements that can make those
streams available. Applications can use the collection to show the user
what streams are available by using gst_stream_collection_get_stream
()
Once posted, a StreamCollection
is immutable. Updates are made by sending
a new StreamCollection
message, which may or may not share some of
the Stream
objects from the collection it replaces. The receiver can check
the sender of a stream collection message to know which collection is
obsoleted.
Several elements in a pipeline can provide StreamCollection
.
Applications can activate streams from a collection by using the
GST_EVENT_SELECT_STREAMS
event on a pipeline, bin or element.
Since: 1.10
Synopsis
- newtype StreamCollection = StreamCollection (ManagedPtr StreamCollection)
- class (GObject o, IsDescendantOf StreamCollection o) => IsStreamCollection o
- toStreamCollection :: (MonadIO m, IsStreamCollection o) => o -> m StreamCollection
- streamCollectionAddStream :: (HasCallStack, MonadIO m, IsStreamCollection a, IsStream b) => a -> b -> m Bool
- streamCollectionGetSize :: (HasCallStack, MonadIO m, IsStreamCollection a) => a -> m Word32
- streamCollectionGetStream :: (HasCallStack, MonadIO m, IsStreamCollection a) => a -> Word32 -> m (Maybe Stream)
- streamCollectionGetUpstreamId :: (HasCallStack, MonadIO m, IsStreamCollection a) => a -> m (Maybe Text)
- streamCollectionNew :: (HasCallStack, MonadIO m) => Maybe Text -> m StreamCollection
- clearStreamCollectionUpstreamId :: (MonadIO m, IsStreamCollection o) => o -> m ()
- constructStreamCollectionUpstreamId :: (IsStreamCollection o, MonadIO m) => Text -> m (GValueConstruct o)
- getStreamCollectionUpstreamId :: (MonadIO m, IsStreamCollection o) => o -> m (Maybe Text)
- setStreamCollectionUpstreamId :: (MonadIO m, IsStreamCollection o) => o -> Text -> m ()
- type StreamCollectionStreamNotifyCallback = Stream -> GParamSpec -> IO ()
- afterStreamCollectionStreamNotify :: (IsStreamCollection a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => StreamCollectionStreamNotifyCallback) -> m SignalHandlerId
- onStreamCollectionStreamNotify :: (IsStreamCollection a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => StreamCollectionStreamNotifyCallback) -> m SignalHandlerId
Exported types
newtype StreamCollection Source #
Memory-managed wrapper type.
StreamCollection (ManagedPtr StreamCollection) |
Instances
Eq StreamCollection Source # | |
Defined in GI.Gst.Objects.StreamCollection (==) :: StreamCollection -> StreamCollection -> Bool # (/=) :: StreamCollection -> StreamCollection -> Bool # | |
GObject StreamCollection Source # | |
Defined in GI.Gst.Objects.StreamCollection | |
ManagedPtrNewtype StreamCollection Source # | |
Defined in GI.Gst.Objects.StreamCollection toManagedPtr :: StreamCollection -> ManagedPtr StreamCollection | |
TypedObject StreamCollection Source # | |
Defined in GI.Gst.Objects.StreamCollection | |
HasParentTypes StreamCollection Source # | |
Defined in GI.Gst.Objects.StreamCollection | |
IsGValue (Maybe StreamCollection) Source # | Convert |
Defined in GI.Gst.Objects.StreamCollection gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe StreamCollection -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe StreamCollection) | |
type ParentTypes StreamCollection Source # | |
Defined in GI.Gst.Objects.StreamCollection |
class (GObject o, IsDescendantOf StreamCollection o) => IsStreamCollection o Source #
Type class for types which can be safely cast to StreamCollection
, for instance with toStreamCollection
.
Instances
(GObject o, IsDescendantOf StreamCollection o) => IsStreamCollection o Source # | |
Defined in GI.Gst.Objects.StreamCollection |
toStreamCollection :: (MonadIO m, IsStreamCollection o) => o -> m StreamCollection Source #
Cast to StreamCollection
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Click to display all available methods, including inherited ones
Methods
addControlBinding, addStream, 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
getControlBinding, getControlRate, getData, getGValueArray, getName, getParent, getPathString, getProperty, getQdata, getSize, getStream, getUpstreamId, getValue.
Setters
setControlBindingDisabled, setControlBindingsDisabled, setControlRate, setData, setDataFull, setName, setParent, setProperty.
addStream
streamCollectionAddStream Source #
:: (HasCallStack, MonadIO m, IsStreamCollection a, IsStream b) | |
=> a |
|
-> b |
|
-> m Bool |
Add the given stream
to the collection
.
Since: 1.10
getSize
streamCollectionGetSize Source #
:: (HasCallStack, MonadIO m, IsStreamCollection a) | |
=> a |
|
-> m Word32 | Returns: The number of streams that |
Get the number of streams this collection contains
Since: 1.10
getStream
streamCollectionGetStream Source #
:: (HasCallStack, MonadIO m, IsStreamCollection a) | |
=> a |
|
-> Word32 |
|
-> m (Maybe Stream) | Returns: A |
getUpstreamId
streamCollectionGetUpstreamId Source #
:: (HasCallStack, MonadIO m, IsStreamCollection a) | |
=> a |
|
-> m (Maybe Text) | Returns: The upstream id |
Returns the upstream id of the collection
.
Since: 1.10
new
:: (HasCallStack, MonadIO m) | |
=> Maybe Text |
|
-> m StreamCollection | Returns: The new |
Create a new StreamCollection
.
Since: 1.10
Properties
upstreamId
No description available in the introspection data.
clearStreamCollectionUpstreamId :: (MonadIO m, IsStreamCollection o) => o -> m () Source #
Set the value of the “upstream-id
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#upstreamId
constructStreamCollectionUpstreamId :: (IsStreamCollection o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “upstream-id
” property. This is rarely needed directly, but it is used by new
.
getStreamCollectionUpstreamId :: (MonadIO m, IsStreamCollection o) => o -> m (Maybe Text) Source #
Get the value of the “upstream-id
” property.
When overloading is enabled, this is equivalent to
get
streamCollection #upstreamId
setStreamCollectionUpstreamId :: (MonadIO m, IsStreamCollection o) => o -> Text -> m () Source #
Set the value of the “upstream-id
” property.
When overloading is enabled, this is equivalent to
set
streamCollection [ #upstreamId:=
value ]
Signals
streamNotify
type StreamCollectionStreamNotifyCallback = Stream -> GParamSpec -> IO () Source #
No description available in the introspection data.
afterStreamCollectionStreamNotify :: (IsStreamCollection a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => StreamCollectionStreamNotifyCallback) -> m SignalHandlerId Source #
Connect a signal handler for the streamNotify signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
streamCollection #streamNotify callback
This signal admits a optional parameter detail
.
If it's not Nothing
, we will connect to “stream-notify::detail
” instead.
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onStreamCollectionStreamNotify :: (IsStreamCollection a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => StreamCollectionStreamNotifyCallback) -> m SignalHandlerId Source #
Connect a signal handler for the streamNotify signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
streamCollection #streamNotify callback
This signal admits a optional parameter detail
.
If it's not Nothing
, we will connect to “stream-notify::detail
” instead.