org.skia.skottie.SkottieAnimation Class Reference

Inheritance diagram for org.skia.skottie.SkottieAnimation:

Classes
class	Config

Public Member Functions
void	updateSurface (int width, int height)
void	start ()
void	end ()
void	pause ()
void	resume ()
long	getStartDelay ()
void	setStartDelay (long startDelay)
Animator	setDuration (long duration)
boolean	isRunning ()
long	getDuration ()
long	getTotalDuration ()
void	setInterpolator (TimeInterpolator value)
void	setProgress (float progress)
float	getProgress ()
void	doFrame (long frameTimeNanos)
void	onSurfaceTextureAvailable (SurfaceTexture surface, int width, int height)
void	onSurfaceTextureSizeChanged (SurfaceTexture surface, int width, int height)
boolean	onSurfaceTextureDestroyed (SurfaceTexture surface)
void	onSurfaceTextureUpdated (SurfaceTexture surfaceTexture)
void	surfaceCreated (SurfaceHolder holder)
void	surfaceChanged (SurfaceHolder holder, int format, int width, int height)
void	surfaceDestroyed (SurfaceHolder holder)

Protected Member Functions
void	finalize () throws Throwable

Package Functions
	SkottieAnimation (SurfaceTexture surfaceTexture, InputStream is)
	SkottieAnimation (TextureView view, InputStream is, int backgroundColor, int repeatCount)
	SkottieAnimation (SurfaceView view, InputStream is, int backgroundColor, int repeatCount)
void	setSurfaceTexture (SurfaceTexture s)
Config	getBackingViewConfig ()
void	setBackingViewConfig (Config config)

Detailed Description

Definition at line 25 of file SkottieAnimation.java.

Constructor & Destructor Documentation

SkottieAnimation() [1/3]

org.skia.skottie.SkottieAnimation.SkottieAnimation ( SurfaceTexture  surfaceTexture, InputStream  is  )

inlinepackage

Definition at line 50 of file SkottieAnimation.java.

                                                                    {
        if (init(is)) {
            mSurfaceTexture = surfaceTexture;
        }
    }

SkottieAnimation() [2/3]

org.skia.skottie.SkottieAnimation.SkottieAnimation ( TextureView  view, InputStream  is, int  backgroundColor, int  repeatCount  )

inlinepackage

Definition at line 55 of file SkottieAnimation.java.

                                                                                             {
        if (init(is)) {
            mSurfaceTexture = view.getSurfaceTexture();
        }
        view.setSurfaceTextureListener(this);
        mBackgroundColor = backgroundColor;
        mRepeatCount = repeatCount;
        mRepeatCounter = mRepeatCount;
    }

SkottieAnimation() [3/3]

org.skia.skottie.SkottieAnimation.SkottieAnimation ( SurfaceView  view, InputStream  is, int  backgroundColor, int  repeatCount  )

inlinepackage

Definition at line 65 of file SkottieAnimation.java.

                                                                                             {
        if (init(is)) {
            mSurfaceHolder = view.getHolder();
        }
        mSurfaceHolder.addCallback(this);
        mBackgroundColor = backgroundColor;
        mRepeatCount = repeatCount;
        mRepeatCounter = mRepeatCount;
    }

Member Function Documentation

doFrame()

void org.skia.skottie.SkottieAnimation.doFrame ( long  frameTimeNanos )

inline

Definition at line 378 of file SkottieAnimation.java.

                                             {
        if (mIsRunning) {
            // Schedule next frame.
            Choreographer.getInstance().postFrameCallback(this);
 
            // Advance animation.
            long durationNS = mDuration * 1000000;
            long timeSinceAnimationStartNS = frameTimeNanos - mAnimationStartTime;
            long animationProgressNS = timeSinceAnimationStartNS % durationNS;
            mProgress = animationProgressNS / (float)durationNS;
            if (timeSinceAnimationStartNS > durationNS) {
                mAnimationStartTime += durationNS;  // prevents overflow
            }
            if (timeSinceAnimationStartNS > durationNS) {
                if (mRepeatCounter > 0) {
                    mRepeatCounter--;
                } else if (mRepeatCounter == 0) {
                    mIsRunning = false;
                    mProgress = 1;
                    notifyAnimationEnd();
                }
            }
        }
        if (config.mValidSurface) {
            drawFrame();
        }
    }

end()

void org.skia.skottie.SkottieAnimation.end ( )

inline

Definition at line 176 of file SkottieAnimation.java.

                      {
        try {
            mRunner.runOnGLThread(() -> {
                mIsRunning = false;
                if (mEglSurface != null) {
                    // Ensure we always have a valid surface & context.
                    mRunner.mEgl.eglMakeCurrent(mRunner.mEglDisplay, mRunner.mPBufferSurface,
                            mRunner.mPBufferSurface, mRunner.mEglContext);
                    mRunner.mEgl.eglDestroySurface(mRunner.mEglDisplay, mEglSurface);
                    mEglSurface = null;
                }
            });
        }
        catch (Throwable t) {
            Log.e(LOG_TAG, "stop failed", t);
            throw new RuntimeException(t);
        }
        notifyAnimationEnd();
    }

finalize()

void org.skia.skottie.SkottieAnimation.finalize ( ) throws Throwable

inlineprotected

Definition at line 132 of file SkottieAnimation.java.

                                               {
        try {
            end();
            nDeleteProxy(mNativeProxy);
            mNativeProxy = 0;
        } finally {
            super.finalize();
        }
    }

getBackingViewConfig()

Config org.skia.skottie.SkottieAnimation.getBackingViewConfig ( )

inlinepackage

Definition at line 467 of file SkottieAnimation.java.

                                  {
        return config;
    }

getDuration()

long org.skia.skottie.SkottieAnimation.getDuration ( )

inline

Definition at line 251 of file SkottieAnimation.java.

                              {
        return mDuration;
    }

getProgress()

float org.skia.skottie.SkottieAnimation.getProgress ( )

inline

Definition at line 287 of file SkottieAnimation.java.

                               {
        return mProgress;
    }

getStartDelay()

long org.skia.skottie.SkottieAnimation.getStartDelay ( )

inline

Definition at line 230 of file SkottieAnimation.java.

                                {
        return 0;
    }

getTotalDuration()

long org.skia.skottie.SkottieAnimation.getTotalDuration ( )

inline

Definition at line 256 of file SkottieAnimation.java.

                                   {
        if (mRepeatCount == -1) {
            return DURATION_INFINITE;
        }
        // TODO: add start delay when implemented
        return mDuration * (1 + mRepeatCount);
    }

isRunning()

boolean org.skia.skottie.SkottieAnimation.isRunning ( )

inline

Definition at line 246 of file SkottieAnimation.java.

                               {
        return mIsRunning;
    }

onSurfaceTextureAvailable()

void org.skia.skottie.SkottieAnimation.onSurfaceTextureAvailable ( SurfaceTexture  surface, int  width, int  height  )

inline

Definition at line 407 of file SkottieAnimation.java.

                                                                                         {
        // will be called on UI thread
        try {
            mRunner.runOnGLThread(() -> {
                mSurfaceTexture = surface;
                updateSurface(width, height);
                config.mValidSurface = true;
            });
        }
        catch (Throwable t) {
            Log.e(LOG_TAG, "updateSurface failed", t);
            throw new RuntimeException(t);
        }
    }

onSurfaceTextureDestroyed()

boolean org.skia.skottie.SkottieAnimation.onSurfaceTextureDestroyed ( SurfaceTexture  surface )

inline

Definition at line 429 of file SkottieAnimation.java.

                                                                     {
        // will be called on UI thread
        onSurfaceTextureAvailable(null, 0, 0);
        config.mValidSurface = false;
        return true;
    }

onSurfaceTextureSizeChanged()

void org.skia.skottie.SkottieAnimation.onSurfaceTextureSizeChanged ( SurfaceTexture  surface, int  width, int  height  )

inline

Definition at line 423 of file SkottieAnimation.java.

                                                                                           {
        // will be called on UI thread
        onSurfaceTextureAvailable(surface, width, height);
    }

onSurfaceTextureUpdated()

void org.skia.skottie.SkottieAnimation.onSurfaceTextureUpdated ( SurfaceTexture  surfaceTexture )

inline

Definition at line 437 of file SkottieAnimation.java.

                                                                       {
 
    }

pause()

void org.skia.skottie.SkottieAnimation.pause ( )

inline

Definition at line 197 of file SkottieAnimation.java.

                        {
        try {
            mRunner.runOnGLThread(() -> {
                mIsRunning = false;
            });
        }
        catch (Throwable t) {
            Log.e(LOG_TAG, "pause failed", t);
            throw new RuntimeException(t);
        }
    }

resume()

void org.skia.skottie.SkottieAnimation.resume ( )

inline

Definition at line 210 of file SkottieAnimation.java.

                         {
        try {
            mRunner.runOnGLThread(() -> {
                if (!mIsRunning) {
                    long currentTime = System.nanoTime();
                    mAnimationStartTime = currentTime - (long)(1000000 * mDuration * mProgress);
                    mIsRunning = true;
                    mNewSurface = true;
                    doFrame(currentTime);
                }
            });
        }
        catch (Throwable t) {
            Log.e(LOG_TAG, "resume failed", t);
            throw new RuntimeException(t);
        }
    }

setBackingViewConfig()

void org.skia.skottie.SkottieAnimation.setBackingViewConfig ( Config  config )

inlinepackage

Definition at line 471 of file SkottieAnimation.java.

                                             {
        this.config.mSurfaceHeight = config.mSurfaceHeight;
        this.config.mSurfaceWidth = config.mSurfaceWidth;
        this.config.mValidSurface = config.mValidSurface;
    }

setDuration()

Animator org.skia.skottie.SkottieAnimation.setDuration ( long  duration )

inline

Definition at line 241 of file SkottieAnimation.java.

                                               {
        return null;
    }

setInterpolator()

void org.skia.skottie.SkottieAnimation.setInterpolator ( TimeInterpolator  value )

inline

Definition at line 266 of file SkottieAnimation.java.

                                                        {
 
    }

setProgress()

void org.skia.skottie.SkottieAnimation.setProgress ( float  progress )

inline

Definition at line 270 of file SkottieAnimation.java.

                                            {
        try {
            mRunner.runOnGLThread(() -> {
                mProgress = progress;
                if (mIsRunning) {
                    mAnimationStartTime = System.nanoTime()
                            - (long)(1000000 * mDuration * mProgress);
                }
                drawFrame();
            });
        }
        catch (Throwable t) {
            Log.e(LOG_TAG, "setProgress failed", t);
            throw new RuntimeException(t);
        }
    }

setStartDelay()

void org.skia.skottie.SkottieAnimation.setStartDelay ( long  startDelay )

inline

Definition at line 236 of file SkottieAnimation.java.

                                               {
 
    }

setSurfaceTexture()

void org.skia.skottie.SkottieAnimation.setSurfaceTexture ( SurfaceTexture  s )

inlinepackage

Definition at line 75 of file SkottieAnimation.java.

                                             {
        mSurfaceTexture = s;
    }

start()

void org.skia.skottie.SkottieAnimation.start ( )

inline

Definition at line 151 of file SkottieAnimation.java.

                        {
        try {
            mRunner.runOnGLThread(() -> {
                if (!mIsRunning) {
                    long currentTime = System.nanoTime();
                    mAnimationStartTime = currentTime - (long)(1000000 * mDuration * mProgress);
                    mIsRunning = true;
                    mNewSurface = true;
                    mRepeatCounter = mRepeatCount;
                    doFrame(currentTime);
                }
            });
        }
        catch (Throwable t) {
            Log.e(LOG_TAG, "start failed", t);
            throw new RuntimeException(t);
        }
        if (this.getListeners() != null) {
            for (AnimatorListener l : this.getListeners()) {
                l.onAnimationStart(this);
            }
        }
    }

surfaceChanged()

void org.skia.skottie.SkottieAnimation.surfaceChanged ( SurfaceHolder  holder, int  format, int  width, int  height  )

inline

Definition at line 447 of file SkottieAnimation.java.

                                                                                        {
        try {
            mRunner.runOnGLThread(() -> {
                mSurfaceHolder = holder;
                updateSurface(width, height);
                config.mValidSurface = true;
            });
        }
        catch (Throwable t) {
            Log.e(LOG_TAG, "updateSurface failed", t);
            throw new RuntimeException(t);
        }
    }

surfaceCreated()

void org.skia.skottie.SkottieAnimation.surfaceCreated ( SurfaceHolder  holder )

inline

Definition at line 443 of file SkottieAnimation.java.

                                                     {
    }

surfaceDestroyed()

void org.skia.skottie.SkottieAnimation.surfaceDestroyed ( SurfaceHolder  holder )

inline

Definition at line 462 of file SkottieAnimation.java.

                                                       {
        config.mValidSurface = false;
        surfaceChanged(null, 0, 0, 0);
    }

updateSurface()

void org.skia.skottie.SkottieAnimation.updateSurface ( int  width, int  height  )

inline

Definition at line 143 of file SkottieAnimation.java.

                                                     {
        config.mSurfaceWidth = width;
        config.mSurfaceHeight = height;
        mNewSurface = true;
        drawFrame();
    }

---

The documentation for this class was generated from the following file:

• third_party/skia/platform_tools/android/apps/skottie/skottielib/src/main/java/org/skia/skottie/SkottieAnimation.java