README.md

TinyPng for .Net

Platform	Status
Windows
Linux

This is a .NET wrapper around the TinyPNG.com image compression service. This is not an official TinyPNG.com product.

• Supports .Net Core and full .Net Framework
• Non-blocking async turtles all the way down
• Byte[], Stream and File API's available

Installation

Install via Nuget

    Install-Package TinyPNG

Quickstart

using (var png = new TinyPngClient("yourSecretApiKey")) 
{
    await png.Compress("cat.jpg");
}

Compressing Images

//create an instance of the TinyPngClient
using (var png = new TinyPngClient("yourSecretApiKey")) 
{
    //compress an image
    var result = await png.Compress("pathToFile or byte array or stream");

    //this gives you the information about your image as stored by TinyPNG
    //they don't give you the actual bits as you may want to chain this with a resize
    //operation without caring for the originally sied image. For that, we need to:
    var compressedImage = await png.Download(result);

    //get the image data as a byte array
    var bytes = await compressedImage.GetImageByteData();

    //get a stream instead
    var stream  = await compressedImage.GetImageStreamData()

    //or just save to disk
    await compressedImage.SaveImageToDisk("pathToSaveImage");

    //async turtle all the things!
    await (await png.Download(await png.Compress("path"))).SaveImageToDisk("savedPath");

}

Further details about the result of the compression are also available on the Input and Output properties of a Compress operation. Some examples:

    //old size
    result.Input.Size;
    
    //new size
    result.Output.Size;

    //URL of the compressed Image
    result.Output.Url; 

Resizing Images

using (var png = new TinyPngClient("yourSecretApiKey")) 
{
    var result = await png.Compress("pathToFile or byte array or stream");
    
    var resizedImage = await png.Resize(result, width, height, ResizeType);

    await resizedImage.SaveImageToDisk("pathToSaveImage");
}

Resize Operations

There are certain combinations when specifying resize options which aren't compatible with TinyPNG. We also include strongly typed resize operations, depending on the type of resize you want to do.

using (var png = new TinyPngClient("yourSecretApiKey")) 
{
    var result = await png.Compress("pathToFile or byte array or stream");
    
    await png.Resize(result, new ScaleWidthResizeOperation(width));
    await png.Resize(result, new ScaleHeightResizeOperation(width));
    await png.Resize(result, new FitResizeOperation(width, height));
    await png.Resize(result, new CoverResizeOperation(width, height));
}

The same Byte[], Stream and File path API's are available from the result of the Resize() method.

Amazon S3 Storage

The result of any compress operation can be stored directly on to Amazon S3 storage. I'd strongly recommend referring to TinyPNG.com's documentation with regard to how to configure the appropriate S3 access.

If you're going to be storing images for most requests onto S3, then you can pass in an AmazonS3Configuration object to the constructor.

using (var png = new TinyPngClient("yourSecretApiKey", 
    new AmazonS3Configuration("awsAccessKeyId", "awsSecretAccessKey", "bucket", "region"))) 
{
    var compressedCat = await png.Compress("cat.jpg");
    var s3Uri = await png.SaveCompressedImageToAmazonS3(compressedCat, "file-name.png");

    //if you'd like to override the particular bucket or region
    //an image is being stored to from what is specified in the AmazonS3Configuration:
    var s3UriInNewSpot = await png.SaveCompressedImageToAmazonS3(
        compressedCat, 
        "file-name.png", 
        bucketOverride: "different-bucket", 
        regionOverride: "different-region");

}

You can also pass a AmazonS3Configuration object directly into calls to SaveCompressedImageToAmazonS3

using (var png = new TinyPngClient("yourSecretApiKey")) 
{
    var compressedCat = await png.Compress("cat.jpg");
    var s3Uri = await png.SaveCompressedImageToAmazonS3(compressedCat, 
        new AmazonS3Configuration(
            "awsAccessKeyId", 
            "awsSecretAccessKey", 
            "bucket", 
            "region"), "file-name.png");
}

Compression Count

You can get a read on the number of compression operations you've performed by inspecting the CompressionCount property on the result of any operation you've performed. This is useful for keeping tabs on your API usage.

var compressedCat = await png.Compress("cat.jpg");
compressedCat.CompressionCount; // = 5