Add AudioSinkPlayback::position

[Weihnachtsbaum]

Objective

• Allow users to get the playback position of playing audio.

Solution

• Add a position method to AudioSinkPlayback
• Implement it for AudioSink and SpatialAudioSink

Testing

• Updated audio_control example to show playback position

[mgi388]

You might like to do a quick audit of Bevy code to confirm the best name here: at a glance it looks like Bevy would name this position() rather than get_pos().

[Weihnachtsbaum]

@mgi388 I'm not entirely sure which Bevy code you are referring to. I definitely agree that the get_ prefix is weird, as other methods on AudioSinkPlayback don't have it (volume(), speed()), but the methods of AudioSinkPlayback correspond almost 1:1 to the methods of rodio::Sink, and it also uses the name get_pos. While it's weird, I'd just use the name rodio uses here, as it makes it easier to understand what corresponds to what.

[mgi388]

@mgi388 I'm not entirely sure which Bevy code you are referring to. I definitely agree that the get_ prefix is weird, as other methods on AudioSinkPlayback don't have it (volume(), speed()), but the methods of AudioSinkPlayback correspond almost 1:1 to the methods of rodio::Sink, and it also uses the name get_pos. While it's weird, I'd just use the name rodio uses here, as it makes it easier to understand what corresponds to what.

@Weihnachtsbaum sorry for the confusion. I’m saying amongst bevy code in other crates I think we see methods that get the position of something named position rather than get_pos.

I’m also not sure if 1:1 mapping to Rodio is a goal especially because there’s a medium to high chance that Rodio won’t be the audio backend for Bevy in the near future (see Bettwr Audio Working Group on Discord).

[Weihnachtsbaum]

@mgi388 That's a fair point, I changed it to position now.

[hukasu]

things like this usually use the terms seek and tell, i'd say, we already have the seek methods and this would be tell

[mgi388]

things like this usually use the terms seek and tell, i'd say, we already have the seek methods and this would be tell

@hukasu do you have a reference for that? I don't have a strong opinion on it really, but if I saw code that said music_controller.tell().as_secs_f32() I'm not sure it would be that intuitive to me compared to music_controller.position().as_secs_f32().

[hukasu]

yeah, maybe not for audio, both kira and rodio use position
because it uses seek i just assumed the counterpart would be tell like file descriptors

[mgi388]

@Weihnachtsbaum I ran the example and pressed spacebar to pause the audio and the progress keeps going presumably due to floating point things. I'm surprised that it fluctuates so much though. I wonder if it's expected from Rodio's side to fluctuate so much? Like even if you rendered it at 2 decimal places e.g. 11.43s, in the example below it would still fluctuate. Any ideas?

Screen.Recording.2025-05-12.at.11.41.07.am.mov

[Weihnachtsbaum]

@mgi388 I'm not sure but it might be because in example the playback speed is changing all the time. I'll have a look at it later today.

[mgi388]

@mgi388 I'm not sure but it might be because in example the playback speed is changing all the time. I'll have a look at it later today.

@Weihnachtsbaum ah that's probably it. It's probably fine then. A solution might be to update the example to only update the speed if it's not paused. I don't think that would have any negative effects on the example, see what you think.

[Weihnachtsbaum]

A solution might be to update the example to only update the speed if it's not paused.

@mgi388 Done 👍

[mgi388]

LGTM. I tested the example again and the progress pauses when you press spacebar.

[SolarLiner]

LGTM! A small update directly exposing more of rodio's API surface.