Add loopBlock callback for when a loop is finished #183
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It's called every time the last frame is shown, on every loop. This is different to `animationBlock` which is only called after all the loops have finished (and never for infinite loops). Why? I have a use case where I'm playing a GIF in an infinite loop but I want to know when it has been shown at least once (first loop has been completed). Currently, there's no good way to satisfy this use case. One way is to read `loopDuration` and then schedule a timer to fire when that time has elapsed, which is roughly when one loop has happened. But in addition to being inaccurate, it's very fiddly because the timer has to be paused/unpaused if the GIF is paused/unpaused. Another way you might think would work is to use `loopCount: 1` instead and then use `animationBlock`. Then there just start playback again for the rest of the loops. The problem with that is that there's no way to restart without preparing the frames again AFAICT. With this new callback, it's very straightforward.
robinst
commented
Oct 7, 2022
| @@ -136,9 +145,12 @@ public class Animator { | |||
| /// - parameter size: The target size of the individual frames. | |||
| /// - parameter contentMode: The view content mode to use for the individual frames. | |||
| /// - parameter loopCount: Desired number of loops, <= 0 for infinite loop. | |||
| /// - parameter completionHandler: Completion callback function | |||
There was a problem hiding this comment.
Note that the parameter name here was outdated, I changed it along with a more descriptive ... description :)
|
Ping |
|
Thank you for the PR and for your patience. While the use case might be quite niche I appreciate the effort and care put into the PR. Happy to get this merged as is. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's called every time the last frame is shown, on every loop. This is different to
animationBlockwhich is only called after all the loops have finished (and never for infinite loops).Why? I have a use case where I'm playing a GIF in an infinite loop but I want to know when it has been shown at least once (first loop has been completed).
Currently, there's no good way to satisfy this use case. One way is to read
loopDurationand then schedule a timer to fire when that time has elapsed, which is roughly when one loop has happened. But in addition to being inaccurate, it's very fiddly because the timer has to be paused/unpaused if the GIF is paused/unpaused.Another way you might think would work is to use
loopCount: 1instead and then useanimationBlock. Then there just start playback again for the rest of the loops. The problem with that is that there's no way to restart without preparing the frames again AFAICT.With this new callback, it's very straightforward.