GI.Gst.Objects.StreamCollection

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

Exported types

newtype StreamCollection

Memory-managed wrapper type.

Constructors

StreamCollection (ManagedPtr StreamCollection)

Instances

Eq StreamCollection

Defined in GI.Gst.Objects.StreamCollection

Methods

(==) :: StreamCollection -> StreamCollection -> Bool

(/=) :: StreamCollection -> StreamCollection -> Bool

GObject StreamCollection

Defined in GI.Gst.Objects.StreamCollection

ManagedPtrNewtype StreamCollection

Defined in GI.Gst.Objects.StreamCollection

Methods

toManagedPtr :: StreamCollection -> ManagedPtr StreamCollection

TypedObject StreamCollection

Defined in GI.Gst.Objects.StreamCollection

Methods

glibType :: IO GType

IsGValue StreamCollection

Convert StreamCollection to and from GValue with toGValue and fromGValue.

Defined in GI.Gst.Objects.StreamCollection

Methods

toGValue :: StreamCollection -> IO GValue

fromGValue :: GValue -> IO StreamCollection

HasParentTypes StreamCollection

Defined in GI.Gst.Objects.StreamCollection

type ParentTypes StreamCollection

Defined in GI.Gst.Objects.StreamCollection

type ParentTypes StreamCollection = '[Object, Object]

class (GObject o, IsDescendantOf StreamCollection o) => IsStreamCollection o

Type class for types which can be safely cast to StreamCollection, for instance with toStreamCollection.

Instances

(GObject o, IsDescendantOf StreamCollection o) => IsStreamCollection o

Defined in GI.Gst.Objects.StreamCollection

toStreamCollection :: (MonadIO m, IsStreamCollection o) => o -> m StreamCollection

Cast to StreamCollection, for types for which this is known to be safe. For general casts, use castTo.

Methods

Overloaded methods

addStream

streamCollectionAddStream

Arguments

:: (HasCallStack, MonadIO m, IsStreamCollection a, IsStream b)

=> a

collection: a StreamCollection

-> b

stream: the Stream to add

-> m Bool

Returns: True if the stream was properly added, else False

Add the given stream to the collection.

Since: 1.10

getSize

streamCollectionGetSize

Arguments

:: (HasCallStack, MonadIO m, IsStreamCollection a)

=> a

collection: a StreamCollection

-> m Word32

Returns: The number of streams that collection contains

Get the number of streams this collection contains

Since: 1.10

getStream

streamCollectionGetStream

Arguments

:: (HasCallStack, MonadIO m, IsStreamCollection a)

=> a

collection: a StreamCollection

-> Word32

index: Index of the stream to retrieve

-> m (Maybe Stream)

Returns: A Stream

Retrieve the Stream with index index from the collection.

The caller should not modify the returned Stream

Since: 1.10

getUpstreamId

streamCollectionGetUpstreamId

Arguments

:: (HasCallStack, MonadIO m, IsStreamCollection a)

=> a

collection: a StreamCollection

-> m Text

Returns: The upstream id

Returns the upstream id of the collection.

Since: 1.10

new

streamCollectionNew

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

upstreamId: The stream id of the parent stream

-> m StreamCollection

Returns: The new StreamCollection.

Create a new StreamCollection.

Since: 1.10

Properties

upstreamId

No description available in the introspection data.

clearStreamCollectionUpstreamId :: (MonadIO m, IsStreamCollection o) => o -> m ()

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)

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 Text

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 ()

Set the value of the “upstream-id” property. When overloading is enabled, this is equivalent to

set streamCollection [ #upstreamId := value ]

Signals

streamNotify

type C_StreamCollectionStreamNotifyCallback = Ptr () -> Ptr Stream -> Ptr GParamSpec -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type StreamCollectionStreamNotifyCallback = Stream -> GParamSpec -> IO ()

No description available in the introspection data.

afterStreamCollectionStreamNotify :: (IsStreamCollection a, MonadIO m) => a -> Maybe Text -> StreamCollectionStreamNotifyCallback -> m SignalHandlerId

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.

genClosure_StreamCollectionStreamNotify :: MonadIO m => StreamCollectionStreamNotifyCallback -> m (GClosure C_StreamCollectionStreamNotifyCallback)

Wrap the callback into a GClosure.

mk_StreamCollectionStreamNotifyCallback :: C_StreamCollectionStreamNotifyCallback -> IO (FunPtr C_StreamCollectionStreamNotifyCallback)

Generate a function pointer callable from C code, from a C_StreamCollectionStreamNotifyCallback.

noStreamCollectionStreamNotifyCallback :: Maybe StreamCollectionStreamNotifyCallback

A convenience synonym for Nothing :: Maybe StreamCollectionStreamNotifyCallback.

onStreamCollectionStreamNotify :: (IsStreamCollection a, MonadIO m) => a -> Maybe Text -> StreamCollectionStreamNotifyCallback -> m SignalHandlerId

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.

wrap_StreamCollectionStreamNotifyCallback :: StreamCollectionStreamNotifyCallback -> C_StreamCollectionStreamNotifyCallback

Wrap a StreamCollectionStreamNotifyCallback into a C_StreamCollectionStreamNotifyCallback.