Schema flow_video.json

Show original (referenced schemas with $ref)

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "allOf": [
        {
            "$schema": "http://json-schema.org/draft-04/schema#",
            "allOf": [
                {
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "description": "Describes the foundations of all NMOS resources",
                    "properties": {
                        "description": {
                            "description": "Detailed description of the resource",
                            "type": "string"
                        },
                        "id": {
                            "description": "Globally unique identifier for the resource",
                            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
                            "type": "string"
                        },
                        "label": {
                            "description": "Freeform string label for the resource",
                            "type": "string"
                        },
                        "tags": {
                            "description": "Key value set of freeform string tags to aid in filtering resources. Values should be represented as an array of strings. Can be empty.",
                            "patternProperties": {
                                "": {
                                    "items": {
                                        "type": "string"
                                    },
                                    "type": "array"
                                }
                            },
                            "type": "object"
                        },
                        "version": {
                            "description": "String formatted TAI timestamp (<seconds>:<nanoseconds>) indicating precisely when an attribute of the resource last changed",
                            "pattern": "^[0-9]+:[0-9]+$",
                            "type": "string"
                        }
                    },
                    "required": [
                        "id",
                        "version",
                        "label",
                        "description",
                        "tags"
                    ],
                    "title": "Base resource",
                    "type": "object"
                },
                {
                    "properties": {
                        "device_id": {
                            "description": "Globally unique identifier for the Device which initially created the Flow",
                            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
                            "type": "string"
                        },
                        "grain_rate": {
                            "description": "Number of Grains per second for this Flow. Must be an integer division of, or equal to the Grain rate specified by the parent Source. Grain rate matches the frame rate for video (see NMOS Content Model). Specified for periodic Flows only.",
                            "properties": {
                                "denominator": {
                                    "default": 1,
                                    "description": "Denominator",
                                    "type": "integer"
                                },
                                "numerator": {
                                    "description": "Numerator",
                                    "type": "integer"
                                }
                            },
                            "required": [
                                "numerator"
                            ],
                            "type": "object"
                        },
                        "parents": {
                            "description": "Array of UUIDs representing the Flow IDs of Grains which came together to generate this Flow (may change over the lifetime of this Flow)",
                            "items": {
                                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
                                "type": "string"
                            },
                            "type": "array"
                        },
                        "source_id": {
                            "description": "Globally unique identifier for the Source which initially created the Flow",
                            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
                            "type": "string"
                        }
                    },
                    "required": [
                        "source_id",
                        "device_id",
                        "parents"
                    ],
                    "type": "object"
                }
            ],
            "description": "Describes a Flow",
            "title": "Flow resource",
            "type": "object"
        },
        {
            "properties": {
                "colorspace": {
                    "description": "Colorspace used for the video",
                    "enum": [
                        "BT601",
                        "BT709",
                        "BT2020",
                        "BT2100"
                    ],
                    "type": "string"
                },
                "format": {
                    "description": "Format of the data coming from the Flow as a URN",
                    "enum": [
                        "urn:x-nmos:format:video"
                    ],
                    "format": "uri",
                    "type": "string"
                },
                "frame_height": {
                    "description": "Height of the picture in pixels",
                    "type": "integer"
                },
                "frame_width": {
                    "description": "Width of the picture in pixels",
                    "type": "integer"
                },
                "interlace_mode": {
                    "default": "progressive",
                    "description": "Interlaced video mode for frames in this Flow",
                    "enum": [
                        "progressive",
                        "interlaced_tff",
                        "interlaced_bff",
                        "interlaced_psf"
                    ],
                    "type": "string"
                },
                "transfer_characteristic": {
                    "default": "SDR",
                    "description": "Transfer characteristic",
                    "enum": [
                        "SDR",
                        "HLG",
                        "PQ"
                    ],
                    "type": "string"
                }
            },
            "required": [
                "format",
                "frame_width",
                "frame_height",
                "colorspace"
            ],
            "type": "object"
        }
    ],
    "description": "Describes a Video Flow",
    "title": "Video Flow resource",
    "type": "object"
}

Documentation built at 13:13:28 CDT on 2023-07-12.
(c) AMWA 2023. RAML/JSON licensed under Apache 2.0. Documentation licensed under CC BY-ND 4.0.