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

GI.Gst.Objects.Stream

Contents

Exported types
Methods
Properties

Description

A high-level object representing a single stream. It might be backed, or not, by an actual flow of data in a pipeline (Pad).

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

Synopsis

Exported types

newtype Stream Source #

Constructors

Stream (ManagedPtr Stream)

Instances

GObject Stream Source #
Methods gobjectType :: Stream -> IO GType #
IsObject Stream Source #

IsStream Stream Source #

IsObject Stream Source #

((~) * info (ResolveStreamMethod t Stream), MethodInfo * info Stream p) => IsLabel t (Stream -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> Stream -> p #
((~) * info (ResolveStreamMethod t Stream), MethodInfo * info Stream p) => IsLabelProxy t (Stream -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> Stream -> p #
HasAttributeList * Stream Source #

type AttributeList Stream Source #
type AttributeList Stream
type SignalList Stream Source #
type SignalList Stream

class GObject o => IsStream o Source #

Instances

(GObject a, UnknownAncestorError Constraint Stream a) => IsStream a Source #

IsStream Stream Source #

toStream :: IsStream o => o -> IO Stream Source #

noStream :: Maybe Stream Source #

Methods

getCaps

data StreamGetCapsMethodInfo Source #

Instances

((~) * signature (m (Maybe Caps)), MonadIO m, IsStream a) => MethodInfo * StreamGetCapsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy StreamGetCapsMethodInfo a -> signature -> s #

streamGetCaps Source #

Arguments

:: (HasCallStack, MonadIO m, IsStream a)
=> a	`stream`: a `Stream`
-> m (Maybe Caps)	Returns: The `Caps` for `stream`

Retrieve the caps for stream, if any

Since: 1.10

getStreamFlags

data StreamGetStreamFlagsMethodInfo Source #

Instances

((~) * signature (m [StreamFlags]), MonadIO m, IsStream a) => MethodInfo * StreamGetStreamFlagsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy StreamGetStreamFlagsMethodInfo a -> signature -> s #

streamGetStreamFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsStream a)
=> a	`stream`: a `Stream`
-> m [StreamFlags]	Returns: The `StreamFlags` for `stream`

Retrieve the current stream flags for stream

Since: 1.10

getStreamId

data StreamGetStreamIdMethodInfo Source #

Instances

((~) * signature (m (Maybe Text)), MonadIO m, IsStream a) => MethodInfo * StreamGetStreamIdMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy StreamGetStreamIdMethodInfo a -> signature -> s #

streamGetStreamId Source #

Arguments

:: (HasCallStack, MonadIO m, IsStream a)
=> a	`stream`: a `Stream`
-> m (Maybe Text)	Returns: the stream ID of `stream`. Only valid during the lifetime of `stream`.

Returns the stream ID of stream.

Since: 1.10

getStreamType

data StreamGetStreamTypeMethodInfo Source #

Instances

((~) * signature (m [StreamType]), MonadIO m, IsStream a) => MethodInfo * StreamGetStreamTypeMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy StreamGetStreamTypeMethodInfo a -> signature -> s #

streamGetStreamType Source #

Arguments

:: (HasCallStack, MonadIO m, IsStream a)
=> a	`stream`: a `Stream`
-> m [StreamType]	Returns: The `StreamType` for `stream`

Retrieve the stream type for stream

Since: 1.10

getTags

data StreamGetTagsMethodInfo Source #

Instances

((~) * signature (m (Maybe TagList)), MonadIO m, IsStream a) => MethodInfo * StreamGetTagsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy StreamGetTagsMethodInfo a -> signature -> s #

streamGetTags Source #

Arguments

:: (HasCallStack, MonadIO m, IsStream a)
=> a	`stream`: a `Stream`
-> m (Maybe TagList)	Returns: The `TagList` for `stream`

Retrieve the tags for stream, if any

Since: 1.10

new

streamNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Maybe Text	`streamId`: the id for the new stream. If `Nothing`, a new one will be automatically generated
-> Maybe Caps	`caps`: the `Caps` of the stream
-> [StreamType]	`type`: the `StreamType` of the stream
-> [StreamFlags]	`flags`: the `StreamFlags` of the stream
-> m Stream	Returns: The new `Stream`

Create a new Stream for the given streamId, caps, type and flags

Since: 1.10

setCaps

data StreamSetCapsMethodInfo Source #

Instances

((~) * signature (Maybe Caps -> m ()), MonadIO m, IsStream a) => MethodInfo * StreamSetCapsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy StreamSetCapsMethodInfo a -> signature -> s #

streamSetCaps Source #

Arguments

:: (HasCallStack, MonadIO m, IsStream a)
=> a	`stream`: a `Stream`
-> Maybe Caps	`caps`: a `Caps`
-> m ()

Set the caps for the Stream

Since: 1.10

setStreamFlags

data StreamSetStreamFlagsMethodInfo Source #

Instances

((~) * signature ([StreamFlags] -> m ()), MonadIO m, IsStream a) => MethodInfo * StreamSetStreamFlagsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy StreamSetStreamFlagsMethodInfo a -> signature -> s #

streamSetStreamFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsStream a)
=> a	`stream`: a `Stream`
-> [StreamFlags]	`flags`: the flags to set on `stream`
-> m ()

Set the flags for the stream.

Since: 1.10

setStreamType

data StreamSetStreamTypeMethodInfo Source #

Instances

((~) * signature ([StreamType] -> m ()), MonadIO m, IsStream a) => MethodInfo * StreamSetStreamTypeMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy StreamSetStreamTypeMethodInfo a -> signature -> s #

streamSetStreamType Source #

Arguments

:: (HasCallStack, MonadIO m, IsStream a)
=> a	`stream`: a `Stream`
-> [StreamType]	`streamType`: the type to set on `stream`
-> m ()

Set the stream type of stream

Since: 1.10

setTags

data StreamSetTagsMethodInfo Source #

Instances

((~) * signature (Maybe TagList -> m ()), MonadIO m, IsStream a) => MethodInfo * StreamSetTagsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy StreamSetTagsMethodInfo a -> signature -> s #

streamSetTags Source #

Arguments

:: (HasCallStack, MonadIO m, IsStream a)
=> a	`stream`: a `Stream`
-> Maybe TagList	`tags`: a `TagList`
-> m ()

Set the tags for the Stream

Since: 1.10

Properties

caps

data StreamCapsPropertyInfo Source #

Instances

AttrInfo StreamCapsPropertyInfo Source #
Associated Types type AttrAllowedOps StreamCapsPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint StreamCapsPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint StreamCapsPropertyInfo :: * -> Constraint # type AttrGetType StreamCapsPropertyInfo :: * # type AttrLabel StreamCapsPropertyInfo :: Symbol # type AttrOrigin StreamCapsPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint StreamCapsPropertyInfo o => Proxy * StreamCapsPropertyInfo -> o -> IO (AttrGetType StreamCapsPropertyInfo) # attrSet :: (AttrBaseTypeConstraint StreamCapsPropertyInfo o, AttrSetTypeConstraint StreamCapsPropertyInfo b) => Proxy * StreamCapsPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint StreamCapsPropertyInfo o => Proxy * StreamCapsPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint StreamCapsPropertyInfo o, AttrSetTypeConstraint StreamCapsPropertyInfo b) => Proxy * StreamCapsPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin StreamCapsPropertyInfo Source #
type AttrOrigin StreamCapsPropertyInfo = Stream
type AttrLabel StreamCapsPropertyInfo Source #
type AttrLabel StreamCapsPropertyInfo = "caps"
type AttrGetType StreamCapsPropertyInfo Source #
type AttrGetType StreamCapsPropertyInfo = Maybe Caps
type AttrBaseTypeConstraint StreamCapsPropertyInfo Source #
type AttrBaseTypeConstraint StreamCapsPropertyInfo = IsStream
type AttrSetTypeConstraint StreamCapsPropertyInfo Source #
type AttrSetTypeConstraint StreamCapsPropertyInfo = * ~ Caps
type AttrAllowedOps StreamCapsPropertyInfo Source #
type AttrAllowedOps StreamCapsPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

clearStreamCaps :: (MonadIO m, IsStream o) => o -> m () Source #

constructStreamCaps :: IsStream o => Caps -> IO (GValueConstruct o) Source #

getStreamCaps :: (MonadIO m, IsStream o) => o -> m (Maybe Caps) Source #

setStreamCaps :: (MonadIO m, IsStream o) => o -> Caps -> m () Source #

streamCaps :: AttrLabelProxy "caps" Source #

streamFlags

data StreamStreamFlagsPropertyInfo Source #

Instances

AttrInfo StreamStreamFlagsPropertyInfo Source #
Associated Types type AttrAllowedOps StreamStreamFlagsPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint StreamStreamFlagsPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint StreamStreamFlagsPropertyInfo :: * -> Constraint # type AttrGetType StreamStreamFlagsPropertyInfo :: * # type AttrLabel StreamStreamFlagsPropertyInfo :: Symbol # type AttrOrigin StreamStreamFlagsPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint StreamStreamFlagsPropertyInfo o => Proxy * StreamStreamFlagsPropertyInfo -> o -> IO (AttrGetType StreamStreamFlagsPropertyInfo) # attrSet :: (AttrBaseTypeConstraint StreamStreamFlagsPropertyInfo o, AttrSetTypeConstraint StreamStreamFlagsPropertyInfo b) => Proxy * StreamStreamFlagsPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint StreamStreamFlagsPropertyInfo o => Proxy * StreamStreamFlagsPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint StreamStreamFlagsPropertyInfo o, AttrSetTypeConstraint StreamStreamFlagsPropertyInfo b) => Proxy * StreamStreamFlagsPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin StreamStreamFlagsPropertyInfo Source #
type AttrOrigin StreamStreamFlagsPropertyInfo = Stream
type AttrLabel StreamStreamFlagsPropertyInfo Source #
type AttrLabel StreamStreamFlagsPropertyInfo = "stream-flags"
type AttrGetType StreamStreamFlagsPropertyInfo Source #
type AttrGetType StreamStreamFlagsPropertyInfo = [StreamFlags]
type AttrBaseTypeConstraint StreamStreamFlagsPropertyInfo Source #
type AttrBaseTypeConstraint StreamStreamFlagsPropertyInfo = IsStream
type AttrSetTypeConstraint StreamStreamFlagsPropertyInfo Source #
type AttrSetTypeConstraint StreamStreamFlagsPropertyInfo = * ~ [StreamFlags]
type AttrAllowedOps StreamStreamFlagsPropertyInfo Source #
type AttrAllowedOps StreamStreamFlagsPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructStreamStreamFlags :: IsStream o => [StreamFlags] -> IO (GValueConstruct o) Source #

getStreamStreamFlags :: (MonadIO m, IsStream o) => o -> m [StreamFlags] Source #

setStreamStreamFlags :: (MonadIO m, IsStream o) => o -> [StreamFlags] -> m () Source #

streamStreamFlags :: AttrLabelProxy "streamFlags" Source #

streamId

data StreamStreamIdPropertyInfo Source #

Instances

AttrInfo StreamStreamIdPropertyInfo Source #
Associated Types type AttrAllowedOps StreamStreamIdPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint StreamStreamIdPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint StreamStreamIdPropertyInfo :: * -> Constraint # type AttrGetType StreamStreamIdPropertyInfo :: * # type AttrLabel StreamStreamIdPropertyInfo :: Symbol # type AttrOrigin StreamStreamIdPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint StreamStreamIdPropertyInfo o => Proxy * StreamStreamIdPropertyInfo -> o -> IO (AttrGetType StreamStreamIdPropertyInfo) # attrSet :: (AttrBaseTypeConstraint StreamStreamIdPropertyInfo o, AttrSetTypeConstraint StreamStreamIdPropertyInfo b) => Proxy * StreamStreamIdPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint StreamStreamIdPropertyInfo o => Proxy * StreamStreamIdPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint StreamStreamIdPropertyInfo o, AttrSetTypeConstraint StreamStreamIdPropertyInfo b) => Proxy * StreamStreamIdPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin StreamStreamIdPropertyInfo Source #
type AttrOrigin StreamStreamIdPropertyInfo = Stream
type AttrLabel StreamStreamIdPropertyInfo Source #
type AttrLabel StreamStreamIdPropertyInfo = "stream-id"
type AttrGetType StreamStreamIdPropertyInfo Source #
type AttrGetType StreamStreamIdPropertyInfo = Maybe Text
type AttrBaseTypeConstraint StreamStreamIdPropertyInfo Source #
type AttrBaseTypeConstraint StreamStreamIdPropertyInfo = IsStream
type AttrSetTypeConstraint StreamStreamIdPropertyInfo Source #
type AttrSetTypeConstraint StreamStreamIdPropertyInfo = * ~ Text
type AttrAllowedOps StreamStreamIdPropertyInfo Source #
type AttrAllowedOps StreamStreamIdPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructStreamStreamId :: IsStream o => Text -> IO (GValueConstruct o) Source #

getStreamStreamId :: (MonadIO m, IsStream o) => o -> m (Maybe Text) Source #

streamStreamId :: AttrLabelProxy "streamId" Source #

streamType

data StreamStreamTypePropertyInfo Source #

Instances

AttrInfo StreamStreamTypePropertyInfo Source #
Associated Types type AttrAllowedOps StreamStreamTypePropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint StreamStreamTypePropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint StreamStreamTypePropertyInfo :: * -> Constraint # type AttrGetType StreamStreamTypePropertyInfo :: * # type AttrLabel StreamStreamTypePropertyInfo :: Symbol # type AttrOrigin StreamStreamTypePropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint StreamStreamTypePropertyInfo o => Proxy * StreamStreamTypePropertyInfo -> o -> IO (AttrGetType StreamStreamTypePropertyInfo) # attrSet :: (AttrBaseTypeConstraint StreamStreamTypePropertyInfo o, AttrSetTypeConstraint StreamStreamTypePropertyInfo b) => Proxy * StreamStreamTypePropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint StreamStreamTypePropertyInfo o => Proxy * StreamStreamTypePropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint StreamStreamTypePropertyInfo o, AttrSetTypeConstraint StreamStreamTypePropertyInfo b) => Proxy * StreamStreamTypePropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin StreamStreamTypePropertyInfo Source #
type AttrOrigin StreamStreamTypePropertyInfo = Stream
type AttrLabel StreamStreamTypePropertyInfo Source #
type AttrLabel StreamStreamTypePropertyInfo = "stream-type"
type AttrGetType StreamStreamTypePropertyInfo Source #
type AttrGetType StreamStreamTypePropertyInfo = [StreamType]
type AttrBaseTypeConstraint StreamStreamTypePropertyInfo Source #
type AttrBaseTypeConstraint StreamStreamTypePropertyInfo = IsStream
type AttrSetTypeConstraint StreamStreamTypePropertyInfo Source #
type AttrSetTypeConstraint StreamStreamTypePropertyInfo = * ~ [StreamType]
type AttrAllowedOps StreamStreamTypePropertyInfo Source #
type AttrAllowedOps StreamStreamTypePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructStreamStreamType :: IsStream o => [StreamType] -> IO (GValueConstruct o) Source #

getStreamStreamType :: (MonadIO m, IsStream o) => o -> m [StreamType] Source #

setStreamStreamType :: (MonadIO m, IsStream o) => o -> [StreamType] -> m () Source #

streamStreamType :: AttrLabelProxy "streamType" Source #

AttrInfo StreamTagsPropertyInfo Source #
Associated Types type AttrAllowedOps StreamTagsPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint StreamTagsPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint StreamTagsPropertyInfo :: * -> Constraint # type AttrGetType StreamTagsPropertyInfo :: * # type AttrLabel StreamTagsPropertyInfo :: Symbol # type AttrOrigin StreamTagsPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint StreamTagsPropertyInfo o => Proxy * StreamTagsPropertyInfo -> o -> IO (AttrGetType StreamTagsPropertyInfo) # attrSet :: (AttrBaseTypeConstraint StreamTagsPropertyInfo o, AttrSetTypeConstraint StreamTagsPropertyInfo b) => Proxy * StreamTagsPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint StreamTagsPropertyInfo o => Proxy * StreamTagsPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint StreamTagsPropertyInfo o, AttrSetTypeConstraint StreamTagsPropertyInfo b) => Proxy * StreamTagsPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin StreamTagsPropertyInfo Source #
type AttrOrigin StreamTagsPropertyInfo = Stream
type AttrLabel StreamTagsPropertyInfo Source #
type AttrLabel StreamTagsPropertyInfo = "tags"
type AttrGetType StreamTagsPropertyInfo Source #
type AttrGetType StreamTagsPropertyInfo = Maybe TagList
type AttrBaseTypeConstraint StreamTagsPropertyInfo Source #
type AttrBaseTypeConstraint StreamTagsPropertyInfo = IsStream
type AttrSetTypeConstraint StreamTagsPropertyInfo Source #
type AttrSetTypeConstraint StreamTagsPropertyInfo = * ~ TagList
type AttrAllowedOps StreamTagsPropertyInfo Source #
type AttrAllowedOps StreamTagsPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))