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

Add useful testing information for stream encoding and packaging teams #910

Conversation

defagos
Copy link
Member

@defagos defagos commented Jun 14, 2024

Description

This PR documents tools available for inspecting and testing streams. This should help stream encoding and packaging teams be more autonomous in testing streams before they deliver them to our Pillarbox players.

Changes made

  • Enhance stream packaging documentation (extend it to encoding as well).

Checklist

  • APIs have been properly documented (if relevant).
  • The documentation has been updated (if relevant).
  • New unit tests have been written (if relevant).
  • The demo has been updated (if relevant).

@defagos defagos linked an issue Jun 14, 2024 that may be closed by this pull request
1 task
@defagos defagos requested review from waliid and amtins June 14, 2024 09:29
@defagos defagos marked this pull request as ready for review June 14, 2024 09:30
@defagos
Copy link
Member Author

defagos commented Jun 14, 2024

@amtins I added you as a reviewer since you might have some additional insights to provide. Documentation is in the DocC format but can still be conveniently read online, though some formatting will not be applied.

Thanks in advance for your help.

@defagos defagos enabled auto-merge June 14, 2024 09:34
@amtins
Copy link
Member

amtins commented Jun 14, 2024

@defagos we can add:

@defagos
Copy link
Member Author

defagos commented Jun 14, 2024

@amtins Thanks, I added TSDuck. The other tools are not really at home in the documentation of PillarboxPlayer since it only supports HLS.

The documentation is also targeting Apple platform needs specifically since PillarboxPlayer is a generic player for Apple platforms. I guess that once we have similar information for Android and the web we could gather all information as a shared consolidated page that is more specific to our company (and on which we could also mention internal tools like MMF).

@amtins
Copy link
Member

amtins commented Jun 14, 2024

@defagos my bad, I thought I was in pillarbox-documentation, misread 😅

@defagos defagos added this pull request to the merge queue Jun 14, 2024
Merged via the queue into main with commit 05f65fc Jun 14, 2024
6 checks passed
@defagos defagos deleted the 909-document-tools-available-for-encoding--packaging-teams-to-test-their-streams branch June 14, 2024 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Document tools available for encoding / packaging teams to test their streams
2 participants