gstreamer/doc/en/Gst/Structure.xml
Aaron Bockover b94528f8e7 Initial import of the sleek new gstreamer-sharp, a massive WIP
git-svn-id: svn://anonsvn.mono-project.com/source/branches/abock/gstreamer-sharp@60875 e3ebcda4-bce8-0310-ba0a-eca2169e7518
2006-05-19 19:24:35 +00:00

613 lines
22 KiB
XML

<Type Name="Structure" FullName="Gst.Structure">
<TypeSignature Language="C#" Value="public class Structure : GLib.Opaque" />
<AssemblyInfo>
<AssemblyName>gst-sharp</AssemblyName>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Structure (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<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=".ctor">
<MemberSignature Language="C#" Value="public Structure (string name, string firstfield, IntPtr varargs);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="firstfield" Type="System.String" />
<Parameter Name="varargs" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<param name="firstfield">To be added.</param>
<param name="varargs">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FixateFieldBoolean">
<MemberSignature Language="C#" Value="public bool FixateFieldBoolean (string field_name, bool target);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="field_name" Type="System.String" />
<Parameter Name="target" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="field_name">To be added.</param>
<param name="target">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EmptyNew">
<MemberSignature Language="C#" Value="public static Gst.Structure EmptyNew (string name);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gst.Structure</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetClockTime">
<MemberSignature Language="C#" Value="public bool GetClockTime (string fieldname, out ulong value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fieldname" Type="System.String" />
<Parameter Name="value" Type="System.UInt64&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="fieldname">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="GetFraction">
<MemberSignature Language="C#" Value="public bool GetFraction (string fieldname, out int value_numerator, out int value_denominator);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fieldname" Type="System.String" />
<Parameter Name="value_numerator" Type="System.Int32&amp;" RefType="out" />
<Parameter Name="value_denominator" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="fieldname">To be added.</param>
<param name="value_numerator">To be added.</param>
<param name="value_denominator">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveFieldsValist">
<MemberSignature Language="C#" Value="public void RemoveFieldsValist (string fieldname, IntPtr varargs);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fieldname" Type="System.String" />
<Parameter Name="varargs" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="fieldname">To be added.</param>
<param name="varargs">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IdGetValue">
<MemberSignature Language="C#" Value="public GLib.Value IdGetValue (int field);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.Value</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="field" Type="System.Int32" />
</Parameters>
<Docs>
<param name="field">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FromString">
<MemberSignature Language="C#" Value="public static Gst.Structure FromString (string str1ng, string end);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gst.Structure</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="str1ng" Type="System.String" />
<Parameter Name="end" Type="System.String" />
</Parameters>
<Docs>
<param name="str1ng">To be added.</param>
<param name="end">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NFields">
<MemberSignature Language="C#" Value="public int NFields ();" />
<MemberType>Method</MemberType>
<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="MapInPlace">
<MemberSignature Language="C#" Value="public bool MapInPlace (Gst.StructureMapFunc func);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="func" Type="Gst.StructureMapFunc" />
</Parameters>
<Docs>
<param name="func">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetValue">
<MemberSignature Language="C#" Value="public void SetValue (string fieldname, GLib.Value value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fieldname" Type="System.String" />
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<param name="fieldname">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IdSetValue">
<MemberSignature Language="C#" Value="public void IdSetValue (int field, GLib.Value value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="field" Type="System.Int32" />
<Parameter Name="value" Type="GLib.Value" />
</Parameters>
<Docs>
<param name="field">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveAllFields">
<MemberSignature Language="C#" Value="public void RemoveAllFields ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasFieldTyped">
<MemberSignature Language="C#" Value="public bool HasFieldTyped (string fieldname, GLib.GType type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fieldname" Type="System.String" />
<Parameter Name="type" Type="GLib.GType" />
</Parameters>
<Docs>
<param name="fieldname">To be added.</param>
<param name="type">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public Gst.Structure Copy ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gst.Structure</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IdEmptyNew">
<MemberSignature Language="C#" Value="public static Gst.Structure IdEmptyNew (int quark);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gst.Structure</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="quark" Type="System.Int32" />
</Parameters>
<Docs>
<param name="quark">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetBoolean">
<MemberSignature Language="C#" Value="public bool GetBoolean (string fieldname, out bool value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fieldname" Type="System.String" />
<Parameter Name="value" Type="System.Boolean&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="fieldname">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="NthFieldName">
<MemberSignature Language="C#" Value="public string NthFieldName (uint index);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FixateFieldNearestDouble">
<MemberSignature Language="C#" Value="public bool FixateFieldNearestDouble (string field_name, double target);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="field_name" Type="System.String" />
<Parameter Name="target" Type="System.Double" />
</Parameters>
<Docs>
<param name="field_name">To be added.</param>
<param name="target">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetFieldType">
<MemberSignature Language="C#" Value="public GLib.GType GetFieldType (string fieldname);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fieldname" Type="System.String" />
</Parameters>
<Docs>
<param name="fieldname">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Foreach">
<MemberSignature Language="C#" Value="public bool Foreach (Gst.StructureForeachFunc func);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="func" Type="Gst.StructureForeachFunc" />
</Parameters>
<Docs>
<param name="func">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FixateFieldNearestInt">
<MemberSignature Language="C#" Value="public bool FixateFieldNearestInt (string field_name, int target);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="field_name" Type="System.String" />
<Parameter Name="target" Type="System.Int32" />
</Parameters>
<Docs>
<param name="field_name">To be added.</param>
<param name="target">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasName">
<MemberSignature Language="C#" Value="public bool HasName (string name);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetString">
<MemberSignature Language="C#" Value="public string GetString (string fieldname);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fieldname" Type="System.String" />
</Parameters>
<Docs>
<param name="fieldname">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetInt">
<MemberSignature Language="C#" Value="public bool GetInt (string fieldname, out int value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fieldname" Type="System.String" />
<Parameter Name="value" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="fieldname">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="GetFourcc">
<MemberSignature Language="C#" Value="public bool GetFourcc (string fieldname, out uint value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fieldname" Type="System.String" />
<Parameter Name="value" Type="System.UInt32&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="fieldname">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="RemoveField">
<MemberSignature Language="C#" Value="public void RemoveField (string fieldname);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fieldname" Type="System.String" />
</Parameters>
<Docs>
<param name="fieldname">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasField">
<MemberSignature Language="C#" Value="public bool HasField (string fieldname);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fieldname" Type="System.String" />
</Parameters>
<Docs>
<param name="fieldname">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetEnum">
<MemberSignature Language="C#" Value="public bool GetEnum (string fieldname, GLib.GType enumtype, out int value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fieldname" Type="System.String" />
<Parameter Name="enumtype" Type="GLib.GType" />
<Parameter Name="value" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="fieldname">To be added.</param>
<param name="enumtype">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="GetValue">
<MemberSignature Language="C#" Value="public GLib.Value GetValue (string fieldname);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.Value</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fieldname" Type="System.String" />
</Parameters>
<Docs>
<param name="fieldname">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FixateFieldNearestFraction">
<MemberSignature Language="C#" Value="public bool FixateFieldNearestFraction (string field_name, int target_numerator, int target_denominator);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="field_name" Type="System.String" />
<Parameter Name="target_numerator" Type="System.Int32" />
<Parameter Name="target_denominator" Type="System.Int32" />
</Parameters>
<Docs>
<param name="field_name">To be added.</param>
<param name="target_numerator">To be added.</param>
<param name="target_denominator">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetDouble">
<MemberSignature Language="C#" Value="public bool GetDouble (string fieldname, out double value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fieldname" Type="System.String" />
<Parameter Name="value" Type="System.Double&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="fieldname">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="Type">
<MemberSignature Language="C#" Value="public GLib.GType Type { set; get; };" />
<MemberType>Property</MemberType>
<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="Name">
<MemberSignature Language="C#" Value="public string Name { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</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>
<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="NameId">
<MemberSignature Language="C#" Value="public int NameId { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Type>