gstreamer/doc/en/Gst.Base/BitReader.xml
2010-02-01 10:44:21 +01:00

381 lines
13 KiB
XML

<Type Name="BitReader" FullName="Gst.Base.BitReader">
<TypeSignature Language="C#" Value="public class BitReader : Gst.GLib.Opaque" />
<AssemblyInfo>
<AssemblyName>gstreamer-sharp</AssemblyName>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Gst.GLib.Opaque</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BitReader (Gst.Buffer buffer);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="buffer" Type="Gst.Buffer" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BitReader (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.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="Buffer">
<MemberSignature Language="C#" Value="public Gst.Buffer Buffer { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Gst.Buffer</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="~BitReader ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.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="Free">
<MemberSignature Language="C#" Value="protected override void Free (IntPtr raw);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<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="Get">
<MemberSignature Language="C#" Value="public bool Get (out byte val, uint nbits);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="val" Type="System.Byte&amp;" RefType="out" />
<Parameter Name="nbits" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="val">To be added.</param>
<param name="nbits">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public bool Get (out ushort val, uint nbits);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="val" Type="System.UInt16&amp;" RefType="out" />
<Parameter Name="nbits" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="val">To be added.</param>
<param name="nbits">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public bool Get (out uint val, uint nbits);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="val" Type="System.UInt32&amp;" RefType="out" />
<Parameter Name="nbits" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="val">To be added.</param>
<param name="nbits">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public bool Get (out ulong val, uint nbits);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="val" Type="System.UInt64&amp;" RefType="out" />
<Parameter Name="nbits" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="val">To be added.</param>
<param name="nbits">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Peek">
<MemberSignature Language="C#" Value="public bool Peek (out byte val, uint nbits);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="val" Type="System.Byte&amp;" RefType="out" />
<Parameter Name="nbits" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="val">To be added.</param>
<param name="nbits">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Peek">
<MemberSignature Language="C#" Value="public bool Peek (out ushort val, uint nbits);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="val" Type="System.UInt16&amp;" RefType="out" />
<Parameter Name="nbits" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="val">To be added.</param>
<param name="nbits">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Peek">
<MemberSignature Language="C#" Value="public bool Peek (out uint val, uint nbits);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="val" Type="System.UInt32&amp;" RefType="out" />
<Parameter Name="nbits" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="val">To be added.</param>
<param name="nbits">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Peek">
<MemberSignature Language="C#" Value="public bool Peek (out ulong val, uint nbits);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="val" Type="System.UInt64&amp;" RefType="out" />
<Parameter Name="nbits" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="val">To be added.</param>
<param name="nbits">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Pos">
<MemberSignature Language="C#" Value="public uint Pos { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Remaining">
<MemberSignature Language="C#" Value="public uint Remaining { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetPos">
<MemberSignature Language="C#" Value="public bool SetPos (uint pos);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pos" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="pos">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Size">
<MemberSignature Language="C#" Value="public uint Size { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Skip">
<MemberSignature Language="C#" Value="public bool Skip (uint nbits);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="nbits" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="nbits">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SkipToByte">
<MemberSignature Language="C#" Value="public bool SkipToByte ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.9.2.0</AssemblyVersion>
<AssemblyVersion>0.9.3.0</AssemblyVersion>
</AssemblyInfo>
<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>
</Members>
</Type>