Skip to content

ARG mux proposal#30

Open
garethsb wants to merge 4 commits intov1.0.xfrom
publish-arg-mux-proposal
Open

ARG mux proposal#30
garethsb wants to merge 4 commits intov1.0.xfrom
publish-arg-mux-proposal

Conversation

@garethsb
Copy link
Contributor

No description provided.

cristian-recoseanu and others added 4 commits October 24, 2023 09:10
* Create substream_constraints.json

* Update constraint_set.json

- to include the new substreams property

* Update Examples.md

- to add MUX example using substreams

* Update APIs/schemas/substream_constraints.json

to an "open enum"

Co-authored-by: Gareth Sylvester-Bradley <31761158+garethsb@users.noreply.github.com>

* Update Examples.md

in line with the latest schema update for "format"

* Update Receiver Capabilities.md

To add substreams section

* Change "MUX" to "mux"

---------

Co-authored-by: Gareth Sylvester-Bradley <31761158+garethsb@users.noreply.github.com>
to include better descriptions
Copy link
Contributor Author

@garethsb garethsb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Annotating with discussion in recent ARG calls

"type": "boolean",
"default": true
},
"urn:x-nmos:substreams": {
Copy link
Contributor Author

@garethsb garethsb Oct 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've discussed that in order to maintain BCP-004-01 v1.0 compatibility this cannot be urn:x-nmos:cap:substreams because of the pattern property below. But not clear whether urn:x-nmos:substreams name is precise enough.

{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Describes substream constraints",
"title": "Constraint Set",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"title": "Constraint Set",
"title": "Substream Constraints",

"type": "object",
"minProperties": 1,
"properties": {
"description": {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Each constraint set uses URN attribute names, since the parameter constraints in each set are intended to be extensible, and the metadata attributes therefore also have URNs, like urn:x-nmos:cap:meta:label.

Here it probably does make sense to use "simple" attribute names, like format and count (or minimum tbc). Should this one be description or label?

Comment on lines +28 to +30
"count": {
"$ref": "param_constraint_number.json"
},
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've discussed that most/all mux Receivers are capable of discarding substreams they are not interested in. Therefore we started discussing whether a minimum attribute could be simpler and sufficient?

E.g. something like

Suggested change
"count": {
"$ref": "param_constraint_number.json"
},
"minimum": {
"type": "integer",
"default": 1,
"minimum": 0
},

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants