AliyunEffectCaption

@interface AliyunEffectCaption : AliyunEffectPasterBase

* A model class that defines animated captions. Each animated caption contains a piece of text and a background sticker.

  • * The text contents.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *text;

  • * The name of the user-configured text font.

    Default is the font name specified in the configuration file.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *captionFontName;

  • * The id of the user-configured text font.

    Default is the font id specified in the configuration file.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger captionFontId;

  • * The time when the text appears.

    The time is relative to the time when the background sticker appears. For example, textRelativeToBeginTime=2 indicates that the text appears two seconds later than the background sticker.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat textRelativeToBeginTime;

  • * The time when the text disappears.

    The time is relative to the time when the background sticker appears.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat textRelativeToEndTime;

  • * The size of the display area where the text is rendered.

    The size is relative to the size of the background sticker.

    Declaration

    Objective-C

    @property (nonatomic) CGRect textFrame;

  • * The position of the centroid of the text.

    The position of the centroid is relative to the position of the background sticker.

    Declaration

    Objective-C

    @property (nonatomic) CGPoint textCenter;

  • * The text size.

    The text size is relative to the size of the background sticker.

    Declaration

    Objective-C

    @property (nonatomic) CGSize textSize;

  • * The key frame image.

    Declaration

    Objective-C

    @property (nonatomic, strong) UIImage *kernelImage;

  • * Whether the text is stroked.

    Declaration

    Objective-C

    @property (nonatomic) BOOL textStroke;

  • * The text color.

    Declaration

    Objective-C

    @property(nonatomic, strong) UIColor *textColor

  • * The text stroke color.

    Declaration

    Objective-C

    @property(nonatomic, strong) UIColor *textStrokeColor

  • * The text background color.

    Declaration

    Objective-C

    @property(nonatomic, strong) UIColor *textLabelColor

  • * The text font name.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *fontName;

  • * The stages when rendering the animated caption.

    The stages include: appear, display, and disappear.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSArray<AliyunEffectPasterTimeItem *> *timeItems;

  • * The frames of the animation.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSArray<AliyunEffectPasterFrameItem *> *frameItems;

  • * The original display duration of the animated caption.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat originDuration;

  • * The original display duration of the text in the animated caption.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat originTextDuration;

  • * The time when the text appears.

    The time is relative to the time when the background sticker appears.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat originTextBeginTime;

  • Deprecated

    deprecated

    Undocumented

    Declaration

    Objective-C

    - (id)initWithRestore:(NSDictionary *)dict __deprecated_msg("deprecated");