uploadcare_client
library
Classes
-
ApiFiles
-
Provides API for working with files
-
ApiGroups
-
Provides API for working with groups
-
ApiUpload
-
Provides API for uploading files
-
ApiVideoEncoding
-
Provides API for working with video encoding
-
ArchiveTransformation
-
Gets a group as an archive: ArchiveTValue
-
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.Simple
auth scheme
-
AutoRotateTransformation
-
Instruct Uploadcare CDN whether it should rotate an image according to the EXIF orientation tag or not.
-
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..5000
range
-
BooleanTransformation
-
An abstraction to make transformation implementation with bool values which transforms to
yes/no
string
-
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
-
ClientOptions
-
Uploadcare client options
-
CndEntity
-
-
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
-
EnhanceTransformation
-
Auto-enhance an image by performing the following operations: auto levels, auto contrast, and saturation sharpening.
value should be in
0..100
range
-
EnumTransformation<T>
-
An abstraction to make transformation implementation with
enum
values
-
FaceRect
-
Provides uploadcare face shape
-
FacesEntity
-
Base object to hold Face Recognition data of an image
-
FileInfoEntity
-
Base object to hold Uploadcare file data
-
FilesOrdering
-
Provides a way to order files
-
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
-
ImageResizeTransformation
-
Resize an image to fit into specified dimensions.
-
ImageTransformation
-
An abstraction for image transformations
-
IntTransformation
-
An abstraction to make transformation implementation with int values
-
InvertTransformation
-
Invert the colors of an image.
-
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
ListEntity
instance
-
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
-
OverlayCoordinates
-
-
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
true
then are using multi-scan rendering.
-
QualityTransformation
-
Sets the level of source quality that affects file sizes and hence loading times and volumes of generated traffic.
-
ResizeTransformation
-
Base class for resize-related transformations
-
RotateTransformation
-
Rotate an image counterclockwise.
value should be in
-360..360
range
-
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.
-
SharedFile
-
Base class which describes cross-platform file implementation
-
SharpTransformation
-
Sharpen an image, might be especially useful with images that were subjected to downscaling.
value should be in
0..20
range
-
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.
-
Transformation
-
Base class for accessing the Uploadcare CDN API
-
UploadcareClient
-
Provides centralized access to
Uploadcare API
-
UrlUploadStatusEntity
-
Provides status data from
fromUrl
uploading
-
VideoEncodingConvertEntity
-
Provides response data from convert job
-
VideoEncodingJobEntity
-
Provides status data for converting job
-
VideoEncodingResultEntity
-
Provides converting result data
-
VideoFormatTransformation
-
Converts a file to one of the HTML5 video formats: VideoFormatTValue
-
VideoResizeTransformation
-
Resizes a video to the specified dimensions. The operation follows the behavior specified by one of the four presets: VideoResizeTValue
-
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