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

636 lines
22 KiB
XML

<Type Name="BaseSrc" FullName="Gst.Base.BaseSrc">
<TypeSignature Language="C#" Value="public class BaseSrc : 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 BaseSrc ();" />
<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 BaseSrc (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="Blocksize">
<MemberSignature Language="C#" Value="public ulong Blocksize { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("blocksize")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.UInt64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DoTimestamp">
<MemberSignature Language="C#" Value="public bool DoTimestamp { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("do-timestamp")</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="Format">
<MemberSignature Language="C#" Value="public Gst.Format Format { set; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.Format</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="IsLive">
<MemberSignature Language="C#" Value="public bool IsLive { 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="Live">
<MemberSignature Language="C#" Value="public bool Live { 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="NumBuffers">
<MemberSignature Language="C#" Value="public int NumBuffers { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("num-buffers")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnCheckGetRange">
<MemberSignature Language="C#" Value="protected virtual bool OnCheckGetRange ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideCheckGetRange", Type=typeof(Gst.Base.BaseSrc))</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="OnCreate">
<MemberSignature Language="C#" Value="protected virtual Gst.FlowReturn OnCreate (ulong offset, uint size, out Gst.Buffer buf);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideCreate", Type=typeof(Gst.Base.BaseSrc))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gst.FlowReturn</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="offset" Type="System.UInt64" />
<Parameter Name="size" Type="System.UInt32" />
<Parameter Name="buf" Type="Gst.Buffer&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="offset">To be added.</param>
<param name="size">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="OnDoSeek">
<MemberSignature Language="C#" Value="protected virtual bool OnDoSeek (Gst.Segment segment);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideDoSeek", Type=typeof(Gst.Base.BaseSrc))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="segment" Type="Gst.Segment" />
</Parameters>
<Docs>
<param name="segment">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<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.BaseSrc))</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="OnFixate">
<MemberSignature Language="C#" Value="protected virtual void OnFixate (Gst.Caps caps);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideFixate", Type=typeof(Gst.Base.BaseSrc))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="caps" Type="Gst.Caps" />
</Parameters>
<Docs>
<param name="caps">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnGetCaps">
<MemberSignature Language="C#" Value="protected virtual Gst.Caps OnGetCaps ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideGetCaps", Type=typeof(Gst.Base.BaseSrc))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gst.Caps</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnGetSize">
<MemberSignature Language="C#" Value="protected virtual bool OnGetSize (out ulong size);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideGetSize", Type=typeof(Gst.Base.BaseSrc))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="size" Type="System.UInt64&amp;" RefType="out" />
</Parameters>
<Docs>
<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="OnGetTimes">
<MemberSignature Language="C#" Value="protected virtual void OnGetTimes (Gst.Buffer buffer, out ulong start, out ulong end);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideGetTimes", Type=typeof(Gst.Base.BaseSrc))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="Gst.Buffer" />
<Parameter Name="start" Type="System.UInt64&amp;" RefType="out" />
<Parameter Name="end" Type="System.UInt64&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="start">To be added.</param>
<param name="end">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnIsSeekable">
<MemberSignature Language="C#" Value="protected virtual bool OnIsSeekable ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideIsSeekable", Type=typeof(Gst.Base.BaseSrc))</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="OnNegotiate">
<MemberSignature Language="C#" Value="protected virtual bool OnNegotiate ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideNegotiate", Type=typeof(Gst.Base.BaseSrc))</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="OnNewsegment">
<MemberSignature Language="C#" Value="protected virtual bool OnNewsegment ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideNewsegment", Type=typeof(Gst.Base.BaseSrc))</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="OnPrepareSeekSegment">
<MemberSignature Language="C#" Value="protected virtual bool OnPrepareSeekSegment (Gst.Event seek, Gst.Segment segment);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverridePrepareSeekSegment", Type=typeof(Gst.Base.BaseSrc))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="seek" Type="Gst.Event" />
<Parameter Name="segment" Type="Gst.Segment" />
</Parameters>
<Docs>
<param name="seek">To be added.</param>
<param name="segment">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnQuery">
<MemberSignature Language="C#" Value="protected virtual bool OnQuery (Gst.Query query);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideQuery", Type=typeof(Gst.Base.BaseSrc))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="query" Type="Gst.Query" />
</Parameters>
<Docs>
<param name="query">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 caps);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideSetCaps", Type=typeof(Gst.Base.BaseSrc))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="caps" Type="Gst.Caps" />
</Parameters>
<Docs>
<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="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.BaseSrc))</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.BaseSrc))</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="OnUnlock">
<MemberSignature Language="C#" Value="protected virtual bool OnUnlock ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideUnlock", Type=typeof(Gst.Base.BaseSrc))</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="OnUnlockStop">
<MemberSignature Language="C#" Value="protected virtual bool OnUnlockStop ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideUnlockStop", Type=typeof(Gst.Base.BaseSrc))</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="QueryLatency">
<MemberSignature Language="C#" Value="public bool QueryLatency (out bool live, out ulong min_latency, out ulong max_latency);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="live" Type="System.Boolean&amp;" RefType="out" />
<Parameter Name="min_latency" Type="System.UInt64&amp;" RefType="out" />
<Parameter Name="max_latency" Type="System.UInt64&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="live">To be added.</param>
<param name="min_latency">To be added.</param>
<param name="max_latency">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Typefind">
<MemberSignature Language="C#" Value="public bool Typefind { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("typefind")</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="WaitPlaying">
<MemberSignature Language="C#" Value="public Gst.FlowReturn WaitPlaying ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.FlowReturn</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>