livekit / protocol

LiveKit protocol. Protobuf definitions for LiveKit's signaling protocol
https://docs.livekit.io
Apache License 2.0
79 stars 65 forks source link

Partial documentation of RoomConfiguration parameters #775

Open biglittlebigben opened 3 months ago

changeset-bot[bot] commented 3 months ago

⚠️ No Changeset found

Latest commit: 981aafaa4c9cdac0b44c9fef6e4d0655ce7c5c19

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

💥 An error occurred when fetching the changed packages and changesets in this PR ``` Some errors occurred when validating the changesets config: The package or glob expression "github.com/livekit/protocol" specified in the `fixed` option does not match any package in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch. ```
rektdeckard commented 3 months ago

This looks great! I took a pass at generating the TS bindings for this, and unfortunately, there is an open issue in ts-proto from 7 months ago that breaks compilation with the option needed to emit the FieldOptions. I was able to get it working with a temporary hack and eventually produced the annotated bindings:

image

Have not done deep testing to make sure this doesn't break things elsewhere, but it's possible the fix in ts-proto is as simple as that. I'll look into making a PR over there.