holoviz / panel

Panel: The powerful data exploration & web app framework for Python
https://panel.holoviz.org
BSD 3-Clause "New" or "Revised" License
4.64k stars 504 forks source link

Improve documentation of VideoStream #3823

Open MarcSkovMadsen opened 2 years ago

MarcSkovMadsen commented 2 years ago

Request

Improve the documentation of VideoStream by describing how to use alternative streams to the default web cam. It would be even better if the example (or a Gallery example) showed how to use live image recognition similar to

Motivation

When reading the docs https://panel.holoviz.org/reference/widgets/VideoStream.html#widgets-gallery-videostream

"The VideoStream widget displays a video from a local stream (for example from a webcam) and allows accessing the streamed video data from Python."

It is indicated that the web cam is only an example. But it is not clear how to use anything else. For example a user is asking here how to use an alternative sensor https://discourse.holoviz.org/t/videostream-source/4225/3.

In the Streamlit community the VideoStream is very popular and I see many examples primary driven by the extension https://github.com/whitphx/streamlit-webrtc. I believe the Panel community could also do this and maybe even better because of the architecture of Panel vs Streamlit. But its difficult to get inspired and started because there is no example of this.

MarcSkovMadsen commented 1 year ago

Something like this would also make a cool blog post @sophiamyang