gstreamer/doc/en/Gst.GLib/IOChannel.xml
Sebastian Dröge 2453ddfe11 Update docs
2009-10-02 15:50:16 +02:00

554 lines
20 KiB
XML

<Type Name="IOChannel" FullName="Gst.GLib.IOChannel">
<TypeSignature Language="C#" Value="public class IOChannel : Gst.GLib.IWrapper, IDisposable" />
<AssemblyInfo>
<AssemblyName>gstreamer-sharp</AssemblyName>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Gst.GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IOChannel (int fd);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="fd" Type="System.Int32" />
</Parameters>
<Docs>
<param name="fd">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IOChannel (string filename, string mode);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="filename" Type="System.String" />
<Parameter Name="mode" Type="System.String" />
</Parameters>
<Docs>
<param name="filename">To be added.</param>
<param name="mode">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddWatch">
<MemberSignature Language="C#" Value="public uint AddWatch (int priority, Gst.GLib.IOCondition condition, Gst.GLib.IOFunc func);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="priority" Type="System.Int32" />
<Parameter Name="condition" Type="Gst.GLib.IOCondition" />
<Parameter Name="func" Type="Gst.GLib.IOFunc" />
</Parameters>
<Docs>
<param name="priority">To be added.</param>
<param name="condition">To be added.</param>
<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="BufferCondition">
<MemberSignature Language="C#" Value="public Gst.GLib.IOCondition BufferCondition { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.IOCondition</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Buffered">
<MemberSignature Language="C#" Value="public bool Buffered { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.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="BufferSize">
<MemberSignature Language="C#" Value="public ulong BufferSize { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<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="CloseOnUnref">
<MemberSignature Language="C#" Value="public bool CloseOnUnref { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.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="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.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="Encoding">
<MemberSignature Language="C#" Value="public string Encoding { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<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="ErrorFromErrno">
<MemberSignature Language="C#" Value="public static Gst.GLib.IOChannelError ErrorFromErrno (int en);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.IOChannelError</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="en" Type="System.Int32" />
</Parameters>
<Docs>
<param name="en">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Flags">
<MemberSignature Language="C#" Value="public Gst.GLib.IOFlags Flags { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.IOFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Flush">
<MemberSignature Language="C#" Value="public Gst.GLib.IOStatus Flush ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FromHandle">
<MemberSignature Language="C#" Value="public static Gst.GLib.IOChannel FromHandle (IntPtr handle);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.IOChannel</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="handle" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="handle">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Handle">
<MemberSignature Language="C#" Value="public IntPtr Handle { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Init">
<MemberSignature Language="C#" Value="protected void Init ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.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="LineTerminator">
<MemberSignature Language="C#" Value="public char[] LineTerminator { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Char[]</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReadChars">
<MemberSignature Language="C#" Value="public Gst.GLib.IOStatus ReadChars (byte[] buf, out ulong bytes_read);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buf" Type="System.Byte[]" />
<Parameter Name="bytes_read" Type="System.UInt64&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="buf">To be added.</param>
<param name="bytes_read">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReadLine">
<MemberSignature Language="C#" Value="public Gst.GLib.IOStatus ReadLine (out string str_return);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="str_return" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="str_return">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReadLine">
<MemberSignature Language="C#" Value="public Gst.GLib.IOStatus ReadLine (out string str_return, out ulong terminator_pos);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="str_return" Type="System.String&amp;" RefType="out" />
<Parameter Name="terminator_pos" Type="System.UInt64&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="str_return">To be added.</param>
<param name="terminator_pos">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReadToEnd">
<MemberSignature Language="C#" Value="public Gst.GLib.IOStatus ReadToEnd (out string str_return);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="str_return" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="str_return">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReadUnichar">
<MemberSignature Language="C#" Value="public Gst.GLib.IOStatus ReadUnichar (out uint thechar);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="thechar" Type="System.UInt32&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="thechar">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SeekPosition">
<MemberSignature Language="C#" Value="public Gst.GLib.IOStatus SeekPosition (long offset, Gst.GLib.SeekType type);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="offset" Type="System.Int64" />
<Parameter Name="type" Type="Gst.GLib.SeekType" />
</Parameters>
<Docs>
<param name="offset">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="Shutdown">
<MemberSignature Language="C#" Value="public Gst.GLib.IOStatus Shutdown (bool flush);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="flush" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="flush">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UnixFd">
<MemberSignature Language="C#" Value="public int UnixFd { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</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="WriteChars">
<MemberSignature Language="C#" Value="public Gst.GLib.IOStatus WriteChars (byte[] buf, out ulong bytes_written);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buf" Type="System.Byte[]" />
<Parameter Name="bytes_written" Type="System.UInt64&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="buf">To be added.</param>
<param name="bytes_written">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WriteChars">
<MemberSignature Language="C#" Value="public Gst.GLib.IOStatus WriteChars (string str, out string remainder);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="str" Type="System.String" />
<Parameter Name="remainder" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="str">To be added.</param>
<param name="remainder">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WriteUnichar">
<MemberSignature Language="C#" Value="public Gst.GLib.IOStatus WriteUnichar (uint thechar);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.0.0</AssemblyVersion>
<AssemblyVersion>0.9.1.0</AssemblyVersion>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.GLib.IOStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="thechar" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="thechar">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>