j3g
/
lum_platform_image_converter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #19 from koji-1009/chore/doc 

doc: Update
This commit is contained in:
Koji Wakamiya 2025-12-15 06:43:28 +09:00 committed by GitHub
parent 392b07c76f e86bc98b4d
commit d1fec905fc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,5 +1,7 @@
# platform_image_converter # platform_image_converter
[![pub package](https://img.shields.io/pub/v/platform_image_converter.svg)](https://pub.dev/packages/platform_image_converter)
A high-performance Flutter plugin for cross-platform image format conversion and resizing using native APIs on iOS, macOS, Android, and Web. A high-performance Flutter plugin for cross-platform image format conversion and resizing using native APIs on iOS, macOS, Android, and Web.
## Features ## Features
@ -88,8 +90,10 @@ static Future<Uint8List> convert({
**Returns:** `Future<Uint8List>` containing the converted image data. **Returns:** `Future<Uint8List>` containing the converted image data.
**Throws:** **Throws:**
- `UnsupportedError`: If the platform or format is not supported. - `UnsupportedError`: If the platform or output format is not supported.
- `Exception`: If conversion fails. - `ImageDecodingException`: If the input image data cannot be decoded.
- `ImageEncodingException`: If the image cannot be encoded to the target format.
- `ImageConversionException`: For other general errors during the conversion process.
### `OutputFormat` Enum ### `OutputFormat` Enum

2
lib/platform_image_converter.dart
View File

@ -45,7 +45,7 @@ class ImageConverter {
/// - [UnsupportedError]: If the platform or output format is not supported. /// - [UnsupportedError]: If the platform or output format is not supported.
/// - [ImageDecodingException]: If the input image data cannot be decoded. /// - [ImageDecodingException]: If the input image data cannot be decoded.
/// - [ImageEncodingException]: If the image cannot be encoded to the target format. /// - [ImageEncodingException]: If the image cannot be encoded to the target format.
/// - [ImageConversionException]: For other general errors during the conversion process. /// /// - [ImageConversionException]: For other general errors during the conversion process.
/// **Example - Convert HEIC to JPEG:** /// **Example - Convert HEIC to JPEG:**
/// ```dart /// ```dart
/// final jpegData = await ImageConverter.convert( /// final jpegData = await ImageConverter.convert(

1
lib/src/image_converter_platform_interface.dart
View File

@ -11,6 +11,7 @@ import 'package:platform_image_converter/src/output_resize.dart';
/// **Implementations:** /// **Implementations:**
/// - [ImageConverterDarwin]: iOS and macOS using ImageIO /// - [ImageConverterDarwin]: iOS and macOS using ImageIO
/// - [ImageConverterAndroid]: Android using BitmapFactory /// - [ImageConverterAndroid]: Android using BitmapFactory
/// - [ImageConverterWeb]: Web using Canvas API
abstract interface class ImageConverterPlatform { abstract interface class ImageConverterPlatform {
/// Converts an image to a target format. /// Converts an image to a target format.
/// ///