Skip to content

WebGear FAQs

What is WebGear API and what does it do?

Answer: WebGear is a powerful ASGI Video-Broadcaster API ideal for transmitting Motion-JPEG-frames from a single source to multiple recipients via the browser. For more info. see WebGear doc ➶

 

How to get started with WebGear API?

Answer: First, refer to the Switching from OpenCV guide, then go through WebGear documentation. If you still have doubts, ask us on Gitter ➶ Community channel.

 

"WebGear is throwing ModuleNotFoundError on importing", Why?

Answer: This error means, VidGear is installed WITHOUT asyncio package support on your machine. For this support, see Requirements ➶.

 

Can WebGear always need Active Internet Connection?

Answer: No, it just need internet only once during its Auto-Generation Process ➶ to download default data-files and it takes few seconds. You can also download files manually from Github Server, otherwise you can also add your own custom files. For more information see Data-Files Auto-Generation WorkFlow ➶

 

Is it possible to stream on a different device on the network with WebGear?

If you set "0.0.0.0" as host value instead of "localhost" on Host Machine, then you must still use http://localhost:8000/ to access stream on that same host machine browser.

For accessing WebGear on different Client Devices on the network, use "0.0.0.0" as host value instead of "localhost" on Host Machine. Then type the IP-address of source machine followed by the defined port value in your desired Client Device's browser (for e.g. http://192.27.0.101:8000) to access the stream.

 

Can I manually place default files for WebGear?

Answer: Yes, you can either download default files from Github Server, and manually place at default location, OR, you can yourself create the require three critical files (i.e index.html, 404.html & 500.html) inside templates folder at the default location, thereby you don't need any internet connection at all. For more information see Data-Files Auto-Generation WorkFlow ➶

 

How to send OpenCV frames directly to Webgear Server?

Answer: See this usage example ➶.

 

How can I add my custom WebPage to WebGear?

Answer: See this usage example ➶.

 

How can to add CORS headers to WebGear?

Answer: See this usage example ➶.

 

Can I change the default location?

Answer: Yes, you can use WebGear's custom_data_location attribute of option parameter in WebGear API, to change default location to somewhere else.

 

Can I delete/rename the WebGear default data?

Answer: Yes, but you've to follow these rules ➶

 

What Web browser are supported by WebGear API?

Answer: All modern browser with Javascript support are supported by WebGear. If not, then discuss with us on Gitter ➶ Community channel.