Schema receiver_transport_constraints_ndi.json

Show original (referenced schemas with $ref)

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "description": "Used to express the dynamic constraints on NDI receiver transport parameters. These constraints may be set and changed at runtime. Every transport parameter supported must have an entry, even if it is only an empty object.",
    "patternProperties": {
        "^ext_[a-zA-Z0-9_]+$": {
            "additionalProperties": false,
            "description": "The constraints for a single transport parameter",
            "properties": {
                "description": {
                    "description": "A human readable string describing the constraint (optional)",
                    "type": "string"
                },
                "enum": {
                    "description": "An array of allowed values",
                    "items": {
                        "anyOf": [
                            {
                                "type": "boolean"
                            },
                            {
                                "type": "integer"
                            },
                            {
                                "type": "null"
                            },
                            {
                                "type": "number"
                            },
                            {
                                "type": "string"
                            }
                        ]
                    },
                    "minItems": 1,
                    "type": "array",
                    "uniqueItems": true
                },
                "maximum": {
                    "description": "The inclusive maximum value the parameter can be set to",
                    "type": [
                        "integer",
                        "number"
                    ]
                },
                "minimum": {
                    "description": "The inclusive minimum value the parameter can be set to",
                    "type": [
                        "integer",
                        "number"
                    ]
                },
                "pattern": {
                    "description": "A regex pattern that must be satisfied for this parameter",
                    "format": "regex",
                    "type": "string"
                }
            },
            "type": "object"
        }
    },
    "properties": {
        "interface_ip": {
            "additionalProperties": false,
            "description": "The constraints for a single transport parameter",
            "properties": {
                "description": {
                    "description": "A human readable string describing the constraint (optional)",
                    "type": "string"
                },
                "enum": {
                    "description": "An array of allowed values",
                    "items": {
                        "anyOf": [
                            {
                                "type": "boolean"
                            },
                            {
                                "type": "integer"
                            },
                            {
                                "type": "null"
                            },
                            {
                                "type": "number"
                            },
                            {
                                "type": "string"
                            }
                        ]
                    },
                    "minItems": 1,
                    "type": "array",
                    "uniqueItems": true
                },
                "maximum": {
                    "description": "The inclusive maximum value the parameter can be set to",
                    "type": [
                        "integer",
                        "number"
                    ]
                },
                "minimum": {
                    "description": "The inclusive minimum value the parameter can be set to",
                    "type": [
                        "integer",
                        "number"
                    ]
                },
                "pattern": {
                    "description": "A regex pattern that must be satisfied for this parameter",
                    "format": "regex",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "machine_name": {
            "additionalProperties": false,
            "description": "The constraints for a single transport parameter",
            "properties": {
                "description": {
                    "description": "A human readable string describing the constraint (optional)",
                    "type": "string"
                },
                "enum": {
                    "description": "An array of allowed values",
                    "items": {
                        "anyOf": [
                            {
                                "type": "boolean"
                            },
                            {
                                "type": "integer"
                            },
                            {
                                "type": "null"
                            },
                            {
                                "type": "number"
                            },
                            {
                                "type": "string"
                            }
                        ]
                    },
                    "minItems": 1,
                    "type": "array",
                    "uniqueItems": true
                },
                "maximum": {
                    "description": "The inclusive maximum value the parameter can be set to",
                    "type": [
                        "integer",
                        "number"
                    ]
                },
                "minimum": {
                    "description": "The inclusive minimum value the parameter can be set to",
                    "type": [
                        "integer",
                        "number"
                    ]
                },
                "pattern": {
                    "description": "A regex pattern that must be satisfied for this parameter",
                    "format": "regex",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "source_ip": {
            "additionalProperties": false,
            "description": "The constraints for a single transport parameter",
            "properties": {
                "description": {
                    "description": "A human readable string describing the constraint (optional)",
                    "type": "string"
                },
                "enum": {
                    "description": "An array of allowed values",
                    "items": {
                        "anyOf": [
                            {
                                "type": "boolean"
                            },
                            {
                                "type": "integer"
                            },
                            {
                                "type": "null"
                            },
                            {
                                "type": "number"
                            },
                            {
                                "type": "string"
                            }
                        ]
                    },
                    "minItems": 1,
                    "type": "array",
                    "uniqueItems": true
                },
                "maximum": {
                    "description": "The inclusive maximum value the parameter can be set to",
                    "type": [
                        "integer",
                        "number"
                    ]
                },
                "minimum": {
                    "description": "The inclusive minimum value the parameter can be set to",
                    "type": [
                        "integer",
                        "number"
                    ]
                },
                "pattern": {
                    "description": "A regex pattern that must be satisfied for this parameter",
                    "format": "regex",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "source_name": {
            "additionalProperties": false,
            "description": "The constraints for a single transport parameter",
            "properties": {
                "description": {
                    "description": "A human readable string describing the constraint (optional)",
                    "type": "string"
                },
                "enum": {
                    "description": "An array of allowed values",
                    "items": {
                        "anyOf": [
                            {
                                "type": "boolean"
                            },
                            {
                                "type": "integer"
                            },
                            {
                                "type": "null"
                            },
                            {
                                "type": "number"
                            },
                            {
                                "type": "string"
                            }
                        ]
                    },
                    "minItems": 1,
                    "type": "array",
                    "uniqueItems": true
                },
                "maximum": {
                    "description": "The inclusive maximum value the parameter can be set to",
                    "type": [
                        "integer",
                        "number"
                    ]
                },
                "minimum": {
                    "description": "The inclusive minimum value the parameter can be set to",
                    "type": [
                        "integer",
                        "number"
                    ]
                },
                "pattern": {
                    "description": "A regex pattern that must be satisfied for this parameter",
                    "format": "regex",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "source_port": {
            "additionalProperties": false,
            "description": "The constraints for a single transport parameter",
            "properties": {
                "description": {
                    "description": "A human readable string describing the constraint (optional)",
                    "type": "string"
                },
                "enum": {
                    "description": "An array of allowed values",
                    "items": {
                        "anyOf": [
                            {
                                "type": "boolean"
                            },
                            {
                                "type": "integer"
                            },
                            {
                                "type": "null"
                            },
                            {
                                "type": "number"
                            },
                            {
                                "type": "string"
                            }
                        ]
                    },
                    "minItems": 1,
                    "type": "array",
                    "uniqueItems": true
                },
                "maximum": {
                    "description": "The inclusive maximum value the parameter can be set to",
                    "type": [
                        "integer",
                        "number"
                    ]
                },
                "minimum": {
                    "description": "The inclusive minimum value the parameter can be set to",
                    "type": [
                        "integer",
                        "number"
                    ]
                },
                "pattern": {
                    "description": "A regex pattern that must be satisfied for this parameter",
                    "format": "regex",
                    "type": "string"
                }
            },
            "type": "object"
        },
        "source_url": {
            "additionalProperties": false,
            "description": "The constraints for a single transport parameter",
            "properties": {
                "description": {
                    "description": "A human readable string describing the constraint (optional)",
                    "type": "string"
                },
                "enum": {
                    "description": "An array of allowed values",
                    "items": {
                        "anyOf": [
                            {
                                "type": "boolean"
                            },
                            {
                                "type": "integer"
                            },
                            {
                                "type": "null"
                            },
                            {
                                "type": "number"
                            },
                            {
                                "type": "string"
                            }
                        ]
                    },
                    "minItems": 1,
                    "type": "array",
                    "uniqueItems": true
                },
                "maximum": {
                    "description": "The inclusive maximum value the parameter can be set to",
                    "type": [
                        "integer",
                        "number"
                    ]
                },
                "minimum": {
                    "description": "The inclusive minimum value the parameter can be set to",
                    "type": [
                        "integer",
                        "number"
                    ]
                },
                "pattern": {
                    "description": "A regex pattern that must be satisfied for this parameter",
                    "format": "regex",
                    "type": "string"
                }
            },
            "type": "object"
        }
    },
    "type": "object"
}

Documentation built at 04:50:57 CDT on 2024-08-29.
(c) AMWA 2024. RAML/JSON licensed under Apache 2.0. Documentation licensed under CC BY-ND 4.0.