SDImageIOAnimatedCoder

@interface SDImageIOAnimatedCoder
    : NSObject <SDProgressiveImageCoder, SDAnimatedImageCoder>

This is the abstract class for all animated coder, which use the Image/IO API. You can not use this directly as real coders. A exception will be raised if you use this class. All of the properties need the subclass to implement and works as expected. For Image/IO, See Apple’s documentation: https://developer.apple.com/documentation/imageio

Subclass Override

  • The supported animated image format. Such as SDImageFormatGIF.

    Note

    Subclass override.

    Declaration

    Objective-C

    @property (readonly, class) SDImageFormat imageFormat;

    Swift

    class var imageFormat: SDImageFormat { get }
  • The supported image format UTI Type. Such as kUTTypeGIF. This can be used for cases when we can not detect SDImageFormat. Such as progressive decoding's hint formatkCGImageSourceTypeIdentifierHint`.

    Note

    Subclass override.

    Declaration

    Objective-C

    @property (readonly, nonnull, class) NSString *imageUTType;

    Swift

    class var imageUTType: String { get }
  • The image container property key used in Image/IO API. Such as kCGImagePropertyGIFDictionary.

    Note

    Subclass override.

    Declaration

    Objective-C

    @property (readonly, nonnull, class) NSString *dictionaryProperty;

    Swift

    class var dictionaryProperty: String { get }
  • The image unclamped delay time property key used in Image/IO API. Such as kCGImagePropertyGIFUnclampedDelayTime

    Note

    Subclass override.

    Declaration

    Objective-C

    @property (readonly, nonnull, class) NSString *unclampedDelayTimeProperty;

    Swift

    class var unclampedDelayTimeProperty: String { get }
  • The image delay time property key used in Image/IO API. Such as kCGImagePropertyGIFDelayTime.

    Note

    Subclass override.

    Declaration

    Objective-C

    @property (readonly, nonnull, class) NSString *delayTimeProperty;

    Swift

    class var delayTimeProperty: String { get }
  • The image loop count property key used in Image/IO API. Such as kCGImagePropertyGIFLoopCount.

    Note

    Subclass override.

    Declaration

    Objective-C

    @property (readonly, nonnull, class) NSString *loopCountProperty;

    Swift

    class var loopCountProperty: String { get }
  • The default loop count when there are no any loop count information inside image container metadata. For example, for GIF format, the standard use 1 (play once). For APNG format, the standard use 0 (infinity loop).

    Note

    Subclass override.

    Declaration

    Objective-C

    @property (readonly, class) NSUInteger defaultLoopCount;

    Swift

    class var defaultLoopCount: UInt { get }