search

ryanheise / audio_service

Flutter plugin to play audio in the background while the screen is off.
803 stars 480 forks source link

Documentation needed for rating #419

Open sivaperumal644 opened 4 years ago

sivaperumal644 commented 4 years ago

To which pages does your suggestion apply?

Describe your suggestion

I see that rating is supported in this plugin but there isn't any Documentation or example to explain how it could be implemented. I tried passing Rating.heartRating(isLiked) to MediaItem but it didn't work. So a documentation and example on how rating works would really help.

ryanheise commented 4 years ago

@sivaperumal644 , thanks for the request. I think also it could be a good idea to add documentation to the API docs.

First, can you clarify what didn't work? I'm personally not sure what the expected behaviour should be since I haven't used the feature myself, but if there is some obvious expected behaviour that is not occurring, it could be worth filing a bug report stating what is happening vs what was expected.

@hacker1024 , do you know if this feature still works, or did I possibly break something?

hacker1024 commented 4 years ago

Rating has been broken in my app for a while due to a change I made, and I haven't got round to fixing it, so I haven't noticed anything.

I'll test it as soon as I can.

I've been watching pretty much every change made to this plugin since I started using it, and I haven't seen anything that looks like it would have broken it, but I suppose it's possible.

Regardless, some documentation isn't a terrible idea. I can work on that, if you'd like?

hacker1024 commented 4 years ago

This may be related to #376

ryanheise commented 4 years ago

Thanks, @hacker1024 , that would be great. Incidentally, one change I recently made was to make the AudioService.* methods pass through directly to the background task instead of going through the transport controls, so the transport controls are only used by any other clients outside of the app that may wish to set ratings. I am not aware of whether there are actually any clients that would do this, but if there were any, Android Auto might be one.

I guess that in your use case, you were just using it to communicate between the Flutter UI and the background task.

chrisheib commented 1 year ago

Running into this too now. Has this been resolved before?

ryanheise commented 1 year ago

I think we can track the bug in #376 and then come back to this issue to document it once it's fixed.