gstreamer/doc/en/Gst.Base/BaseTransform.xml
Sebastian Dröge 564af1b394 Update docs
2009-05-28 15:42:17 +02:00

571 lines
20 KiB
XML

<Type Name="BaseTransform" FullName="Gst.Base.BaseTransform">
<TypeSignature Language="C#" Value="public class BaseTransform : Gst.Element" />
<AssemblyInfo>
<AssemblyName>gstreamer-sharp</AssemblyName>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Gst.Element</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected BaseTransform ();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BaseTransform (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GapAware">
<MemberSignature Language="C#" Value="public bool GapAware { set; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InPlace">
<MemberSignature Language="C#" Value="public bool InPlace { set; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsInPlace">
<MemberSignature Language="C#" Value="public bool IsInPlace { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsPassthrough">
<MemberSignature Language="C#" Value="public bool IsPassthrough { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsQosEnabled">
<MemberSignature Language="C#" Value="public bool IsQosEnabled { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnBeforeTransform">
<MemberSignature Language="C#" Value="protected virtual void OnBeforeTransform (Gst.Buffer buffer);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideBeforeTransform", Type=typeof(Gst.Base.BaseTransform))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="Gst.Buffer" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnEvent">
<MemberSignature Language="C#" Value="protected virtual bool OnEvent (Gst.Event evnt);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideEvent", Type=typeof(Gst.Base.BaseTransform))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gst.Event" />
</Parameters>
<Docs>
<param name="evnt">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnFixateCaps">
<MemberSignature Language="C#" Value="protected virtual void OnFixateCaps (Gst.PadDirection direction, Gst.Caps caps, Gst.Caps othercaps);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideFixateCaps", Type=typeof(Gst.Base.BaseTransform))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="direction" Type="Gst.PadDirection" />
<Parameter Name="caps" Type="Gst.Caps" />
<Parameter Name="othercaps" Type="Gst.Caps" />
</Parameters>
<Docs>
<param name="direction">To be added.</param>
<param name="caps">To be added.</param>
<param name="othercaps">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnGetUnitSize">
<MemberSignature Language="C#" Value="protected virtual bool OnGetUnitSize (Gst.Caps caps, out uint size);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideGetUnitSize", Type=typeof(Gst.Base.BaseTransform))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="caps" Type="Gst.Caps" />
<Parameter Name="size" Type="System.UInt32&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="caps">To be added.</param>
<param name="size">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnPrepareOutputBuffer">
<MemberSignature Language="C#" Value="protected virtual Gst.FlowReturn OnPrepareOutputBuffer (Gst.Buffer input, int size, Gst.Caps caps, out Gst.Buffer buf);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverridePrepareOutputBuffer", Type=typeof(Gst.Base.BaseTransform))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gst.FlowReturn</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="input" Type="Gst.Buffer" />
<Parameter Name="size" Type="System.Int32" />
<Parameter Name="caps" Type="Gst.Caps" />
<Parameter Name="buf" Type="Gst.Buffer&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="input">To be added.</param>
<param name="size">To be added.</param>
<param name="caps">To be added.</param>
<param name="buf">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnSetCaps">
<MemberSignature Language="C#" Value="protected virtual bool OnSetCaps (Gst.Caps incaps, Gst.Caps outcaps);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideSetCaps", Type=typeof(Gst.Base.BaseTransform))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="incaps" Type="Gst.Caps" />
<Parameter Name="outcaps" Type="Gst.Caps" />
</Parameters>
<Docs>
<param name="incaps">To be added.</param>
<param name="outcaps">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnSrcEvent">
<MemberSignature Language="C#" Value="protected virtual bool OnSrcEvent (Gst.Event evnt);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideSrcEvent", Type=typeof(Gst.Base.BaseTransform))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gst.Event" />
</Parameters>
<Docs>
<param name="evnt">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnStart">
<MemberSignature Language="C#" Value="protected virtual bool OnStart ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideStart", Type=typeof(Gst.Base.BaseTransform))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnStop">
<MemberSignature Language="C#" Value="protected virtual bool OnStop ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideStop", Type=typeof(Gst.Base.BaseTransform))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnTransform">
<MemberSignature Language="C#" Value="protected virtual Gst.FlowReturn OnTransform (Gst.Buffer inbuf, Gst.Buffer outbuf);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideTransform", Type=typeof(Gst.Base.BaseTransform))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gst.FlowReturn</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="inbuf" Type="Gst.Buffer" />
<Parameter Name="outbuf" Type="Gst.Buffer" />
</Parameters>
<Docs>
<param name="inbuf">To be added.</param>
<param name="outbuf">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnTransformCaps">
<MemberSignature Language="C#" Value="protected virtual Gst.Caps OnTransformCaps (Gst.PadDirection direction, Gst.Caps caps);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideTransformCaps", Type=typeof(Gst.Base.BaseTransform))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gst.Caps</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="direction" Type="Gst.PadDirection" />
<Parameter Name="caps" Type="Gst.Caps" />
</Parameters>
<Docs>
<param name="direction">To be added.</param>
<param name="caps">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnTransformIp">
<MemberSignature Language="C#" Value="protected virtual Gst.FlowReturn OnTransformIp (Gst.Buffer buf);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideTransformIp", Type=typeof(Gst.Base.BaseTransform))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gst.FlowReturn</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buf" Type="Gst.Buffer" />
</Parameters>
<Docs>
<param name="buf">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnTransformSize">
<MemberSignature Language="C#" Value="protected virtual bool OnTransformSize (Gst.PadDirection direction, Gst.Caps caps, uint size, Gst.Caps othercaps, out uint othersize);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideTransformSize", Type=typeof(Gst.Base.BaseTransform))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="direction" Type="Gst.PadDirection" />
<Parameter Name="caps" Type="Gst.Caps" />
<Parameter Name="size" Type="System.UInt32" />
<Parameter Name="othercaps" Type="Gst.Caps" />
<Parameter Name="othersize" Type="System.UInt32&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="direction">To be added.</param>
<param name="caps">To be added.</param>
<param name="size">To be added.</param>
<param name="othercaps">To be added.</param>
<param name="othersize">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Passthrough">
<MemberSignature Language="C#" Value="public bool Passthrough { set; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Qos">
<MemberSignature Language="C#" Value="public bool Qos { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("qos")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="QosEnabled">
<MemberSignature Language="C#" Value="public bool QosEnabled { set; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Reconfigure">
<MemberSignature Language="C#" Value="public void Reconfigure ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Suggest">
<MemberSignature Language="C#" Value="public void Suggest (Gst.Caps caps, uint size);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="caps" Type="Gst.Caps" />
<Parameter Name="size" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="caps">To be added.</param>
<param name="size">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateQos">
<MemberSignature Language="C#" Value="public void UpdateQos (double proportion, long diff, ulong timestamp);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="proportion" Type="System.Double" />
<Parameter Name="diff" Type="System.Int64" />
<Parameter Name="timestamp" Type="System.UInt64" />
</Parameters>
<Docs>
<param name="proportion">To be added.</param>
<param name="diff">To be added.</param>
<param name="timestamp">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>