hhy5277/svgaplayer-ios

Similar to Lottie. Render After Effects / Animate CC (Flash) animations natively on Android and iOS, Web. 使用 SVGAPlayer 在 Android、iOS、Web中播放 After Effects / Animate CC (Flash) 动画。

SVGAPlayer

简体中文

Supporting SVGA Library

SVGA is an Apache-licensed open source project. And now SVGA library with its ongoing development made possible entirely by the support of PonyCui and errnull. To support SVGA library development, please consider:

• Hire PonyCui as a counselor.
• One-time donation via AliPay or WeChat.

Introduce

SVGAPlayer is a light-weight animation renderer. You use tools to export svga file from Adobe Animate CC or Adobe After Effects, and then use SVGAPlayer to render animation on mobile application.

SVGAPlayer-iOS render animation natively via iOS CoreAnimation Framework, brings you a high-performance, low-cost animation experience.

If wonder more information, go to this website.

Usage

Here introduce SVGAPlayer-iOS usage. Wonder exporting usage? Click here.

Install Via CocoaPods

You want to add pod 'SVGAPlayer', '~> 2.3' similar to the following to your Podfile:

target 'MyApp' do pod 'SVGAPlayer', '~> 2.3' end

Then run a pod install inside your terminal, or from CocoaPods.app.

Locate files

SVGAPlayer could load svga file from application bundle or remote server.

Using code

Create a SVGAPlayer instance.

SVGAPlayer *player = [[SVGAPlayer alloc] initWithFrame:CGRectMake(0, 0, 200, 200)];
[self.view addSubview:player]; // Add subview by yourself.

Create a SVGAParser instance, parse from bundle like this.

SVGAParser *parser = [[SVGAParser alloc] init];
[parser parseWithNamed:@"posche" inBundle:nil completionBlock:^(SVGAVideoEntity * _Nonnull videoItem) {
    
} failureBlock:nil];

Create a SVGAParser instance, parse from remote server like this.

SVGAParser *parser = [[SVGAParser alloc] init];
[parser parseWithURL:[NSURL URLWithString:@"https://github.com/yyued/SVGA-Samples/blob/master/posche.svga?raw=true"] completionBlock:^(SVGAVideoEntity * _Nullable videoItem) {
    
} failureBlock:nil];

Set videoItem to SVGAPlayer, play it as you want.

[parser parseWithURL:[NSURL URLWithString:@"https://github.com/yyued/SVGA-Samples/blob/master/posche.svga?raw=true"] completionBlock:^(SVGAVideoEntity * _Nullable videoItem) {
    if (videoItem != nil) {
        player.videoItem = videoItem;
        [player startAnimation];
    }
} failureBlock:nil];

Cache

SVGAParser use NSURLSession request remote data via network. You may use following ways to control cache.

Response Header

Server response SVGA files in Body, and response header either. response header has cache-control / etag / expired keys, all these keys telling NSURLSession how to handle cache.

Request NSData By Yourself

If you couldn't fix Server Response Header, You should build NSURLRequest with CachePolicy by yourself, and fetch NSData.

Deliver NSData to SVGAParser, as usual.

Features

Here are many feature samples.

• Replace an element with Bitmap.
• Add text above an element.
• Hides an element dynamicaly.
• Use a custom drawer for element.

APIs

Head on over to https://github.com/yyued/SVGAPlayer-iOS/wiki/APIs