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

Contents

Exported types
Methods
Properties
Signals
- padCreated

Description

Padtemplates describe the possible media types a pad or an elementfactory can handle. This allows for both inspection of handled types before loading the element plugin as well as identifying pads on elements that are not yet created (request or sometimes pads).

Pad and PadTemplates have Caps attached to it to describe the media type they are capable of dealing with. padTemplateGetCaps or GST_PAD_TEMPLATE_CAPS() are used to get the caps of a padtemplate. It's not possible to modify the caps of a padtemplate after creation.

PadTemplates have a PadPresence property which identifies the lifetime of the pad and that can be retrieved with GST_PAD_TEMPLATE_PRESENCE(). Also the direction of the pad can be retrieved from the PadTemplate with GST_PAD_TEMPLATE_DIRECTION().

The GST_PAD_TEMPLATE_NAME_TEMPLATE () is important for GST_PAD_REQUEST pads because it has to be used as the name in the elementGetRequestPad call to instantiate a pad from this template.

Padtemplates can be created with padTemplateNew or with gst_static_pad_template_get (), which creates a PadTemplate from a StaticPadTemplate that can be filled with the convenient GST_STATIC_PAD_TEMPLATE() macro.

A padtemplate can be used to create a pad (see padNewFromTemplate or gst_pad_new_from_static_template ()) or to add to an element class (see gst_element_class_add_static_pad_template ()).

The following code example shows the code to create a pad from a padtemplate.

C code

 GstStaticPadTemplate my_template =
 GST_STATIC_PAD_TEMPLATE (
   "sink",          // the name of the pad
   GST_PAD_SINK,    // the direction of the pad
   GST_PAD_ALWAYS,  // when this pad will be present
   GST_STATIC_CAPS (        // the capabilities of the padtemplate
     "audio/x-raw, "
       "channels = (int) [ 1, 6 ]"
   )
 );
 void
 my_method (void)
 {
   GstPad *pad;
   pad = gst_pad_new_from_static_template (&amp;my_template, "sink");
   ...
 }

The following example shows you how to add the padtemplate to an element class, this is usually done in the class_init of the class:

C code

 static void
 my_element_class_init (GstMyElementClass *klass)
 {
   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);

   gst_element_class_add_static_pad_template (gstelement_class, &amp;my_template);
 }

Synopsis

Exported types

newtype PadTemplate Source #

Constructors

PadTemplate (ManagedPtr PadTemplate)

Instances

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

IsPadTemplate PadTemplate Source #

IsObject PadTemplate Source #

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

type AttributeList PadTemplate Source #
type AttributeList PadTemplate
type SignalList PadTemplate Source #
type SignalList PadTemplate

class GObject o => IsPadTemplate o Source #

Instances

(GObject a, UnknownAncestorError Constraint PadTemplate a) => IsPadTemplate a Source #

IsPadTemplate PadTemplate Source #

toPadTemplate :: IsPadTemplate o => o -> IO PadTemplate Source #

noPadTemplate :: Maybe PadTemplate Source #

Methods

getCaps

data PadTemplateGetCapsMethodInfo Source #

Instances

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

padTemplateGetCaps Source #

Arguments

:: (HasCallStack, MonadIO m, IsPadTemplate a)
=> a	`templ`: a `PadTemplate` to get capabilities of.
-> m Caps	Returns: the `Caps` of the pad template. Unref after usage.

Gets the capabilities of the pad template.

new

padTemplateNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`nameTemplate`: the name template.
-> PadDirection	`direction`: the `PadDirection` of the template.
-> PadPresence	`presence`: the `PadPresence` of the pad.
-> Caps	`caps`: a `Caps` set for the template.
-> m PadTemplate	Returns: a new `PadTemplate`.

Creates a new pad template with a name according to the given template and with the given arguments.

padCreated

data PadTemplatePadCreatedMethodInfo Source #

Instances

((~) * signature (b -> m ()), MonadIO m, IsPadTemplate a, IsPad b) => MethodInfo * PadTemplatePadCreatedMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy PadTemplatePadCreatedMethodInfo a -> signature -> s #

padTemplatePadCreated Source #

Arguments

:: (HasCallStack, MonadIO m, IsPadTemplate a, IsPad b)
=> a	`templ`: a `PadTemplate` that has been created
-> b	`pad`: the `Pad` that created it
-> m ()

Emit the pad-created signal for this template when created by this pad.

Properties

caps

data PadTemplateCapsPropertyInfo Source #

Instances

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

constructPadTemplateCaps :: IsPadTemplate o => Caps -> IO (GValueConstruct o) Source #

getPadTemplateCaps :: (MonadIO m, IsPadTemplate o) => o -> m (Maybe Caps) Source #

padTemplateCaps :: AttrLabelProxy "caps" Source #

direction

data PadTemplateDirectionPropertyInfo Source #

Instances

AttrInfo PadTemplateDirectionPropertyInfo Source #
Associated Types type AttrAllowedOps PadTemplateDirectionPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint PadTemplateDirectionPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint PadTemplateDirectionPropertyInfo :: * -> Constraint # type AttrGetType PadTemplateDirectionPropertyInfo :: * # type AttrLabel PadTemplateDirectionPropertyInfo :: Symbol # type AttrOrigin PadTemplateDirectionPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint PadTemplateDirectionPropertyInfo o => Proxy * PadTemplateDirectionPropertyInfo -> o -> IO (AttrGetType PadTemplateDirectionPropertyInfo) # attrSet :: (AttrBaseTypeConstraint PadTemplateDirectionPropertyInfo o, AttrSetTypeConstraint PadTemplateDirectionPropertyInfo b) => Proxy * PadTemplateDirectionPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint PadTemplateDirectionPropertyInfo o => Proxy * PadTemplateDirectionPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint PadTemplateDirectionPropertyInfo o, AttrSetTypeConstraint PadTemplateDirectionPropertyInfo b) => Proxy * PadTemplateDirectionPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin PadTemplateDirectionPropertyInfo Source #
type AttrOrigin PadTemplateDirectionPropertyInfo = PadTemplate
type AttrLabel PadTemplateDirectionPropertyInfo Source #
type AttrLabel PadTemplateDirectionPropertyInfo = "direction"
type AttrGetType PadTemplateDirectionPropertyInfo Source #
type AttrGetType PadTemplateDirectionPropertyInfo = PadDirection
type AttrBaseTypeConstraint PadTemplateDirectionPropertyInfo Source #
type AttrBaseTypeConstraint PadTemplateDirectionPropertyInfo = IsPadTemplate
type AttrSetTypeConstraint PadTemplateDirectionPropertyInfo Source #
type AttrSetTypeConstraint PadTemplateDirectionPropertyInfo = * ~ PadDirection
type AttrAllowedOps PadTemplateDirectionPropertyInfo Source #
type AttrAllowedOps PadTemplateDirectionPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag))

constructPadTemplateDirection :: IsPadTemplate o => PadDirection -> IO (GValueConstruct o) Source #

getPadTemplateDirection :: (MonadIO m, IsPadTemplate o) => o -> m PadDirection Source #

padTemplateDirection :: AttrLabelProxy "direction" Source #

nameTemplate

data PadTemplateNameTemplatePropertyInfo Source #

Instances

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

constructPadTemplateNameTemplate :: IsPadTemplate o => Text -> IO (GValueConstruct o) Source #

getPadTemplateNameTemplate :: (MonadIO m, IsPadTemplate o) => o -> m (Maybe Text) Source #

padTemplateNameTemplate :: AttrLabelProxy "nameTemplate" Source #

presence

data PadTemplatePresencePropertyInfo Source #

Instances

AttrInfo PadTemplatePresencePropertyInfo Source #
Associated Types type AttrAllowedOps PadTemplatePresencePropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint PadTemplatePresencePropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint PadTemplatePresencePropertyInfo :: * -> Constraint # type AttrGetType PadTemplatePresencePropertyInfo :: * # type AttrLabel PadTemplatePresencePropertyInfo :: Symbol # type AttrOrigin PadTemplatePresencePropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint PadTemplatePresencePropertyInfo o => Proxy * PadTemplatePresencePropertyInfo -> o -> IO (AttrGetType PadTemplatePresencePropertyInfo) # attrSet :: (AttrBaseTypeConstraint PadTemplatePresencePropertyInfo o, AttrSetTypeConstraint PadTemplatePresencePropertyInfo b) => Proxy * PadTemplatePresencePropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint PadTemplatePresencePropertyInfo o => Proxy * PadTemplatePresencePropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint PadTemplatePresencePropertyInfo o, AttrSetTypeConstraint PadTemplatePresencePropertyInfo b) => Proxy * PadTemplatePresencePropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin PadTemplatePresencePropertyInfo Source #
type AttrOrigin PadTemplatePresencePropertyInfo = PadTemplate
type AttrLabel PadTemplatePresencePropertyInfo Source #
type AttrLabel PadTemplatePresencePropertyInfo = "presence"
type AttrGetType PadTemplatePresencePropertyInfo Source #
type AttrGetType PadTemplatePresencePropertyInfo = PadPresence
type AttrBaseTypeConstraint PadTemplatePresencePropertyInfo Source #
type AttrBaseTypeConstraint PadTemplatePresencePropertyInfo = IsPadTemplate
type AttrSetTypeConstraint PadTemplatePresencePropertyInfo Source #
type AttrSetTypeConstraint PadTemplatePresencePropertyInfo = * ~ PadPresence
type AttrAllowedOps PadTemplatePresencePropertyInfo Source #
type AttrAllowedOps PadTemplatePresencePropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag))

constructPadTemplatePresence :: IsPadTemplate o => PadPresence -> IO (GValueConstruct o) Source #

getPadTemplatePresence :: (MonadIO m, IsPadTemplate o) => o -> m PadPresence Source #

padTemplatePresence :: AttrLabelProxy "presence" Source #

Signals

padCreated

type C_PadTemplatePadCreatedCallback = Ptr () -> Ptr Pad -> Ptr () -> IO () Source #

type PadTemplatePadCreatedCallback = Pad -> IO () Source #

data PadTemplatePadCreatedSignalInfo Source #

Instances

afterPadTemplatePadCreated :: (IsPadTemplate a, MonadIO m) => a -> PadTemplatePadCreatedCallback -> m SignalHandlerId Source #

genClosure_PadTemplatePadCreated :: PadTemplatePadCreatedCallback -> IO Closure Source #

mk_PadTemplatePadCreatedCallback :: C_PadTemplatePadCreatedCallback -> IO (FunPtr C_PadTemplatePadCreatedCallback) Source #

noPadTemplatePadCreatedCallback :: Maybe PadTemplatePadCreatedCallback Source #

onPadTemplatePadCreated :: (IsPadTemplate a, MonadIO m) => a -> PadTemplatePadCreatedCallback -> m SignalHandlerId Source #

wrap_PadTemplatePadCreatedCallback :: PadTemplatePadCreatedCallback -> Ptr () -> Ptr Pad -> Ptr () -> IO () Source #

SignalInfo PadTemplatePadCreatedSignalInfo Source #
Associated Types type HaskellCallbackType PadTemplatePadCreatedSignalInfo :: * # Methods connectSignal :: GObject o => SignalProxy o PadTemplatePadCreatedSignalInfo -> o -> HaskellCallbackType PadTemplatePadCreatedSignalInfo -> SignalConnectMode -> IO SignalHandlerId #
type HaskellCallbackType PadTemplatePadCreatedSignalInfo Source #
type HaskellCallbackType PadTemplatePadCreatedSignalInfo = PadTemplatePadCreatedCallback