Skip to content

Commit

Permalink
better comments
Browse files Browse the repository at this point in the history
  • Loading branch information
thesyncim committed Dec 2, 2024
1 parent 8169a90 commit aca8a1b
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 2 deletions.
25 changes: 23 additions & 2 deletions protobuf/video/sfu/models/models.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions protobuf/video/sfu/models/models.proto
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,20 @@ message PublishOption {
// - Half resolution (2 layers) = 640x360
// - Quarter resolution (3 layers) = 320x180
VideoDimension video_dimension = 7;

// The unique identifier for the publish request.
// - This `id` is assigned exclusively by the SFU. Any `id` set by the client
// in the `PublishOption` will be ignored and overwritten by the SFU.
// - The primary purpose of this `id` is to uniquely identify each publish
// request, even in scenarios where multiple publish requests for the same
// `track_type` and `codec` are active simultaneously.
// For example:
// - A user may publish two tracks of the same type (e.g., video) and codec
// (e.g., VP9) concurrently.
// - This uniqueness ensures that individual requests can be managed
// independently. For instance, an `id` is critical when stopping a specific
// publish request without affecting others.
int32 id = 8;
}

message Codec {
Expand Down
27 changes: 27 additions & 0 deletions protobuf/video/sfu/models/models_vtproto.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit aca8a1b

Please sign in to comment.