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

Removed voice & banner instructions from last step and added ssmlAnnouncements #4644

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

Trietes
Copy link
Contributor

@Trietes Trietes commented Mar 21, 2024

Issue

This PR is targetting to solve two of the issues mentioned in #4640. I've added simple voice ssmlAnnouncements to make the routing answers compatible with the navigation SDKs. I've also removed the voice and banner instructions from the last step since they are not required by the SDKs and just lead to confusing instructions on the screen.

Tasklist

  • Add tests
  • Add #fixes with the issue number that this PR addresses
  • Update the changelog

Copy link
Contributor

@eikes eikes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was not aware that the MapBox navigation SDK requires a ssmlAnnouncement but thank you for adding that.

I'll have to check what happens in the MapLibre navigation SDK when the last bannerInstructions and voiceInstructions are empty, I assume that it still works.

@Trietes
Copy link
Contributor Author

Trietes commented Apr 5, 2024

I was not aware that the MapBox navigation SDK requires a ssmlAnnouncement but thank you for adding that.

Might also depend on the SDK version. In my case the app just crashed. I would guess mapbox navigation SDK set this as requiered at some point.

I'll have to check what happens in the MapLibre navigation SDK when the last bannerInstructions and voiceInstructions are empty, I assume that it still works.

Would be really cool if you can do this. At least directions API V5 of mapbox always returns empty lists in the last step. So I guess it shouldn't be a probelm for Maplibre. In case of Mapbox Navigation SDK it just leads to the strange side effects mentioned in the Issue.

@Trietes Trietes mentioned this pull request Apr 19, 2024
3 tasks
@Trietes
Copy link
Contributor Author

Trietes commented May 2, 2024

Just wanted to give a small update on this: I've it running now with an Maplibre app. Works fine on my side

@ianthetechie
Copy link
Contributor

Yeah, I can confirm that some versions of the Mapbox-derived SDKs will crash without this. In our API middle layer for navigation at Stadia Maps, we added SSML <speak>{}</speak> wrapping exactly like this PR 😂

I'll have to check what happens in the MapLibre navigation SDK when the last bannerInstructions and voiceInstructions are empty, I assume that it still works.

This should work in every SDK I'm aware of (incl. newer ones like Ferrostar).

Anyone able to fix up the conflicts + get this merged? Seems pretty straightforward and low-risk to me :D

@Trietes
Copy link
Contributor Author

Trietes commented May 18, 2024

Thanks for updating the branch! Should be ready for merging now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants