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.

Exported types

newtype StreamCollection

Constructors

StreamCollection (ManagedPtr StreamCollection)

Instances

GObject StreamCollection

Methods

gobjectType :: StreamCollection -> IO GType

IsObject StreamCollection

IsStreamCollection StreamCollection

IsObject StreamCollection

((~) * info (ResolveStreamCollectionMethod t StreamCollection), MethodInfo * info StreamCollection p) => IsLabel t (StreamCollection -> p)

Methods

fromLabel :: Proxy# Symbol t -> StreamCollection -> p

((~) * info (ResolveStreamCollectionMethod t StreamCollection), MethodInfo * info StreamCollection p) => IsLabelProxy t (StreamCollection -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> StreamCollection -> p

HasAttributeList * StreamCollection

type AttributeList StreamCollection

type AttributeList StreamCollection

type SignalList StreamCollection

type SignalList StreamCollection

class GObject o => IsStreamCollection o

Instances

(GObject a, UnknownAncestorError Constraint StreamCollection a) => IsStreamCollection a

IsStreamCollection StreamCollection

toStreamCollection :: IsStreamCollection o => o -> IO StreamCollection

noStreamCollection :: Maybe StreamCollection

Methods

addStream

data StreamCollectionAddStreamMethodInfo

Instances

((~) * signature (b -> m Bool), MonadIO m, IsStreamCollection a, IsStream b) => MethodInfo * StreamCollectionAddStreamMethodInfo a signature

Methods

overloadedMethod :: MethodProxy StreamCollectionAddStreamMethodInfo a -> signature -> s

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

data StreamCollectionGetSizeMethodInfo

Instances

((~) * signature (m Word32), MonadIO m, IsStreamCollection a) => MethodInfo * StreamCollectionGetSizeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy StreamCollectionGetSizeMethodInfo a -> signature -> s

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

data StreamCollectionGetStreamMethodInfo

Instances

((~) * signature (Word32 -> m Stream), MonadIO m, IsStreamCollection a) => MethodInfo * StreamCollectionGetStreamMethodInfo a signature

Methods

overloadedMethod :: MethodProxy StreamCollectionGetStreamMethodInfo a -> signature -> s

streamCollectionGetStream

Arguments

:: (HasCallStack, MonadIO m, IsStreamCollection a)

=> a

collection: a StreamCollection

-> Word32

index: Index of the stream to retrieve

-> m 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

data StreamCollectionGetUpstreamIdMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsStreamCollection a) => MethodInfo * StreamCollectionGetUpstreamIdMethodInfo a signature

Methods

overloadedMethod :: MethodProxy StreamCollectionGetUpstreamIdMethodInfo a -> signature -> s

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

data StreamCollectionUpstreamIdPropertyInfo

Instances

AttrInfo StreamCollectionUpstreamIdPropertyInfo

Associated Types

type AttrAllowedOps StreamCollectionUpstreamIdPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint StreamCollectionUpstreamIdPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint StreamCollectionUpstreamIdPropertyInfo :: * -> Constraint

type AttrGetType StreamCollectionUpstreamIdPropertyInfo :: *

type AttrLabel StreamCollectionUpstreamIdPropertyInfo :: Symbol

type AttrOrigin StreamCollectionUpstreamIdPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint StreamCollectionUpstreamIdPropertyInfo o => Proxy * StreamCollectionUpstreamIdPropertyInfo -> o -> IO (AttrGetType StreamCollectionUpstreamIdPropertyInfo)

attrSet :: (AttrBaseTypeConstraint StreamCollectionUpstreamIdPropertyInfo o, AttrSetTypeConstraint StreamCollectionUpstreamIdPropertyInfo b) => Proxy * StreamCollectionUpstreamIdPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint StreamCollectionUpstreamIdPropertyInfo o => Proxy * StreamCollectionUpstreamIdPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint StreamCollectionUpstreamIdPropertyInfo o, AttrSetTypeConstraint StreamCollectionUpstreamIdPropertyInfo b) => Proxy * StreamCollectionUpstreamIdPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin StreamCollectionUpstreamIdPropertyInfo

type AttrOrigin StreamCollectionUpstreamIdPropertyInfo = StreamCollection

type AttrLabel StreamCollectionUpstreamIdPropertyInfo

type AttrLabel StreamCollectionUpstreamIdPropertyInfo = "upstream-id"

type AttrGetType StreamCollectionUpstreamIdPropertyInfo

type AttrGetType StreamCollectionUpstreamIdPropertyInfo = Text

type AttrBaseTypeConstraint StreamCollectionUpstreamIdPropertyInfo

type AttrBaseTypeConstraint StreamCollectionUpstreamIdPropertyInfo = IsStreamCollection

type AttrSetTypeConstraint StreamCollectionUpstreamIdPropertyInfo

type AttrSetTypeConstraint StreamCollectionUpstreamIdPropertyInfo = * ~ Text

type AttrAllowedOps StreamCollectionUpstreamIdPropertyInfo

type AttrAllowedOps StreamCollectionUpstreamIdPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

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

constructStreamCollectionUpstreamId :: IsStreamCollection o => Text -> IO (GValueConstruct o)

getStreamCollectionUpstreamId :: (MonadIO m, IsStreamCollection o) => o -> m Text

setStreamCollectionUpstreamId :: (MonadIO m, IsStreamCollection o) => o -> Text -> m ()

streamCollectionUpstreamId :: AttrLabelProxy "upstreamId"

Signals

streamNotify

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

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

data StreamCollectionStreamNotifySignalInfo

Instances

SignalInfo StreamCollectionStreamNotifySignalInfo

Associated Types

type HaskellCallbackType StreamCollectionStreamNotifySignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o StreamCollectionStreamNotifySignalInfo -> o -> HaskellCallbackType StreamCollectionStreamNotifySignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType StreamCollectionStreamNotifySignalInfo

type HaskellCallbackType StreamCollectionStreamNotifySignalInfo = StreamCollectionStreamNotifyCallback

afterStreamCollectionStreamNotify :: (GObject a, MonadIO m) => a -> StreamCollectionStreamNotifyCallback -> m SignalHandlerId

genClosure_StreamCollectionStreamNotify :: StreamCollectionStreamNotifyCallback -> IO Closure

mk_StreamCollectionStreamNotifyCallback :: C_StreamCollectionStreamNotifyCallback -> IO (FunPtr C_StreamCollectionStreamNotifyCallback)

noStreamCollectionStreamNotifyCallback :: Maybe StreamCollectionStreamNotifyCallback

onStreamCollectionStreamNotify :: (GObject a, MonadIO m) => a -> StreamCollectionStreamNotifyCallback -> m SignalHandlerId

wrap_StreamCollectionStreamNotifyCallback :: StreamCollectionStreamNotifyCallback -> Ptr () -> Ptr Stream -> Ptr GParamSpec -> Ptr () -> IO ()