gstreamer/doc/en/Gst.Video/VideoUtil.xml

<Type Name="VideoUtil" FullName="Gst.Video.VideoUtil">
  <TypeSignature Language="C#" Value="public class VideoUtil" />
  <AssemblyInfo>
    <AssemblyName>gstreamer-sharp</AssemblyName>
    <AssemblyVersion>0.9.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.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 VideoUtil ();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CalculateDisplayRatio">
      <MemberSignature Language="C#" Value="public static bool CalculateDisplayRatio (out uint dar_n, out uint dar_d, uint video_width, uint video_height, uint video_par_n, uint video_par_d, uint display_par_n, uint display_par_d);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="dar_n" Type="System.UInt32&amp;" RefType="out" />
        <Parameter Name="dar_d" Type="System.UInt32&amp;" RefType="out" />
        <Parameter Name="video_width" Type="System.UInt32" />
        <Parameter Name="video_height" Type="System.UInt32" />
        <Parameter Name="video_par_n" Type="System.UInt32" />
        <Parameter Name="video_par_d" Type="System.UInt32" />
        <Parameter Name="display_par_n" Type="System.UInt32" />
        <Parameter Name="display_par_d" Type="System.UInt32" />
      </Parameters>
      <Docs>
        <param name="dar_n">To be added.</param>
        <param name="dar_d">To be added.</param>
        <param name="video_width">To be added.</param>
        <param name="video_height">To be added.</param>
        <param name="video_par_n">To be added.</param>
        <param name="video_par_d">To be added.</param>
        <param name="display_par_n">To be added.</param>
        <param name="display_par_d">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatConvert">
      <MemberSignature Language="C#" Value="public static bool FormatConvert (Gst.Video.VideoFormat format, int width, int height, int fps_n, int fps_d, Gst.Format src_format, long src_value, Gst.Format dest_format, out long dest_value);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="format" Type="Gst.Video.VideoFormat" />
        <Parameter Name="width" Type="System.Int32" />
        <Parameter Name="height" Type="System.Int32" />
        <Parameter Name="fps_n" Type="System.Int32" />
        <Parameter Name="fps_d" Type="System.Int32" />
        <Parameter Name="src_format" Type="Gst.Format" />
        <Parameter Name="src_value" Type="System.Int64" />
        <Parameter Name="dest_format" Type="Gst.Format" />
        <Parameter Name="dest_value" Type="System.Int64&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <param name="format">To be added.</param>
        <param name="width">To be added.</param>
        <param name="height">To be added.</param>
        <param name="fps_n">To be added.</param>
        <param name="fps_d">To be added.</param>
        <param name="src_format">To be added.</param>
        <param name="src_value">To be added.</param>
        <param name="dest_format">To be added.</param>
        <param name="dest_value">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatFromFourcc">
      <MemberSignature Language="C#" Value="public static Gst.Video.VideoFormat FormatFromFourcc (Gst.Fourcc fourcc);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Gst.Video.VideoFormat</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="fourcc" Type="Gst.Fourcc" />
      </Parameters>
      <Docs>
        <param name="fourcc">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatFromFourcc">
      <MemberSignature Language="C#" Value="public static Gst.Video.VideoFormat FormatFromFourcc (uint fourcc);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Gst.Video.VideoFormat</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="fourcc" Type="System.UInt32" />
      </Parameters>
      <Docs>
        <param name="fourcc">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatGetComponentHeight">
      <MemberSignature Language="C#" Value="public static int FormatGetComponentHeight (Gst.Video.VideoFormat format, int component, int height);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="format" Type="Gst.Video.VideoFormat" />
        <Parameter Name="component" Type="System.Int32" />
        <Parameter Name="height" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="format">To be added.</param>
        <param name="component">To be added.</param>
        <param name="height">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatGetComponentOffset">
      <MemberSignature Language="C#" Value="public static int FormatGetComponentOffset (Gst.Video.VideoFormat format, int component, int width, int height);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="format" Type="Gst.Video.VideoFormat" />
        <Parameter Name="component" Type="System.Int32" />
        <Parameter Name="width" Type="System.Int32" />
        <Parameter Name="height" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="format">To be added.</param>
        <param name="component">To be added.</param>
        <param name="width">To be added.</param>
        <param name="height">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatGetComponentWidth">
      <MemberSignature Language="C#" Value="public static int FormatGetComponentWidth (Gst.Video.VideoFormat format, int component, int width);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="format" Type="Gst.Video.VideoFormat" />
        <Parameter Name="component" Type="System.Int32" />
        <Parameter Name="width" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="format">To be added.</param>
        <param name="component">To be added.</param>
        <param name="width">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatGetPixelStride">
      <MemberSignature Language="C#" Value="public static int FormatGetPixelStride (Gst.Video.VideoFormat format, int component);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="format" Type="Gst.Video.VideoFormat" />
        <Parameter Name="component" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="format">To be added.</param>
        <param name="component">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatGetRowStride">
      <MemberSignature Language="C#" Value="public static int FormatGetRowStride (Gst.Video.VideoFormat format, int component, int width);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="format" Type="Gst.Video.VideoFormat" />
        <Parameter Name="component" Type="System.Int32" />
        <Parameter Name="width" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="format">To be added.</param>
        <param name="component">To be added.</param>
        <param name="width">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatGetSize">
      <MemberSignature Language="C#" Value="public static int FormatGetSize (Gst.Video.VideoFormat format, int width, int height);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="format" Type="Gst.Video.VideoFormat" />
        <Parameter Name="width" Type="System.Int32" />
        <Parameter Name="height" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="format">To be added.</param>
        <param name="width">To be added.</param>
        <param name="height">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatHasAlpha">
      <MemberSignature Language="C#" Value="public static bool FormatHasAlpha (Gst.Video.VideoFormat format);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="format" Type="Gst.Video.VideoFormat" />
      </Parameters>
      <Docs>
        <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="FormatIsRgb">
      <MemberSignature Language="C#" Value="public static bool FormatIsRgb (Gst.Video.VideoFormat format);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="format" Type="Gst.Video.VideoFormat" />
      </Parameters>
      <Docs>
        <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="FormatIsYuv">
      <MemberSignature Language="C#" Value="public static bool FormatIsYuv (Gst.Video.VideoFormat format);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="format" Type="Gst.Video.VideoFormat" />
      </Parameters>
      <Docs>
        <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="FormatNewCaps">
      <MemberSignature Language="C#" Value="public static Gst.Caps FormatNewCaps (Gst.Video.VideoFormat format, int width, int height, int framerate_n, int framerate_d, int par_n, int par_d);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Gst.Caps</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="format" Type="Gst.Video.VideoFormat" />
        <Parameter Name="width" Type="System.Int32" />
        <Parameter Name="height" Type="System.Int32" />
        <Parameter Name="framerate_n" Type="System.Int32" />
        <Parameter Name="framerate_d" Type="System.Int32" />
        <Parameter Name="par_n" Type="System.Int32" />
        <Parameter Name="par_d" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="format">To be added.</param>
        <param name="width">To be added.</param>
        <param name="height">To be added.</param>
        <param name="framerate_n">To be added.</param>
        <param name="framerate_d">To be added.</param>
        <param name="par_n">To be added.</param>
        <param name="par_d">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatNewCaps">
      <MemberSignature Language="C#" Value="public static Gst.Caps FormatNewCaps (Gst.Video.VideoFormat format, int width, int height, int framerate_n, int framerate_d, int par_n, int par_d, bool interlaced);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Gst.Caps</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="format" Type="Gst.Video.VideoFormat" />
        <Parameter Name="width" Type="System.Int32" />
        <Parameter Name="height" Type="System.Int32" />
        <Parameter Name="framerate_n" Type="System.Int32" />
        <Parameter Name="framerate_d" Type="System.Int32" />
        <Parameter Name="par_n" Type="System.Int32" />
        <Parameter Name="par_d" Type="System.Int32" />
        <Parameter Name="interlaced" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="format">To be added.</param>
        <param name="width">To be added.</param>
        <param name="height">To be added.</param>
        <param name="framerate_n">To be added.</param>
        <param name="framerate_d">To be added.</param>
        <param name="par_n">To be added.</param>
        <param name="par_d">To be added.</param>
        <param name="interlaced">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatParseCaps">
      <MemberSignature Language="C#" Value="public static bool FormatParseCaps (Gst.Caps caps, out Gst.Video.VideoFormat format, out int width, out int height);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="caps" Type="Gst.Caps" />
        <Parameter Name="format" Type="Gst.Video.VideoFormat&amp;" RefType="out" />
        <Parameter Name="width" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="height" Type="System.Int32&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <param name="caps">To be added.</param>
        <param name="format">To be added.</param>
        <param name="width">To be added.</param>
        <param name="height">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatParseCapsInterlaced">
      <MemberSignature Language="C#" Value="public static bool FormatParseCapsInterlaced (Gst.Caps caps, out bool interlaced);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="caps" Type="Gst.Caps" />
        <Parameter Name="interlaced" Type="System.Boolean&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <param name="caps">To be added.</param>
        <param name="interlaced">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormatToFourcc">
      <MemberSignature Language="C#" Value="public static Gst.Fourcc FormatToFourcc (Gst.Video.VideoFormat format);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Gst.Fourcc</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="format" Type="Gst.Video.VideoFormat" />
      </Parameters>
      <Docs>
        <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="GetFrameRate">
      <MemberSignature Language="C#" Value="public static Gst.Fraction GetFrameRate (Gst.Pad pad);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Gst.Fraction</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="pad" Type="Gst.Pad" />
      </Parameters>
      <Docs>
        <param name="pad">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetSize">
      <MemberSignature Language="C#" Value="public static bool GetSize (Gst.Pad pad, out int width, out int height);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="pad" Type="Gst.Pad" />
        <Parameter Name="width" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="height" Type="System.Int32&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <param name="pad">To be added.</param>
        <param name="width">To be added.</param>
        <param name="height">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ParseCapsFramerate">
      <MemberSignature Language="C#" Value="public static bool ParseCapsFramerate (Gst.Caps caps, out int fps_n, out int fps_d);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="caps" Type="Gst.Caps" />
        <Parameter Name="fps_n" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="fps_d" Type="System.Int32&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <param name="caps">To be added.</param>
        <param name="fps_n">To be added.</param>
        <param name="fps_d">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ParseCapsPixelAspectRatio">
      <MemberSignature Language="C#" Value="public static bool ParseCapsPixelAspectRatio (Gst.Caps caps, out int par_n, out int par_d);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.9.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="caps" Type="Gst.Caps" />
        <Parameter Name="par_n" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="par_d" Type="System.Int32&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <param name="caps">To be added.</param>
        <param name="par_n">To be added.</param>
        <param name="par_d">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>