gstreamer/doc/en/Gst/Message.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

548 lines
20 KiB
XML

<Type Name="Message" FullName="Gst.Message">
<TypeSignature Language="C#" Value="public class Message : Gst.MiniObject" />
<AssemblyInfo>
<AssemblyName>gst-sharp</AssemblyName>
<AssemblyVersion>0.9.5.99</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Gst.MiniObject</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Message (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message=null, IsError=False)</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<param name="gtype">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Message (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 Message (Gst.Object src, Gst.Structure structure);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="src" Type="Gst.Object" />
<Parameter Name="structure" Type="Gst.Structure" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="structure">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Message (Gst.Object src, Gst.Clock clock);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="src" Type="Gst.Object" />
<Parameter Name="clock" Type="Gst.Clock" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="clock">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Message (Gst.Object src, Gst.Clock clock, bool ready);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="src" Type="Gst.Object" />
<Parameter Name="clock" Type="Gst.Clock" />
<Parameter Name="ready" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="clock">To be added.</param>
<param name="ready">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Message (Gst.MessageType type, Gst.Object src, Gst.Structure structure);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="type" Type="Gst.MessageType" />
<Parameter Name="src" Type="Gst.Object" />
<Parameter Name="structure" Type="Gst.Structure" />
</Parameters>
<Docs>
<param name="type">To be added.</param>
<param name="src">To be added.</param>
<param name="structure">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Message (Gst.Object src, Gst.Format format, long duration);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="src" Type="Gst.Object" />
<Parameter Name="format" Type="Gst.Format" />
<Parameter Name="duration" Type="System.Int64" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="format">To be added.</param>
<param name="duration">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Message (Gst.Object src);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="src" Type="Gst.Object" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Message (Gst.Object src, IntPtr error, string debug);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="src" Type="Gst.Object" />
<Parameter Name="error" Type="System.IntPtr" />
<Parameter Name="debug" Type="System.String" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="error">To be added.</param>
<param name="debug">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Message (Gst.Object src, Gst.State oldstate, Gst.State newstate, Gst.State pending);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="src" Type="Gst.Object" />
<Parameter Name="oldstate" Type="Gst.State" />
<Parameter Name="newstate" Type="Gst.State" />
<Parameter Name="pending" Type="Gst.State" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="oldstate">To be added.</param>
<param name="newstate">To be added.</param>
<param name="pending">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Message (Gst.Object src, Gst.TagList tag_list);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="src" Type="Gst.Object" />
<Parameter Name="tag_list" Type="Gst.TagList" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="tag_list">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NewElement">
<MemberSignature Language="C#" Value="public static Gst.Message NewElement (Gst.Object src, Gst.Structure structure);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gst.Message</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="src" Type="Gst.Object" />
<Parameter Name="structure" Type="Gst.Structure" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="structure">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NewNewClock">
<MemberSignature Language="C#" Value="public static Gst.Message NewNewClock (Gst.Object src, Gst.Clock clock);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gst.Message</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="src" Type="Gst.Object" />
<Parameter Name="clock" Type="Gst.Clock" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="clock">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NewSegmentDone">
<MemberSignature Language="C#" Value="public static Gst.Message NewSegmentDone (Gst.Object src, Gst.Format format, long position);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gst.Message</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="src" Type="Gst.Object" />
<Parameter Name="format" Type="Gst.Format" />
<Parameter Name="position" Type="System.Int64" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="format">To be added.</param>
<param name="position">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NewSegmentStart">
<MemberSignature Language="C#" Value="public static Gst.Message NewSegmentStart (Gst.Object src, Gst.Format format, long position);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gst.Message</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="src" Type="Gst.Object" />
<Parameter Name="format" Type="Gst.Format" />
<Parameter Name="position" Type="System.Int64" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="format">To be added.</param>
<param name="position">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NewStateDirty">
<MemberSignature Language="C#" Value="public static Gst.Message NewStateDirty (Gst.Object src);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gst.Message</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="src" Type="Gst.Object" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NewWarning">
<MemberSignature Language="C#" Value="public static Gst.Message NewWarning (Gst.Object src, IntPtr error, string debug);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gst.Message</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="src" Type="Gst.Object" />
<Parameter Name="error" Type="System.IntPtr" />
<Parameter Name="debug" Type="System.String" />
</Parameters>
<Docs>
<param name="src">To be added.</param>
<param name="error">To be added.</param>
<param name="debug">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ParseNewClock">
<MemberSignature Language="C#" Value="public void ParseNewClock (Gst.Clock clock);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="clock" Type="Gst.Clock" />
</Parameters>
<Docs>
<param name="clock">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ParseSegmentDone">
<MemberSignature Language="C#" Value="public void ParseSegmentDone (out Gst.Format format, out long position);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="Gst.Format&amp;" RefType="out" />
<Parameter Name="position" Type="System.Int64&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="format">To be added.</param>
<param name="position">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ParseDuration">
<MemberSignature Language="C#" Value="public void ParseDuration (out Gst.Format format, out long duration);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="Gst.Format&amp;" RefType="out" />
<Parameter Name="duration" Type="System.Int64&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="format">To be added.</param>
<param name="duration">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ParseClockProvide">
<MemberSignature Language="C#" Value="public bool ParseClockProvide (Gst.Clock clock);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="clock" Type="Gst.Clock" />
</Parameters>
<Docs>
<param name="clock">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ParseTag">
<MemberSignature Language="C#" Value="public void ParseTag (Gst.TagList tag_list);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="tag_list" Type="Gst.TagList" />
</Parameters>
<Docs>
<param name="tag_list">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ParseClockLost">
<MemberSignature Language="C#" Value="public void ParseClockLost (Gst.Clock clock);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="clock" Type="Gst.Clock" />
</Parameters>
<Docs>
<param name="clock">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TypeGetName">
<MemberSignature Language="C#" Value="public static string TypeGetName (Gst.MessageType type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="Gst.MessageType" />
</Parameters>
<Docs>
<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="ParseSegmentStart">
<MemberSignature Language="C#" Value="public void ParseSegmentStart (out Gst.Format format, out long position);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="Gst.Format&amp;" RefType="out" />
<Parameter Name="position" Type="System.Int64&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="format">To be added.</param>
<param name="position">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TypeToQuark">
<MemberSignature Language="C#" Value="public static int TypeToQuark (Gst.MessageType type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="Gst.MessageType" />
</Parameters>
<Docs>
<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="ParseStateChanged">
<MemberSignature Language="C#" Value="public void ParseStateChanged (out Gst.State oldstate, out Gst.State newstate, out Gst.State pending);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="oldstate" Type="Gst.State&amp;" RefType="out" />
<Parameter Name="newstate" Type="Gst.State&amp;" RefType="out" />
<Parameter Name="pending" Type="Gst.State&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="oldstate">To be added.</param>
<param name="newstate">To be added.</param>
<param name="pending">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Timestamp">
<MemberSignature Language="C#" Value="public ulong Timestamp { get; };" />
<MemberType>Property</MemberType>
<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="Src">
<MemberSignature Language="C#" Value="public Gst.Object Src { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gst.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public Gst.MessageType Type { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gst.MessageType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Structure">
<MemberSignature Language="C#" Value="public Gst.Structure Structure { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gst.Structure</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="ParseError">
<MemberSignature Language="C#" Value="public void ParseError (out string error);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="error" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="error">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetMessage">
<MemberSignature Language="C#" Value="public static Gst.Message GetMessage (IntPtr raw);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gst.Message</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Type>