mix livekit.proto.fetch (LiveKit v0.1.0)

Copy Markdown View Source

Downloads the LiveKit protocol definitions into priv/proto.

mix proto.fetch

The protocol revision is pinned by Mix.Tasks.Livekit.Proto.Fetch so that fetching is reproducible; see revision/0. Pass --ref to vendor a different commit, tag or branch:

mix proto.fetch --ref 2172178d20d4c8d14d6873b4e9560cc38cf48c0c

Only the files needed by the server APIs (and their transitive imports) are vendored. Well-known Google types are supplied by protoc and are not vendored.

Requires curl and tar. This task is a development-time tool: the fetched .proto files and the modules generated from them are committed, so cloning the repository is enough to use the SDK.

Summary

Functions

files()

The proto files vendored by this task, relative to the protocol's protobufs/ directory.

revision()

The pinned protocol revision as {version, commit_sha}.

Functions

files()

@spec files() :: [String.t()]

The proto files vendored by this task, relative to the protocol's protobufs/ directory.

revision()

@spec revision() :: {String.t(), String.t()}

The pinned protocol revision as {version, commit_sha}.