Document AudioStreamPlayer.get_playback_position() intentionally always returning 0.0 when using AudioStreamInteractive
#99200
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
KingTheFifth
changed the title
AudioStreamPlayer.get_playback_position() intentionally aways returning 0.0 when using AudioStreamInteractive`AudioStreamPlayer.get_playback_position() intentionally aways returning 0.0 when using AudioStreamInteractive
RedMser
reviewed
Nov 14, 2024
doc/classes/AudioStreamPlayer.xml
Outdated
| @@ -22,6 +22,7 @@ | |||
| <description> | |||
| Returns the position in the [AudioStream] of the latest sound, in seconds. Returns [code]0.0[/code] if no sounds are playing. | |||
| [b]Note:[/b] The position is not always accurate, as the [AudioServer] does not mix audio every processed frame. To get more accurate results, add [method AudioServer.get_time_since_last_mix] to the returned position. | |||
| [b]Note:[/b] The returned position is always [code]0.0[/code] if the [AudioStream] is [AudioStreamInteractive]. [AudioStreamInteractive] may have multiple clips with transitions between them. This means that the playback position loses meaning, especially during transitions. | |||
There was a problem hiding this comment.
Suggested change
| [b]Note:[/b] The returned position is always [code]0.0[/code] if the [AudioStream] is [AudioStreamInteractive]. [AudioStreamInteractive] may have multiple clips with transitions between them. This means that the playback position loses meaning, especially during transitions. | |
| [b]Note:[/b] The returned position is always [code]0.0[/code] if the [member stream] is of type [AudioStreamInteractive], since it can have multiple clips playing at once. |
I think it can be a bit shorter while still getting the point across. + refers to the "stream" property now instead of the class. Feel free to tweak my suggestion further if you like :)
There was a problem hiding this comment.
You can also add particularly during transitions. at the end if wanted, but I didn't think it's necessary to understand this behavior. And the sentence would get a bit long :p
There was a problem hiding this comment.
Continuing with the above suggestion.
Suggested change
| [b]Note:[/b] The returned position is always [code]0.0[/code] if the [AudioStream] is [AudioStreamInteractive]. [AudioStreamInteractive] may have multiple clips with transitions between them. This means that the playback position loses meaning, especially during transitions. | |
| [b]Note:[/b] This method always returns [code]0.0[/code] if the [member stream] is an [AudioStreamInteractive], since it can have multiple clips playing at once. |
I do agree to keep verbosity at a minimum, especially because this method doesn't have a "strict" dependance on this class. That is to say that you don't need to know about AudioStreamInteractive to make use of this method.
There was a problem hiding this comment.
That makes very much sense! Thank you very much for the feedback. I have fixed it now :)
AThousandShips
changed the title
AudioStreamPlayer.get_playback_position() intentionally aways returning 0.0 when using AudioStreamInteractiveAudioStreamPlayer.get_playback_position() intentionally aways returning 0.0 when using AudioStreamInteractive
Mickeon
approved these changes
Nov 18, 2024
Repiteo
reviewed
Nov 19, 2024
…ways returning `0.0` when using `AudioStreamInteractive`
|
Thanks! Congratulations on your first contribution! 🎉 |
akien-mga
changed the title
AudioStreamPlayer.get_playback_position() intentionally aways returning 0.0 when using AudioStreamInteractiveAudioStreamPlayer.get_playback_position() intentionally always returning 0.0 when using AudioStreamInteractive
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.
Fix #97791
AudioStreamPlayer.get_playback_position()always returns0.0if theAudioStreamfor theAudioStreamPlayerisAudioStreamInteractive. This is intended behaviour that lacks documentation, as confirmed by #97806 (comment) and #97791 (comment). This pull requests adds documentation for the behaviour to the class reference.