AnimationInformation.java

/*
 * Copyright (c) 2015-present, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD-style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 */
package com.facebook.fresco.animation.backend;

/**
 * Basic animation metadata: Frame and loop count & duration
 */
public interface AnimationInformation {

  /**
   * Loop count to be returned by {@link #getLoopCount()} when the animation should be repeated
   * indefinitely.
   */
  int LOOP_COUNT_INFINITE = 0;

  /**
   * Get the number of frames for the animation
   *
   * @return the number of frames
   */
  int getFrameCount();

  /**
   * Get the frame duration for a given frame number in milliseconds.
   *
   * @param frameNumber the frame to get the duration for
   * @return the duration in ms
   */
  int getFrameDurationMs(int frameNumber);

  /**
   * Get the number of loops the animation has or {@link #LOOP_COUNT_INFINITE} for infinite looping.
   *
   * @return the loop count or {@link #LOOP_COUNT_INFINITE}
   */
  int getLoopCount();
}