Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Suggestion] Rename methods #29

Closed
GustavoContreiras opened this issue Jun 21, 2019 · 3 comments
Closed

[Suggestion] Rename methods #29

GustavoContreiras opened this issue Jun 21, 2019 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@GustavoContreiras
Copy link
Contributor

I saw that you owners are not americans and maybe thats the reason the methods don't have a intuitive name.

My suggestions for rename:
startCompress -> compressVideo
convertVideoToGif -> compressVideoToGif
stopCompress -> cancelCompress
getThumbnail -> getThumbnailBytesList
getThumbnailWithFile -> getThumbnail

@GustavoContreiras GustavoContreiras added the enhancement New feature or request label Jun 21, 2019
@rurico
Copy link
Owner

rurico commented Jun 21, 2019

@GustavoContreiras About renameconvertVideoToGif maybe us should ask his opinion @vlada3003

@vlada3003
Copy link
Collaborator

Conversion of video to gif won't do any compression of the video, that's why I have chosen the method name.
I agree with other suggestions with just a couple observations. cancelCompress should be cancelCompression. Renaming to an existing method name might be confusing to existing library users, maybe getThumbnailFile would be more appropriate?

@GustavoContreiras
Copy link
Contributor Author

GustavoContreiras commented Jun 21, 2019

I don't know how its working on backend, but as an user of the package, converting to gif looks like a compression cause it uses the compressProgress stream.

So maybe it should have a convertingProgress stream and a isConverting boolean.

And yeah, maybe getThumbnailFile is more appropriate.

About old users from the library, you can delegate the method with the old method name with a warning that it will be deprecated.

But if you gonna think on renaming these things maybe the package should call Flutter Video Manager cause it's not just compressing it's also converting and etc haha

Obs: the package is awesome and it is extremely needed for my project, thanks a lot for this work.

@rurico rurico closed this as completed in 12bcee7 Jun 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants