This package has nothing to do with Gary Vaynerchuk.
Overview
VeeFriends.ImageEncoder is a C# SDK designed for encoding and decoding hidden data within images. It supports various use cases including encoding data into images from URLs, streams, or OpenSea avatars, and decoding hidden data from these images.
Installation
To install the SDK, add it to your project using NuGet:
dotnet add package VeeFriends.ImageEncoder
Dependency Injection
To use VeeFriends.ImageEncoder with dependency injection, configure the services in your Program.cs:
using Microsoft.Extensions.DependencyInjection;
using VeeFriends.ImageEncoder;
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
builder.Services.AddVeeFriendsImageEncoder(new()
{
OpenSeaApiKey = "..."
});
var app = builder.Build();
// Configure the HTTP request pipeline.
app.UseAuthorization();
app.MapControllers();
app.Run();
ImageEncoder Class Summary
The ImageEncoder class provides various methods for encoding and decoding images. Below is a categorized summary of its methods:
using VeeFriends.ImageEncoder;
using System.Threading;
using System.IO;
using System.Threading.Tasks;
public class Example
{
private readonly ImageEncoder _imageEncoder;
public Example(ImageEncoder imageEncoder)
{
_imageEncoder = imageEncoder;
}
public async Task EncodeImageFromUrl()
{
string imageUrl = "https://example.com/image.jpg";
string codeToEncode = "SecretCode";
CancellationToken cancellationToken = new CancellationToken();
Stream encodedImage = await _imageEncoder.EncodeImage(imageUrl, codeToEncode, cancellationToken);
// Save or use the encodedImage stream
}
}
Decoding an Image from URL
using VeeFriends.ImageEncoder;
using System.Threading;
using System.Threading.Tasks;
public class Example
{
private readonly ImageEncoder _imageEncoder;
public Example(ImageEncoder imageEncoder)
{
_imageEncoder = imageEncoder;
}
public async Task DecodeImageFromUrl()
{
string imageUrl = "https://example.com/encoded-image.jpg";
CancellationToken cancellationToken = new CancellationToken();
string decodedCode = await _imageEncoder.DecodeImage(imageUrl, cancellationToken);
// Use the decodedCode
}
}
Generating and Encoding an Avatar
using VeeFriends.ImageEncoder;
using System.Threading;
using System.IO;
using System.Threading.Tasks;
public class Example
{
private readonly ImageEncoder _imageEncoder;
public Example(ImageEncoder imageEncoder)
{
_imageEncoder = imageEncoder;
}
public async Task GenerateAndEncodeAvatar()
{
string characterImageUrl = "https://example.com/character-image.jpg";
string codeToEncode = "SecretCode";
CancellationToken cancellationToken = new CancellationToken();
Stream encodedAvatar = await _imageEncoder.GenerateAvatar(characterImageUrl, codeToEncode, cancellationToken);
// Save or use the encodedAvatar stream
}
}
License
This project is licensed under the MIT License.
Disclaimer
This SDK uses the ImageSharp library, which is licensed by Six Labors under the terms outlined in their LICENSE.
Key Points:
License Types:
Apache License, Version 2.0: For Open Source or Source Available software, Transitive Package Dependencies, Direct Package Dependencies for entities with less than $1M USD annual gross revenue, Non-profits, and Registered Charities.
Six Labors Commercial License: Required for other commercial use cases.
Please review the full license for detailed terms and conditions.
