diff options
| author | sr55 <[email protected]> | 2011-09-17 19:23:28 +0000 |
|---|---|---|
| committer | sr55 <[email protected]> | 2011-09-17 19:23:28 +0000 |
| commit | ac48779d6481154c16419d3c758af39ddcba4d86 (patch) | |
| tree | d332c630a64e0128e2442eeca2491cbc10cb7bcf /win/CS/HandBrake.Interop/HandBrakeInterop/Converters.cs | |
| parent | d428990eccd41c5ea9e67115a093ea0c09bc3e2a (diff) | |
Interop: Add in a bunch of missing comments.
git-svn-id: svn://svn.handbrake.fr/HandBrake/trunk@4229 b64f7644-9d1e-0410-96f1-a4d463321fa5
Diffstat (limited to 'win/CS/HandBrake.Interop/HandBrakeInterop/Converters.cs')
| -rw-r--r-- | win/CS/HandBrake.Interop/HandBrakeInterop/Converters.cs | 58 |
1 files changed, 53 insertions, 5 deletions
diff --git a/win/CS/HandBrake.Interop/HandBrakeInterop/Converters.cs b/win/CS/HandBrake.Interop/HandBrakeInterop/Converters.cs index 868a8b720..b0e81fcd3 100644 --- a/win/CS/HandBrake.Interop/HandBrakeInterop/Converters.cs +++ b/win/CS/HandBrake.Interop/HandBrakeInterop/Converters.cs @@ -18,7 +18,10 @@ namespace HandBrake.Interop public static class Converters
{
- private static Dictionary<double, int> vrates = new Dictionary<double, int>
+ /// <summary>
+ /// Video Frame Rates
+ /// </summary>
+ private static Dictionary<double, int> vrates = new Dictionary<double, int>
{
{5, 5400000},
{10, 2700000},
@@ -30,7 +33,19 @@ namespace HandBrake.Interop {29.97, 900900}
};
- public static int FramerateToVrate(double framerate)
+ /// <summary>
+ /// Convert Framerate to Video Rates
+ /// </summary>
+ /// <param name="framerate">
+ /// The framerate.
+ /// </param>
+ /// <returns>
+ /// The vrate if a valid framerate is passed in.
+ /// </returns>
+ /// <exception cref="ArgumentException">
+ /// Thrown when framerate is invalid.
+ /// </exception>
+ public static int FramerateToVrate(double framerate)
{
if (!vrates.ContainsKey(framerate))
{
@@ -40,7 +55,19 @@ namespace HandBrake.Interop return vrates[framerate];
}
- public static int MixdownToNative(Mixdown mixdown)
+ /// <summary>
+ /// Convert a Mixdown object to HandBrakes native mixdown constant.
+ /// </summary>
+ /// <param name="mixdown">
+ /// The mixdown.
+ /// </param>
+ /// <returns>
+ /// NativeContstant that represents the mixdown.
+ /// </returns>
+ /// <exception cref="ArgumentException">
+ /// Thrown for an invalid mixodown.
+ /// </exception>
+ public static int MixdownToNative(Mixdown mixdown)
{
if (mixdown == Mixdown.Auto)
{
@@ -64,7 +91,19 @@ namespace HandBrake.Interop return 0;
}
- public static Mixdown NativeToMixdown(int mixdown)
+ /// <summary>
+ /// Convert an native internal handbrake mixdown to a local mixdown enum.
+ /// </summary>
+ /// <param name="mixdown">
+ /// The mixdown.
+ /// </param>
+ /// <returns>
+ /// A mixdown object.
+ /// </returns>
+ /// <exception cref="ArgumentException">
+ /// thrown when mixdown is invalid.
+ /// </exception>
+ public static Mixdown NativeToMixdown(int mixdown)
{
switch (mixdown)
{
@@ -117,7 +156,16 @@ namespace HandBrake.Interop return 0;
}
- public static AudioCodec NativeToAudioCodec(uint codec)
+ /// <summary>
+ /// Convert Native HB Internal Audio int to a AudioCodec model.
+ /// </summary>
+ /// <param name="codec">
+ /// The codec.
+ /// </param>
+ /// <returns>
+ /// An AudioCodec object.
+ /// </returns>
+ public static AudioCodec NativeToAudioCodec(uint codec)
{
switch (codec)
{
|