@webcast.js/socket

Webcast
=======

This file and its corresponding repository documents the webcast protocol for streaming audio and video data using
websockets.

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

The Webcast Flowchart

$3

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).

$3

#### Client

A fully functional client is available for testing at webcast/webcaster.

Alternatively, we provide a simple webcam sender client.

#### Server

⚠️ this example is outdated ⚠️

The examples/server/ directory contains a demo server, written in NodeJS. 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. 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)))"
``

$3

See API

$3

See SPECS