PommaLabs.Thumbnailer.Client 6.2.1

Thumbnailer Client for .NET

A .NET client for Thumbnailer, which wraps v2 endpoints under an easy to use interface.

Table of Contents

• Install
• Usage
• Maintainers
• Contributing
  • Contributors
  • Editing
  • Restoring dependencies
  • Running tests
• License

Install

NuGet package PommaLabs.Thumbnailer.Client is available for download:

dotnet add package PommaLabs.Thumbnailer.Client

Usage

Client wraps the job-based logic of v2 endpoints under a simpler interface, which hides the details of Thumbnailer jobs and exposes high-level operations such as media optimization and thumbnail generation.

When using dependency injection, client can be registered and configured using following extension method:

using Microsoft.Extensions.DependencyInjection;
using PommaLabs.Thumbnailer.Client;

services.Configure<ThumbnailerClientConfiguration>(Configuration.GetSection("Thumbnailer"));
services.AddThumbnailerClient();

After that, client will be available as an instance of IThumbnailerClient. Client can also be created by instancing following class, providing required objects such as client configuration and a logger:

using PommaLabs.Thumbnailer.Client;
using PommaLabs.Thumbnailer.Client.Services.Clients;

IThumbnailerClient thumbnailerClient = new ConcreteThumbnailerClient(clientConfiguration, logger);

Media optimization can be invoked with following methods:

var optimizedMediaBytes = await thumbnailerClient.OptimizeMediaAsync(
  fileContents, optionalContentType, optionalFileName, optionalCancellationToken);

var optimizedMediaBytes = await thumbnailerClient.OptimizeMediaAsync(
  fileUri, optionalCancellationToken);

Thumbnail generation can be invoked with following methods:

var thumbnailBytes = await thumbnailerClient.GenerateThumbnailAsync(
  fileContents, optionalContentType, optionalFileName,
  /* Thumbnail generation parameters... */, optionalCancellationToken);

var thumbnailBytes = await thumbnailerClient.GenerateThumbnailAsync(
  fileUri, /* Thumbnail generation parameters... */, optionalCancellationToken);

Maintainers

@pomma89.

Contributing

MRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

Contributors

@AlessioGiacobbe implemented new client methods to access image placeholder generation endpoints, which rely on BlurHash and ThumbHash algorithms.

Editing

Visual Studio Code, with Remote Containers extension, is the recommended way to work on this project.

A development container has been configured with all required tools.

Visual Studio Community is also supported and an updated solution file, thumbnailer-dotnet-client.sln, has been provided.

Restoring dependencies

When opening the development container, dependencies should be automatically restored.

Anyway, dependencies can be restored with following command:

dotnet restore

Running tests

Tests can be run with following command:

dotnet test

Tests can also be run with following command, which collects coverage information:

./build.sh --target run-tests

License

MIT © 2019-2024 PommaLabs Team and Contributors