History

mcottontensor 2326ef3217 Update package.json Signed-off-by: mcottontensor <80377552+mcottontensor@users.noreply.github.com>		2024-02-29 09:49:58 +11:00
..
docs	Remove some overly specific functions from protocol and updated reference in frontend. Cleaned up some broken windows scripts for wilbur. More will need to be updated.	2024-02-22 15:45:22 +11:00
protobuf	Updated proto file with detailed documentation.	2024-02-22 13:53:38 +11:00
src	Some small fix ups from the PR review.	2024-02-29 09:15:29 +11:00
.eslintignore	Adding matchmaker support.	2024-02-21 15:06:08 +11:00
.eslintrc.js	Adding matchmaker support.	2024-02-21 15:06:08 +11:00
.gitignore	Building commonjs alongside es2015	2024-01-30 15:14:51 +11:00
README.md	Small readme updates. Testing markdown protobuf doc generation.	2024-02-22 12:42:38 +11:00
package-lock.json	Updating windows batch scripts for wilbur	2024-02-28 11:04:33 +11:00
package.json	Update package.json	2024-02-29 09:49:58 +11:00
tsconfig.base.json	Reverted back to doc generation using revisions. Branch mode requires us to specify which branch.	2024-02-22 14:51:02 +11:00
tsconfig.cjs.json	Small cleanup with common ts build	2024-02-01 09:17:29 +11:00
tsconfig.esm.json	Small cleanup with common ts build	2024-02-01 09:17:29 +11:00

README.md

lib-pixelstreamingcommon

The common library for the browser/client side of Pixel Streaming experiences. This library exposes common functionality for frontend applications of the pixel streaming ecosystem.

For examples of how to implement this library.

See lib-pixelstreamingfrontend
See lib-pixelstreamingsignalling
Also see Wilbur which uses the signalling library to implement a full signalling server.

Documentation

The API is documented here.