gstreamer/doc/en/Gst/Index.xml
Sebastian Dröge 175b5ee5c5 Update docs
2009-09-11 10:30:27 +02:00

619 lines
23 KiB
XML

<Type Name="Index" FullName="Gst.Index">
<TypeSignature Language="C#" Value="public class Index : Gst.Object" />
<AssemblyInfo>
<AssemblyName>gstreamer-sharp</AssemblyName>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Gst.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Index ();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Index (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</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="AddAssociation">
<MemberSignature Language="C#" Value="public Gst.IndexEntry AddAssociation (int id, Gst.AssocFlags flags, int n, Gst.IndexAssociation[] list);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.IndexEntry</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Int32" />
<Parameter Name="flags" Type="Gst.AssocFlags" />
<Parameter Name="n" Type="System.Int32" />
<Parameter Name="list" Type="Gst.IndexAssociation[]" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="flags">To be added.</param>
<param name="n">To be added.</param>
<param name="list">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddFormat">
<MemberSignature Language="C#" Value="public Gst.IndexEntry AddFormat (int id, Gst.Format format);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.IndexEntry</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Int32" />
<Parameter Name="format" Type="Gst.Format" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="format">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddId">
<MemberSignature Language="C#" Value="public Gst.IndexEntry AddId (int id, string description);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.IndexEntry</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Int32" />
<Parameter Name="description" Type="System.String" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="description">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddObject">
<MemberSignature Language="C#" Value="public Gst.IndexEntry AddObject (int id, string key, GLib.GType type, GLib.Object objekt);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.IndexEntry</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Int32" />
<Parameter Name="key" Type="System.String" />
<Parameter Name="type" Type="GLib.GType" />
<Parameter Name="objekt" Type="GLib.Object" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="key">To be added.</param>
<param name="type">To be added.</param>
<param name="objekt">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddObject">
<MemberSignature Language="C#" Value="public Gst.IndexEntry AddObject (int id, string key, Gst.GLib.GType type, Gst.GLib.Object objekt);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.IndexEntry</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Int32" />
<Parameter Name="key" Type="System.String" />
<Parameter Name="type" Type="Gst.GLib.GType" />
<Parameter Name="objekt" Type="Gst.GLib.Object" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="key">To be added.</param>
<param name="type">To be added.</param>
<param name="objekt">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Certainty">
<MemberSignature Language="C#" Value="public Gst.IndexCertainty Certainty { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.IndexCertainty</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Commit">
<MemberSignature Language="C#" Value="public void Commit (int id);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Int32" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EntryAdded">
<MemberSignature Language="C#" Value="public event Gst.EntryAddedHandler EntryAdded;" />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Gst.GLib.Signal("entry-added")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gst.EntryAddedHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Filter">
<MemberSignature Language="C#" Value="public Gst.IndexFilter Filter { set; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.IndexFilter</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetAssocEntry">
<MemberSignature Language="C#" Value="public Gst.IndexEntry GetAssocEntry (int id, Gst.IndexLookupMethod method, Gst.AssocFlags flags, Gst.Format format, long value);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.IndexEntry</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Int32" />
<Parameter Name="method" Type="Gst.IndexLookupMethod" />
<Parameter Name="flags" Type="Gst.AssocFlags" />
<Parameter Name="format" Type="Gst.Format" />
<Parameter Name="value" Type="System.Int64" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="method">To be added.</param>
<param name="flags">To be added.</param>
<param name="format">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetWriterId">
<MemberSignature Language="C#" Value="public bool GetWriterId (Gst.Object writer, out int id);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="Gst.Object" />
<Parameter Name="id" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="writer">To be added.</param>
<param name="id">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Group">
<MemberSignature Language="C#" Value="public int Group { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<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="GType">
<MemberSignature Language="C#" Value="public static Gst.GLib.GType GType { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.GType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsReadable">
<MemberSignature Language="C#" Value="public bool IsReadable { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</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="IsWritable">
<MemberSignature Language="C#" Value="public bool IsWritable { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</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="Method">
<MemberSignature Language="C#" Value="public Gst.IndexResolverMethod Method { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Gst.GLib.Property("resolver")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gst.IndexResolverMethod</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NewGroup">
<MemberSignature Language="C#" Value="public int NewGroup ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnAddEntry">
<MemberSignature Language="C#" Value="protected virtual void OnAddEntry (Gst.IndexEntry entry);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Gst.GLib.DefaultSignalHandler(ConnectionMethod="OverrideAddEntry", Type=typeof(Gst.Index))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="entry" Type="Gst.IndexEntry" />
</Parameters>
<Docs>
<param name="entry">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnCommit">
<MemberSignature Language="C#" Value="protected virtual void OnCommit (int id);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Gst.GLib.DefaultSignalHandler(ConnectionMethod="OverrideCommit", Type=typeof(Gst.Index))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Int32" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnEntryAdded">
<MemberSignature Language="C#" Value="protected virtual void OnEntryAdded (Gst.IndexEntry entry);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Gst.GLib.DefaultSignalHandler(ConnectionMethod="OverrideEntryAdded", Type=typeof(Gst.Index))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="entry" Type="Gst.IndexEntry" />
</Parameters>
<Docs>
<param name="entry">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnGetAssocEntry">
<MemberSignature Language="C#" Value="protected virtual Gst.IndexEntry OnGetAssocEntry (int id, Gst.IndexLookupMethod method, Gst.AssocFlags flags, Gst.Format format, long value);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Gst.GLib.DefaultSignalHandler(ConnectionMethod="OverrideGetAssocEntry", Type=typeof(Gst.Index))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gst.IndexEntry</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Int32" />
<Parameter Name="method" Type="Gst.IndexLookupMethod" />
<Parameter Name="flags" Type="Gst.AssocFlags" />
<Parameter Name="format" Type="Gst.Format" />
<Parameter Name="value" Type="System.Int64" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="method">To be added.</param>
<param name="flags">To be added.</param>
<param name="format">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnGetAssocEntry">
<MemberSignature Language="C#" Value="protected virtual Gst.IndexEntry OnGetAssocEntry (int id, Gst.IndexLookupMethod method, Gst.AssocFlags flags, Gst.Format format, long value, IntPtr func, IntPtr user_data);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideGetAssocEntry", Type=typeof(Gst.Index))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gst.IndexEntry</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Int32" />
<Parameter Name="method" Type="Gst.IndexLookupMethod" />
<Parameter Name="flags" Type="Gst.AssocFlags" />
<Parameter Name="format" Type="Gst.Format" />
<Parameter Name="value" Type="System.Int64" />
<Parameter Name="func" Type="System.IntPtr" />
<Parameter Name="user_data" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="method">To be added.</param>
<param name="flags">To be added.</param>
<param name="format">To be added.</param>
<param name="value">To be added.</param>
<param name="func">To be added.</param>
<param name="user_data">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnGetWriterId">
<MemberSignature Language="C#" Value="protected virtual bool OnGetWriterId (out int writer_id, string writer_string);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Gst.GLib.DefaultSignalHandler(ConnectionMethod="OverrideGetWriterId", Type=typeof(Gst.Index))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer_id" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="writer_string" Type="System.String" />
</Parameters>
<Docs>
<param name="writer_id">To be added.</param>
<param name="writer_string">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Resolver">
<MemberSignature Language="C#" Value="public Gst.IndexResolver Resolver { set; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.IndexResolver</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetGroup">
<MemberSignature Language="C#" Value="public bool SetGroup (int groupnum);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="groupnum" Type="System.Int32" />
</Parameters>
<Docs>
<param name="groupnum">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>