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

Changelog for version 1.7.0? #39930

Closed
sibbl opened this issue Oct 2, 2019 — with docs.microsoft.com · 8 comments

Comments

Copy link

commented Oct 2, 2019 — with docs.microsoft.com

As the Cognitive Services Speech SDK is not open source, I as a developer rely on the changelog.

Background: in my specific case, I'm wondering why AudioOutputStream.CreatePullStream() doesn't accept the AudioStreamFormat as a parameter anymore since version 1.7.0.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

@sibbl

This comment has been minimized.

Copy link
Author

commented Oct 2, 2019

Turns out that you moved this in my case into

speechConfig.SetSpeechSynthesisOutputFormat(SpeechSynthesisOutputFormat.Raw16Khz16BitMonoPcm);

as I found out digging into the sample code. It would still be awesome to have a changelog available.

Even the sample code repo's PR was hard to go through because lots of non-sdk-version related changes were made at the same time.

@RohitMungi-MSFT

This comment has been minimized.

Copy link
Contributor

commented Oct 2, 2019

@BrianMouncer Is it possible to publish the changelog of release along with release notes?

@RohitMungi-MSFT

This comment has been minimized.

Copy link
Contributor

commented Oct 4, 2019

@BrianMouncer It would be great if you could consider the request to document changelogs for future releases.

@BrianMouncer

This comment has been minimized.

Copy link
Contributor

commented Oct 4, 2019

@sibbl I was unaware that we made changes to AudioStreamFormat or at least what object it hangs off of. I check with this team and see this was intentional, as we usually will not make any type of breaking change.

@sibbl and @RohitMungi-MSFT what would you like to see from the change logs. This might be helpful for our public sample repo. We squash everything there, but you would at least have some commits history you could click through from a change log history... however for the main SDK changes, I fear the "change log" would just be the history of commits you can't see, and the titles are not very helpful (e.g. change implement work items #12345, which isn't very helpful to you).

If you can elaborate on what you would like to see in a "Change Log", I'd appreciate it.

Brian.

@RohitMungi-MSFT

This comment has been minimized.

Copy link
Contributor

commented Oct 5, 2019

@BrianMouncer Thanks for the clarification around the change log items. Since this is the SDK it might really not be available for public in general.
Regarding the issue with the recent change @sibbl mentioned we hope this is documented in the release notes if it is a breaking change.

@sibbl I think we can go ahead and close this issue as our team will work to document any breaking changes in future releases and update this one.

@sibbl

This comment has been minimized.

Copy link
Author

commented Oct 7, 2019

@BrianMouncer

If you can elaborate on what you would like to see in a "Change Log", I'd appreciate it.

As of the time when I opened the issue, the version 1.6.0 was the latest version being described at the changelog site. This was one week after the package was released to public.

Thanks for looking into the breaking change though, I had not expected this from a minor version update. I would've expected a hint in the changelog to use speechConfig.SetSpeechSynthesisOutputFormat instead of the solution I had (which was setting the expected output format in the pull stream instead. Which worked fine since this parameter overload was removed in v1.7).

Meanwhile version 1.7.0 is described on the page, so yes I agree with @RohitMungi-MSFT and will close the issue. Thanks! :)

@sibbl sibbl closed this Oct 7, 2019
@BrianMouncer

This comment has been minimized.

Copy link
Contributor

commented Oct 7, 2019

@sibbl

I had a chat with the engineer that removed this, andI have a question for you.
What have you been using the set audio format API for? The engineer who made this change, considered it a bug fix, and that property wasn't actually hooked up completely, however he may have only looked at the TTS output code paths.

Please let us know if there is anything else you notice different in the moved and now implemented API, as we normally wouldn't make a breaking change like this at all, let alone doing it without calling it out in the release notes.

Thanks for pointing this out, and I apologize for any inconvenience this caused.

@yulin-li

This comment has been minimized.

Copy link
Contributor

commented Oct 12, 2019

@sibbl

Thanks for pointing this. There was a bug where the format parameter in AuidioOutputFormat didn't have any effect on setting output format. So we removed this useless parameter. And as you said, we should use speechConfig.SetSpeechSynthesisOutputFormat to set the output format.

I apologize for the inconvenience and will update the relase doc to add this API change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.