Pixelbin

Pixelbin Dart library helps you integrate Pixelbin with your Dart/Flutter Application.

Usage

Install using Pub Package Manager

Run this command:

With Dart:

dart pub add pixelbin

With Flutter:

flutter pub add pixelbin

This will add a line like this to your package's pubspec.yaml (and run an implicit dart pub get):

dependencies:
  pixelbin: ^latest_release_version

Creating Image from URL or Cloud details

import 'package:pixelbin/pixelbin_dart_sdk.dart';
final PixelBinImage? imageFromUrl = PixelBin.shared.imageFromUrl(
        "https://cdn.pixelbin.io/v2/dummy-cloudname/erase.bg(shadow:false,r:true,i:general)~af.remove()~t.blur(s:0.3,dpr:1.0)/__playground/playground-default.jpeg");
debugPrint(imageFromUrl?.encoded);
// Create Image url from cloud, zone and other details
final PixelBinImage imageFromDetails = pixelBin.image(
          imagePath: imageFromUrl.imagePath, cloud: imageFromUrl.cloudName, transformations: imageFromUrl.transformations, version: imageFromUrl.version);
debugPrint(imageFromDetails.encoded);

Applying Transformations and Getting Transformations

import 'package:pixelbin/pixelbin_dart_sdk.dart';
// Create Image url from cloud, zone and imagePath on cloud (Not local path)
final image = PixelBin.shared.image(imagePath: "example/logo/apple.jpg", cloud: "apple_cloud", zone: "south_asia");
      debugPrint(imageFromDetails.encoded); // https://cdn.pixelbin.io/v2/apple_cloud/south_asia/original/example/logo/apple.jpg
final eraseTransformation = Transformation.erasebg(); // Creating Erasebg Transformation
final resizeTransformation = Transformation.resize(height: 200, width: 200); // Creating Resize Transformation
image.addTransformations([eraseTransformation, resizeTransformation]); // Applying multiple transformations with list(keep passing all transformations in list)
// OR
image.addTransformation(eraseTransformation);
image.addTransformation(resizeTransformation); // Applying transformations one by one
final outputUrl = image.encoded; // https://cdn.pixelbin.io/v2/apple_cloud/south_asia/erase.bg()~t.resize(h:100,w:100)/example/logo/apple.jpg
debugPrint(outputUrl);

Uploading Image and getting url object

// Signed Url and Field can be generated via using Backed SDK for pixelbin or API to generate signed url for upload
// Assume imagePath: "example/logo/apple.jpg", cloud: "apple_cloud", zone: "south_asia" & generate details
final signUrl = "SIGNED_URL";
final fields = {// Key: Value}; // META_DATA in value
final signedDetails = SignedDetails(url: signUrl, fields: fields)
// file is local picked file, other fields chunkSize: Int = 1024, concurrency: Int = 1
try {
     final signedDetails = SignedDetails(url: signUrl,fields:fields);
     final PixelBinImage? uploadResponse = await PixelBin.shared
          .upload(file: file, signedDetails: signedDetails);
     debugPrint("Response:=> ${uploadResponse?.encoded}");
    } catch (e) {
     debugPrint("Error:=> ${e.toString()}");
    }

Parameter	Type	Description
file (File)	File	File to upload to Pixelbin
signedDetails (SignedDetails)	Object	Signed details generated with the Pixelbin Backend SDK
chunkSize (Int)	Integer	Size of chunks to be uploaded in KB (default value is 1024)
concurrency (Int)	Integer	Number of chunks to be uploaded in parallel API calls

Resolves with Image object on success.
Rejects with error on failure.

List of Supported Transformations

1. DetectBackgroundType

1. detect

Usage Example

final t = Transformation.detectbackgroundtype.detect(

);

2. Artifact

1. remove

Usage Example

final t = Transformation.artifact.remove(

);

3. AWSRekognitionPlugin

1. detectLabels

Supported Configuration

Parameter	Type	Default
maximumLabels	integer	`5`
minimumConfidence	integer	`55`

Usage Example

final t = Transformation.awsrekognitionplugin.detectlabels(

    maximumLabels: "5", 

    minimumConfidence: "55"

);

2. moderation

Supported Configuration

Parameter	Type	Default
minimumConfidence	integer	`55`

Usage Example

final t = Transformation.awsrekognitionplugin.moderation(

    minimumConfidence: "55"

);

4. BackgroundGenerator

1. bg

Supported Configuration

Parameter	Type	Default
backgroundPrompt	custom	`YSBmb3Jlc3QgZnVsbCBvZiBvYWsgdHJlZXMsd2l0aCBicmlnaHQgbGlnaHRzLCBzdW4gYW5kIGEgbG90IG9mIG1hZ2ljLCB1bHRyYSByZWFsaXN0aWMsIDhr`
focus	enum: `Product`, `Background`	`Product`
negativePrompt	custom	N/A
seed	integer	`123`

Usage Example

final t = Transformation.backgroundgenerator.bg(

    backgroundPrompt: "YSBmb3Jlc3QgZnVsbCBvZiBvYWsgdHJlZXMsd2l0aCBicmlnaHQgbGlnaHRzLCBzdW4gYW5kIGEgbG90IG9mIG1hZ2ljLCB1bHRyYSByZWFsaXN0aWMsIDhr", 

    focus: "Product", 

    negativePrompt: "", 

    seed: "123"

);

5. VariationGenerator

1. generate

Supported Configuration

Parameter	Type	Default
generateVariationPrompt	custom	N/A
noOfVariations	integer	`1`
seed	integer	N/A
autoscale	boolean	`true`

Usage Example

final t = Transformation.variationgenerator.generate(

    generateVariationPrompt: "", 

    noOfVariations: "1", 

    seed: "", 

    autoscale: "true"

);

6. EraseBG

1. bg

Supported Configuration

Parameter	Type	Default
foregroundType	enum: `general`, `ecommerce`, `car`, `human`, `object`	`general`
addShadow	boolean	N/A
refine	boolean	`true`

Usage Example

final t = Transformation.erasebg.bg(

    foregroundType: "general", 

    addShadow: "", 

    refine: "true"

);

7. GoogleVisionPlugin

1. detectLabels

Supported Configuration

Parameter	Type	Default
maximumLabels	integer	`5`

Usage Example

final t = Transformation.googlevisionplugin.detectlabels(

    maximumLabels: "5"

);

8. ImageCentering

1. detect

Supported Configuration

Parameter	Type	Default
distancePercentage	integer	`10`

Usage Example

final t = Transformation.imagecentering.detect(

    distancePercentage: "10"

);

9. IntelligentCrop

1. crop

Supported Configuration

Parameter	Type	Default
requiredWidth	integer	N/A
requiredHeight	integer	N/A
paddingPercentage	integer	N/A
maintainOriginalAspect	boolean	N/A
aspectRatio	string	N/A
gravityTowards	enum: `object`, `foreground`, `face`, `none`	`none`
preferredDirection	enum: `north_west`, `north`, `north_east`, `west`, `center`, `east`, `south_west`, `south`, `south_east`	`center`
objectType	enum: `airplane`, `apple`, `backpack`, `banana`, `baseball_bat`, `baseball_glove`, `bear`, `bed`, `bench`, `bicycle`, `bird`, `boat`, `book`, `bottle`, `bowl`, `broccoli`, `bus`, `cake`, `car`, `carrot`, `cat`, `cell_phone`, `chair`, `clock`, `couch`, `cow`, `cup`, `dining_table`, `dog`, `donut`, `elephant`, `fire_hydrant`, `fork`, `frisbee`, `giraffe`, `hair_drier`, `handbag`, `horse`, `hot_dog`, `keyboard`, `kite`, `knife`, `laptop`, `microwave`, `motorcycle`, `mouse`, `orange`, `oven`, `parking_meter`, `person`, `pizza`, `potted_plant`, `refrigerator`, `remote`, `sandwich`, `scissors`, `sheep`, `sink`, `skateboard`, `skis`, `snowboard`, `spoon`, `sports_ball`, `stop_sign`, `suitcase`, `surfboard`, `teddy_bear`, `tennis_racket`, `tie`, `toaster`, `toilet`, `toothbrush`, `traffic_light`, `train`, `truck`, `tv`, `umbrella`, `vase`, `wine_glass`, `zebra`	`person`

Usage Example

final t = Transformation.intelligentcrop.crop(

    requiredWidth: "", 

    requiredHeight: "", 

    paddingPercentage: "", 

    maintainOriginalAspect: "", 

    aspectRatio: "", 

    gravityTowards: "none", 

    preferredDirection: "center", 

    objectType: "person"

);

10. ObjectCounter

1. detect

Usage Example

final t = Transformation.objectcounter.detect(

);

11. NSFWDetection

1. detect

Supported Configuration

Parameter	Type	Default
minimumConfidence	float	`0.5`

Usage Example

final t = Transformation.nsfwdetection.detect(

    minimumConfidence: "0.5"

);

12. NumberPlateDetection

1. detect

Usage Example

final t = Transformation.numberplatedetection.detect(

);

13. ObjectDetection

1. detect

Usage Example

final t = Transformation.objectdetection.detect(

);

14. CheckObjectSize

1. detect

Supported Configuration

Parameter	Type	Default
objectThresholdPercent	integer	`50`

Usage Example

final t = Transformation.checkobjectsize.detect(

    objectThresholdPercent: "50"

);

15. TextDetectionandRecognition

1. extract

Supported Configuration

Parameter	Type	Default
detectOnly	boolean	N/A

Usage Example

final t = Transformation.textdetectionandrecognition.extract(

    detectOnly: ""

);

16. PdfWatermarkRemoval

1. remove

Usage Example

final t = Transformation.pdfwatermarkremoval.remove(

);

17. ProductTagging

1. tag

Usage Example

final t = Transformation.producttagging.tag(

);

18. CheckProductVisibility

1. detect

Usage Example

final t = Transformation.checkproductvisibility.detect(

);

19. RemoveBG

1. bg

Usage Example

final t = Transformation.removebg.bg(

);

20. Basic

1. resize

Supported Configuration

Parameter	Type	Default
height	integer	N/A
width	integer	N/A
fit	enum: `cover`, `contain`, `fill`, `inside`, `outside`	`cover`
background	color	`000000`
position	enum: `top`, `bottom`, `left`, `right`, `right_top`, `right_bottom`, `left_top`, `left_bottom`, `center`	`center`
algorithm	enum: `nearest`, `cubic`, `mitchell`, `lanczos2`, `lanczos3`	`lanczos3`
dpr	float	`1`

Usage Example

final t = Transformation.basic.resize(

    height: "", 

    width: "", 

    fit: "cover", 

    background: "000000", 

    position: "center", 

    algorithm: "lanczos3", 

    dpr: "1"

);

2. compress

Supported Configuration

Parameter	Type	Default
quality	integer	`80`

Usage Example

final t = Transformation.basic.compress(

    quality: "80"

);

3. extend

Supported Configuration

Parameter	Type	Default
top	integer	`10`
left	integer	`10`
bottom	integer	`10`
right	integer	`10`
background	color	`000000`
borderType	enum: `constant`, `replicate`, `reflect`, `wrap`	`constant`
dpr	float	`1`

Usage Example

final t = Transformation.basic.extend(

    top: "10", 

    left: "10", 

    bottom: "10", 

    right: "10", 

    background: "000000", 

    borderType: "constant", 

    dpr: "1"

);

4. extract

Supported Configuration

Parameter	Type	Default
top	integer	`10`
left	integer	`10`
height	integer	`50`
width	integer	`20`
boundingBox	bbox	N/A

Usage Example

final t = Transformation.basic.extract(

    top: "10", 

    left: "10", 

    height: "50", 

    width: "20", 

    boundingBox: ""

);

5. trim

Supported Configuration

Parameter	Type	Default
threshold	integer	`10`

Usage Example

final t = Transformation.basic.trim(

    threshold: "10"

);

6. rotate

Supported Configuration

Parameter	Type	Default
angle	integer	N/A
background	color	`000000`

Usage Example

final t = Transformation.basic.rotate(

    angle: "", 

    background: "000000"

);

7. flip

Usage Example

final t = Transformation.basic.flip(

);

8. flop

Usage Example

final t = Transformation.basic.flop(

);

9. sharpen

Supported Configuration

Parameter	Type	Default
sigma	float	`1.5`

Usage Example

final t = Transformation.basic.sharpen(

    sigma: "1.5"

);

10. median

Supported Configuration

Parameter	Type	Default
size	integer	`3`

Usage Example

final t = Transformation.basic.median(

    size: "3"

);

11. blur

Supported Configuration

Parameter	Type	Default
sigma	float	`0.3`
dpr	float	`1`

Usage Example

final t = Transformation.basic.blur(

    sigma: "0.3", 

    dpr: "1"

);

12. flatten

Supported Configuration

Parameter	Type	Default
background	color	`000000`

Usage Example

final t = Transformation.basic.flatten(

    background: "000000"

);

13. negate

Usage Example

final t = Transformation.basic.negate(

);

14. normalise

Usage Example

final t = Transformation.basic.normalise(

);

15. linear

Supported Configuration

Parameter	Type	Default
a	integer	`1`
b	integer	N/A

Usage Example

final t = Transformation.basic.linear(

    a: "1", 

    b: ""

);

16. modulate

Supported Configuration

Parameter	Type	Default
brightness	float	`1`
saturation	float	`1`
hue	integer	`90`

Usage Example

final t = Transformation.basic.modulate(

    brightness: "1", 

    saturation: "1", 

    hue: "90"

);

17. grey

Usage Example

final t = Transformation.basic.grey(

);

18. tint

Supported Configuration

Parameter	Type	Default
color	color	`000000`

Usage Example

final t = Transformation.basic.tint(

    color: "000000"

);

19. toFormat

Supported Configuration

Parameter	Type	Default
format	enum: `jpeg`, `png`, `webp`, `tiff`, `avif`, `bmp`, `heif`	`jpeg`
quality	integer	`75`

Usage Example

final t = Transformation.basic.toformat(

    format: "jpeg", 

    quality: "75"

);

20. density

Supported Configuration

Parameter	Type	Default
density	integer	`300`

Usage Example

final t = Transformation.basic.density(

    density: "300"

);

21. merge

Supported Configuration

Parameter	Type	Default
mode	enum: `overlay`, `underlay`, `wrap`	`overlay`
image	file	N/A
transformation	custom	N/A
background	color	`00000000`
height	integer	N/A
width	integer	N/A
top	integer	N/A
left	integer	N/A
gravity	enum: `northwest`, `north`, `northeast`, `east`, `center`, `west`, `southwest`, `south`, `southeast`, `custom`	`center`
blend	enum: `over`, `in`, `out`, `atop`, `dest`, `dest-over`, `dest-in`, `dest-out`, `dest-atop`, `xor`, `add`, `saturate`, `multiply`, `screen`, `overlay`, `darken`, `lighten`, `colour-dodge`, `color-dodge`, `colour-burn`, `color-burn`, `hard-light`, `soft-light`, `difference`, `exclusion`	`over`
tile	boolean	N/A
listOfBboxes	bboxList	N/A
listOfPolygons	polygonList	N/A

Usage Example

final t = Transformation.basic.merge(

    mode: "overlay", 

    image: "", 

    transformation: "", 

    background: "00000000", 

    height: "", 

    width: "", 

    top: "", 

    left: "", 

    gravity: "center", 

    blend: "over", 

    tile: "", 

    listOfBboxes: "", 

    listOfPolygons: ""

);

21. SoftShadowGenerator

1. gen

Supported Configuration

Parameter	Type	Default
backgroundImage	file	N/A
backgroundColor	color	`ffffff`
shadowAngle	float	`120`
shadowIntensity	float	`0.5`

Usage Example

final t = Transformation.softshadowgenerator.gen(

    backgroundImage: "", 

    backgroundColor: "ffffff", 

    shadowAngle: "120", 

    shadowIntensity: "0.5"

);

22. SuperResolution

1. upscale

Supported Configuration

Parameter	Type	Default
type	enum: `2x`, `4x`, `8x`	`2x`
enhanceFace	boolean	N/A
model	enum: `Picasso`, `Flash`	`Picasso`
enhanceQuality	boolean	N/A

Usage Example

final t = Transformation.superresolution.upscale(

    type: "2x", 

    enhanceFace: "", 

    model: "Picasso", 

    enhanceQuality: ""

);

23. VideoWatermarkRemoval

1. remove

Usage Example

final t = Transformation.videowatermarkremoval.remove(

);

24. ViewDetection

1. detect

Usage Example

final t = Transformation.viewdetection.detect(

);

25. WatermarkRemoval

1. remove

Supported Configuration

Parameter	Type	Default
removeText	boolean	N/A
removeLogo	boolean	N/A
box1	string	`0_0_100_100`
box2	string	`0_0_0_0`
box3	string	`0_0_0_0`
box4	string	`0_0_0_0`
box5	string	`0_0_0_0`

Usage Example

final t = Transformation.watermarkremoval.remove(

    removeText: "", 

    removeLogo: "", 

    box1: "0_0_100_100", 

    box2: "0_0_0_0", 

    box3: "0_0_0_0", 

    box4: "0_0_0_0", 

    box5: "0_0_0_0"

);

26. WatermarkDetection

1. detect

Supported Configuration

Parameter	Type	Default
detectText	boolean	N/A

Usage Example

final t = Transformation.watermarkdetection.detect(

    detectText: ""

);

Libraries

async
pixelbin
pixelbin_dart_sdk
pixelbin_image
transformation
transformation_data
transformations/a_w_s_rekognition_plugin
transformations/artifact
transformations/background_generator
transformations/basic
transformations/check_object_size
transformations/check_product_visibility
transformations/detect_background_type
transformations/erase_b_g
transformations/google_vision_plugin
transformations/image_centering
transformations/intelligent_crop
transformations/n_s_f_w_detection
transformations/number_plate_detection
transformations/object_counter
transformations/object_detection
transformations/pdf_watermark_removal
transformations/product_tagging
transformations/remove_b_g
transformations/soft_shadow_generator
transformations/super_resolution
transformations/text_detectionand_recognition
transformations/variation_generator
transformations/video_watermark_removal
transformations/view_detection
transformations/watermark_detection
transformations/watermark_removal
upload