aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Api/ImageProcessor.cs
diff options
context:
space:
mode:
Diffstat (limited to 'MediaBrowser.Api/ImageProcessor.cs')
-rw-r--r--MediaBrowser.Api/ImageProcessor.cs8
1 files changed, 8 insertions, 0 deletions
diff --git a/MediaBrowser.Api/ImageProcessor.cs b/MediaBrowser.Api/ImageProcessor.cs
index c4a2fdb69..32c7e05a2 100644
--- a/MediaBrowser.Api/ImageProcessor.cs
+++ b/MediaBrowser.Api/ImageProcessor.cs
@@ -9,6 +9,14 @@ namespace MediaBrowser.Api
{
public static class ImageProcessor
{
+ /// <summary>
+ /// Resizes an image from a source stream and saves the result to an output stream
+ /// </summary>
+ /// <param name="width">Use if a fixed width is required. Aspect ratio will be preserved.</param>
+ /// <param name="height">Use if a fixed height is required. Aspect ratio will be preserved.</param>
+ /// <param name="maxWidth">Use if a max width is required. Aspect ratio will be preserved.</param>
+ /// <param name="maxHeight">Use if a max height is required. Aspect ratio will be preserved.</param>
+ /// <param name="quality">Quality level, from 0-100. Currently only applies to JPG. The default value should suffice.</param>
public static void ProcessImage(Stream sourceImageStream, Stream toStream, int? width, int? height, int? maxWidth, int? maxHeight, int? quality)
{
Image originalImage = Image.FromStream(sourceImageStream);