getStats().switchHistory is not returning variant tracks ids

[hussam-i-am]

• What version of Shaka Player are you using? 2.1.0
  • Can you reproduce the issue with our latest release version? Yes
  • Can you reproduce the issue with the latest code from master? Yes
• Are you using the demo app or your own custom app? Both
  • If custom app, can you reproduce the issue using our demo app? Yes
• What browser and OS are you using? MacOS/Chrome
• What did you do? Called player.getStats().switchHistory`
  • What content did you load? Angel One demo asset
  • How did you interact with the content, if at all? Loaded demo asset
• What did you expect to happen? According to the documentation, When accessing switchHistory, it should return a StreamChoice with either a variant or text type
• What actually happened? StreamChoice is still returning the old format with types video and audio, with ids not matching the ids of the chosen variant tracks

[hussam-i-am]

Since this is marked at v2.2.0, I'd be happy to fork and create a fix, if it can be cherry picked for the next release. I looked over the code that adds the audio and video tracks to the history, is there anything that I should be aware of?

[joeyparrish]

Yes, I would be happy to take a PR for this. I would also be glad to cherry-pick the fix to v2.1.x.

[joeyparrish]

I looked into this a little as part of #823, which overlaps a lot. Here's what I found:

• Track ID for variants is taken from Variant ID
• Track ID for text is taken from Stream ID
• Stream and Variant IDs are auto-incremented integers, not from manifest
• switchHistory contains Stream IDs only

The crux of the problem is that variant Tracks have the Variant ID, but the two Streams inside the Variant have their own IDs which are only seen in switchHistory and can't be correlated to anything through the public API.

[joeyparrish]

Changing switchHistory to contain variant changes instead of individual audio/video streams would probably suffice.

[hussam-i-am]

Great, I figured it was something along those lines. Will try to get a PR up in the next week or so.

[joeyparrish]

Cherry-picked to v2.1.3.