Class ImageEncoder
Definition
- Namespace:
- Tizen.Multimedia.Util
- Assembly:
- Tizen.Multimedia.Util.dll
This is a base class for image encoders.
public abstract class ImageEncoder : IDisposable
- Inheritance
-
objectImageEncoder
- Derived
-
Tizen.Multimedia.Util.JpegXlEncoderTizen.Multimedia.Util.JpegXlEncoderTizen.Multimedia.Util.JpegXlEncoderTizen.Multimedia.Util.WebPEncoderTizen.Multimedia.Util.WebPEncoderTizen.Multimedia.Util.WebPEncoderTizen.Multimedia.Util.WebPEncoderTizen.Multimedia.Util.WebPEncoder
- Implements
-
System.IDisposable
Properties
View SourceOutputFormat
Gets the image format of this encoder.
Declaration
public ImageFormat OutputFormat { get; }
Property Value
Type | Description |
---|---|
ImageFormat |
Methods
View SourceDispose()
Releases all resources used by the ImageEncoder.
Declaration
public void Dispose()
Dispose(bool)
Releases the unmanaged resources used by the ImageEncoder.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
bool | disposing | true to release both managed and unmanaged resources; false to release only unmanaged resources. |
EncodeAsync(byte[], Stream)
Encodes an image from a raw image buffer to a specified System.IO.Stream.
Declaration
public Task EncodeAsync(byte[] inputBuffer, Stream outStream)
Parameters
Type | Name | Description |
---|---|---|
byte[] | inputBuffer | The image buffer to encode. |
System.IO.Stream | outStream | The stream that the image is encoded to. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A task that represents the asynchronous encoding operation. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
|
System.ArgumentException |
|
System.InvalidOperationException | The resolution is not set. |
System.ObjectDisposedException | The ImageEncoder has already been disposed of. |
See Also
View SourceSetColorSpace(ColorSpace)
Sets the color-space of the output image.
Declaration
public void SetColorSpace(ColorSpace colorSpace)
Parameters
Type | Name | Description |
---|---|---|
ColorSpace | colorSpace | The target color-space. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException |
|
System.NotSupportedException |
|
See Also
View SourceSetResolution(Size)
Sets the resolution of the output image.
Declaration
public void SetResolution(Size resolution)
Parameters
Type | Name | Description |
---|---|---|
Size | resolution | The target resolution. |
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException | The width of |