webcast.js

KO | EN

gitlite — search

#python #hacktoberfest #ai #golang #rust #deep-learning #docker #nodejs #java #windows #awesome #pytorch #mcp #open-source

(★ 83)

API and documentation for the webcast websocket protocol

File Explorer

Download Latest Version (.zip)

- webcast.d.ts
- webcast.js
- - Cakefile
  - package.json
  - README.md
  - server.coffee
- - client.js
  - client.ts
  - index.html
  - main.css
  - server.liq
  - webcast.js
  - webcast.ts
- webcast.svg
.eslintrc
.gitignore
.prettierignore
.prettierrc
API.md
LICENSE
package.json
README.md
SPECS.md
tsconfig.json
webcast.ts

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Webcast
=======

This file and its corresponding repository documents the webcast protocol for streaming audio and video data using
[websockets](http://en.wikipedia.org/wiki/WebSocket).

Documentation
-------------

<table>
  <tr><td><img src="https://rawgithub.com/savonet/webcast/master/misc/webcast.svg" alt="Webcast Flowchart" title="Webcast Flowchart"/></td></tr>
  <tr><td>The Webcast Flowchart</td></tr>
</table>

### Description

The webcast protocol is used to send multimedia data to a streaming server using websockets. It is designed to be implemented
in browsers, thus providing a readily available browser client to stream local files and live media (webcam video, microphone audio).

### How to test?

#### Client

A fully functional client is available for testing at [webcast/webcaster](https://github.com/webcast/webcaster).

Alternatively, we provide a simple [webcam sender client](examples/webcam/).

#### Server

**⚠️ this example is outdated ⚠️**

The `examples/server/` directory contains a demo server, written in [NodeJS](http://nodejs.org/). In order to run it, you
will need a functional node install. Once this is done, you can execute `npm install` in the `server/` directory
and then `cake run` and you should be good to go!

Alternatively, a fully functional implementation of the protocol is available in
[liquidsoap](https://github.com/savonet/liquidsoap). To test it, you can simply run liquidsoap with the following
command line:
```
liquidsoap "output.ao(fallible=true,audio_to_stereo(input.harbor('mount',port=8080)))"
```

### Webcast.js API

See [API](https://github.com/webcast/webcast.js/blob/master/API.md)

### Protocol Specifications

See [SPECS](https://github.com/webcast/webcast.js/blob/master/SPECS.md)

webcast.js

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

webcast.js

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README