uploadcare_flutter library Null safety
Classes
-
AddonExecutionStatus<
T> - AddonResultInfo
- ApiAddons
- Since v0.7
- ApiDocumentConverting
- Provides API for working with document converting
- ApiFiles
- Provides API for working with files
- ApiGroups
- Provides API for working with groups
- ApiProject
- See https://uploadcare.com/api-refs/rest-api/v0.5.0/#tag/Project
- ApiUpload
- Provides API for uploading files
- ApiVideoEncoding
- Provides API for working with video encoding
- ApiWebhooks
- Since v0.6
- AppData
- ArchiveTransformation
- Gets a group as an archive: ArchiveTValue
- AspectRatio
- ASWRecognitionBoundingBox
- See https://docs.aws.amazon.com/rekognition/latest/dg/images-displaying-bounding-boxes.html
- AudioStreamMetadata
- AuthScheme
- To authenticate your account, every request made to https://api.uploadcare.com/ MUST be signed. There are two available auth schemes: a simple one with intuitive auth-param and a more sophisticated and secure one that can be used for Signed Requests.
- AuthSchemeRegular
-
Provides
Uploadcare(regular) auth scheme - AuthSchemeSimple
-
Provides
Uploadcare.Simpleauth scheme - AutoRotateTransformation
- Instruct Uploadcare CDN whether it should rotate an image according to the EXIF orientation tag or not.
- AWSRecognitionInstance
- AWSRecognitionLabel
- AWSRekognitionAddonResult
- BlurRegionTransformation
-
Blurs the specified region of the image by the
radiusfactor. The filtering mode is Gaussian Blur, whereradiusparameter sets the blur radius — effect intensity. Technically,radiuscontrols the Gaussian Blur standard deviation multiplied by ten. The value ofradiusmight come up to 5000, while the default value is determined automatically based on the size of the region. Note, largerradiusvalues do not affect the operation performance. - BlurTransformation
-
Blur images by the strength factor. The filtering mode is Gaussian Blur, where strength parameter sets the blur radius — effect intensity.
Technically, strength controls the Gaussian Blur standard deviation multiplied by ten.
Note, different strength values do not affect the operation performance.
value should be in
0..5000range - BooleanTransformation
-
An abstraction to make transformation implementation with bool values which transforms to
yes/nostring - CancelToken
- Provides cancel mechanism to upload process
- CdnFile
- Provides a simple way to work with Transformation
- CdnGroup
- Provides a simple way to work with GroupTransformation
- CdnImage
- Provides a simple way to work with ImageTransformation
- ClamAVAddonResult
- ClientOptions
- Uploadcare client options
- CndEntity
- Collaborator
- ColorBrightnessTransformation
- See https://uploadcare.com/docs/transformations/image/colors/#image-colors-operations
- ColorContrastTransformation
- See https://uploadcare.com/docs/transformations/image/colors/#image-colors-operations
- ColorExposureTransformation
- See https://uploadcare.com/docs/transformations/image/colors/#image-colors-operations
- ColorGammaTransformation
- See https://uploadcare.com/docs/transformations/image/colors/#image-colors-operations
- ColorSaturationTransformation
- See https://uploadcare.com/docs/transformations/image/colors/#image-colors-operations
- ColorVibranceTransformation
- See https://uploadcare.com/docs/transformations/image/colors/#image-colors-operations
- ColorWarmthTransformation
- See https://uploadcare.com/docs/transformations/image/colors/#image-colors-operations
-
ConvertEntity<
E extends ConvertResultEntity> - Provides response data from convert job
-
ConvertJobEntity<
E extends ConvertResultEntity> - Provides status data for converting job
- ConvertResultEntity
- Provides converting result data
- Coordinates
- CropTransformation
- Crop an image to fit into specified dimensions, implement optional offsets.
- CutTransformation
- Cuts out a video fragment based on the following parameters: start, length
- Dimensions
- dart:ui Size replacement for non flutter project
- DocumentConvertingResultEntity
- DocumentFormatTransformation
- DocumentTransformation
- An abstraction for document transformations
- EnhanceTransformation
-
Auto-enhance an image by performing the following operations: auto levels, auto contrast, and saturation sharpening.
value should be in
0..100range -
EnumTransformation<
T> -
An abstraction to make transformation implementation with
enumvalues - FaceRect
- Provides uploadcare face shape
- FacesEntity
- Base object to hold Face Recognition data of an image
- FileInfoEntity
- Base object to hold Uploadcare file data
- FilesIncludeFields
- FilesOrdering
- Provides a way to order files
- FilterTransformation
- Applies one of predefined photo filters by its FilterTValue. The way your images look affects their engagement rates. You apply filters thus providing beautiful images consistent across content pieces you publish.
- FlipTransformation
- Flip an image (mirror-reverse an image across the horizontal axis).
- GifToVideoTransformation
- GIF to Video conversion that provides better loading times thus reducing your bounce rate. The feature is available on paid plans only. Converts GIF files to video on the fly. You can change output format with VideoFormatTransformation and change video quality with QualityTransformation
- GrayscaleTransformation
- Desaturate an image.
- GroupInfoEntity
-
Groups are identified in a way similar to individual files.
A group ID consists of a UUID followed by a
~tilde character and a group size: integer number of files in group. For example, here is an identifier for a group holding 12 files,badfc9f7-f88f-4921-9cc0-22e2c08aa2da~12 - GroupTransformation
- An abstraction for group transformations
- ImageFormatTransformation
- Convert an image to one of the supported output formats: ImageFormatTValue
- ImageInfo
- ImageInfoGeoLocation
- ImageResizeTransformation
- Resize an image to fit into specified dimensions.
- ImageTransformation
- An abstraction for image transformations
- InlineTransformation
- By default, CDN instructs browsers to show images and download other file types. The inline control allows you to change this behavior.
- IntTransformation
- An abstraction to make transformation implementation with int values
- InvertTransformation
- Invert the colors of an image.
- JsonFileInfoTransformation
- Returns file-related information, such as image dimensions or geotagging data in the JSON format.
-
ListEntity<
T> -
When you get a collection in a response, like with getting a list of files, it is paginated.
That is, items in the collection are returned in batches.
Every returned batch object is
ListEntityinstance - ListEntityTotals
- MaxIccSizeTransformation
- Strip off an ICC profile from an image based on the profile value in kilobytes. value should be positive int
- MirrorTransformation
- Mirror an image (mirror-reverse an image across the vertical axis).
- NullParamTransformation
- An abstraction to make transformation implementation with no parameters
- Offsets
- dart:ui Offset replacement for non flutter project
- OverlayTransformation
- The overlay operation allows to layer images one over another.
- PreviewTransformation
- Resize an image to fit into specified dimensions, proportional.
- ProgressEntity
- An object that represents progress data
- ProgressiveTransformation
-
Convert JPEG to Progressive JPEG. Has no effect on non-JPEGs. Does not force image formats to jpeg.
if value is equal
truethen are using multi-scan rendering. - ProjectEntity
- QualityTransformation
- Sets the level of source quality that affects file sizes and hence loading times and volumes of generated traffic.
- RemoveBgAddonResult
- ResizeTransformation
- Base class for resize-related transformations
- RotateTransformation
-
Rotate an image counterclockwise.
value should be in
-360..360range - ScaleCropTransformation
- Downscale an image along one of the axes (the one with smaller linear size) and crop the rest. The method can be implemented with manual, center-focused or “smart crop” behavior.
- SetFillTransformation
- Set the fill color when converting alpha channel enabled images to JPEG, with CropTransformation or StretchTransformation.
- SharpTransformation
-
Sharpen an image, might be especially useful with images that were subjected to downscaling.
value should be in
0..20range - SrgbTransformation
- The operation sets how Uploadcare behaves depending on different color profiles of uploaded images.
- StretchTransformation
- Set the ImageResizeTransformation behavior when provided Size are greater than the source image dimensions. The directive should come before ImageResizeTransformation transformation to give any effect.
- StripMetaTransformation
- The original image often comes with additional information built into the image file. In most cases, this information doesn't affect image rendering and thus can be safely stripped from the processed images. However, you can control this behavior with this option. This could be helpful if you want to keep meta information in the processed image.
- Transformation
- Base class for accessing the Uploadcare CDN API
- UCFile
- Base class which describes cross-platform file implementation
- UnsharpMaskingTransformation
- See: https://uploadcare.com/docs/transformations/image/blur-sharpen/#operation-blur-mask
- UploadcareClient
-
Provides centralized access to
Uploadcare API - UploadcareImageProvider
-
Constructs right
Uploadcare CND urlbyidand providedtransformationsif any - UrlUploadStatusEntity
-
Provides status data from
fromUrluploading - VideoEncodingResultEntity
- Provides converting result data
- VideoFormatTransformation
- Converts a file to one of the HTML5 video formats: VideoFormatTValue
- VideoInfo
- VideoResizeTransformation
- Resizes a video to the specified dimensions. The operation follows the behavior specified by one of the four presets: VideoResizeTValue
- VideoStreamMetadata
- VideoThumbsGenerateTransformation
- Creates N thumbnails for your video, where N is a non-zero integer ranging from 1 to 50; defaults to 1.
- VideoTransformation
- An abstraction for video transformations
- WebhookEntity
- ZoomObjectTransformation
- Zoom objects operation is best suited for images with solid or uniform backgrounds.
Extensions
- DimensionsExtension
- Extension for Dimensions
- FaceRectExtension
- Extension for FaceRect
- FacesEntityExtension
- Extension for FacesEntity
- OffsetsExtension
- Extension for Offsets
Constants
- kAPIEndpoint → const String
-
'https://api.uploadcare.com' - kCDNEndpoint → const String
-
'https://ucarecdn.com' - kUploadEndpoint → const String
-
Uploadcare constants
'https://upload.uploadcare.com'
Enums
- AddonExecutionStatusValue
- Defines the status of an Add-On execution. In most cases, once the status changes to AddonExecutionStatusValue.Done, Application Data of the file that had been specified as a target, will contain the result of the execution.
- ArchiveTValue
- BlurRegionTValue
- ConvertJobStatusValue
- CropTagTValue
- Possible CropTransformation.tag values
- DucumentOutFormatTValue
- FilesFilterValue
- FilesIncludeFieldsValue
- FilesPatternValue
- FilterTValue
- Filter names
- ImageColorMode
- ImageFormatTValue
- MeasureUnits
- OrderDirection
- QualityTValue
- RemoveBgChannelsValue
- RemoveBgTypeLevelValue
- RemoveBgTypeValue
- ScaleCropTypeTValue
- Type value which enables smart image analysis for ScaleCropTransformation
- SrgbTValue
- StretchTValue
- StripMetaTValue
- UrlUploadStatusValue
- VideoFormatTValue
- VideoResizeTValue
- WebhookEvent
Typedefs
-
ConvertResultCreator<
T> = T Function(Map< String, dynamic> data) - ProgressListener = void Function(ProgressEntity progress)