{ "components": { "schemas": { "AboutResponse": { "additionalProperties": false, "example": { "daemon_version": "x.y.z" }, "properties": { "daemon_version": { "type": "string" } }, "required": [ "daemon_version" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "ActionRequest": { "additionalProperties": false, "properties": { "file_path": { "type": "string" }, "password": { "type": "string" }, "server": { "type": "string" }, "username": { "type": "string" } }, "type": "object", "x-videon-source": "daemon/avstream action handler request fields" }, "ActionResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/RestActionResponseData" }, "message": { "type": "string" }, "status": { "type": "string" } }, "required": [ "status", "message", "data" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "AudCodecValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "mpeg2_aac", "mpeg4_aac", "mpeg4_aac_loas", "opus" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "mpeg2_aac", "mpeg4_aac", "mpeg4_aac_loas", "opus" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "AudSampleValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "SAMPLE_32_khz", "SAMPLE_44p1_khz", "SAMPLE_48_khz", "SAMPLE_7p35_khz", "SAMPLE_8_khz", "SAMPLE_11p025_khz", "SAMPLE_12_khz", "SAMPLE_16_khz", "SAMPLE_22p05_khz", "SAMPLE_24_khz", "SAMPLE_64_khz", "SAMPLE_88p2_khz", "SAMPLE_96_khz", "SAMPLE_176p4_khz", "SAMPLE_192_khz", "SAMPLE_352p8_khz", "SAMPLE_384_khz", "SAMPLE_705p6_khz", "SAMPLE_768_khz" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "SAMPLE_32_khz", "SAMPLE_44p1_khz", "SAMPLE_48_khz", "SAMPLE_7p35_khz", "SAMPLE_8_khz", "SAMPLE_11p025_khz", "SAMPLE_12_khz", "SAMPLE_16_khz", "SAMPLE_22p05_khz", "SAMPLE_24_khz", "SAMPLE_64_khz", "SAMPLE_88p2_khz", "SAMPLE_96_khz", "SAMPLE_176p4_khz", "SAMPLE_192_khz", "SAMPLE_352p8_khz", "SAMPLE_384_khz", "SAMPLE_705p6_khz", "SAMPLE_768_khz" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "AudioEncoder": { "additionalProperties": false, "properties": { "active": { "type": "boolean" }, "aud_encoder_id": { "type": "integer" }, "seconds_in_status": { "type": "integer" }, "status": { "enum": [ "DISABLED", "PENDING", "RUNNING", "RETRYING_ENDED", "UNABLE_TO_ENCODE", "NO_INPUT", "INSUFFICIENT_RESOURCES", "FAILED_TO_START", "INVALID_CONFIG" ], "type": "string" } }, "required": [ "aud_encoder_id", "active", "status", "seconds_in_status" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "AudioEncoderConfiguration": { "additionalProperties": false, "properties": { "active": { "type": "boolean" }, "aud_encoder_id": { "type": "integer" }, "bitrate": { "$ref": "#/components/schemas/BitrateValidation" }, "bitrate_mode": { "$ref": "#/components/schemas/StreamBitrateModeValidation" }, "channel_configuration": { "$ref": "#/components/schemas/ChannelConfiguration" }, "codec": { "$ref": "#/components/schemas/AudCodecValidation" }, "connection_caps": { "$ref": "#/components/schemas/ConnectionCapabilities" }, "enable_retry": { "type": "boolean" }, "in_channel_id": { "type": "integer" }, "mix_mode": { "$ref": "#/components/schemas/FBAudioMixModeValidation" }, "name": { "type": "string" }, "sample": { "$ref": "#/components/schemas/AudSampleValidation" }, "seconds_in_status": { "type": "integer" }, "status": { "enum": [ "DISABLED", "PENDING", "RUNNING", "RETRYING_ENDED", "UNABLE_TO_ENCODE", "NO_INPUT", "INSUFFICIENT_RESOURCES", "FAILED_TO_START", "INVALID_CONFIG" ], "type": "string" } }, "required": [ "name", "active", "aud_encoder_id", "enable_retry", "in_channel_id", "codec", "sample", "mix_mode", "bitrate", "status", "seconds_in_status", "channel_configuration", "bitrate_mode", "connection_caps" ], "type": "object", "x-videon-defaulting": { "missing_request_body": "Daemon applies default audio encoder settings and default channel selection.", "optional_fields": [ "in_channel_id", "codec", "bitrate" ] }, "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "AudioEncoderConfigurationWriteRequest": { "additionalProperties": false, "properties": { "active": { "type": "boolean" }, "aud_encoder_id": { "type": "integer" }, "bitrate": { "additionalProperties": false, "properties": { "value": { "type": "integer" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "bitrate_mode": { "additionalProperties": false, "properties": { "value": { "enum": [ "constant", "variable", "constant_strict" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "channel_configuration": { "additionalProperties": false, "properties": { "selected_channels": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "selected_channels" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "codec": { "additionalProperties": false, "properties": { "value": { "enum": [ "mpeg2_aac", "mpeg4_aac", "mpeg4_aac_loas", "opus" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "connection_caps": { "additionalProperties": false, "properties": { "consumer_caps": { "items": { "enum": [ "RAW_VIDEO", "RAW_AUDIO", "ES_VIDEO_H264", "ES_VIDEO_H265", "ES_VIDEO_MJPEG", "ES_AUDIO_AAC_MPEG4_ADTS", "ES_AUDIO_OPUS", "DATA_SMPTE291", "DATA_SMPTE291_10BIT_SCTE_104", "DATA_SMPTE2038", "DATA_MPEGTS_METADATA_AU_WRAPPER_KLV_SYNC" ], "type": "string" }, "type": "array" }, "producer_caps": { "items": { "enum": [ "RAW_VIDEO", "RAW_AUDIO", "ES_VIDEO_H264", "ES_VIDEO_H265", "ES_VIDEO_MJPEG", "ES_AUDIO_AAC_MPEG4_ADTS", "ES_AUDIO_OPUS", "DATA_SMPTE291", "DATA_SMPTE291_10BIT_SCTE_104", "DATA_SMPTE2038", "DATA_MPEGTS_METADATA_AU_WRAPPER_KLV_SYNC" ], "type": "string" }, "type": "array" } }, "required": [ "consumer_caps", "producer_caps" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "enable_retry": { "type": "boolean" }, "in_channel_id": { "type": "integer" }, "mix_mode": { "additionalProperties": false, "properties": { "value": { "enum": [ "STEREO", "DUAL_MONO", "LEFT_MONO", "RIGHT_MONO", "CROSS_MONO" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "name": { "type": "string" }, "sample": { "additionalProperties": false, "properties": { "value": { "enum": [ "SAMPLE_32_khz", "SAMPLE_44p1_khz", "SAMPLE_48_khz", "SAMPLE_7p35_khz", "SAMPLE_8_khz", "SAMPLE_11p025_khz", "SAMPLE_12_khz", "SAMPLE_16_khz", "SAMPLE_22p05_khz", "SAMPLE_24_khz", "SAMPLE_64_khz", "SAMPLE_88p2_khz", "SAMPLE_96_khz", "SAMPLE_176p4_khz", "SAMPLE_192_khz", "SAMPLE_352p8_khz", "SAMPLE_384_khz", "SAMPLE_705p6_khz", "SAMPLE_768_khz" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" } }, "required": [ "name", "active", "aud_encoder_id", "enable_retry", "in_channel_id", "codec", "sample", "mix_mode", "bitrate", "channel_configuration", "bitrate_mode", "connection_caps" ], "type": "object", "x-videon-defaulting": { "missing_request_body": "Daemon applies default audio encoder settings and default channel selection.", "optional_fields": [ "in_channel_id", "codec", "bitrate" ] }, "x-videon-note": "Write-schema projection: excludes runtime/status/range/possible-values fields from request bodies.", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "AudioEncoderListResponse": { "additionalProperties": false, "properties": { "aud_encoders": { "items": { "$ref": "#/components/schemas/AudioEncoder" }, "type": "array" }, "available_codecs": { "items": { "enum": [ "mpeg2_aac", "mpeg4_aac", "mpeg4_aac_loas", "opus" ], "type": "string" }, "type": "array" }, "max_aud_encoders": { "type": "integer" } }, "required": [ "aud_encoders", "available_codecs", "max_aud_encoders" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "AudioInputValidation": { "additionalProperties": false, "properties": { "detected": { "type": "boolean" }, "possible_values": { "items": { "enum": [ "input_embedded", "input_3p5mm", "input_auto", "input_hdmi", "input_sdi", "input_tpg" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "sdi_ignore_phase": { "type": "boolean" }, "value": { "enum": [ "input_embedded", "input_3p5mm", "input_auto", "input_hdmi", "input_sdi", "input_tpg" ], "type": "string" } }, "required": [ "value", "possible_values", "detected", "sdi_ignore_phase" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "AudioSourceValidation": { "additionalProperties": false, "properties": { "audio_source_ids": { "items": { "type": "integer" }, "type": "array" }, "max_sources": { "type": "integer" } }, "required": [ "max_sources", "audio_source_ids" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "AudioSourceValidationDeprecated": { "additionalProperties": false, "properties": { "audio_source_id": { "type": "integer" } }, "required": [ "audio_source_id" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "BitrateValidation": { "additionalProperties": false, "properties": { "value": { "type": "integer" }, "value_range": { "$ref": "#/components/schemas/RangeValidation" } }, "required": [ "value", "value_range" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "ChannelConfiguration": { "additionalProperties": false, "properties": { "avail_channel_range": { "$ref": "#/components/schemas/RangeValidation" }, "num_channel_range": { "$ref": "#/components/schemas/RangeValidation" }, "selected_channels": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "num_channel_range", "avail_channel_range", "selected_channels" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "ChunkInterval": { "additionalProperties": false, "properties": { "interval": { "minimum": 0, "type": "integer" }, "possible_units": { "items": { "enum": [ "unspecified", "MILLISECONDS", "FRAMES" ], "type": "string" }, "type": "array" }, "unit": { "enum": [ "unspecified", "MILLISECONDS", "FRAMES" ], "type": "string" } }, "required": [ "interval", "unit", "possible_units" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "ComponentStatusResponse": { "additionalProperties": false, "properties": { "code": { "enum": [ "OFF", "PENDING", "CONNECTED", "RUNNING", "REMOTE_CLOSED", "ERROR", "ERROR_INTERNAL", "ERROR_AVINPUT_MISMATCH", "ERROR_SOURCE_AV_MISSING", "ERROR_SOURCE_VIDEO_MISSING", "ERROR_SOURCE_AUDIO_MISSING", "ERROR_UNSUPPORTED_CODEC", "ERROR_UNSUPPORTED_BITRATE", "ERROR_UNSUPPORTED_BITRATE_MODE", "ERROR_UNSUPPORTED_RESOLUTION", "ERROR_REMOTE", "ERROR_REMOTE_UNREACHABLE", "ERROR_REMOTE_ACCESS_DENIED", "ERROR_STORAGE_NO_DEVICE", "ERROR_STORAGE_UNSUPPORTED_FILESYSTEM", "ERROR_STORAGE_DEVICE_FULL", "RETRYING", "RETRYING_ENDED", "ERROR_INVALID_CONFIG" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "ConnectionCapabilities": { "additionalProperties": false, "properties": { "consumer_caps": { "items": { "enum": [ "RAW_VIDEO", "RAW_AUDIO", "ES_VIDEO_H264", "ES_VIDEO_H265", "ES_VIDEO_MJPEG", "ES_AUDIO_AAC_MPEG4_ADTS", "ES_AUDIO_OPUS", "DATA_SMPTE291", "DATA_SMPTE291_10BIT_SCTE_104", "DATA_SMPTE2038", "DATA_MPEGTS_METADATA_AU_WRAPPER_KLV_SYNC" ], "type": "string" }, "type": "array" }, "producer_caps": { "items": { "enum": [ "RAW_VIDEO", "RAW_AUDIO", "ES_VIDEO_H264", "ES_VIDEO_H265", "ES_VIDEO_MJPEG", "ES_AUDIO_AAC_MPEG4_ADTS", "ES_AUDIO_OPUS", "DATA_SMPTE291", "DATA_SMPTE291_10BIT_SCTE_104", "DATA_SMPTE2038", "DATA_MPEGTS_METADATA_AU_WRAPPER_KLV_SYNC" ], "type": "string" }, "type": "array" } }, "required": [ "consumer_caps", "producer_caps" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DatCodecTable": { "additionalProperties": false, "properties": { "klv_sync": { "$ref": "#/components/schemas/KlvSync" }, "scte35": { "$ref": "#/components/schemas/SCTE35Codec" }, "smpte2038": { "$ref": "#/components/schemas/SMPTE2038Codec" }, "value": { "enum": [ "klv_sync", "scte35", "smpte2038" ], "type": "string" } }, "required": [ "value", "klv_sync", "scte35", "smpte2038" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DataEncoder": { "additionalProperties": false, "properties": { "active": { "type": "boolean" }, "codec": { "enum": [ "klv_sync", "scte35", "smpte2038" ], "type": "string" }, "data_encoder_id": { "type": "integer" }, "seconds_in_status": { "type": "integer" }, "status": { "enum": [ "DISABLED", "PENDING", "RUNNING", "RETRYING_ENDED", "UNABLE_TO_ENCODE", "NO_INPUT", "INSUFFICIENT_RESOURCES", "FAILED_TO_START", "INVALID_CONFIG" ], "type": "string" } }, "required": [ "data_encoder_id", "active", "status", "seconds_in_status", "codec" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DataEncoderConfiguration": { "additionalProperties": false, "properties": { "active": { "type": "boolean" }, "codec": { "$ref": "#/components/schemas/DatCodecTable" }, "connection_caps": { "$ref": "#/components/schemas/ConnectionCapabilities" }, "data_encoder_id": { "type": "integer" }, "in_channel_id": { "type": "integer" }, "name": { "type": "string" }, "seconds_in_status": { "type": "integer" }, "status": { "enum": [ "DISABLED", "PENDING", "RUNNING", "RETRYING_ENDED", "UNABLE_TO_ENCODE", "NO_INPUT", "INSUFFICIENT_RESOURCES", "FAILED_TO_START", "INVALID_CONFIG" ], "type": "string" } }, "required": [ "name", "active", "data_encoder_id", "in_channel_id", "codec", "status", "seconds_in_status", "connection_caps" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DataEncoderConfigurationWriteRequest": { "additionalProperties": false, "properties": { "active": { "type": "boolean" }, "codec": { "additionalProperties": false, "properties": { "klv_sync": { "additionalProperties": false, "properties": { "disable_misb1402_timestamps": { "type": "boolean" } }, "required": [ "disable_misb1402_timestamps" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "scte35": { "additionalProperties": false, "properties": { "splice_duration": { "type": "integer" } }, "required": [ "splice_duration" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "smpte2038": { "additionalProperties": false, "properties": { "stop_processing": { "type": "boolean" } }, "required": [ "stop_processing" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "value": { "enum": [ "klv_sync", "scte35", "smpte2038" ], "type": "string" } }, "required": [ "value", "klv_sync", "scte35", "smpte2038" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "connection_caps": { "additionalProperties": false, "properties": { "consumer_caps": { "items": { "enum": [ "RAW_VIDEO", "RAW_AUDIO", "ES_VIDEO_H264", "ES_VIDEO_H265", "ES_VIDEO_MJPEG", "ES_AUDIO_AAC_MPEG4_ADTS", "ES_AUDIO_OPUS", "DATA_SMPTE291", "DATA_SMPTE291_10BIT_SCTE_104", "DATA_SMPTE2038", "DATA_MPEGTS_METADATA_AU_WRAPPER_KLV_SYNC" ], "type": "string" }, "type": "array" }, "producer_caps": { "items": { "enum": [ "RAW_VIDEO", "RAW_AUDIO", "ES_VIDEO_H264", "ES_VIDEO_H265", "ES_VIDEO_MJPEG", "ES_AUDIO_AAC_MPEG4_ADTS", "ES_AUDIO_OPUS", "DATA_SMPTE291", "DATA_SMPTE291_10BIT_SCTE_104", "DATA_SMPTE2038", "DATA_MPEGTS_METADATA_AU_WRAPPER_KLV_SYNC" ], "type": "string" }, "type": "array" } }, "required": [ "consumer_caps", "producer_caps" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "data_encoder_id": { "type": "integer" }, "in_channel_id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "name", "active", "data_encoder_id", "in_channel_id", "codec", "connection_caps" ], "type": "object", "x-videon-note": "Write-schema projection: excludes runtime/status/range/possible-values fields from request bodies.", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DataEncoderKlv": { "additionalProperties": false, "properties": { "id": { "type": "integer" }, "klv": { "items": { "$ref": "#/components/schemas/RestKlvElement" }, "type": "array" }, "precision_datetime_utc": { "type": "string" } }, "required": [ "id", "precision_datetime_utc", "klv" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DataEncoderKlvListResponse": { "additionalProperties": false, "properties": { "klv": { "items": { "$ref": "#/components/schemas/DataEncoderKlv" }, "type": "array" } }, "required": [ "klv" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DataEncoderKlvWriteRequest": { "additionalProperties": false, "properties": { "id": { "type": "integer" }, "klv": { "items": { "additionalProperties": false, "properties": { "blob": { "type": "string" }, "enumerated": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "length": { "type": "integer" }, "value": { "type": "string" } }, "required": [ "key", "length", "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "value": { "type": "string" } }, "required": [ "value", "blob", "enumerated" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "type": "array" }, "precision_datetime_utc": { "type": "string" } }, "required": [ "id", "precision_datetime_utc", "klv" ], "type": "object", "x-videon-note": "Write-schema projection: excludes runtime/status/range/possible-values fields from request bodies.", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DataEncoderListResponse": { "additionalProperties": false, "properties": { "available_codecs": { "items": { "enum": [ "klv_sync", "scte35", "smpte2038" ], "type": "string" }, "type": "array" }, "data_encoders": { "items": { "$ref": "#/components/schemas/DataEncoder" }, "type": "array" }, "max_klv_sync": { "type": "integer" }, "max_scte35": { "type": "integer" }, "max_smpte2038": { "type": "integer" } }, "required": [ "data_encoders", "available_codecs", "max_klv_sync", "max_scte35", "max_smpte2038" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DataEncoderSpliceCommand": { "additionalProperties": false, "properties": { "id": { "type": "integer" }, "process_time_utc": { "type": "string" }, "splice_command": { "$ref": "#/components/schemas/RestSpliceCommandVariant" } }, "required": [ "id", "process_time_utc", "splice_command" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DataEncoderSpliceCommandListResponse": { "additionalProperties": false, "properties": { "splice_commands": { "items": { "$ref": "#/components/schemas/DataEncoderSpliceCommand" }, "type": "array" } }, "required": [ "splice_commands" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DataEncoderSpliceCommandWriteRequest": { "additionalProperties": false, "properties": { "id": { "type": "integer" }, "process_time_utc": { "type": "string" }, "splice_command": { "additionalProperties": false, "properties": { "splice_insert": { "additionalProperties": false, "properties": { "duration_msec": { "minimum": 0, "type": "integer" }, "preroll_time_msec": { "minimum": 0, "type": "integer" }, "splice_event_id": { "minimum": 0, "type": "integer" } }, "required": [ "splice_event_id", "preroll_time_msec", "duration_msec" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "time_signal": { "additionalProperties": false, "properties": { "preroll_time_msec": { "minimum": 0, "type": "integer" }, "segment_num": { "maximum": 255, "minimum": 0, "type": "integer" }, "segmentation_descriptor": { "type": "string" }, "segmentation_event_id": { "minimum": 0, "type": "integer" }, "segmentation_type_id": { "maximum": 255, "minimum": 0, "type": "integer" } }, "required": [ "segmentation_event_id", "preroll_time_msec", "segmentation_descriptor", "segmentation_type_id", "segment_num" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "value": { "type": "string" } }, "required": [ "value", "splice_insert", "time_signal" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" } }, "required": [ "id", "process_time_utc", "splice_command" ], "type": "object", "x-videon-note": "Write-schema projection: excludes runtime/status/range/possible-values fields from request bodies.", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DataSourceObject": { "additionalProperties": false, "properties": { "data_source_ids": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "data_source_ids" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DebugVerbosityComponentsResponse": { "additionalProperties": false, "properties": { "component_type_overrides": { "additionalProperties": { "enum": [ "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ], "type": "string" }, "type": "object" }, "component_types": { "additionalProperties": { "enum": [ "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ], "type": "string" }, "type": "object" }, "components": { "additionalProperties": { "enum": [ "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ], "type": "string" }, "type": "object" }, "default_verbosity": { "type": "string" }, "overrides": { "additionalProperties": { "enum": [ "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ], "type": "string" }, "type": "object" } }, "required": [ "default_verbosity", "components", "overrides", "component_types" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DebugVerbosityComponentsUpdateRequest": { "additionalProperties": false, "example": { "components": { "startup": "INFO" } }, "minProperties": 1, "properties": { "component_types": { "additionalProperties": { "enum": [ "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ], "type": "string" }, "type": "object" }, "components": { "additionalProperties": { "enum": [ "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ], "type": "string" }, "type": "object" } }, "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DebugVerbosityRequest": { "additionalProperties": false, "example": { "verbosity": "INFO" }, "properties": { "verbosity": { "enum": [ "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ], "type": "string" } }, "required": [ "verbosity" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DebugVerbosityResponse": { "additionalProperties": false, "example": { "verbosity": "WARN" }, "properties": { "verbosity": { "enum": [ "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ], "type": "string" } }, "required": [ "verbosity" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DebugVerbosityScopesResponse": { "additionalProperties": false, "properties": { "default_verbosity": { "type": "string" }, "scope_overrides": { "additionalProperties": { "enum": [ "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ], "type": "string" }, "type": "object" }, "scope_substring_overrides": { "additionalProperties": { "enum": [ "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ], "type": "string" }, "type": "object" }, "scopes": { "additionalProperties": { "enum": [ "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ], "type": "string" }, "type": "object" } }, "required": [ "default_verbosity", "scopes" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DebugVerbosityScopesUpdateRequest": { "additionalProperties": false, "example": { "scopes": { "rtmp": "INFO" } }, "minProperties": 1, "properties": { "scopes": { "additionalProperties": { "enum": [ "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ], "type": "string" }, "type": "object" } }, "required": [ "scopes" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "DeviceListResponse": { "oneOf": [ { "description": "Canonical runtime shape: bare JSON array of entities.", "items": { "$ref": "#/components/schemas/DeviceResponse" }, "type": "array" }, { "additionalProperties": false, "description": "Alternate wrapped list shape for compatibility.", "properties": { "devices": { "items": { "$ref": "#/components/schemas/DeviceResponse" }, "type": "array" } }, "required": [ "devices" ], "type": "object" } ], "x-videon-listResponseCanonical": "bare_array", "x-videon-source": "configuration_generated.fbs" }, "DeviceResponse": { "additionalProperties": false, "properties": { "device_id": { "type": "string" }, "ip_address": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "device_id", "ip_address" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "EncoderListResponse": { "additionalProperties": false, "properties": { "aud_encoders": { "items": { "$ref": "#/components/schemas/AudioEncoder" }, "type": "array" }, "data_encoders": { "items": { "$ref": "#/components/schemas/DataEncoder" }, "type": "array" }, "max_aud_encoders": { "type": "integer" }, "max_vid_encoders": { "type": "integer" }, "vid_encoders": { "items": { "$ref": "#/components/schemas/VideoEncoder" }, "type": "array" } }, "required": [ "vid_encoders", "max_vid_encoders", "aud_encoders", "max_aud_encoders", "data_encoders" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "ErrorResponse": { "additionalProperties": false, "example": { "error": "Invalid request value" }, "properties": { "details": { "type": "string" }, "error": { "type": "string" } }, "required": [ "error" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "FBAudioMixModeValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "STEREO", "DUAL_MONO", "LEFT_MONO", "RIGHT_MONO", "CROSS_MONO" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "STEREO", "DUAL_MONO", "LEFT_MONO", "RIGHT_MONO", "CROSS_MONO" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "FB_BlockDeviceSelectionPolicyValidation": { "additionalProperties": false, "properties": { "data": { "type": "string" }, "possible_values": { "items": { "enum": [ "unspecified", "ATTACH_TIME_FIRST", "ATTACH_TIME_LAST", "FREE_SPACE_MAX", "TOTAL_SPACE_MAX", "VOLUME_UUID" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "unspecified", "ATTACH_TIME_FIRST", "ATTACH_TIME_LAST", "FREE_SPACE_MAX", "TOTAL_SPACE_MAX", "VOLUME_UUID" ], "type": "string" } }, "required": [ "value", "possible_values", "data" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "FB_FilenameTimezoneSelectionValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "unspecified", "UTC", "LOCALTIME" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "unspecified", "UTC", "LOCALTIME" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "FB_Socket": { "additionalProperties": false, "properties": { "sdt_service_provider": { "type": "string" } }, "required": [ "sdt_service_provider" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "FTPProtocolValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "FTP", "SFTP" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "FTP", "SFTP" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "FTPUpload": { "additionalProperties": false, "properties": { "bytes_uploaded": { "type": "integer" }, "delete_file_after_upload": { "type": "boolean" }, "enable": { "type": "boolean" }, "file_path": { "type": "string" }, "files_remaining": { "type": "integer" }, "password": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "$ref": "#/components/schemas/FTPProtocolValidation" }, "seconds_elapsed": { "type": "number" }, "server": { "type": "string" }, "sftp_key": { "type": "string" }, "status": { "enum": [ "FTP_NO_ERROR", "FTP_SUCCESS", "FTP_SUCCESS_UPLOAD_IN_PROGRESS", "FTP_FAILURE", "FTP_FAILURE_SERVER_UNREACHABLE", "FTP_FAILURE_CONNECTION_TIMED_OUT", "FTP_FAILURE_AUTHENTICATION", "FTP_FAILURE_AUTHORIZATION", "FTP_FAILURE_SERVER_DISK_FULL", "FTP_FAILURE_CANCELLED", "FTP_FAILURE_STORAGE_DEVICE_TOO_SLOW", "FTP_FAILURE_SFTP_KEY" ], "type": "string" }, "total_bytes": { "type": "integer" }, "username": { "type": "string" } }, "required": [ "enable", "protocol", "sftp_key", "server", "port", "username", "password", "file_path", "delete_file_after_upload", "bytes_uploaded", "total_bytes", "seconds_elapsed", "files_remaining", "status" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "FileFormatValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "MP4", "TS", "FMP4", "F4V" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "MP4", "TS", "FMP4", "F4V" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "FileRecord": { "additionalProperties": false, "properties": { "available_drives": { "items": { "$ref": "#/components/schemas/FileRecordDevice" }, "type": "array" }, "delete_oldest_when_full": { "type": "boolean" }, "device_selection_policy": { "$ref": "#/components/schemas/FB_BlockDeviceSelectionPolicyValidation" }, "file_format": { "$ref": "#/components/schemas/FileFormatValidation" }, "filename_base": { "type": "string" }, "filename_timezone": { "$ref": "#/components/schemas/FB_FilenameTimezoneSelectionValidation" }, "ftp_upload": { "$ref": "#/components/schemas/FTPUpload" }, "limit_max_file_size": { "$ref": "#/components/schemas/LimitMaxFileSize" }, "selected_device_name": { "type": "string" }, "status": { "enum": [ "FILE_NO_ERROR", "FILE_NO_STORAGE_DEVICE", "FILE_UNKNOWN_FILESYSTEM", "FILE_STORAGE_DEVICE_FULL", "FILE_UNMOUNTING", "FILE_UNMOUNT_ERROR", "FILE_STORAGE_DEVICE_TOO_SLOW", "FILE_STORAGE_UNMOUNTABLE", "FILE_NO_VIDEO_SOURCE", "FILE_NO_AUDIO_SOURCE", "FILE_NO_AV_SOURCE", "FILE_CODEC_ERROR", "FILE_UNKNOWN_FAILURE", "FILE_AVINPUT_MISMATCH_ERROR" ], "type": "string" } }, "required": [ "filename_base", "filename_timezone", "selected_device_name", "status", "file_format", "delete_oldest_when_full", "limit_max_file_size", "device_selection_policy", "available_drives", "ftp_upload" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "FileRecordDevice": { "additionalProperties": false, "properties": { "free_space": { "type": "integer" }, "size": { "type": "integer" }, "type": { "type": "string" }, "uuid": { "type": "string" } }, "required": [ "uuid", "type", "size", "free_space" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "GraphicOverlayConfiguration": { "additionalProperties": false, "properties": { "enable": { "type": "boolean" }, "image_status": { "enum": [ "NO_IMAGE", "INVALID_FORMAT", "INVALID_RESOLUTION", "LOADED", "PENDING", "FAILURE" ], "type": "string" }, "position": { "$ref": "#/components/schemas/GraphicOverlayPositionConfiguration" } }, "required": [ "enable", "position", "image_status" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "GraphicOverlayLockAspectValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "NO_LOCK", "LOCK_TO_WIDTH", "LOCK_TO_HEIGHT" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "NO_LOCK", "LOCK_TO_WIDTH", "LOCK_TO_HEIGHT" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "GraphicOverlayPosPresetValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "MANUAL", "FULLSCREEN", "LOWER_THIRD", "TOP_LEFT", "BOTTOM_LEFT", "TOP_CENTER", "CENTER", "BOTTOM_CENTER", "TOP_RIGHT", "BOTTOM_RIGHT" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "MANUAL", "FULLSCREEN", "LOWER_THIRD", "TOP_LEFT", "BOTTOM_LEFT", "TOP_CENTER", "CENTER", "BOTTOM_CENTER", "TOP_RIGHT", "BOTTOM_RIGHT" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "GraphicOverlayPositionConfiguration": { "additionalProperties": false, "properties": { "height": { "type": "integer" }, "lock_aspect_ratio": { "$ref": "#/components/schemas/GraphicOverlayLockAspectValidation" }, "lock_resolution_ratio": { "$ref": "#/components/schemas/GraphicOverlayLockAspectValidation" }, "preset": { "$ref": "#/components/schemas/GraphicOverlayPosPresetValidation" }, "width": { "type": "integer" }, "x": { "type": "integer" }, "y": { "type": "integer" } }, "required": [ "x", "y", "width", "height", "lock_resolution_ratio", "lock_aspect_ratio", "preset" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "H264LevelValidation": { "additionalProperties": false, "properties": { "value": { "enum": [ "LVL3", "LVL3P1", "LVL3P2", "LVL4", "LVL4P1", "LVL4P2", "LVL5", "LVL5P1", "LVL5P2" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "H264ProfileValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "PROFILE_HIGH", "PROFILE_MAIN", "PROFILE_BASELINE" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "PROFILE_HIGH", "PROFILE_MAIN", "PROFILE_BASELINE" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "H264Validation": { "additionalProperties": false, "properties": { "level": { "$ref": "#/components/schemas/H264LevelValidation" }, "profile": { "$ref": "#/components/schemas/H264ProfileValidation" } }, "required": [ "profile", "level" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "H265LevelValidation": { "additionalProperties": false, "properties": { "value": { "enum": [ "LVL_1_MAIN", "LVL_2_MAIN", "LVL_2P1_MAIN", "LVL_3_MAIN", "LVL_3P1_MAIN", "LVL_4_MAIN", "LVL_4_HIGH", "LVL_4P1_MAIN", "LVL_4P1_HIGH", "LVL_5_MAIN", "LVL_5_HIGH", "LVL_5P1_MAIN", "LVL_5P1_HIGH" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "H265ProfileValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "PROFILE_MAIN" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "PROFILE_MAIN" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "H265Validation": { "additionalProperties": false, "properties": { "level": { "$ref": "#/components/schemas/H265LevelValidation" }, "profile": { "$ref": "#/components/schemas/H265ProfileValidation" } }, "required": [ "profile", "level" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "HTTPPush": { "additionalProperties": false, "properties": { "manifest_type": { "$ref": "#/components/schemas/ManifestTypeValidation" }, "media_container": { "$ref": "#/components/schemas/FileFormatValidation" }, "number_of_segments": { "minimum": 0, "type": "integer" }, "save_segment_window": { "type": "boolean" }, "segment_length": { "minimum": 0, "type": "integer" }, "service": { "$ref": "#/components/schemas/StreamService" }, "synchronization": { "$ref": "#/components/schemas/SyncValidation" }, "ultra_low_latency": { "$ref": "#/components/schemas/ULLValidation" } }, "required": [ "manifest_type", "media_container", "segment_length", "number_of_segments", "save_segment_window", "service", "synchronization", "ultra_low_latency" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "HardwareInput": { "additionalProperties": false, "properties": { "hw_channel": { "type": "integer" } }, "required": [ "hw_channel" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "IdResponse": { "additionalProperties": false, "example": { "id": 1 }, "properties": { "id": { "type": "integer" } }, "required": [ "id" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "InputChannel": { "additionalProperties": false, "properties": { "in_channel_id": { "type": "integer" }, "input_type": { "enum": [ "notConfigured", "hardware", "gstreamer" ], "type": "string" }, "status": { "$ref": "#/components/schemas/InputChannelStatus" } }, "required": [ "in_channel_id", "input_type", "status" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "InputChannelAudioStatus": { "additionalProperties": false, "properties": { "detected": { "type": "boolean" } }, "required": [ "detected" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "InputChannelConfiguration": { "additionalProperties": false, "properties": { "aud_channels_to_ignore_changes": { "items": { "type": "integer" }, "type": "array" }, "audio_input": { "$ref": "#/components/schemas/AudioInputValidation" }, "connection_caps": { "$ref": "#/components/schemas/ConnectionCapabilities" }, "enable_persistent_input": { "type": "boolean" }, "force_av_mute": { "type": "boolean" }, "graphic_overlay": { "$ref": "#/components/schemas/GraphicOverlayConfiguration" }, "in_channel_id": { "type": "integer" }, "input_type": { "$ref": "#/components/schemas/InputType" }, "locked": { "type": "boolean" }, "name": { "type": "string" }, "video_input": { "$ref": "#/components/schemas/VideoInputValidation" }, "video_rotation": { "$ref": "#/components/schemas/VideoRotationValidation" } }, "required": [ "in_channel_id", "locked", "audio_input", "video_input", "graphic_overlay", "video_rotation", "name", "input_type", "connection_caps", "enable_persistent_input", "force_av_mute", "aud_channels_to_ignore_changes" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "InputChannelConfigurationWriteRequest": { "additionalProperties": false, "properties": { "aud_channels_to_ignore_changes": { "items": { "type": "integer" }, "type": "array" }, "audio_input": { "additionalProperties": false, "properties": { "detected": { "type": "boolean" }, "sdi_ignore_phase": { "type": "boolean" }, "value": { "enum": [ "input_embedded", "input_3p5mm", "input_auto", "input_hdmi", "input_sdi", "input_tpg" ], "type": "string" } }, "required": [ "value", "detected", "sdi_ignore_phase" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "connection_caps": { "additionalProperties": false, "properties": { "consumer_caps": { "items": { "enum": [ "RAW_VIDEO", "RAW_AUDIO", "ES_VIDEO_H264", "ES_VIDEO_H265", "ES_VIDEO_MJPEG", "ES_AUDIO_AAC_MPEG4_ADTS", "ES_AUDIO_OPUS", "DATA_SMPTE291", "DATA_SMPTE291_10BIT_SCTE_104", "DATA_SMPTE2038", "DATA_MPEGTS_METADATA_AU_WRAPPER_KLV_SYNC" ], "type": "string" }, "type": "array" }, "producer_caps": { "items": { "enum": [ "RAW_VIDEO", "RAW_AUDIO", "ES_VIDEO_H264", "ES_VIDEO_H265", "ES_VIDEO_MJPEG", "ES_AUDIO_AAC_MPEG4_ADTS", "ES_AUDIO_OPUS", "DATA_SMPTE291", "DATA_SMPTE291_10BIT_SCTE_104", "DATA_SMPTE2038", "DATA_MPEGTS_METADATA_AU_WRAPPER_KLV_SYNC" ], "type": "string" }, "type": "array" } }, "required": [ "consumer_caps", "producer_caps" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "enable_persistent_input": { "type": "boolean" }, "force_av_mute": { "type": "boolean" }, "graphic_overlay": { "additionalProperties": false, "properties": { "enable": { "type": "boolean" }, "position": { "additionalProperties": false, "properties": { "height": { "type": "integer" }, "lock_aspect_ratio": { "additionalProperties": false, "properties": { "value": { "enum": [ "NO_LOCK", "LOCK_TO_WIDTH", "LOCK_TO_HEIGHT" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "lock_resolution_ratio": { "additionalProperties": false, "properties": { "value": { "enum": [ "NO_LOCK", "LOCK_TO_WIDTH", "LOCK_TO_HEIGHT" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "preset": { "additionalProperties": false, "properties": { "value": { "enum": [ "MANUAL", "FULLSCREEN", "LOWER_THIRD", "TOP_LEFT", "BOTTOM_LEFT", "TOP_CENTER", "CENTER", "BOTTOM_CENTER", "TOP_RIGHT", "BOTTOM_RIGHT" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "width": { "type": "integer" }, "x": { "type": "integer" }, "y": { "type": "integer" } }, "required": [ "x", "y", "width", "height", "lock_resolution_ratio", "lock_aspect_ratio", "preset" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" } }, "required": [ "enable", "position" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "in_channel_id": { "type": "integer" }, "input_type": { "additionalProperties": false, "properties": { "hardware": { "additionalProperties": false, "properties": { "hw_channel": { "type": "integer" } }, "required": [ "hw_channel" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "value": { "enum": [ "notConfigured", "hardware", "gstreamer" ], "type": "string" } }, "required": [ "value", "hardware" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "locked": { "type": "boolean" }, "name": { "type": "string" }, "video_input": { "additionalProperties": false, "properties": { "detected_format": { "additionalProperties": false, "properties": { "value": { "enum": [ "FORMAT_UNDEFINED", "FORMAT_180p2398", "FORMAT_180p24", "FORMAT_180p25", "FORMAT_180p2997", "FORMAT_180p30", "FORMAT_180p50", "FORMAT_180p5994", "FORMAT_180p60", "FORMAT_270p2398", "FORMAT_270p24", "FORMAT_270p25", "FORMAT_270p2997", "FORMAT_270p30", "FORMAT_270p50", "FORMAT_270p5994", "FORMAT_270p60", "FORMAT_360p2398", "FORMAT_360p24", "FORMAT_360p25", "FORMAT_360p2997", "FORMAT_360p30", "FORMAT_360p50", "FORMAT_360p5994", "FORMAT_360p60", "FORMAT_480i5994", "FORMAT_480i60", "FORMAT_480p2398", "FORMAT_480p24", "FORMAT_480p25", "FORMAT_480p50", "FORMAT_480p2997", "FORMAT_480p30", "FORMAT_480p5994", "FORMAT_480p60", "FORMAT_576i50", "FORMAT_576p2398", "FORMAT_576p24", "FORMAT_576p25", "FORMAT_576p50", "FORMAT_576p2997", "FORMAT_576p30", "FORMAT_576p5994", "FORMAT_576p60", "FORMAT_540p2398", "FORMAT_540p24", "FORMAT_540p25", "FORMAT_540p2997", "FORMAT_540p30", "FORMAT_540p50", "FORMAT_540p5994", "FORMAT_540p60", "FORMAT_720p2398", "FORMAT_720p24", "FORMAT_720p25", "FORMAT_720p2997", "FORMAT_720p30", "FORMAT_720p50", "FORMAT_720p5994", "FORMAT_720p60", "FORMAT_1080i50", "FORMAT_1080i5994", "FORMAT_1080i60", "FORMAT_1080p2398", "FORMAT_1080p24", "FORMAT_1080p25", "FORMAT_1080p2997", "FORMAT_1080p30", "FORMAT_1080p50", "FORMAT_1080p5994", "FORMAT_1080p60", "FORMAT_1200p60", "FORMAT_1440p60", "FORMAT_2160p2398", "FORMAT_2160p24", "FORMAT_2160p25", "FORMAT_2160p2997", "FORMAT_2160p30", "FORMAT_2160p50", "FORMAT_2160p5994", "FORMAT_2160p60" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "value": { "enum": [ "input_hdmi", "input_vga", "input_sdi", "input_auto", "input_tpg" ], "type": "string" } }, "required": [ "value", "detected_format" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "video_rotation": { "additionalProperties": false, "properties": { "value": { "enum": [ "ROTATE_0", "ROTATE_90", "ROTATE_180", "ROTATE_270" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" } }, "required": [ "in_channel_id", "locked", "audio_input", "video_input", "graphic_overlay", "video_rotation", "name", "input_type", "connection_caps", "enable_persistent_input", "force_av_mute", "aud_channels_to_ignore_changes" ], "type": "object", "x-videon-note": "Write-schema projection: excludes runtime/status/range/possible-values fields from request bodies.", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "InputChannelListResponse": { "additionalProperties": false, "properties": { "in_channels": { "items": { "$ref": "#/components/schemas/InputChannel" }, "type": "array" }, "possible_gstreamer_instances": { "type": "integer" }, "possible_hw_channels": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "in_channels", "possible_hw_channels", "possible_gstreamer_instances" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "InputChannelStatus": { "additionalProperties": false, "properties": { "audio": { "$ref": "#/components/schemas/InputChannelAudioStatus" }, "locked": { "type": "boolean" } }, "required": [ "locked", "audio" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "InputType": { "additionalProperties": false, "properties": { "hardware": { "$ref": "#/components/schemas/HardwareInput" }, "value": { "enum": [ "notConfigured", "hardware", "gstreamer" ], "type": "string" } }, "required": [ "value", "hardware" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "KeyInterval": { "additionalProperties": false, "properties": { "interval": { "type": "integer" }, "interval_range_frames": { "$ref": "#/components/schemas/RangeValidation" }, "interval_range_milliseconds": { "$ref": "#/components/schemas/RangeValidation" }, "possible_units": { "items": { "enum": [ "unspecified", "MILLISECONDS", "FRAMES" ], "type": "string" }, "type": "array" }, "unit": { "enum": [ "unspecified", "MILLISECONDS", "FRAMES" ], "type": "string" } }, "required": [ "interval", "unit", "possible_units", "interval_range_frames", "interval_range_milliseconds" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "KlvSync": { "additionalProperties": false, "properties": { "disable_misb1402_timestamps": { "type": "boolean" } }, "required": [ "disable_misb1402_timestamps" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "LimitMaxFileSize": { "additionalProperties": false, "properties": { "enable": { "type": "boolean" }, "value": { "minimum": 0, "type": "integer" } }, "required": [ "enable", "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "ManifestTypeValidation": { "additionalProperties": false, "properties": { "available_protocols": { "items": { "enum": [ "DASH", "HLS" ], "type": "string" }, "type": "array" }, "protocols": { "items": { "enum": [ "DASH", "HLS" ], "type": "string" }, "type": "array" } }, "required": [ "protocols", "available_protocols" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "Multicast": { "additionalProperties": false, "properties": { "multicast_ip": { "type": "string" }, "multicast_port": { "minimum": 0, "type": "integer" }, "protocol": { "enum": [ "unspecified", "RTP", "RAW_UDP", "SRT" ], "type": "string" }, "ttl": { "minimum": 0, "type": "integer" } }, "required": [ "protocol", "multicast_ip", "multicast_port", "ttl" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "NetworkValidation": { "additionalProperties": false, "properties": { "dns_addresses": { "items": { "type": "string" }, "type": "array" }, "gateway": { "type": "string" }, "ip_address": { "type": "string" }, "netmask": { "type": "string" } }, "required": [ "ip_address", "netmask", "gateway", "dns_addresses" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "NtpValidation": { "additionalProperties": false, "properties": { "ntp_server": { "type": "string" }, "timezone": { "type": "string" } }, "required": [ "ntp_server", "timezone" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "Output": { "additionalProperties": false, "properties": { "out_stream_id": { "type": "integer" }, "output_type": { "enum": [ "notConfigured", "multicast", "unicast", "rtmp", "file", "rtsp", "http_push", "thumbnail", "srt", "socket", "zixi", "whip" ], "type": "string" } }, "required": [ "out_stream_id", "output_type" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "OutputStatusObject": { "additionalProperties": false, "properties": { "code": { "enum": [ "OFF", "PENDING", "CONNECTED", "RUNNING", "REMOTE_CLOSED", "ERROR", "ERROR_INTERNAL", "ERROR_AVINPUT_MISMATCH", "ERROR_SOURCE_AV_MISSING", "ERROR_SOURCE_VIDEO_MISSING", "ERROR_SOURCE_AUDIO_MISSING", "ERROR_UNSUPPORTED_CODEC", "ERROR_UNSUPPORTED_BITRATE", "ERROR_UNSUPPORTED_BITRATE_MODE", "ERROR_UNSUPPORTED_RESOLUTION", "ERROR_REMOTE", "ERROR_REMOTE_UNREACHABLE", "ERROR_REMOTE_ACCESS_DENIED", "ERROR_STORAGE_NO_DEVICE", "ERROR_STORAGE_UNSUPPORTED_FILESYSTEM", "ERROR_STORAGE_DEVICE_FULL", "RETRYING", "RETRYING_ENDED", "ERROR_INVALID_CONFIG" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "OutputStreamConfiguration": { "additionalProperties": false, "properties": { "audio_source": { "$ref": "#/components/schemas/AudioSourceValidationDeprecated" }, "audio_sources": { "$ref": "#/components/schemas/AudioSourceValidation" }, "connection_caps": { "$ref": "#/components/schemas/ConnectionCapabilities" }, "data_sources": { "$ref": "#/components/schemas/DataSourceObject" }, "enable": { "type": "boolean" }, "enable_retry": { "type": "boolean" }, "name": { "type": "string" }, "out_stream_id": { "type": "integer" }, "output_type": { "$ref": "#/components/schemas/OutputType" }, "status": { "$ref": "#/components/schemas/OutputStatusObject" }, "unlimited_retries": { "type": "boolean" }, "video_source": { "$ref": "#/components/schemas/VideoSourceValidationDeprecated" }, "video_sources": { "$ref": "#/components/schemas/VideoSourceValidation" } }, "required": [ "out_stream_id", "enable", "audio_sources", "video_sources", "output_type", "audio_source", "video_source", "name", "status", "connection_caps", "data_sources", "enable_retry", "unlimited_retries" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "OutputStreamConfigurationWriteRequest": { "additionalProperties": false, "properties": { "audio_source": { "additionalProperties": false, "properties": { "audio_source_id": { "type": "integer" } }, "required": [ "audio_source_id" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "audio_sources": { "additionalProperties": false, "properties": { "audio_source_ids": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "audio_source_ids" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "connection_caps": { "additionalProperties": false, "properties": { "consumer_caps": { "items": { "enum": [ "RAW_VIDEO", "RAW_AUDIO", "ES_VIDEO_H264", "ES_VIDEO_H265", "ES_VIDEO_MJPEG", "ES_AUDIO_AAC_MPEG4_ADTS", "ES_AUDIO_OPUS", "DATA_SMPTE291", "DATA_SMPTE291_10BIT_SCTE_104", "DATA_SMPTE2038", "DATA_MPEGTS_METADATA_AU_WRAPPER_KLV_SYNC" ], "type": "string" }, "type": "array" }, "producer_caps": { "items": { "enum": [ "RAW_VIDEO", "RAW_AUDIO", "ES_VIDEO_H264", "ES_VIDEO_H265", "ES_VIDEO_MJPEG", "ES_AUDIO_AAC_MPEG4_ADTS", "ES_AUDIO_OPUS", "DATA_SMPTE291", "DATA_SMPTE291_10BIT_SCTE_104", "DATA_SMPTE2038", "DATA_MPEGTS_METADATA_AU_WRAPPER_KLV_SYNC" ], "type": "string" }, "type": "array" } }, "required": [ "consumer_caps", "producer_caps" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "data_sources": { "additionalProperties": false, "properties": { "data_source_ids": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "data_source_ids" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "enable": { "type": "boolean" }, "enable_retry": { "type": "boolean" }, "name": { "type": "string" }, "out_stream_id": { "type": "integer" }, "output_type": { "additionalProperties": false, "properties": { "file_record": { "additionalProperties": false, "properties": { "delete_oldest_when_full": { "type": "boolean" }, "device_selection_policy": { "additionalProperties": false, "properties": { "data": { "type": "string" }, "value": { "enum": [ "unspecified", "ATTACH_TIME_FIRST", "ATTACH_TIME_LAST", "FREE_SPACE_MAX", "TOTAL_SPACE_MAX", "VOLUME_UUID" ], "type": "string" } }, "required": [ "value", "data" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "file_format": { "additionalProperties": false, "properties": { "value": { "enum": [ "MP4", "TS", "FMP4", "F4V" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "filename_base": { "type": "string" }, "filename_timezone": { "additionalProperties": false, "properties": { "value": { "enum": [ "unspecified", "UTC", "LOCALTIME" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "ftp_upload": { "additionalProperties": false, "properties": { "bytes_uploaded": { "type": "integer" }, "delete_file_after_upload": { "type": "boolean" }, "enable": { "type": "boolean" }, "file_path": { "type": "string" }, "files_remaining": { "type": "integer" }, "password": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "additionalProperties": false, "properties": { "value": { "enum": [ "FTP", "SFTP" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "seconds_elapsed": { "type": "number" }, "server": { "type": "string" }, "sftp_key": { "type": "string" }, "total_bytes": { "type": "integer" }, "username": { "type": "string" } }, "required": [ "enable", "protocol", "sftp_key", "server", "port", "username", "password", "file_path", "delete_file_after_upload", "bytes_uploaded", "total_bytes", "seconds_elapsed", "files_remaining" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "limit_max_file_size": { "additionalProperties": false, "properties": { "enable": { "type": "boolean" }, "value": { "minimum": 0, "type": "integer" } }, "required": [ "enable", "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "selected_device_name": { "type": "string" } }, "required": [ "filename_base", "filename_timezone", "selected_device_name", "file_format", "delete_oldest_when_full", "limit_max_file_size", "device_selection_policy", "ftp_upload" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "http_push": { "additionalProperties": false, "properties": { "manifest_type": { "additionalProperties": false, "properties": { "protocols": { "items": { "enum": [ "DASH", "HLS" ], "type": "string" }, "type": "array" } }, "required": [ "protocols" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "media_container": { "additionalProperties": false, "properties": { "value": { "enum": [ "MP4", "TS", "FMP4", "F4V" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "number_of_segments": { "minimum": 0, "type": "integer" }, "save_segment_window": { "type": "boolean" }, "segment_length": { "minimum": 0, "type": "integer" }, "service": { "additionalProperties": false, "properties": { "data": { "type": "string" }, "value": { "type": "string" } }, "required": [ "value", "data" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "synchronization": { "additionalProperties": false, "properties": { "dash_presentation_delay": { "minimum": 0, "type": "integer" }, "dash_time_service": { "type": "string" }, "enable": { "type": "boolean" } }, "required": [ "enable", "dash_presentation_delay", "dash_time_service" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "ultra_low_latency": { "additionalProperties": false, "properties": { "chunk_interval": { "additionalProperties": false, "properties": { "interval": { "minimum": 0, "type": "integer" }, "possible_units": { "items": { "enum": [ "unspecified", "MILLISECONDS", "FRAMES" ], "type": "string" }, "type": "array" }, "unit": { "enum": [ "unspecified", "MILLISECONDS", "FRAMES" ], "type": "string" } }, "required": [ "interval", "unit", "possible_units" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "enable": { "type": "boolean" }, "target_latency_ms": { "type": "integer" } }, "required": [ "enable", "chunk_interval", "target_latency_ms" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" } }, "required": [ "manifest_type", "media_container", "segment_length", "number_of_segments", "save_segment_window", "service", "synchronization", "ultra_low_latency" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "multicast": { "additionalProperties": false, "properties": { "multicast_ip": { "type": "string" }, "multicast_port": { "minimum": 0, "type": "integer" }, "protocol": { "enum": [ "unspecified", "RTP", "RAW_UDP", "SRT" ], "type": "string" }, "ttl": { "minimum": 0, "type": "integer" } }, "required": [ "protocol", "multicast_ip", "multicast_port", "ttl" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "rtmp": { "additionalProperties": false, "properties": { "service": { "additionalProperties": false, "properties": { "data": { "type": "string" }, "value": { "type": "string" } }, "required": [ "value", "data" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" } }, "required": [ "service" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "rtsp": { "additionalProperties": false, "properties": { "server_port": { "minimum": 0, "type": "integer" }, "stream_name": { "type": "string" } }, "required": [ "stream_name", "server_port" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "socket": { "additionalProperties": false, "properties": { "sdt_service_provider": { "type": "string" } }, "required": [ "sdt_service_provider" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "srt": { "additionalProperties": false, "properties": { "bw_overhead": { "type": "integer" }, "call_mode": { "additionalProperties": false, "properties": { "value": { "enum": [ "CALLER", "LISTENER" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "dest_ip": { "type": "string" }, "dest_port": { "minimum": 0, "type": "integer" }, "encryption_enabled": { "type": "boolean" }, "key_size": { "additionalProperties": false, "properties": { "value": { "enum": [ "NONE", "AES128", "AES192", "AES256" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "latency": { "type": "integer" }, "passphrase": { "type": "string" }, "protocol": { "enum": [ "unspecified", "RTP", "RAW_UDP", "SRT" ], "type": "string" }, "stream_id": { "type": "string" } }, "required": [ "dest_ip", "dest_port", "latency", "passphrase", "bw_overhead", "key_size", "protocol", "stream_id", "call_mode", "encryption_enabled" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "thumbnail": { "additionalProperties": false, "properties": { "interval": { "additionalProperties": false, "properties": { "value": { "minimum": 0, "type": "integer" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "width": { "additionalProperties": false, "properties": { "value": { "minimum": 0, "type": "integer" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" } }, "required": [ "interval", "width" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "unicast": { "additionalProperties": false, "properties": { "destination_ip": { "type": "string" }, "destination_port": { "minimum": 0, "type": "integer" }, "protocol": { "enum": [ "unspecified", "RTP", "RAW_UDP", "SRT" ], "type": "string" } }, "required": [ "protocol", "destination_ip", "destination_port" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "value": { "enum": [ "notConfigured", "multicast", "unicast", "rtmp", "file", "rtsp", "http_push", "thumbnail", "srt", "socket", "zixi", "whip" ], "type": "string" }, "whip": { "additionalProperties": false, "properties": { "service": { "additionalProperties": false, "properties": { "data": { "type": "string" }, "value": { "type": "string" } }, "required": [ "value", "data" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" } }, "required": [ "service" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "zixi": { "additionalProperties": false, "properties": { "destination_ip": { "type": "string" }, "destination_port": { "type": "integer" }, "dtls": { "additionalProperties": false, "properties": { "dtls_cert_exist": { "type": "boolean" }, "ignore_dtls_cert_error": { "type": "boolean" } }, "required": [ "dtls_cert_exist", "ignore_dtls_cert_error" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "enable_back_pressure_bitrate_adjustment": { "type": "boolean" }, "encryption_enabled": { "type": "boolean" }, "encryption_key": { "type": "string" }, "fec_percentage": { "type": "integer" }, "key_size": { "additionalProperties": false, "properties": { "value": { "enum": [ "AES128", "AES192", "AES256" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "passphrase": { "type": "string" }, "stream_id": { "type": "string" } }, "required": [ "destination_ip", "destination_port", "fec_percentage", "passphrase", "key_size", "stream_id", "encryption_enabled", "encryption_key", "enable_back_pressure_bitrate_adjustment", "dtls" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" } }, "required": [ "value", "unicast", "multicast", "rtsp", "rtmp", "http_push", "file_record", "thumbnail", "srt", "socket", "zixi", "whip" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "unlimited_retries": { "type": "boolean" }, "video_source": { "additionalProperties": false, "properties": { "video_source_id": { "type": "integer" } }, "required": [ "video_source_id" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "video_sources": { "additionalProperties": false, "properties": { "video_source_ids": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "video_source_ids" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" } }, "required": [ "out_stream_id", "enable", "audio_sources", "video_sources", "output_type", "audio_source", "video_source", "name", "connection_caps", "data_sources", "enable_retry", "unlimited_retries" ], "type": "object", "x-videon-note": "Write-schema projection: excludes runtime/status/range/possible-values fields from request bodies.", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "OutputStreamListResponse": { "additionalProperties": false, "properties": { "max_file_record": { "type": "integer" }, "max_http_push": { "type": "integer" }, "max_multicast": { "type": "integer" }, "max_rtmp": { "type": "integer" }, "max_rtsp": { "type": "integer" }, "max_socket": { "type": "integer" }, "max_srt": { "type": "integer" }, "max_thumbnail": { "type": "integer" }, "max_unicast": { "type": "integer" }, "max_whip": { "type": "integer" }, "max_zixi": { "type": "integer" }, "out_streams": { "items": { "$ref": "#/components/schemas/Output" }, "type": "array" } }, "required": [ "out_streams", "max_unicast", "max_multicast", "max_rtsp", "max_rtmp", "max_file_record", "max_http_push", "max_srt", "max_zixi", "max_thumbnail", "max_socket", "max_whip" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "OutputType": { "additionalProperties": false, "properties": { "file_record": { "$ref": "#/components/schemas/FileRecord" }, "http_push": { "$ref": "#/components/schemas/HTTPPush" }, "multicast": { "$ref": "#/components/schemas/Multicast" }, "rtmp": { "$ref": "#/components/schemas/RTMP" }, "rtsp": { "$ref": "#/components/schemas/RTSP" }, "socket": { "$ref": "#/components/schemas/FB_Socket" }, "srt": { "$ref": "#/components/schemas/SRT" }, "thumbnail": { "$ref": "#/components/schemas/Thumbnail" }, "unicast": { "$ref": "#/components/schemas/Unicast" }, "value": { "enum": [ "notConfigured", "multicast", "unicast", "rtmp", "file", "rtsp", "http_push", "thumbnail", "srt", "socket", "zixi", "whip" ], "type": "string" }, "whip": { "$ref": "#/components/schemas/WHIP" }, "zixi": { "$ref": "#/components/schemas/Zixi" } }, "required": [ "value", "unicast", "multicast", "rtsp", "rtmp", "http_push", "file_record", "thumbnail", "srt", "socket", "zixi", "whip" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "OverlayGraphicResponse": { "format": "binary", "type": "string" }, "OverlayGraphicUploadRequest": { "properties": { "file": { "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" }, "PlainTextResponse": { "type": "string" }, "RTMP": { "additionalProperties": false, "properties": { "service": { "$ref": "#/components/schemas/StreamService" }, "status": { "enum": [ "STREAM_OFF", "STREAM_PENDING", "STREAM_UNREACHABLE", "STREAM_ACCESS_DENIED", "STREAM_CONNECT_ERROR", "STREAM_CODEC_ERROR", "STREAM_CONNECTED", "STREAM_RUNNING", "STREAM_REMUX_ERROR", "STREAM_SERVER_CLOSED", "STREAM_BITRATE_UNSUPPORTED", "STREAM_BITRATE_MODE_UNSUPPORTED", "STREAM_RESOLUTION_UNSUPPORTED", "STREAM_AVINPUT_MISMATCH_ERROR", "STREAM_INVALID_CONFIG", "AUTH_OFF", "AUTH_PENDING", "AUTH_FAILED", "AUTH_SUCCESS" ], "type": "string" } }, "required": [ "status", "service" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "RTSP": { "additionalProperties": false, "properties": { "server_port": { "minimum": 0, "type": "integer" }, "stream_name": { "type": "string" } }, "required": [ "stream_name", "server_port" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "RangeValidation": { "additionalProperties": false, "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "required": [ "min", "max" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "RestActionResponseData": { "additionalProperties": false, "properties": { "result": { "type": "string" } }, "required": [ "result" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "RestKlvElement": { "additionalProperties": false, "properties": { "blob": { "type": "string" }, "enumerated": { "$ref": "#/components/schemas/RestKlvEnumeratedPayload" }, "value": { "type": "string" } }, "required": [ "value", "blob", "enumerated" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "RestKlvEnumeratedPayload": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "length": { "type": "integer" }, "value": { "type": "string" } }, "required": [ "key", "length", "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "RestSpliceCommandVariant": { "additionalProperties": false, "properties": { "splice_insert": { "$ref": "#/components/schemas/RestSpliceInsertPayload" }, "time_signal": { "$ref": "#/components/schemas/RestTimeSignalPayload" }, "value": { "type": "string" } }, "required": [ "value", "splice_insert", "time_signal" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "RestSpliceInsertPayload": { "additionalProperties": false, "properties": { "duration_msec": { "minimum": 0, "type": "integer" }, "preroll_time_msec": { "minimum": 0, "type": "integer" }, "splice_event_id": { "minimum": 0, "type": "integer" } }, "required": [ "splice_event_id", "preroll_time_msec", "duration_msec" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "RestTimeSignalPayload": { "additionalProperties": false, "properties": { "preroll_time_msec": { "minimum": 0, "type": "integer" }, "segment_num": { "maximum": 255, "minimum": 0, "type": "integer" }, "segmentation_descriptor": { "type": "string" }, "segmentation_event_id": { "minimum": 0, "type": "integer" }, "segmentation_type_id": { "maximum": 255, "minimum": 0, "type": "integer" } }, "required": [ "segmentation_event_id", "preroll_time_msec", "segmentation_descriptor", "segmentation_type_id", "segment_num" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "SCTE35Codec": { "additionalProperties": false, "properties": { "splice_duration": { "type": "integer" } }, "required": [ "splice_duration" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "SMPTE2038Codec": { "additionalProperties": false, "properties": { "stop_processing": { "type": "boolean" } }, "required": [ "stop_processing" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "SRT": { "additionalProperties": false, "properties": { "bw_overhead": { "type": "integer" }, "call_mode": { "$ref": "#/components/schemas/SRTCallModeValidation" }, "dest_ip": { "type": "string" }, "dest_port": { "minimum": 0, "type": "integer" }, "encryption_enabled": { "type": "boolean" }, "key_size": { "$ref": "#/components/schemas/SRTKeySizeValidation" }, "latency": { "type": "integer" }, "passphrase": { "type": "string" }, "protocol": { "enum": [ "unspecified", "RTP", "RAW_UDP", "SRT" ], "type": "string" }, "status": { "enum": [ "STREAM_OFF", "STREAM_PENDING", "STREAM_UNREACHABLE", "STREAM_ACCESS_DENIED", "STREAM_CONNECT_ERROR", "STREAM_CONNECTED", "STREAM_RUNNING", "STREAM_AVINPUT_MISMATCH_ERROR", "STREAM_INVALID_CONFIG" ], "type": "string" }, "stream_id": { "type": "string" } }, "required": [ "status", "dest_ip", "dest_port", "latency", "passphrase", "bw_overhead", "key_size", "protocol", "stream_id", "call_mode", "encryption_enabled" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "SRTCallModeValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "CALLER", "LISTENER" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "CALLER", "LISTENER" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "SRTKeySizeValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "NONE", "AES128", "AES192", "AES256" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "NONE", "AES128", "AES192", "AES256" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "StaticNetworkValidation": { "additionalProperties": false, "properties": { "dns_address": { "type": "string" }, "dns_addresses": { "items": { "type": "string" }, "type": "array" }, "gateway": { "type": "string" }, "ip_address": { "type": "string" }, "netmask": { "type": "string" } }, "required": [ "ip_address", "netmask", "gateway", "dns_address", "dns_addresses" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "StorageDeviceListResponse": { "oneOf": [ { "description": "Canonical runtime shape: bare JSON array of entities.", "items": { "$ref": "#/components/schemas/StorageDeviceResponse" }, "type": "array" }, { "additionalProperties": false, "description": "Alternate wrapped list shape for compatibility.", "properties": { "storage": { "items": { "$ref": "#/components/schemas/StorageDeviceResponse" }, "type": "array" } }, "required": [ "storage" ], "type": "object" } ], "x-videon-listResponseCanonical": "bare_array", "x-videon-source": "configuration_generated.fbs" }, "StorageDeviceResponse": { "additionalProperties": false, "properties": { "devno": { "minimum": 0, "type": "integer" }, "devpath": { "type": "string" }, "devtime_us": { "type": "integer" }, "disk_devno": { "minimum": 0, "type": "integer" }, "fslimits": { "$ref": "#/components/schemas/StorageFsLimits" }, "fstype": { "type": "string" }, "kind": { "type": "string" }, "label": { "type": "string" }, "model": { "type": "string" }, "mount": { "$ref": "#/components/schemas/StorageMount" }, "partno": { "type": "integer" }, "size_bytes": { "type": "integer" }, "syspath": { "type": "string" }, "type": { "type": "string" }, "usage": { "type": "string" }, "uuid": { "type": "string" }, "vendor": { "type": "string" }, "version": { "type": "string" } }, "required": [ "devpath", "syspath", "devno", "devtime_us", "fstype", "version", "label", "uuid", "usage", "kind", "disk_devno", "partno", "type", "vendor", "model", "size_bytes", "mount", "fslimits" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "StorageFsLimits": { "additionalProperties": false, "properties": { "max_file_size_bytes": { "type": "integer" }, "max_filename_length": { "type": "integer" }, "max_path_length": { "type": "integer" }, "max_volume_size_bytes": { "type": "integer" } }, "required": [ "max_volume_size_bytes", "max_file_size_bytes", "max_filename_length", "max_path_length" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "StorageMount": { "additionalProperties": false, "properties": { "avail_bytes": { "type": "integer" }, "blocksize_bytes": { "type": "integer" }, "devno": { "minimum": 0, "type": "integer" }, "dir": { "type": "string" }, "freq": { "type": "integer" }, "fsname": { "type": "string" }, "opts": { "type": "string" }, "passno": { "type": "integer" }, "size_bytes": { "type": "integer" }, "type": { "type": "string" } }, "required": [ "devno", "fsname", "dir", "type", "opts", "freq", "passno", "size_bytes", "avail_bytes", "blocksize_bytes" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "StreamBitrateModeValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "constant", "variable", "constant_strict" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "constant", "variable", "constant_strict" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "StreamService": { "additionalProperties": false, "properties": { "data": { "type": "string" }, "possible_values": { "items": { "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "type": "string" } }, "required": [ "value", "possible_values", "data" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "SyncGroup": { "additionalProperties": false, "properties": { "active": { "type": "boolean" }, "sync_group_id": { "type": "integer" } }, "required": [ "sync_group_id", "active" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "SyncGroupConfiguration": { "additionalProperties": false, "properties": { "active": { "type": "boolean" }, "connection_caps": { "$ref": "#/components/schemas/ConnectionCapabilities" }, "encoder_ids": { "items": { "type": "integer" }, "type": "array" }, "in_channel_id": { "type": "integer" }, "keyframe_interval": { "$ref": "#/components/schemas/KeyInterval" }, "latency_mode": { "$ref": "#/components/schemas/VidLatencyModeValidation" }, "limit_to_30_fps": { "type": "boolean" }, "name": { "type": "string" }, "sync_group_id": { "type": "integer" } }, "required": [ "name", "sync_group_id", "in_channel_id", "encoder_ids", "keyframe_interval", "limit_to_30_fps", "latency_mode", "active", "connection_caps" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "SyncGroupConfigurationWriteRequest": { "additionalProperties": false, "properties": { "active": { "type": "boolean" }, "connection_caps": { "additionalProperties": false, "properties": { "consumer_caps": { "items": { "enum": [ "RAW_VIDEO", "RAW_AUDIO", "ES_VIDEO_H264", "ES_VIDEO_H265", "ES_VIDEO_MJPEG", "ES_AUDIO_AAC_MPEG4_ADTS", "ES_AUDIO_OPUS", "DATA_SMPTE291", "DATA_SMPTE291_10BIT_SCTE_104", "DATA_SMPTE2038", "DATA_MPEGTS_METADATA_AU_WRAPPER_KLV_SYNC" ], "type": "string" }, "type": "array" }, "producer_caps": { "items": { "enum": [ "RAW_VIDEO", "RAW_AUDIO", "ES_VIDEO_H264", "ES_VIDEO_H265", "ES_VIDEO_MJPEG", "ES_AUDIO_AAC_MPEG4_ADTS", "ES_AUDIO_OPUS", "DATA_SMPTE291", "DATA_SMPTE291_10BIT_SCTE_104", "DATA_SMPTE2038", "DATA_MPEGTS_METADATA_AU_WRAPPER_KLV_SYNC" ], "type": "string" }, "type": "array" } }, "required": [ "consumer_caps", "producer_caps" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "encoder_ids": { "items": { "type": "integer" }, "type": "array" }, "in_channel_id": { "type": "integer" }, "keyframe_interval": { "additionalProperties": false, "properties": { "interval": { "type": "integer" }, "interval_range_frames": { "additionalProperties": false, "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "required": [ "min", "max" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "interval_range_milliseconds": { "additionalProperties": false, "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "required": [ "min", "max" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "possible_units": { "items": { "enum": [ "unspecified", "MILLISECONDS", "FRAMES" ], "type": "string" }, "type": "array" }, "unit": { "enum": [ "unspecified", "MILLISECONDS", "FRAMES" ], "type": "string" } }, "required": [ "interval", "unit", "possible_units", "interval_range_frames", "interval_range_milliseconds" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "latency_mode": { "additionalProperties": false, "properties": { "value": { "enum": [ "NORMAL", "LOW", "LOWEST", "REALTIME", "HIGH" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "limit_to_30_fps": { "type": "boolean" }, "name": { "type": "string" }, "sync_group_id": { "type": "integer" } }, "required": [ "name", "sync_group_id", "in_channel_id", "encoder_ids", "keyframe_interval", "limit_to_30_fps", "latency_mode", "active", "connection_caps" ], "type": "object", "x-videon-note": "Write-schema projection: excludes runtime/status/range/possible-values fields from request bodies.", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "SyncGroupListResponse": { "additionalProperties": false, "properties": { "max_sync_groups": { "type": "integer" }, "sync_groups": { "items": { "$ref": "#/components/schemas/SyncGroup" }, "type": "array" } }, "required": [ "sync_groups", "max_sync_groups" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "SyncValidation": { "additionalProperties": false, "properties": { "dash_presentation_delay": { "minimum": 0, "type": "integer" }, "dash_time_service": { "type": "string" }, "enable": { "type": "boolean" } }, "required": [ "enable", "dash_presentation_delay", "dash_time_service" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "SystemConfiguration": { "additionalProperties": false, "properties": { "clock": { "$ref": "#/components/schemas/NtpValidation" }, "device_id": { "type": "string" }, "device_name": { "type": "string" }, "entitlement_state": { "maximum": 255, "minimum": 0, "type": "integer" }, "ip_address": { "type": "string" }, "ip_scheme": { "enum": [ "unspecified", "static", "dhcp" ], "type": "string" }, "mac_address": { "type": "string" }, "net_connected": { "type": "boolean" }, "network": { "$ref": "#/components/schemas/NetworkValidation" }, "static_network": { "$ref": "#/components/schemas/StaticNetworkValidation" }, "version": { "type": "string" }, "xml": { "$ref": "#/components/schemas/XmlValidation" } }, "required": [ "device_name", "ip_scheme", "net_connected", "mac_address", "ip_address", "network", "static_network", "version", "device_id", "xml", "clock", "entitlement_state" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "SystemConfigurationWriteRequest": { "additionalProperties": false, "properties": { "clock": { "additionalProperties": false, "properties": { "ntp_server": { "type": "string" }, "timezone": { "type": "string" } }, "required": [ "ntp_server", "timezone" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "device_id": { "type": "string" }, "device_name": { "type": "string" }, "entitlement_state": { "maximum": 255, "minimum": 0, "type": "integer" }, "ip_address": { "type": "string" }, "ip_scheme": { "enum": [ "unspecified", "static", "dhcp" ], "type": "string" }, "mac_address": { "type": "string" }, "net_connected": { "type": "boolean" }, "network": { "additionalProperties": false, "properties": { "dns_addresses": { "items": { "type": "string" }, "type": "array" }, "gateway": { "type": "string" }, "ip_address": { "type": "string" }, "netmask": { "type": "string" } }, "required": [ "ip_address", "netmask", "gateway", "dns_addresses" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "static_network": { "additionalProperties": false, "properties": { "dns_address": { "type": "string" }, "dns_addresses": { "items": { "type": "string" }, "type": "array" }, "gateway": { "type": "string" }, "ip_address": { "type": "string" }, "netmask": { "type": "string" } }, "required": [ "ip_address", "netmask", "gateway", "dns_address", "dns_addresses" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "version": { "type": "string" }, "xml": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "password": { "type": "string" }, "poll_interval": { "type": "integer" }, "url": { "type": "string" }, "username": { "type": "string" } }, "required": [ "enabled", "url", "poll_interval", "username", "password" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" } }, "required": [ "device_name", "ip_scheme", "net_connected", "mac_address", "ip_address", "network", "static_network", "version", "device_id", "xml", "clock", "entitlement_state" ], "type": "object", "x-videon-note": "Write-schema projection: excludes runtime/status/range/possible-values fields from request bodies.", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "Thumbnail": { "additionalProperties": false, "properties": { "interval": { "$ref": "#/components/schemas/ThumbnailValidation" }, "width": { "$ref": "#/components/schemas/ThumbnailValidation" } }, "required": [ "interval", "width" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "ThumbnailValidation": { "additionalProperties": false, "properties": { "value": { "minimum": 0, "type": "integer" }, "value_range": { "$ref": "#/components/schemas/RangeValidation" } }, "required": [ "value", "value_range" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "ULLValidation": { "additionalProperties": false, "properties": { "chunk_interval": { "$ref": "#/components/schemas/ChunkInterval" }, "enable": { "type": "boolean" }, "target_latency_ms": { "type": "integer" } }, "required": [ "enable", "chunk_interval", "target_latency_ms" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "Unicast": { "additionalProperties": false, "properties": { "destination_ip": { "type": "string" }, "destination_port": { "minimum": 0, "type": "integer" }, "protocol": { "enum": [ "unspecified", "RTP", "RAW_UDP", "SRT" ], "type": "string" } }, "required": [ "protocol", "destination_ip", "destination_port" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "VidCodecValidation": { "additionalProperties": false, "properties": { "h264": { "$ref": "#/components/schemas/H264Validation" }, "h265": { "$ref": "#/components/schemas/H265Validation" }, "possible_values": { "items": { "enum": [ "H264", "H265" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "H264", "H265" ], "type": "string" } }, "required": [ "value", "possible_values", "h264", "h265" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "VidFormatValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "FORMAT_UNDEFINED", "FORMAT_180p2398", "FORMAT_180p24", "FORMAT_180p25", "FORMAT_180p2997", "FORMAT_180p30", "FORMAT_180p50", "FORMAT_180p5994", "FORMAT_180p60", "FORMAT_270p2398", "FORMAT_270p24", "FORMAT_270p25", "FORMAT_270p2997", "FORMAT_270p30", "FORMAT_270p50", "FORMAT_270p5994", "FORMAT_270p60", "FORMAT_360p2398", "FORMAT_360p24", "FORMAT_360p25", "FORMAT_360p2997", "FORMAT_360p30", "FORMAT_360p50", "FORMAT_360p5994", "FORMAT_360p60", "FORMAT_480i5994", "FORMAT_480i60", "FORMAT_480p2398", "FORMAT_480p24", "FORMAT_480p25", "FORMAT_480p50", "FORMAT_480p2997", "FORMAT_480p30", "FORMAT_480p5994", "FORMAT_480p60", "FORMAT_576i50", "FORMAT_576p2398", "FORMAT_576p24", "FORMAT_576p25", "FORMAT_576p50", "FORMAT_576p2997", "FORMAT_576p30", "FORMAT_576p5994", "FORMAT_576p60", "FORMAT_540p2398", "FORMAT_540p24", "FORMAT_540p25", "FORMAT_540p2997", "FORMAT_540p30", "FORMAT_540p50", "FORMAT_540p5994", "FORMAT_540p60", "FORMAT_720p2398", "FORMAT_720p24", "FORMAT_720p25", "FORMAT_720p2997", "FORMAT_720p30", "FORMAT_720p50", "FORMAT_720p5994", "FORMAT_720p60", "FORMAT_1080i50", "FORMAT_1080i5994", "FORMAT_1080i60", "FORMAT_1080p2398", "FORMAT_1080p24", "FORMAT_1080p25", "FORMAT_1080p2997", "FORMAT_1080p30", "FORMAT_1080p50", "FORMAT_1080p5994", "FORMAT_1080p60", "FORMAT_1200p60", "FORMAT_1440p60", "FORMAT_2160p2398", "FORMAT_2160p24", "FORMAT_2160p25", "FORMAT_2160p2997", "FORMAT_2160p30", "FORMAT_2160p50", "FORMAT_2160p5994", "FORMAT_2160p60" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "FORMAT_UNDEFINED", "FORMAT_180p2398", "FORMAT_180p24", "FORMAT_180p25", "FORMAT_180p2997", "FORMAT_180p30", "FORMAT_180p50", "FORMAT_180p5994", "FORMAT_180p60", "FORMAT_270p2398", "FORMAT_270p24", "FORMAT_270p25", "FORMAT_270p2997", "FORMAT_270p30", "FORMAT_270p50", "FORMAT_270p5994", "FORMAT_270p60", "FORMAT_360p2398", "FORMAT_360p24", "FORMAT_360p25", "FORMAT_360p2997", "FORMAT_360p30", "FORMAT_360p50", "FORMAT_360p5994", "FORMAT_360p60", "FORMAT_480i5994", "FORMAT_480i60", "FORMAT_480p2398", "FORMAT_480p24", "FORMAT_480p25", "FORMAT_480p50", "FORMAT_480p2997", "FORMAT_480p30", "FORMAT_480p5994", "FORMAT_480p60", "FORMAT_576i50", "FORMAT_576p2398", "FORMAT_576p24", "FORMAT_576p25", "FORMAT_576p50", "FORMAT_576p2997", "FORMAT_576p30", "FORMAT_576p5994", "FORMAT_576p60", "FORMAT_540p2398", "FORMAT_540p24", "FORMAT_540p25", "FORMAT_540p2997", "FORMAT_540p30", "FORMAT_540p50", "FORMAT_540p5994", "FORMAT_540p60", "FORMAT_720p2398", "FORMAT_720p24", "FORMAT_720p25", "FORMAT_720p2997", "FORMAT_720p30", "FORMAT_720p50", "FORMAT_720p5994", "FORMAT_720p60", "FORMAT_1080i50", "FORMAT_1080i5994", "FORMAT_1080i60", "FORMAT_1080p2398", "FORMAT_1080p24", "FORMAT_1080p25", "FORMAT_1080p2997", "FORMAT_1080p30", "FORMAT_1080p50", "FORMAT_1080p5994", "FORMAT_1080p60", "FORMAT_1200p60", "FORMAT_1440p60", "FORMAT_2160p2398", "FORMAT_2160p24", "FORMAT_2160p25", "FORMAT_2160p2997", "FORMAT_2160p30", "FORMAT_2160p50", "FORMAT_2160p5994", "FORMAT_2160p60" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "VidLatencyModeValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "NORMAL", "LOW", "LOWEST", "REALTIME", "HIGH" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "NORMAL", "LOW", "LOWEST", "REALTIME", "HIGH" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "VidResolutionValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "RES_426X240", "RES_640X360", "RES_720X576", "RES_720X480", "RES_854X480", "RES_1280X720", "RES_1920X1080", "RES_PASSTHROUGH", "RES_480X270", "RES_960X540", "RES_320X180", "RES_3840X2160", "RES_320X180_BLUR", "RES_180X320", "RES_270X480", "RES_360X640", "RES_480X854", "RES_576X720", "RES_540X960", "RES_720X1280", "RES_1080X1920", "RES_2160X3840", "RES_1920X1200", "RES_2560X1440", "RES_1200X1920", "RES_1440X2560" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "RES_426X240", "RES_640X360", "RES_720X576", "RES_720X480", "RES_854X480", "RES_1280X720", "RES_1920X1080", "RES_PASSTHROUGH", "RES_480X270", "RES_960X540", "RES_320X180", "RES_3840X2160", "RES_320X180_BLUR", "RES_180X320", "RES_270X480", "RES_360X640", "RES_480X854", "RES_576X720", "RES_540X960", "RES_720X1280", "RES_1080X1920", "RES_2160X3840", "RES_1920X1200", "RES_2560X1440", "RES_1200X1920", "RES_1440X2560" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "VideoEncoder": { "additionalProperties": false, "properties": { "active": { "type": "boolean" }, "seconds_in_status": { "type": "integer" }, "status": { "enum": [ "DISABLED", "PENDING", "RUNNING", "RETRYING_ENDED", "UNABLE_TO_ENCODE", "NO_INPUT", "INSUFFICIENT_RESOURCES", "FAILED_TO_START", "INVALID_CONFIG" ], "type": "string" }, "vid_encoder_id": { "type": "integer" } }, "required": [ "vid_encoder_id", "active", "status", "seconds_in_status" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "VideoEncoderConfiguration": { "additionalProperties": false, "properties": { "active": { "type": "boolean" }, "allow_outputs_to_adjust_bitrate": { "type": "boolean" }, "bitrate": { "$ref": "#/components/schemas/BitrateValidation" }, "bitrate_mode": { "$ref": "#/components/schemas/StreamBitrateModeValidation" }, "cc_processing_enabled": { "type": "boolean" }, "codec": { "$ref": "#/components/schemas/VidCodecValidation" }, "connection_caps": { "$ref": "#/components/schemas/ConnectionCapabilities" }, "current_bitrate": { "type": "integer" }, "enable_retry": { "type": "boolean" }, "in_channel_id": { "type": "integer" }, "keyframe_interval": { "$ref": "#/components/schemas/KeyInterval" }, "klv_timestamp_enabled": { "type": "boolean" }, "latency_mode": { "$ref": "#/components/schemas/VidLatencyModeValidation" }, "limit_to_30_fps": { "type": "boolean" }, "name": { "type": "string" }, "scaling_resolution": { "$ref": "#/components/schemas/VidResolutionValidation" }, "seconds_in_status": { "type": "integer" }, "status": { "enum": [ "DISABLED", "PENDING", "RUNNING", "RETRYING_ENDED", "UNABLE_TO_ENCODE", "NO_INPUT", "INSUFFICIENT_RESOURCES", "FAILED_TO_START", "INVALID_CONFIG" ], "type": "string" }, "sync_group_id": { "type": "integer" }, "vid_encoder_id": { "type": "integer" } }, "required": [ "name", "active", "vid_encoder_id", "enable_retry", "in_channel_id", "sync_group_id", "bitrate", "latency_mode", "bitrate_mode", "keyframe_interval", "scaling_resolution", "limit_to_30_fps", "codec", "klv_timestamp_enabled", "cc_processing_enabled", "status", "seconds_in_status", "current_bitrate", "connection_caps", "allow_outputs_to_adjust_bitrate" ], "type": "object", "x-videon-defaulting": { "missing_request_body": "Daemon applies default video encoder settings and default channel selection.", "optional_fields": [ "in_channel_id", "codec", "bitrate" ] }, "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "VideoEncoderConfigurationWriteRequest": { "additionalProperties": false, "properties": { "active": { "type": "boolean" }, "allow_outputs_to_adjust_bitrate": { "type": "boolean" }, "bitrate": { "additionalProperties": false, "properties": { "value": { "type": "integer" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "bitrate_mode": { "additionalProperties": false, "properties": { "value": { "enum": [ "constant", "variable", "constant_strict" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "cc_processing_enabled": { "type": "boolean" }, "codec": { "additionalProperties": false, "properties": { "h264": { "additionalProperties": false, "properties": { "level": { "additionalProperties": false, "properties": { "value": { "enum": [ "LVL3", "LVL3P1", "LVL3P2", "LVL4", "LVL4P1", "LVL4P2", "LVL5", "LVL5P1", "LVL5P2" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "profile": { "additionalProperties": false, "properties": { "value": { "enum": [ "PROFILE_HIGH", "PROFILE_MAIN", "PROFILE_BASELINE" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" } }, "required": [ "profile", "level" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "h265": { "additionalProperties": false, "properties": { "level": { "additionalProperties": false, "properties": { "value": { "enum": [ "LVL_1_MAIN", "LVL_2_MAIN", "LVL_2P1_MAIN", "LVL_3_MAIN", "LVL_3P1_MAIN", "LVL_4_MAIN", "LVL_4_HIGH", "LVL_4P1_MAIN", "LVL_4P1_HIGH", "LVL_5_MAIN", "LVL_5_HIGH", "LVL_5P1_MAIN", "LVL_5P1_HIGH" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "profile": { "additionalProperties": false, "properties": { "value": { "enum": [ "PROFILE_MAIN" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" } }, "required": [ "profile", "level" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "value": { "enum": [ "H264", "H265" ], "type": "string" } }, "required": [ "value", "h264", "h265" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "connection_caps": { "additionalProperties": false, "properties": { "consumer_caps": { "items": { "enum": [ "RAW_VIDEO", "RAW_AUDIO", "ES_VIDEO_H264", "ES_VIDEO_H265", "ES_VIDEO_MJPEG", "ES_AUDIO_AAC_MPEG4_ADTS", "ES_AUDIO_OPUS", "DATA_SMPTE291", "DATA_SMPTE291_10BIT_SCTE_104", "DATA_SMPTE2038", "DATA_MPEGTS_METADATA_AU_WRAPPER_KLV_SYNC" ], "type": "string" }, "type": "array" }, "producer_caps": { "items": { "enum": [ "RAW_VIDEO", "RAW_AUDIO", "ES_VIDEO_H264", "ES_VIDEO_H265", "ES_VIDEO_MJPEG", "ES_AUDIO_AAC_MPEG4_ADTS", "ES_AUDIO_OPUS", "DATA_SMPTE291", "DATA_SMPTE291_10BIT_SCTE_104", "DATA_SMPTE2038", "DATA_MPEGTS_METADATA_AU_WRAPPER_KLV_SYNC" ], "type": "string" }, "type": "array" } }, "required": [ "consumer_caps", "producer_caps" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "enable_retry": { "type": "boolean" }, "in_channel_id": { "type": "integer" }, "keyframe_interval": { "additionalProperties": false, "properties": { "interval": { "type": "integer" }, "interval_range_frames": { "additionalProperties": false, "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "required": [ "min", "max" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "interval_range_milliseconds": { "additionalProperties": false, "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "required": [ "min", "max" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "possible_units": { "items": { "enum": [ "unspecified", "MILLISECONDS", "FRAMES" ], "type": "string" }, "type": "array" }, "unit": { "enum": [ "unspecified", "MILLISECONDS", "FRAMES" ], "type": "string" } }, "required": [ "interval", "unit", "possible_units", "interval_range_frames", "interval_range_milliseconds" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "klv_timestamp_enabled": { "type": "boolean" }, "latency_mode": { "additionalProperties": false, "properties": { "value": { "enum": [ "NORMAL", "LOW", "LOWEST", "REALTIME", "HIGH" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "limit_to_30_fps": { "type": "boolean" }, "name": { "type": "string" }, "scaling_resolution": { "additionalProperties": false, "properties": { "value": { "enum": [ "RES_426X240", "RES_640X360", "RES_720X576", "RES_720X480", "RES_854X480", "RES_1280X720", "RES_1920X1080", "RES_PASSTHROUGH", "RES_480X270", "RES_960X540", "RES_320X180", "RES_3840X2160", "RES_320X180_BLUR", "RES_180X320", "RES_270X480", "RES_360X640", "RES_480X854", "RES_576X720", "RES_540X960", "RES_720X1280", "RES_1080X1920", "RES_2160X3840", "RES_1920X1200", "RES_2560X1440", "RES_1200X1920", "RES_1440X2560" ], "type": "string" } }, "required": [ "value" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "sync_group_id": { "type": "integer" }, "vid_encoder_id": { "type": "integer" } }, "required": [ "name", "active", "vid_encoder_id", "enable_retry", "in_channel_id", "sync_group_id", "bitrate", "latency_mode", "bitrate_mode", "keyframe_interval", "scaling_resolution", "limit_to_30_fps", "codec", "klv_timestamp_enabled", "cc_processing_enabled", "connection_caps", "allow_outputs_to_adjust_bitrate" ], "type": "object", "x-videon-defaulting": { "missing_request_body": "Daemon applies default video encoder settings and default channel selection.", "optional_fields": [ "in_channel_id", "codec", "bitrate" ] }, "x-videon-note": "Write-schema projection: excludes runtime/status/range/possible-values fields from request bodies.", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "VideoEncoderListResponse": { "additionalProperties": false, "properties": { "available_codecs": { "items": { "enum": [ "H264", "H265" ], "type": "string" }, "type": "array" }, "max_sync_groups": { "type": "integer" }, "max_vid_encoders": { "type": "integer" }, "sync_groups": { "items": { "$ref": "#/components/schemas/SyncGroup" }, "type": "array" }, "vid_encoders": { "items": { "$ref": "#/components/schemas/VideoEncoder" }, "type": "array" } }, "required": [ "vid_encoders", "available_codecs", "max_vid_encoders", "sync_groups", "max_sync_groups" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "VideoInputValidation": { "additionalProperties": false, "properties": { "detected_format": { "$ref": "#/components/schemas/VidFormatValidation" }, "possible_values": { "items": { "enum": [ "input_hdmi", "input_vga", "input_sdi", "input_auto", "input_tpg" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "input_hdmi", "input_vga", "input_sdi", "input_auto", "input_tpg" ], "type": "string" } }, "required": [ "value", "possible_values", "detected_format" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "VideoRotationValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "ROTATE_0", "ROTATE_90", "ROTATE_180", "ROTATE_270" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "ROTATE_0", "ROTATE_90", "ROTATE_180", "ROTATE_270" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "VideoSourceValidation": { "additionalProperties": false, "properties": { "max_sources": { "type": "integer" }, "video_source_ids": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "max_sources", "video_source_ids" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "VideoSourceValidationDeprecated": { "additionalProperties": false, "properties": { "video_source_id": { "type": "integer" } }, "required": [ "video_source_id" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "WHIP": { "additionalProperties": false, "properties": { "service": { "$ref": "#/components/schemas/StreamService" } }, "required": [ "service" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "XmlConfiguration": { "additionalProperties": false, "properties": { "xml": { "$ref": "#/components/schemas/XmlValidation" } }, "required": [ "xml" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "XmlConfigurationWriteRequest": { "additionalProperties": false, "properties": { "xml": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "password": { "type": "string" }, "poll_interval": { "type": "integer" }, "url": { "type": "string" }, "username": { "type": "string" } }, "required": [ "enabled", "url", "poll_interval", "username", "password" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" } }, "required": [ "xml" ], "type": "object", "x-videon-note": "Write-schema projection: excludes runtime/status/range/possible-values fields from request bodies.", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "XmlValidation": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "password": { "type": "string" }, "poll_interval": { "type": "integer" }, "url": { "type": "string" }, "username": { "type": "string" } }, "required": [ "enabled", "url", "poll_interval", "username", "password" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "Zixi": { "additionalProperties": false, "properties": { "destination_ip": { "type": "string" }, "destination_port": { "type": "integer" }, "dtls": { "$ref": "#/components/schemas/ZixiDTLS" }, "enable_back_pressure_bitrate_adjustment": { "type": "boolean" }, "encryption_enabled": { "type": "boolean" }, "encryption_key": { "type": "string" }, "fec_percentage": { "type": "integer" }, "key_size": { "$ref": "#/components/schemas/ZixiKeySizeValidation" }, "max_latency_ms": { "type": "integer" }, "passphrase": { "type": "string" }, "stream_id": { "type": "string" } }, "required": [ "destination_ip", "destination_port", "max_latency_ms", "fec_percentage", "passphrase", "key_size", "stream_id", "encryption_enabled", "encryption_key", "enable_back_pressure_bitrate_adjustment", "dtls" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "ZixiDTLS": { "additionalProperties": false, "properties": { "dtls_cert_exist": { "type": "boolean" }, "ignore_dtls_cert_error": { "type": "boolean" } }, "required": [ "dtls_cert_exist", "ignore_dtls_cert_error" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" }, "ZixiKeySizeValidation": { "additionalProperties": false, "properties": { "possible_values": { "items": { "enum": [ "AES128", "AES192", "AES256" ], "type": "string" }, "type": "array", "x-videon-testFieldSource": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false } }, "value": { "enum": [ "AES128", "AES192", "AES256" ], "type": "string" } }, "required": [ "value", "possible_values" ], "type": "object", "x-videon-source": "flatbuffers/schema/configuration.fbs" } } }, "info": { "description": "Autogenerated from daemon REST operation metadata registry.", "title": "Videon Stream REST API v2 (trogdor)", "version": "v2" }, "openapi": "3.0.3", "paths": { "/v2/about": { "get": { "operationId": "getAbout", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AboutResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get daemon version information", "tags": [ "system" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } } }, "/v2/debug_verbosity": { "get": { "operationId": "getDebugVerbosity", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DebugVerbosityResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get default debug verbosity", "tags": [ "debug" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "put": { "operationId": "setDebugVerbosity", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DebugVerbosityRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Set default debug verbosity", "tags": [ "debug" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [ { "coveragePriority": "secondary", "description": "Fan out request body by `verbosity`.", "fieldPath": "verbosity", "type": "enum", "valueSource": "request_schema_enum", "values": [ "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ] } ], "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": true } } }, "/v2/debug_verbosity/components": { "get": { "operationId": "getDebugVerbosityComponents", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DebugVerbosityComponentsResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get component category and component type verbosity map", "tags": [ "debug" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "put": { "operationId": "setDebugVerbosityComponents", "parameters": [ { "description": "Strict component type validation toggle.", "in": "query", "name": "strict", "required": false, "schema": { "default": true, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DebugVerbosityComponentsUpdateRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Set component category or component type verbosity overrides", "tags": [ "debug" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [], "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [ { "description": "Fan out query parameter `strict`.", "in": "query", "name": "strict", "type": "boolean", "values": [ true, false ] } ], "requiresRequestBody": true } } }, "/v2/debug_verbosity/components/{component}": { "delete": { "operationId": "deleteDebugVerbosityComponentOverride", "parameters": [ { "description": "Path parameter `component`.", "in": "path", "name": "component", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Delete one component category or type verbosity override", "tags": [ "debug" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "component", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } } }, "/v2/debug_verbosity/scopes": { "get": { "operationId": "getDebugVerbosityScopes", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DebugVerbosityScopesResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get logging scope verbosity map", "tags": [ "debug" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "put": { "operationId": "setDebugVerbosityScopes", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DebugVerbosityScopesUpdateRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Set logging scope verbosity overrides", "tags": [ "debug" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [], "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": true } } }, "/v2/debug_verbosity/scopes/{scope}": { "delete": { "operationId": "deleteDebugVerbosityScopeOverride", "parameters": [ { "description": "Path parameter `scope`.", "in": "path", "name": "scope", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Delete one logging scope verbosity override", "tags": [ "debug" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "scope", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } } }, "/v2/devices": { "get": { "operationId": "listDevices", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceListResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "List available devices", "tags": [ "devices" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } } }, "/v2/devices/{deviceid}": { "get": { "operationId": "getDevice", "parameters": [ { "description": "Path parameter `deviceid`.", "in": "path", "name": "deviceid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get one device by identifier", "tags": [ "devices" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "deviceid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } } }, "/v2/encoders": { "get": { "operationId": "listEncoders", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EncoderListResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "List encoders", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } } }, "/v2/encoders/aud_encoders": { "get": { "operationId": "listAudioEncoders", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioEncoderListResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "List audio encoders", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "post": { "operationId": "createAudioEncoder", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "bitrate": { "value": 128 }, "bitrate_mode": { "value": "variable" }, "channel_configuration": { "selected_channels": [ 1, 2 ] }, "codec": { "value": "mpeg4_aac" } }, "schema": { "$ref": "#/components/schemas/AudioEncoderConfigurationWriteRequest" } } }, "required": false }, "responses": { "200": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Successful response when daemon returns no response payload" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioEncoderConfiguration" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Create audio encoder (request body optional; daemon applies defaults when omitted)", "tags": [ "encoders" ], "x-videon-defaulting": { "missingRequestBodyBehavior": "If request body is omitted, daemon applies default values for this create/update operation." }, "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": false, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [ { "coveragePriority": "secondary", "description": "Fan out request body by boolean `active`.", "fieldPath": "active", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `enable_retry`.", "fieldPath": "enable_retry", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coverageGoal": "Generate at least one test per value of FlatBuffers enum AudCodec.", "coveragePriority": "primary", "description": "Fan out request body by `codec.value`.", "fieldPath": "codec.value", "flatbufferEnum": "AudCodec", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "mpeg2_aac", "mpeg4_aac", "mpeg4_aac_loas", "opus" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `sample.value`.", "fieldPath": "sample.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "SAMPLE_32_khz", "SAMPLE_44p1_khz", "SAMPLE_48_khz", "SAMPLE_7p35_khz", "SAMPLE_8_khz", "SAMPLE_11p025_khz", "SAMPLE_12_khz", "SAMPLE_16_khz", "SAMPLE_22p05_khz", "SAMPLE_24_khz", "SAMPLE_64_khz", "SAMPLE_88p2_khz", "SAMPLE_96_khz", "SAMPLE_176p4_khz", "SAMPLE_192_khz", "SAMPLE_352p8_khz", "SAMPLE_384_khz", "SAMPLE_705p6_khz", "SAMPLE_768_khz" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `mix_mode.value`.", "fieldPath": "mix_mode.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "STEREO", "DUAL_MONO", "LEFT_MONO", "RIGHT_MONO", "CROSS_MONO" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `bitrate_mode.value`.", "fieldPath": "bitrate_mode.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "constant", "variable", "constant_strict" ] } ], "capabilityGate": "none", "createCapacityPrecondition": { "currentCount": { "countStrategy": "array_length", "fieldPath": "aud_encoders" }, "description": "Create only when audio encoder count is below max_aud_encoders.", "limit": { "countStrategy": "integer_value", "fieldPath": "max_aud_encoders" }, "listEndpoint": { "method": "GET", "path": "/v2/encoders/aud_encoders", "responseSchema": "AudioEncoderListResponse" }, "listOperationId": "listAudioEncoders", "precondition": "current_count < limit" }, "mandatoryCoverageFanouts": [ { "coverageGoal": "Generate at least one test per value of FlatBuffers enum AudCodec.", "coveragePriority": "primary", "description": "Fan out request body by `codec.value`.", "fieldPath": "codec.value", "flatbufferEnum": "AudCodec", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "mpeg2_aac", "mpeg4_aac", "mpeg4_aac_loas", "opus" ] } ], "precondition": "none", "queryParameterFanoutCandidates": [], "recycleOnCapacity": { "deleteEndpoint": { "method": "DELETE", "path": "/v2/encoders/aud_encoders/{encoderid}" }, "deleteOperationId": "deleteAudioEncoder", "description": "When create capacity is exhausted, delete one existing entity using the standard DELETE endpoint, then retry the POST create attempt.", "idFieldPath": "aud_encoder_id", "idParameter": "encoderid", "listArrayFieldPath": "aud_encoders", "selectionPolicy": "lowest_id_first", "strategy": "delete_existing_then_retry_create" }, "requiresRequestBody": true } } }, "/v2/encoders/aud_encoders/{encoderid}": { "delete": { "operationId": "deleteAudioEncoder", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Delete one audio encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "get": { "operationId": "getAudioEncoder", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioEncoderConfiguration" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get one audio encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "put": { "operationId": "updateAudioEncoder", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "bitrate": { "value": 128 }, "bitrate_mode": { "value": "variable" }, "channel_configuration": { "selected_channels": [ 1, 2 ] }, "codec": { "value": "mpeg4_aac" } }, "schema": { "$ref": "#/components/schemas/AudioEncoderConfigurationWriteRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Update one audio encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [ { "coveragePriority": "secondary", "description": "Fan out request body by boolean `active`.", "fieldPath": "active", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `enable_retry`.", "fieldPath": "enable_retry", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coverageGoal": "Generate at least one test per value of FlatBuffers enum AudCodec.", "coveragePriority": "primary", "description": "Fan out request body by `codec.value`.", "fieldPath": "codec.value", "flatbufferEnum": "AudCodec", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "mpeg2_aac", "mpeg4_aac", "mpeg4_aac_loas", "opus" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `sample.value`.", "fieldPath": "sample.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "SAMPLE_32_khz", "SAMPLE_44p1_khz", "SAMPLE_48_khz", "SAMPLE_7p35_khz", "SAMPLE_8_khz", "SAMPLE_11p025_khz", "SAMPLE_12_khz", "SAMPLE_16_khz", "SAMPLE_22p05_khz", "SAMPLE_24_khz", "SAMPLE_64_khz", "SAMPLE_88p2_khz", "SAMPLE_96_khz", "SAMPLE_176p4_khz", "SAMPLE_192_khz", "SAMPLE_352p8_khz", "SAMPLE_384_khz", "SAMPLE_705p6_khz", "SAMPLE_768_khz" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `mix_mode.value`.", "fieldPath": "mix_mode.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "STEREO", "DUAL_MONO", "LEFT_MONO", "RIGHT_MONO", "CROSS_MONO" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `bitrate_mode.value`.", "fieldPath": "bitrate_mode.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "constant", "variable", "constant_strict" ] } ], "capabilityGate": "none", "mandatoryCoverageFanouts": [ { "coverageGoal": "Generate at least one test per value of FlatBuffers enum AudCodec.", "coveragePriority": "primary", "description": "Fan out request body by `codec.value`.", "fieldPath": "codec.value", "flatbufferEnum": "AudCodec", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "mpeg2_aac", "mpeg4_aac", "mpeg4_aac_loas", "opus" ] } ], "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": true, "suggestedRuntimeProbeEndpoints": [ { "method": "GET", "path": "/v2/encoders/aud_encoders/{encoderid}", "purpose": "Read audio encoder runtime fields (value_range, possible_values, status)." } ] } } }, "/v2/encoders/data_encoders": { "get": { "operationId": "listDataEncoders", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEncoderListResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "List data encoders", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "post": { "operationId": "createDataEncoder", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "active": true, "codec": { "value": "klv_sync" } }, "schema": { "$ref": "#/components/schemas/DataEncoderConfigurationWriteRequest" } } }, "required": true }, "responses": { "200": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Successful response when daemon returns no response payload" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEncoderConfiguration" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Create data encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": false, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [ { "coveragePriority": "secondary", "description": "Fan out request body by boolean `active`.", "fieldPath": "active", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coverageGoal": "Generate at least one test per value of FlatBuffers enum DatCodec.", "coveragePriority": "primary", "description": "Fan out request body by `codec.value`.", "fieldPath": "codec.value", "flatbufferEnum": "DatCodec", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "klv_sync", "scte35", "smpte2038" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `codec.klv_sync.disable_misb1402_timestamps`.", "fieldPath": "codec.klv_sync.disable_misb1402_timestamps", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `codec.smpte2038.stop_processing`.", "fieldPath": "codec.smpte2038.stop_processing", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] } ], "capabilityGate": "none", "createCapacityPrecondition": { "currentCount": { "countStrategy": "array_length_filtered", "fieldPath": "data_encoders", "filterByRequestField": { "candidateItemFieldPaths": [ "codec.value", "codec" ], "requestFieldPath": "codec.value" } }, "description": "Create only when codec-specific data encoder capacity is available.", "limitByRequestField": { "countStrategy": "integer_value", "defaultPolicy": "skip_when_unmapped", "fieldMap": { "klv_sync": "max_klv_sync", "scte35": "max_scte35", "smpte2038": "max_smpte2038" }, "requestFieldPath": "codec.value" }, "listEndpoint": { "method": "GET", "path": "/v2/encoders/data_encoders", "responseSchema": "DataEncoderListResponse" }, "listOperationId": "listDataEncoders", "precondition": "current_count_for_codec < limit_for_codec" }, "mandatoryCoverageFanouts": [ { "coverageGoal": "Generate at least one test per value of FlatBuffers enum DatCodec.", "coveragePriority": "primary", "description": "Fan out request body by `codec.value`.", "fieldPath": "codec.value", "flatbufferEnum": "DatCodec", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "klv_sync", "scte35", "smpte2038" ] } ], "precondition": "none", "queryParameterFanoutCandidates": [], "recycleOnCapacity": { "deleteEndpoint": { "method": "DELETE", "path": "/v2/encoders/data_encoders/{encoderid}" }, "deleteOperationId": "deleteDataEncoder", "description": "When create capacity is exhausted, delete one existing entity using the standard DELETE endpoint, then retry the POST create attempt.", "idFieldPath": "data_encoder_id", "idParameter": "encoderid", "listArrayFieldPath": "data_encoders", "selectionPolicy": "lowest_id_first", "strategy": "delete_existing_then_retry_create" }, "requiresRequestBody": true } } }, "/v2/encoders/data_encoders/{encoderid}": { "delete": { "operationId": "deleteDataEncoder", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Delete one data encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "get": { "operationId": "getDataEncoder", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEncoderConfiguration" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get one data encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "put": { "operationId": "updateDataEncoder", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "active": true, "codec": { "value": "klv_sync" } }, "schema": { "$ref": "#/components/schemas/DataEncoderConfigurationWriteRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Update one data encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [ { "coveragePriority": "secondary", "description": "Fan out request body by boolean `active`.", "fieldPath": "active", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coverageGoal": "Generate at least one test per value of FlatBuffers enum DatCodec.", "coveragePriority": "primary", "description": "Fan out request body by `codec.value`.", "fieldPath": "codec.value", "flatbufferEnum": "DatCodec", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "klv_sync", "scte35", "smpte2038" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `codec.klv_sync.disable_misb1402_timestamps`.", "fieldPath": "codec.klv_sync.disable_misb1402_timestamps", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `codec.smpte2038.stop_processing`.", "fieldPath": "codec.smpte2038.stop_processing", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] } ], "capabilityGate": "none", "mandatoryCoverageFanouts": [ { "coverageGoal": "Generate at least one test per value of FlatBuffers enum DatCodec.", "coveragePriority": "primary", "description": "Fan out request body by `codec.value`.", "fieldPath": "codec.value", "flatbufferEnum": "DatCodec", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "klv_sync", "scte35", "smpte2038" ] } ], "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": true, "suggestedRuntimeProbeEndpoints": [ { "method": "GET", "path": "/v2/encoders/data_encoders/{encoderid}", "purpose": "Read data encoder runtime fields and codec-specific configuration." } ] } } }, "/v2/encoders/data_encoders/{encoderid}/action/{actionname}": { "post": { "description": "Supported actions and constraints:\n- `insert_splice`: applies when componentType=data_encoder, codec.value=scte35.", "operationId": "runDataEncoderAction", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } }, { "description": "Action name for `runDataEncoderAction`. Values reflect daemon-supported actions. See `x-videon-testHints.actionContracts` for per-action applicability and body rules.", "in": "path", "name": "actionname", "required": true, "schema": { "enum": [ "insert_splice" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": {}, "schema": { "$ref": "#/components/schemas/ActionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionResponse" } } }, "description": "Successful response" }, "204": { "description": "Action accepted with no response body" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Run action on one data encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": false, "x-videon-sideEffect": "action", "x-videon-testHints": { "actionContracts": { "insert_splice": { "appliesWhen": { "codec.value": "scte35", "componentType": "data_encoder" }, "requestBody": {} } }, "actionNameOptions": [ "insert_splice" ], "bodyFanoutCandidates": [], "capabilityGate": "none", "pathFanoutCandidates": [ { "coverageGoal": "Generate at least one test per action in actionNameOptions for this operation.", "coveragePriority": "primary", "description": "Fan out path parameter `actionname`.", "in": "path", "name": "actionname", "type": "enum", "valueSource": "daemon_action_handlers", "values": [ "insert_splice" ] } ], "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" }, { "name": "actionname", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": true, "suggestedRuntimeProbeEndpoints": [ { "method": "GET", "path": "/v2/encoders/data_encoders/{encoderid}", "purpose": "Read data encoder runtime fields and codec-specific configuration." }, { "method": "GET", "path": "/v2/encoders/data_encoders/{encoderid}/action/{actionname}", "purpose": "Resolve component id and baseline configuration before running actions." } ] } } }, "/v2/encoders/data_encoders/{encoderid}/klv": { "get": { "operationId": "listDataEncoderKlv", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEncoderKlvListResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "List KLV payloads for one data encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "klv", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "post": { "operationId": "createDataEncoderKlv", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEncoderKlvWriteRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Create KLV payload for one data encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": false, "x-videon-sideEffect": "action", "x-videon-testHints": { "bodyFanoutCandidates": [], "capabilityGate": "klv", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": true, "suggestedRuntimeProbeEndpoints": [ { "method": "GET", "path": "/v2/encoders/data_encoders/{encoderid}", "purpose": "Read data encoder runtime fields and codec-specific configuration." } ] } } }, "/v2/encoders/data_encoders/{encoderid}/klv/{klvid}": { "delete": { "operationId": "deleteDataEncoderKlv", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter `klvid`.", "in": "path", "name": "klvid", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Delete one KLV payload for one data encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "action", "x-videon-testHints": { "capabilityGate": "klv", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" }, { "name": "klvid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "get": { "operationId": "getDataEncoderKlv", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter `klvid`.", "in": "path", "name": "klvid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEncoderKlv" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get one KLV payload for one data encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "klv", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" }, { "name": "klvid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "put": { "operationId": "updateDataEncoderKlv", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter `klvid`.", "in": "path", "name": "klvid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEncoderKlvWriteRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Update one KLV payload for one data encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "action", "x-videon-testHints": { "bodyFanoutCandidates": [], "capabilityGate": "klv", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" }, { "name": "klvid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": true, "suggestedRuntimeProbeEndpoints": [ { "method": "GET", "path": "/v2/encoders/data_encoders/{encoderid}", "purpose": "Read data encoder runtime fields and codec-specific configuration." } ] } } }, "/v2/encoders/data_encoders/{encoderid}/splice_commands": { "delete": { "operationId": "deleteAllDataEncoderSpliceCommands", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Delete all splice commands for one data encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "action", "x-videon-testHints": { "capabilityGate": "scte35", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "get": { "operationId": "listDataEncoderSpliceCommands", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEncoderSpliceCommandListResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "List splice commands for one data encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "scte35", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "post": { "operationId": "createDataEncoderSpliceCommand", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEncoderSpliceCommandWriteRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Create splice command for one data encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": false, "x-videon-sideEffect": "action", "x-videon-testHints": { "bodyFanoutCandidates": [], "capabilityGate": "scte35", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": true, "suggestedRuntimeProbeEndpoints": [ { "method": "GET", "path": "/v2/encoders/data_encoders/{encoderid}", "purpose": "Read data encoder runtime fields and codec-specific configuration." } ] } } }, "/v2/encoders/data_encoders/{encoderid}/splice_commands/{splicecommandid}": { "delete": { "operationId": "deleteDataEncoderSpliceCommand", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter `splicecommandid`.", "in": "path", "name": "splicecommandid", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Delete one splice command for one data encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "action", "x-videon-testHints": { "capabilityGate": "scte35", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" }, { "name": "splicecommandid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "get": { "operationId": "getDataEncoderSpliceCommand", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter `splicecommandid`.", "in": "path", "name": "splicecommandid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataEncoderSpliceCommand" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get one splice command for one data encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "scte35", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" }, { "name": "splicecommandid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } } }, "/v2/encoders/vid_encoders": { "get": { "operationId": "listVideoEncoders", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoEncoderListResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "List video encoders", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "post": { "operationId": "createVideoEncoder", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "bitrate": { "value": 10000 }, "bitrate_mode": { "value": "variable" }, "codec": { "h264": { "profile": { "value": "PROFILE_HIGH" } }, "value": "H264" }, "keyframe_interval": { "interval": 1000, "unit": "MILLISECONDS" }, "latency_mode": { "value": "NORMAL" }, "limit_to_30_fps": false, "scaling_resolution": { "value": "RES_PASSTHROUGH" } }, "schema": { "$ref": "#/components/schemas/VideoEncoderConfigurationWriteRequest" } } }, "required": false }, "responses": { "200": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Successful response when daemon returns no response payload" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoEncoderConfiguration" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Create video encoder (request body optional; daemon applies defaults when omitted)", "tags": [ "encoders" ], "x-videon-defaulting": { "missingRequestBodyBehavior": "If request body is omitted, daemon applies default values for this create/update operation." }, "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": false, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [ { "coveragePriority": "secondary", "description": "Fan out request body by boolean `active`.", "fieldPath": "active", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `enable_retry`.", "fieldPath": "enable_retry", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `latency_mode.value`.", "fieldPath": "latency_mode.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "NORMAL", "LOW", "LOWEST", "REALTIME", "HIGH" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `bitrate_mode.value`.", "fieldPath": "bitrate_mode.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "constant", "variable", "constant_strict" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `keyframe_interval.unit`.", "fieldPath": "keyframe_interval.unit", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "MILLISECONDS", "FRAMES" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `scaling_resolution.value`.", "fieldPath": "scaling_resolution.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "RES_426X240", "RES_640X360", "RES_720X576", "RES_720X480", "RES_854X480", "RES_1280X720", "RES_1920X1080", "RES_PASSTHROUGH", "RES_480X270", "RES_960X540", "RES_320X180", "RES_3840X2160", "RES_320X180_BLUR", "RES_180X320", "RES_270X480", "RES_360X640", "RES_480X854", "RES_576X720", "RES_540X960", "RES_720X1280", "RES_1080X1920", "RES_2160X3840", "RES_1920X1200", "RES_2560X1440", "RES_1200X1920", "RES_1440X2560" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `limit_to_30_fps`.", "fieldPath": "limit_to_30_fps", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coverageGoal": "Generate at least one test per value of FlatBuffers enum VidCodec.", "coveragePriority": "primary", "description": "Fan out request body by `codec.value`.", "fieldPath": "codec.value", "flatbufferEnum": "VidCodec", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "H264", "H265" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `codec.h264.profile.value`.", "fieldPath": "codec.h264.profile.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "PROFILE_HIGH", "PROFILE_MAIN", "PROFILE_BASELINE" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `codec.h264.level.value`.", "fieldPath": "codec.h264.level.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "LVL3", "LVL3P1", "LVL3P2", "LVL4", "LVL4P1", "LVL4P2", "LVL5", "LVL5P1", "LVL5P2" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `codec.h265.profile.value`.", "fieldPath": "codec.h265.profile.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "PROFILE_MAIN" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `codec.h265.level.value`.", "fieldPath": "codec.h265.level.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "LVL_1_MAIN", "LVL_2_MAIN", "LVL_2P1_MAIN", "LVL_3_MAIN", "LVL_3P1_MAIN", "LVL_4_MAIN", "LVL_4_HIGH", "LVL_4P1_MAIN", "LVL_4P1_HIGH", "LVL_5_MAIN", "LVL_5_HIGH", "LVL_5P1_MAIN", "LVL_5P1_HIGH" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `klv_timestamp_enabled`.", "fieldPath": "klv_timestamp_enabled", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `cc_processing_enabled`.", "fieldPath": "cc_processing_enabled", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `allow_outputs_to_adjust_bitrate`.", "fieldPath": "allow_outputs_to_adjust_bitrate", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] } ], "capabilityGate": "none", "createCapacityPrecondition": { "currentCount": { "countStrategy": "array_length", "fieldPath": "vid_encoders" }, "description": "Create only when video encoder count is below max_vid_encoders.", "limit": { "countStrategy": "integer_value", "fieldPath": "max_vid_encoders" }, "listEndpoint": { "method": "GET", "path": "/v2/encoders/vid_encoders", "responseSchema": "VideoEncoderListResponse" }, "listOperationId": "listVideoEncoders", "precondition": "current_count < limit" }, "mandatoryCoverageFanouts": [ { "coverageGoal": "Generate at least one test per value of FlatBuffers enum VidCodec.", "coveragePriority": "primary", "description": "Fan out request body by `codec.value`.", "fieldPath": "codec.value", "flatbufferEnum": "VidCodec", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "H264", "H265" ] } ], "precondition": "none", "queryParameterFanoutCandidates": [], "recycleOnCapacity": { "deleteEndpoint": { "method": "DELETE", "path": "/v2/encoders/vid_encoders/{encoderid}" }, "deleteOperationId": "deleteVideoEncoder", "description": "When create capacity is exhausted, delete one existing entity using the standard DELETE endpoint, then retry the POST create attempt.", "idFieldPath": "vid_encoder_id", "idParameter": "encoderid", "listArrayFieldPath": "vid_encoders", "selectionPolicy": "lowest_id_first", "strategy": "delete_existing_then_retry_create" }, "requiresRequestBody": true } } }, "/v2/encoders/vid_encoders/sync_groups": { "get": { "operationId": "listSyncGroups", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncGroupListResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "List video encoder sync groups", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "post": { "operationId": "createSyncGroup", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "keyframe_interval": { "interval": 1000, "unit": "MILLISECONDS" }, "latency_mode": { "value": "NORMAL" }, "limit_to_30_fps": false, "name": "regression_sync_group" }, "schema": { "$ref": "#/components/schemas/SyncGroupConfigurationWriteRequest" } } }, "required": true }, "responses": { "200": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Successful response when daemon returns no response payload" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncGroupConfiguration" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Create video encoder sync group", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": false, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [ { "coveragePriority": "secondary", "description": "Fan out request body by `keyframe_interval.unit`.", "fieldPath": "keyframe_interval.unit", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "MILLISECONDS", "FRAMES" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `limit_to_30_fps`.", "fieldPath": "limit_to_30_fps", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `latency_mode.value`.", "fieldPath": "latency_mode.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "NORMAL", "LOW", "LOWEST", "REALTIME", "HIGH" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `active`.", "fieldPath": "active", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] } ], "capabilityGate": "none", "createCapacityPrecondition": { "currentCount": { "countStrategy": "array_length", "fieldPath": "sync_groups" }, "description": "Create only when sync group count is below max_sync_groups.", "limit": { "countStrategy": "integer_value", "fieldPath": "max_sync_groups" }, "listEndpoint": { "method": "GET", "path": "/v2/encoders/vid_encoders/sync_groups", "responseSchema": "SyncGroupListResponse" }, "listOperationId": "listSyncGroups", "precondition": "current_count < limit" }, "precondition": "none", "queryParameterFanoutCandidates": [], "recycleOnCapacity": { "deleteEndpoint": { "method": "DELETE", "path": "/v2/encoders/vid_encoders/sync_groups/{syncgroupid}" }, "deleteOperationId": "deleteSyncGroup", "description": "When create capacity is exhausted, delete one existing entity using the standard DELETE endpoint, then retry the POST create attempt.", "idFieldPath": "sync_group_id", "idParameter": "syncgroupid", "listArrayFieldPath": "sync_groups", "selectionPolicy": "lowest_id_first", "strategy": "delete_existing_then_retry_create" }, "requiresRequestBody": true } } }, "/v2/encoders/vid_encoders/sync_groups/{syncgroupid}": { "delete": { "operationId": "deleteSyncGroup", "parameters": [ { "description": "Path parameter `syncgroupid`.", "in": "path", "name": "syncgroupid", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Delete one video encoder sync group", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "syncgroupid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "get": { "operationId": "getSyncGroup", "parameters": [ { "description": "Path parameter `syncgroupid`.", "in": "path", "name": "syncgroupid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncGroupConfiguration" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get one video encoder sync group", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "syncgroupid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "put": { "operationId": "updateSyncGroup", "parameters": [ { "description": "Path parameter `syncgroupid`.", "in": "path", "name": "syncgroupid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "keyframe_interval": { "interval": 1000, "unit": "MILLISECONDS" }, "latency_mode": { "value": "NORMAL" }, "limit_to_30_fps": false, "name": "regression_sync_group" }, "schema": { "$ref": "#/components/schemas/SyncGroupConfigurationWriteRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Update one video encoder sync group", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [ { "coveragePriority": "secondary", "description": "Fan out request body by `keyframe_interval.unit`.", "fieldPath": "keyframe_interval.unit", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "MILLISECONDS", "FRAMES" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `limit_to_30_fps`.", "fieldPath": "limit_to_30_fps", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `latency_mode.value`.", "fieldPath": "latency_mode.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "NORMAL", "LOW", "LOWEST", "REALTIME", "HIGH" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `active`.", "fieldPath": "active", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] } ], "capabilityGate": "none", "pathParameterStrategies": [ { "name": "syncgroupid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": true } } }, "/v2/encoders/vid_encoders/{encoderid}": { "delete": { "operationId": "deleteVideoEncoder", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Delete one video encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "get": { "operationId": "getVideoEncoder", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoEncoderConfiguration" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get one video encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "put": { "operationId": "updateVideoEncoder", "parameters": [ { "description": "Path parameter `encoderid`.", "in": "path", "name": "encoderid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "bitrate": { "value": 10000 }, "bitrate_mode": { "value": "variable" }, "codec": { "h264": { "profile": { "value": "PROFILE_HIGH" } }, "value": "H264" }, "keyframe_interval": { "interval": 1000, "unit": "MILLISECONDS" }, "latency_mode": { "value": "NORMAL" }, "limit_to_30_fps": false, "scaling_resolution": { "value": "RES_PASSTHROUGH" } }, "schema": { "$ref": "#/components/schemas/VideoEncoderConfigurationWriteRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Update one video encoder", "tags": [ "encoders" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [ { "coveragePriority": "secondary", "description": "Fan out request body by boolean `active`.", "fieldPath": "active", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `enable_retry`.", "fieldPath": "enable_retry", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `latency_mode.value`.", "fieldPath": "latency_mode.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "NORMAL", "LOW", "LOWEST", "REALTIME", "HIGH" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `bitrate_mode.value`.", "fieldPath": "bitrate_mode.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "constant", "variable", "constant_strict" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `keyframe_interval.unit`.", "fieldPath": "keyframe_interval.unit", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "MILLISECONDS", "FRAMES" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `scaling_resolution.value`.", "fieldPath": "scaling_resolution.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "RES_426X240", "RES_640X360", "RES_720X576", "RES_720X480", "RES_854X480", "RES_1280X720", "RES_1920X1080", "RES_PASSTHROUGH", "RES_480X270", "RES_960X540", "RES_320X180", "RES_3840X2160", "RES_320X180_BLUR", "RES_180X320", "RES_270X480", "RES_360X640", "RES_480X854", "RES_576X720", "RES_540X960", "RES_720X1280", "RES_1080X1920", "RES_2160X3840", "RES_1920X1200", "RES_2560X1440", "RES_1200X1920", "RES_1440X2560" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `limit_to_30_fps`.", "fieldPath": "limit_to_30_fps", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coverageGoal": "Generate at least one test per value of FlatBuffers enum VidCodec.", "coveragePriority": "primary", "description": "Fan out request body by `codec.value`.", "fieldPath": "codec.value", "flatbufferEnum": "VidCodec", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "H264", "H265" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `codec.h264.profile.value`.", "fieldPath": "codec.h264.profile.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "PROFILE_HIGH", "PROFILE_MAIN", "PROFILE_BASELINE" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `codec.h264.level.value`.", "fieldPath": "codec.h264.level.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "LVL3", "LVL3P1", "LVL3P2", "LVL4", "LVL4P1", "LVL4P2", "LVL5", "LVL5P1", "LVL5P2" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `codec.h265.profile.value`.", "fieldPath": "codec.h265.profile.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "PROFILE_MAIN" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `codec.h265.level.value`.", "fieldPath": "codec.h265.level.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "LVL_1_MAIN", "LVL_2_MAIN", "LVL_2P1_MAIN", "LVL_3_MAIN", "LVL_3P1_MAIN", "LVL_4_MAIN", "LVL_4_HIGH", "LVL_4P1_MAIN", "LVL_4P1_HIGH", "LVL_5_MAIN", "LVL_5_HIGH", "LVL_5P1_MAIN", "LVL_5P1_HIGH" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `klv_timestamp_enabled`.", "fieldPath": "klv_timestamp_enabled", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `cc_processing_enabled`.", "fieldPath": "cc_processing_enabled", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `allow_outputs_to_adjust_bitrate`.", "fieldPath": "allow_outputs_to_adjust_bitrate", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] } ], "capabilityGate": "none", "mandatoryCoverageFanouts": [ { "coverageGoal": "Generate at least one test per value of FlatBuffers enum VidCodec.", "coveragePriority": "primary", "description": "Fan out request body by `codec.value`.", "fieldPath": "codec.value", "flatbufferEnum": "VidCodec", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "H264", "H265" ] } ], "pathParameterStrategies": [ { "name": "encoderid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": true, "suggestedRuntimeProbeEndpoints": [ { "method": "GET", "path": "/v2/encoders/vid_encoders/{encoderid}", "purpose": "Read video encoder runtime fields (value_range, possible_values, status)." } ] } } }, "/v2/in_channels": { "get": { "operationId": "listInputChannels", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InputChannelListResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "List input channels", "tags": [ "inputs" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "post": { "operationId": "createInputChannel", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "input_type": { "hardware": { "hw_channel": 0 }, "value": "hardware" } }, "schema": { "$ref": "#/components/schemas/InputChannelConfigurationWriteRequest" } } }, "required": true }, "responses": { "200": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Successful response when daemon returns no response payload" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InputChannelConfiguration" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Create input channel", "tags": [ "inputs" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": false, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [ { "coveragePriority": "secondary", "description": "Fan out request body by boolean `locked`.", "fieldPath": "locked", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `audio_input.value`.", "fieldPath": "audio_input.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "input_embedded", "input_3p5mm", "input_auto", "input_hdmi", "input_sdi", "input_tpg" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `audio_input.detected`.", "fieldPath": "audio_input.detected", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `audio_input.sdi_ignore_phase`.", "fieldPath": "audio_input.sdi_ignore_phase", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `video_input.value`.", "fieldPath": "video_input.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "input_hdmi", "input_vga", "input_sdi", "input_auto", "input_tpg" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `video_input.detected_format.value`.", "fieldPath": "video_input.detected_format.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "FORMAT_UNDEFINED", "FORMAT_180p2398", "FORMAT_180p24", "FORMAT_180p25", "FORMAT_180p2997", "FORMAT_180p30", "FORMAT_180p50", "FORMAT_180p5994", "FORMAT_180p60", "FORMAT_270p2398", "FORMAT_270p24", "FORMAT_270p25", "FORMAT_270p2997", "FORMAT_270p30", "FORMAT_270p50", "FORMAT_270p5994", "FORMAT_270p60", "FORMAT_360p2398", "FORMAT_360p24", "FORMAT_360p25", "FORMAT_360p2997", "FORMAT_360p30", "FORMAT_360p50", "FORMAT_360p5994", "FORMAT_360p60", "FORMAT_480i5994", "FORMAT_480i60", "FORMAT_480p2398", "FORMAT_480p24", "FORMAT_480p25", "FORMAT_480p50", "FORMAT_480p2997", "FORMAT_480p30", "FORMAT_480p5994", "FORMAT_480p60", "FORMAT_576i50", "FORMAT_576p2398", "FORMAT_576p24", "FORMAT_576p25", "FORMAT_576p50", "FORMAT_576p2997", "FORMAT_576p30", "FORMAT_576p5994", "FORMAT_576p60", "FORMAT_540p2398", "FORMAT_540p24", "FORMAT_540p25", "FORMAT_540p2997", "FORMAT_540p30", "FORMAT_540p50", "FORMAT_540p5994", "FORMAT_540p60", "FORMAT_720p2398", "FORMAT_720p24", "FORMAT_720p25", "FORMAT_720p2997", "FORMAT_720p30", "FORMAT_720p50", "FORMAT_720p5994", "FORMAT_720p60", "FORMAT_1080i50", "FORMAT_1080i5994", "FORMAT_1080i60", "FORMAT_1080p2398", "FORMAT_1080p24", "FORMAT_1080p25", "FORMAT_1080p2997", "FORMAT_1080p30", "FORMAT_1080p50", "FORMAT_1080p5994", "FORMAT_1080p60", "FORMAT_1200p60", "FORMAT_1440p60", "FORMAT_2160p2398", "FORMAT_2160p24", "FORMAT_2160p25", "FORMAT_2160p2997", "FORMAT_2160p30", "FORMAT_2160p50", "FORMAT_2160p5994", "FORMAT_2160p60" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `graphic_overlay.enable`.", "fieldPath": "graphic_overlay.enable", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `graphic_overlay.position.lock_resolution_ratio.value`.", "fieldPath": "graphic_overlay.position.lock_resolution_ratio.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "NO_LOCK", "LOCK_TO_WIDTH", "LOCK_TO_HEIGHT" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `graphic_overlay.position.lock_aspect_ratio.value`.", "fieldPath": "graphic_overlay.position.lock_aspect_ratio.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "NO_LOCK", "LOCK_TO_WIDTH", "LOCK_TO_HEIGHT" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `graphic_overlay.position.preset.value`.", "fieldPath": "graphic_overlay.position.preset.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "MANUAL", "FULLSCREEN", "LOWER_THIRD", "TOP_LEFT", "BOTTOM_LEFT", "TOP_CENTER", "CENTER", "BOTTOM_CENTER", "TOP_RIGHT", "BOTTOM_RIGHT" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `video_rotation.value`.", "fieldPath": "video_rotation.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "ROTATE_0", "ROTATE_90", "ROTATE_180", "ROTATE_270" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `input_type.value`.", "fieldPath": "input_type.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "notConfigured", "hardware", "gstreamer" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `enable_persistent_input`.", "fieldPath": "enable_persistent_input", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `force_av_mute`.", "fieldPath": "force_av_mute", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] } ], "capabilityGate": "none", "createCapacityPrecondition": { "currentCount": { "countStrategy": "array_length", "fieldPath": "in_channels" }, "description": "Create only when fewer input channels exist than available hardware channels.", "limit": { "countStrategy": "array_length", "fieldPath": "possible_hw_channels" }, "listEndpoint": { "method": "GET", "path": "/v2/in_channels", "responseSchema": "InputChannelListResponse" }, "listOperationId": "listInputChannels", "precondition": "current_count < limit" }, "precondition": "none", "queryParameterFanoutCandidates": [], "recycleOnCapacity": { "deleteEndpoint": { "method": "DELETE", "path": "/v2/in_channels/{inputchannelid}" }, "deleteOperationId": "deleteInputChannel", "description": "When create capacity is exhausted, delete one existing entity using the standard DELETE endpoint, then retry the POST create attempt.", "idFieldPath": "in_channel_id", "idParameter": "inputchannelid", "listArrayFieldPath": "in_channels", "selectionPolicy": "lowest_id_first", "strategy": "delete_existing_then_retry_create" }, "requiresRequestBody": true } } }, "/v2/in_channels/{inputchannelid}": { "delete": { "operationId": "deleteInputChannel", "parameters": [ { "description": "Path parameter `inputchannelid`.", "in": "path", "name": "inputchannelid", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Delete one input channel", "tags": [ "inputs" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "inputchannelid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "get": { "operationId": "getInputChannel", "parameters": [ { "description": "Path parameter `inputchannelid`.", "in": "path", "name": "inputchannelid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InputChannelConfiguration" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get one input channel", "tags": [ "inputs" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "inputchannelid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "put": { "operationId": "updateInputChannel", "parameters": [ { "description": "Path parameter `inputchannelid`.", "in": "path", "name": "inputchannelid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "input_type": { "hardware": { "hw_channel": 0 }, "value": "hardware" } }, "schema": { "$ref": "#/components/schemas/InputChannelConfigurationWriteRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Update one input channel", "tags": [ "inputs" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [ { "coveragePriority": "secondary", "description": "Fan out request body by boolean `locked`.", "fieldPath": "locked", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `audio_input.value`.", "fieldPath": "audio_input.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "input_embedded", "input_3p5mm", "input_auto", "input_hdmi", "input_sdi", "input_tpg" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `audio_input.detected`.", "fieldPath": "audio_input.detected", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `audio_input.sdi_ignore_phase`.", "fieldPath": "audio_input.sdi_ignore_phase", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `video_input.value`.", "fieldPath": "video_input.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "input_hdmi", "input_vga", "input_sdi", "input_auto", "input_tpg" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `video_input.detected_format.value`.", "fieldPath": "video_input.detected_format.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "FORMAT_UNDEFINED", "FORMAT_180p2398", "FORMAT_180p24", "FORMAT_180p25", "FORMAT_180p2997", "FORMAT_180p30", "FORMAT_180p50", "FORMAT_180p5994", "FORMAT_180p60", "FORMAT_270p2398", "FORMAT_270p24", "FORMAT_270p25", "FORMAT_270p2997", "FORMAT_270p30", "FORMAT_270p50", "FORMAT_270p5994", "FORMAT_270p60", "FORMAT_360p2398", "FORMAT_360p24", "FORMAT_360p25", "FORMAT_360p2997", "FORMAT_360p30", "FORMAT_360p50", "FORMAT_360p5994", "FORMAT_360p60", "FORMAT_480i5994", "FORMAT_480i60", "FORMAT_480p2398", "FORMAT_480p24", "FORMAT_480p25", "FORMAT_480p50", "FORMAT_480p2997", "FORMAT_480p30", "FORMAT_480p5994", "FORMAT_480p60", "FORMAT_576i50", "FORMAT_576p2398", "FORMAT_576p24", "FORMAT_576p25", "FORMAT_576p50", "FORMAT_576p2997", "FORMAT_576p30", "FORMAT_576p5994", "FORMAT_576p60", "FORMAT_540p2398", "FORMAT_540p24", "FORMAT_540p25", "FORMAT_540p2997", "FORMAT_540p30", "FORMAT_540p50", "FORMAT_540p5994", "FORMAT_540p60", "FORMAT_720p2398", "FORMAT_720p24", "FORMAT_720p25", "FORMAT_720p2997", "FORMAT_720p30", "FORMAT_720p50", "FORMAT_720p5994", "FORMAT_720p60", "FORMAT_1080i50", "FORMAT_1080i5994", "FORMAT_1080i60", "FORMAT_1080p2398", "FORMAT_1080p24", "FORMAT_1080p25", "FORMAT_1080p2997", "FORMAT_1080p30", "FORMAT_1080p50", "FORMAT_1080p5994", "FORMAT_1080p60", "FORMAT_1200p60", "FORMAT_1440p60", "FORMAT_2160p2398", "FORMAT_2160p24", "FORMAT_2160p25", "FORMAT_2160p2997", "FORMAT_2160p30", "FORMAT_2160p50", "FORMAT_2160p5994", "FORMAT_2160p60" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `graphic_overlay.enable`.", "fieldPath": "graphic_overlay.enable", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `graphic_overlay.position.lock_resolution_ratio.value`.", "fieldPath": "graphic_overlay.position.lock_resolution_ratio.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "NO_LOCK", "LOCK_TO_WIDTH", "LOCK_TO_HEIGHT" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `graphic_overlay.position.lock_aspect_ratio.value`.", "fieldPath": "graphic_overlay.position.lock_aspect_ratio.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "NO_LOCK", "LOCK_TO_WIDTH", "LOCK_TO_HEIGHT" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `graphic_overlay.position.preset.value`.", "fieldPath": "graphic_overlay.position.preset.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "MANUAL", "FULLSCREEN", "LOWER_THIRD", "TOP_LEFT", "BOTTOM_LEFT", "TOP_CENTER", "CENTER", "BOTTOM_CENTER", "TOP_RIGHT", "BOTTOM_RIGHT" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `video_rotation.value`.", "fieldPath": "video_rotation.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "ROTATE_0", "ROTATE_90", "ROTATE_180", "ROTATE_270" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `input_type.value`.", "fieldPath": "input_type.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "notConfigured", "hardware", "gstreamer" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `enable_persistent_input`.", "fieldPath": "enable_persistent_input", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `force_av_mute`.", "fieldPath": "force_av_mute", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] } ], "capabilityGate": "none", "pathParameterStrategies": [ { "name": "inputchannelid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": true, "suggestedRuntimeProbeEndpoints": [ { "method": "GET", "path": "/v2/in_channels/{inputchannelid}", "purpose": "Read input channel runtime validation fields after create/update." } ] } } }, "/v2/in_channels/{inputchannelid}/overlay_graphic": { "delete": { "operationId": "deleteInputChannelOverlayGraphic", "parameters": [ { "description": "Path parameter `inputchannelid`.", "in": "path", "name": "inputchannelid", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Delete one input channel overlay graphic", "tags": [ "inputs" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "capabilityGate": "graphic_overlay", "pathParameterStrategies": [ { "name": "inputchannelid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "graphic_overlay_enabled", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "get": { "operationId": "getInputChannelOverlayGraphic", "parameters": [ { "description": "Path parameter `inputchannelid`.", "in": "path", "name": "inputchannelid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "image/png": { "schema": { "$ref": "#/components/schemas/OverlayGraphicResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get one input channel overlay graphic", "tags": [ "inputs" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "graphic_overlay", "pathParameterStrategies": [ { "name": "inputchannelid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "graphic_overlay_enabled", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "post": { "operationId": "uploadInputChannelOverlayGraphic", "parameters": [ { "description": "Path parameter `inputchannelid`.", "in": "path", "name": "inputchannelid", "required": true, "schema": { "type": "string" } }, { "description": "If true, persist overlay image to configuration storage.", "in": "query", "name": "persist", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OverlayGraphicUploadRequest" } } }, "required": true }, "responses": { "200": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Successful response when daemon returns no response payload" }, "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Upload one input channel overlay graphic", "tags": [ "inputs" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": false, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [], "capabilityGate": "graphic_overlay", "pathParameterStrategies": [ { "name": "inputchannelid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "graphic_overlay_enabled", "queryParameterFanoutCandidates": [ { "description": "Fan out query parameter `persist`.", "in": "query", "name": "persist", "type": "boolean", "values": [ true, false ] } ], "requiresRequestBody": true, "suggestedRuntimeProbeEndpoints": [ { "method": "GET", "path": "/v2/in_channels/{inputchannelid}", "purpose": "Read input channel runtime validation fields after create/update." } ] } } }, "/v2/in_channels/{inputchannelid}/status": { "get": { "operationId": "getInputChannelStatus", "parameters": [ { "description": "Path parameter `inputchannelid`.", "in": "path", "name": "inputchannelid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComponentStatusResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get one input channel status", "tags": [ "inputs" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "inputchannelid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } } }, "/v2/out_streams": { "get": { "operationId": "listOutStreams", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputStreamListResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "List output streams", "tags": [ "out_streams" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "post": { "operationId": "createOutStream", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "enable": true, "output_type": { "value": "rtmp" } }, "schema": { "$ref": "#/components/schemas/OutputStreamConfigurationWriteRequest" } } }, "required": true }, "responses": { "200": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Successful response when daemon returns no response payload" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputStreamConfiguration" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Create output stream", "tags": [ "out_streams" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": false, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [ { "coveragePriority": "secondary", "description": "Fan out request body by boolean `enable`.", "fieldPath": "enable", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coverageGoal": "Generate at least one test per value of FlatBuffers enum StreamType.", "coveragePriority": "primary", "description": "Fan out request body by `output_type.value`.", "fieldPath": "output_type.value", "flatbufferEnum": "StreamType", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "multicast", "unicast", "rtmp", "file", "rtsp", "http_push", "thumbnail", "srt", "socket", "zixi", "whip" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.unicast.protocol`.", "fieldPath": "output_type.unicast.protocol", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "RTP", "RAW_UDP", "SRT" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.multicast.protocol`.", "fieldPath": "output_type.multicast.protocol", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "RTP", "RAW_UDP", "SRT" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.http_push.media_container.value`.", "fieldPath": "output_type.http_push.media_container.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "MP4", "TS", "FMP4", "F4V" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.http_push.save_segment_window`.", "fieldPath": "output_type.http_push.save_segment_window", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.http_push.synchronization.enable`.", "fieldPath": "output_type.http_push.synchronization.enable", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.http_push.ultra_low_latency.enable`.", "fieldPath": "output_type.http_push.ultra_low_latency.enable", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.http_push.ultra_low_latency.chunk_interval.unit`.", "fieldPath": "output_type.http_push.ultra_low_latency.chunk_interval.unit", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "MILLISECONDS", "FRAMES" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.file_record.filename_timezone.value`.", "fieldPath": "output_type.file_record.filename_timezone.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "UTC", "LOCALTIME" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.file_record.file_format.value`.", "fieldPath": "output_type.file_record.file_format.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "MP4", "TS", "FMP4", "F4V" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.file_record.delete_oldest_when_full`.", "fieldPath": "output_type.file_record.delete_oldest_when_full", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.file_record.limit_max_file_size.enable`.", "fieldPath": "output_type.file_record.limit_max_file_size.enable", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.file_record.device_selection_policy.value`.", "fieldPath": "output_type.file_record.device_selection_policy.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "ATTACH_TIME_FIRST", "ATTACH_TIME_LAST", "FREE_SPACE_MAX", "TOTAL_SPACE_MAX", "VOLUME_UUID" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.file_record.ftp_upload.enable`.", "fieldPath": "output_type.file_record.ftp_upload.enable", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.file_record.ftp_upload.protocol.value`.", "fieldPath": "output_type.file_record.ftp_upload.protocol.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "FTP", "SFTP" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.file_record.ftp_upload.delete_file_after_upload`.", "fieldPath": "output_type.file_record.ftp_upload.delete_file_after_upload", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.srt.key_size.value`.", "fieldPath": "output_type.srt.key_size.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "NONE", "AES128", "AES192", "AES256" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.srt.protocol`.", "fieldPath": "output_type.srt.protocol", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "RTP", "RAW_UDP", "SRT" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.srt.call_mode.value`.", "fieldPath": "output_type.srt.call_mode.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "CALLER", "LISTENER" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.srt.encryption_enabled`.", "fieldPath": "output_type.srt.encryption_enabled", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.zixi.key_size.value`.", "fieldPath": "output_type.zixi.key_size.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "AES128", "AES192", "AES256" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.zixi.encryption_enabled`.", "fieldPath": "output_type.zixi.encryption_enabled", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.zixi.enable_back_pressure_bitrate_adjustment`.", "fieldPath": "output_type.zixi.enable_back_pressure_bitrate_adjustment", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.zixi.dtls.dtls_cert_exist`.", "fieldPath": "output_type.zixi.dtls.dtls_cert_exist", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.zixi.dtls.ignore_dtls_cert_error`.", "fieldPath": "output_type.zixi.dtls.ignore_dtls_cert_error", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `enable_retry`.", "fieldPath": "enable_retry", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `unlimited_retries`.", "fieldPath": "unlimited_retries", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] } ], "capabilityGate": "none", "createCapacityPrecondition": { "currentCount": { "countStrategy": "array_length_filtered", "fieldPath": "out_streams", "filterByRequestField": { "candidateItemFieldPaths": [ "output_type.value", "output_type" ], "requestFieldPath": "output_type.value" } }, "description": "Create only when output-type-specific stream capacity is available.", "limitByRequestField": { "countStrategy": "integer_value", "defaultPolicy": "skip_when_unmapped", "fieldMap": { "file": "max_file_record", "http_push": "max_http_push", "multicast": "max_multicast", "rtmp": "max_rtmp", "rtsp": "max_rtsp", "socket": "max_socket", "srt": "max_srt", "thumbnail": "max_thumbnail", "unicast": "max_unicast", "whip": "max_whip", "zixi": "max_zixi" }, "requestFieldPath": "output_type.value" }, "listEndpoint": { "method": "GET", "path": "/v2/out_streams", "responseSchema": "OutputStreamListResponse" }, "listOperationId": "listOutStreams", "precondition": "current_count_for_output_type < limit_for_output_type" }, "mandatoryCoverageFanouts": [ { "coverageGoal": "Generate at least one test per value of FlatBuffers enum StreamType.", "coveragePriority": "primary", "description": "Fan out request body by `output_type.value`.", "fieldPath": "output_type.value", "flatbufferEnum": "StreamType", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "multicast", "unicast", "rtmp", "file", "rtsp", "http_push", "thumbnail", "srt", "socket", "zixi", "whip" ] } ], "precondition": "none", "queryParameterFanoutCandidates": [], "recycleOnCapacity": { "deleteEndpoint": { "method": "DELETE", "path": "/v2/out_streams/{outputid}" }, "deleteOperationId": "deleteOutStream", "description": "When create capacity is exhausted, delete one existing entity using the standard DELETE endpoint, then retry the POST create attempt.", "idFieldPath": "out_stream_id", "idParameter": "outputid", "listArrayFieldPath": "out_streams", "selectionPolicy": "lowest_id_first", "strategy": "delete_existing_then_retry_create" }, "requiresRequestBody": true } } }, "/v2/out_streams/{outputid}": { "delete": { "operationId": "deleteOutStream", "parameters": [ { "description": "Path parameter `outputid`.", "in": "path", "name": "outputid", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Delete one output stream", "tags": [ "out_streams" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "outputid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "get": { "operationId": "getOutStream", "parameters": [ { "description": "Path parameter `outputid`.", "in": "path", "name": "outputid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputStreamConfiguration" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get one output stream", "tags": [ "out_streams" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "outputid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "put": { "operationId": "updateOutStream", "parameters": [ { "description": "Path parameter `outputid`.", "in": "path", "name": "outputid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "enable": true, "output_type": { "value": "rtmp" } }, "schema": { "$ref": "#/components/schemas/OutputStreamConfigurationWriteRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Update one output stream", "tags": [ "out_streams" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [ { "coveragePriority": "secondary", "description": "Fan out request body by boolean `enable`.", "fieldPath": "enable", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coverageGoal": "Generate at least one test per value of FlatBuffers enum StreamType.", "coveragePriority": "primary", "description": "Fan out request body by `output_type.value`.", "fieldPath": "output_type.value", "flatbufferEnum": "StreamType", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "multicast", "unicast", "rtmp", "file", "rtsp", "http_push", "thumbnail", "srt", "socket", "zixi", "whip" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.unicast.protocol`.", "fieldPath": "output_type.unicast.protocol", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "RTP", "RAW_UDP", "SRT" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.multicast.protocol`.", "fieldPath": "output_type.multicast.protocol", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "RTP", "RAW_UDP", "SRT" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.http_push.media_container.value`.", "fieldPath": "output_type.http_push.media_container.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "MP4", "TS", "FMP4", "F4V" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.http_push.save_segment_window`.", "fieldPath": "output_type.http_push.save_segment_window", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.http_push.synchronization.enable`.", "fieldPath": "output_type.http_push.synchronization.enable", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.http_push.ultra_low_latency.enable`.", "fieldPath": "output_type.http_push.ultra_low_latency.enable", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.http_push.ultra_low_latency.chunk_interval.unit`.", "fieldPath": "output_type.http_push.ultra_low_latency.chunk_interval.unit", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "MILLISECONDS", "FRAMES" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.file_record.filename_timezone.value`.", "fieldPath": "output_type.file_record.filename_timezone.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "UTC", "LOCALTIME" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.file_record.file_format.value`.", "fieldPath": "output_type.file_record.file_format.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "MP4", "TS", "FMP4", "F4V" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.file_record.delete_oldest_when_full`.", "fieldPath": "output_type.file_record.delete_oldest_when_full", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.file_record.limit_max_file_size.enable`.", "fieldPath": "output_type.file_record.limit_max_file_size.enable", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.file_record.device_selection_policy.value`.", "fieldPath": "output_type.file_record.device_selection_policy.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "ATTACH_TIME_FIRST", "ATTACH_TIME_LAST", "FREE_SPACE_MAX", "TOTAL_SPACE_MAX", "VOLUME_UUID" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.file_record.ftp_upload.enable`.", "fieldPath": "output_type.file_record.ftp_upload.enable", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.file_record.ftp_upload.protocol.value`.", "fieldPath": "output_type.file_record.ftp_upload.protocol.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "FTP", "SFTP" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.file_record.ftp_upload.delete_file_after_upload`.", "fieldPath": "output_type.file_record.ftp_upload.delete_file_after_upload", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.srt.key_size.value`.", "fieldPath": "output_type.srt.key_size.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "NONE", "AES128", "AES192", "AES256" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.srt.protocol`.", "fieldPath": "output_type.srt.protocol", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "RTP", "RAW_UDP", "SRT" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.srt.call_mode.value`.", "fieldPath": "output_type.srt.call_mode.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "CALLER", "LISTENER" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.srt.encryption_enabled`.", "fieldPath": "output_type.srt.encryption_enabled", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by `output_type.zixi.key_size.value`.", "fieldPath": "output_type.zixi.key_size.value", "type": "enum", "valueSource": "request_schema_enum", "values": [ "AES128", "AES192", "AES256" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.zixi.encryption_enabled`.", "fieldPath": "output_type.zixi.encryption_enabled", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.zixi.enable_back_pressure_bitrate_adjustment`.", "fieldPath": "output_type.zixi.enable_back_pressure_bitrate_adjustment", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.zixi.dtls.dtls_cert_exist`.", "fieldPath": "output_type.zixi.dtls.dtls_cert_exist", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `output_type.zixi.dtls.ignore_dtls_cert_error`.", "fieldPath": "output_type.zixi.dtls.ignore_dtls_cert_error", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `enable_retry`.", "fieldPath": "enable_retry", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `unlimited_retries`.", "fieldPath": "unlimited_retries", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] } ], "capabilityGate": "none", "mandatoryCoverageFanouts": [ { "coverageGoal": "Generate at least one test per value of FlatBuffers enum StreamType.", "coveragePriority": "primary", "description": "Fan out request body by `output_type.value`.", "fieldPath": "output_type.value", "flatbufferEnum": "StreamType", "type": "enum", "valueSource": "flatbuffer_enum", "values": [ "multicast", "unicast", "rtmp", "file", "rtsp", "http_push", "thumbnail", "srt", "socket", "zixi", "whip" ] } ], "pathParameterStrategies": [ { "name": "outputid", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": true } } }, "/v2/out_streams/{outputid}/action/{actionname}": { "post": { "description": "Supported actions and constraints:\n- `authenticate_ftp`: applies when componentType=out_stream, output_type.value=['file'].\n - allowed body fields: file_path, password, server, username\n- `clear`: applies when componentType=out_stream, output_type.value=['rtmp', 'whip'].", "operationId": "runOutStreamAction", "parameters": [ { "description": "Path parameter `outputid`.", "in": "path", "name": "outputid", "required": true, "schema": { "type": "string" } }, { "description": "Action name for `runOutStreamAction`. Values reflect daemon-supported actions. See `x-videon-testHints.actionContracts` for per-action applicability and body rules.", "in": "path", "name": "actionname", "required": true, "schema": { "enum": [ "authenticate_ftp", "clear" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": {}, "schema": { "$ref": "#/components/schemas/ActionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionResponse" } } }, "description": "Successful response" }, "204": { "description": "Action accepted with no response body" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Run action on one output stream", "tags": [ "out_streams" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": false, "x-videon-sideEffect": "action", "x-videon-testHints": { "actionContracts": { "authenticate_ftp": { "appliesWhen": { "componentType": "out_stream", "output_type.value": [ "file" ] }, "requestBody": { "fields": { "file_path": { "type": "string" }, "password": { "type": "string" }, "server": { "type": "string" }, "username": { "type": "string" } } } }, "clear": { "appliesWhen": { "componentType": "out_stream", "output_type.value": [ "rtmp", "whip" ] }, "requestBody": {} } }, "actionNameOptions": [ "authenticate_ftp", "clear" ], "bodyFanoutCandidates": [], "capabilityGate": "none", "pathFanoutCandidates": [ { "coverageGoal": "Generate at least one test per action in actionNameOptions for this operation.", "coveragePriority": "primary", "description": "Fan out path parameter `actionname`.", "in": "path", "name": "actionname", "type": "enum", "valueSource": "daemon_action_handlers", "values": [ "authenticate_ftp", "clear" ] } ], "pathParameterStrategies": [ { "name": "outputid", "strategy": "resolve_from_prior_list_or_create_response" }, { "name": "actionname", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": true, "suggestedRuntimeProbeEndpoints": [ { "method": "GET", "path": "/v2/out_streams/{outputid}/action/{actionname}", "purpose": "Resolve component id and baseline configuration before running actions." } ] } } }, "/v2/storage": { "get": { "operationId": "listStorage", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageDeviceListResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "List storage devices", "tags": [ "storage" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } } }, "/v2/storage/{drivename}/": { "get": { "operationId": "getStorage", "parameters": [ { "description": "Path parameter `drivename`.", "in": "path", "name": "drivename", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageDeviceResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get one storage device details", "tags": [ "storage" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "drivename", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } } }, "/v2/storage/{drivename}/format": { "post": { "operationId": "formatStorage", "parameters": [ { "description": "Path parameter `drivename`.", "in": "path", "name": "drivename", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Format one storage device", "tags": [ "storage" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": false, "x-videon-sideEffect": "action", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "drivename", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "device_present", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } } }, "/v2/storage/{drivename}/unmount": { "post": { "operationId": "unmountStorage", "parameters": [ { "description": "Path parameter `drivename`.", "in": "path", "name": "drivename", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Successful response when daemon returns no response payload" }, "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Unmount one storage device", "tags": [ "storage" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": false, "x-videon-sideEffect": "action", "x-videon-testHints": { "capabilityGate": "none", "pathParameterStrategies": [ { "name": "drivename", "strategy": "resolve_from_prior_list_or_create_response" } ], "precondition": "device_mounted", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } } }, "/v2/system": { "get": { "operationId": "getSystemConfiguration", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemConfiguration" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get system configuration", "tags": [ "system" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "put": { "operationId": "updateSystemConfiguration", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemConfigurationWriteRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Update system configuration", "tags": [ "system" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [ { "coveragePriority": "secondary", "description": "Fan out request body by `ip_scheme`.", "fieldPath": "ip_scheme", "type": "enum", "valueSource": "request_schema_enum", "values": [ "unspecified", "static", "dhcp" ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `net_connected`.", "fieldPath": "net_connected", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] }, { "coveragePriority": "secondary", "description": "Fan out request body by boolean `xml.enabled`.", "fieldPath": "xml.enabled", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] } ], "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": true, "suggestedRuntimeProbeEndpoints": [ { "method": "GET", "path": "/v2/system", "purpose": "Read system configuration and runtime network fields." } ] } } }, "/v2/xml": { "get": { "operationId": "getXmlConfiguration", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XmlConfiguration" } } }, "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Get XML configuration", "tags": [ "xml" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "read", "x-videon-testHints": { "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": false } }, "put": { "operationId": "updateXmlConfiguration", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XmlConfigurationWriteRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful response" }, "400": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Invalid request payload or unsupported value" }, "404": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Entity not found" }, "405": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Method not allowed for endpoint" }, "500": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Internal daemon error" }, "503": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlainTextResponse" } } }, "description": "Service unavailable" } }, "summary": "Update XML configuration", "tags": [ "xml" ], "x-videon-flavors": [ "trogdor" ], "x-videon-idempotent": true, "x-videon-sideEffect": "write", "x-videon-testHints": { "bodyFanoutCandidates": [ { "coveragePriority": "secondary", "description": "Fan out request body by boolean `xml.enabled`.", "fieldPath": "xml.enabled", "type": "boolean", "valueSource": "boolean_choice", "values": [ true, false ] } ], "capabilityGate": "none", "precondition": "none", "queryParameterFanoutCandidates": [], "requiresRequestBody": true, "suggestedRuntimeProbeEndpoints": [ { "method": "GET", "path": "/v2/xml", "purpose": "Read XML configuration state." } ] } } } }, "servers": [ { "url": "/" } ], "tags": [ { "name": "system" }, { "name": "xml" }, { "name": "debug" }, { "name": "devices" }, { "name": "storage" }, { "name": "inputs" }, { "name": "encoders" }, { "name": "out_streams" } ], "x-videon-doc-generation": { "flavor": "trogdor", "notes": [ "This specification is generated from code-owned endpoint metadata.", "Action options and action contracts are derived from daemon action handlers under daemon/avstream.", "Write operations use request-only schemas that omit runtime/status/range helper fields.", "x-videon-testHints and x-videon-testHarness support downstream automatic test-harness generation.", "Generator enforces no opaque operation schemas unless explicitly allowlisted with rationale." ], "source": "daemon/cmdif/rest_api_registry_v2.def" }, "x-videon-testHarness": { "contractSchemaSource": "flatbuffers/schema/configuration.fbs", "coverageDimensions": [ { "coverageGoal": "At least one passing test per enum value in VidCodec.", "createOperations": [ "createVideoEncoder" ], "enumValues": [ "H264", "H265" ], "fieldPath": "codec.value", "flatbufferEnum": "VidCodec" }, { "coverageGoal": "At least one passing test per enum value in AudCodec.", "createOperations": [ "createAudioEncoder" ], "enumValues": [ "mpeg2_aac", "mpeg4_aac", "mpeg4_aac_loas", "opus" ], "fieldPath": "codec.value", "flatbufferEnum": "AudCodec" }, { "coverageGoal": "At least one passing test per enum value in DatCodec.", "createOperations": [ "createDataEncoder" ], "enumValues": [ "klv_sync", "scte35", "smpte2038" ], "fieldPath": "codec.value", "flatbufferEnum": "DatCodec" }, { "coverageGoal": "At least one passing test per enum value in StreamType.", "createOperations": [ "createOutStream" ], "enumValues": [ "notConfigured", "multicast", "unicast", "rtmp", "file", "rtsp", "http_push", "thumbnail", "srt", "socket", "zixi", "whip" ], "fieldPath": "output_type.value", "flatbufferEnum": "StreamType" } ], "endpointCatalog": [ { "capabilityGate": "none", "method": "GET", "operationId": "getAbout", "path": "/v2/about", "requestSchema": "", "successSchema": "AboutResponse", "tag": "system" }, { "capabilityGate": "none", "method": "GET", "operationId": "getDebugVerbosity", "path": "/v2/debug_verbosity", "requestSchema": "", "successSchema": "DebugVerbosityResponse", "tag": "debug" }, { "capabilityGate": "none", "method": "PUT", "operationId": "setDebugVerbosity", "path": "/v2/debug_verbosity", "requestSchema": "DebugVerbosityRequest", "successSchema": "NoContent", "tag": "debug" }, { "capabilityGate": "none", "method": "GET", "operationId": "getDebugVerbosityComponents", "path": "/v2/debug_verbosity/components", "requestSchema": "", "successSchema": "DebugVerbosityComponentsResponse", "tag": "debug" }, { "capabilityGate": "none", "method": "PUT", "operationId": "setDebugVerbosityComponents", "path": "/v2/debug_verbosity/components", "requestSchema": "DebugVerbosityComponentsUpdateRequest", "successSchema": "NoContent", "tag": "debug" }, { "capabilityGate": "none", "method": "DELETE", "operationId": "deleteDebugVerbosityComponentOverride", "path": "/v2/debug_verbosity/components/{component}", "requestSchema": "", "successSchema": "NoContent", "tag": "debug" }, { "capabilityGate": "none", "method": "GET", "operationId": "getDebugVerbosityScopes", "path": "/v2/debug_verbosity/scopes", "requestSchema": "", "successSchema": "DebugVerbosityScopesResponse", "tag": "debug" }, { "capabilityGate": "none", "method": "PUT", "operationId": "setDebugVerbosityScopes", "path": "/v2/debug_verbosity/scopes", "requestSchema": "DebugVerbosityScopesUpdateRequest", "successSchema": "NoContent", "tag": "debug" }, { "capabilityGate": "none", "method": "DELETE", "operationId": "deleteDebugVerbosityScopeOverride", "path": "/v2/debug_verbosity/scopes/{scope}", "requestSchema": "", "successSchema": "NoContent", "tag": "debug" }, { "capabilityGate": "none", "method": "GET", "operationId": "listDevices", "path": "/v2/devices", "requestSchema": "", "successSchema": "DeviceListResponse", "tag": "devices" }, { "capabilityGate": "none", "method": "GET", "operationId": "getDevice", "path": "/v2/devices/{deviceid}", "requestSchema": "", "successSchema": "DeviceResponse", "tag": "devices" }, { "capabilityGate": "none", "method": "GET", "operationId": "listEncoders", "path": "/v2/encoders", "requestSchema": "", "successSchema": "EncoderListResponse", "tag": "encoders" }, { "capabilityGate": "none", "method": "GET", "operationId": "listAudioEncoders", "path": "/v2/encoders/aud_encoders", "requestSchema": "", "successSchema": "AudioEncoderListResponse", "tag": "encoders" }, { "capabilityGate": "none", "method": "POST", "operationId": "createAudioEncoder", "path": "/v2/encoders/aud_encoders", "requestSchema": "AudioEncoderConfiguration", "successSchema": "AudioEncoderConfiguration", "tag": "encoders" }, { "capabilityGate": "none", "method": "DELETE", "operationId": "deleteAudioEncoder", "path": "/v2/encoders/aud_encoders/{encoderid}", "requestSchema": "", "successSchema": "NoContent", "tag": "encoders" }, { "capabilityGate": "none", "method": "GET", "operationId": "getAudioEncoder", "path": "/v2/encoders/aud_encoders/{encoderid}", "requestSchema": "", "successSchema": "AudioEncoderConfiguration", "tag": "encoders" }, { "capabilityGate": "none", "method": "PUT", "operationId": "updateAudioEncoder", "path": "/v2/encoders/aud_encoders/{encoderid}", "requestSchema": "AudioEncoderConfiguration", "successSchema": "NoContent", "tag": "encoders" }, { "capabilityGate": "none", "method": "GET", "operationId": "listDataEncoders", "path": "/v2/encoders/data_encoders", "requestSchema": "", "successSchema": "DataEncoderListResponse", "tag": "encoders" }, { "capabilityGate": "none", "method": "POST", "operationId": "createDataEncoder", "path": "/v2/encoders/data_encoders", "requestSchema": "DataEncoderConfiguration", "successSchema": "DataEncoderConfiguration", "tag": "encoders" }, { "capabilityGate": "none", "method": "DELETE", "operationId": "deleteDataEncoder", "path": "/v2/encoders/data_encoders/{encoderid}", "requestSchema": "", "successSchema": "NoContent", "tag": "encoders" }, { "capabilityGate": "none", "method": "GET", "operationId": "getDataEncoder", "path": "/v2/encoders/data_encoders/{encoderid}", "requestSchema": "", "successSchema": "DataEncoderConfiguration", "tag": "encoders" }, { "capabilityGate": "none", "method": "PUT", "operationId": "updateDataEncoder", "path": "/v2/encoders/data_encoders/{encoderid}", "requestSchema": "DataEncoderConfiguration", "successSchema": "NoContent", "tag": "encoders" }, { "capabilityGate": "none", "method": "POST", "operationId": "runDataEncoderAction", "path": "/v2/encoders/data_encoders/{encoderid}/action/{actionname}", "requestSchema": "ActionRequest", "successSchema": "ActionResponse", "tag": "encoders" }, { "capabilityGate": "klv", "method": "GET", "operationId": "listDataEncoderKlv", "path": "/v2/encoders/data_encoders/{encoderid}/klv", "requestSchema": "", "successSchema": "DataEncoderKlvListResponse", "tag": "encoders" }, { "capabilityGate": "klv", "method": "POST", "operationId": "createDataEncoderKlv", "path": "/v2/encoders/data_encoders/{encoderid}/klv", "requestSchema": "DataEncoderKlv", "successSchema": "IdResponse", "tag": "encoders" }, { "capabilityGate": "klv", "method": "DELETE", "operationId": "deleteDataEncoderKlv", "path": "/v2/encoders/data_encoders/{encoderid}/klv/{klvid}", "requestSchema": "", "successSchema": "NoContent", "tag": "encoders" }, { "capabilityGate": "klv", "method": "GET", "operationId": "getDataEncoderKlv", "path": "/v2/encoders/data_encoders/{encoderid}/klv/{klvid}", "requestSchema": "", "successSchema": "DataEncoderKlv", "tag": "encoders" }, { "capabilityGate": "klv", "method": "PUT", "operationId": "updateDataEncoderKlv", "path": "/v2/encoders/data_encoders/{encoderid}/klv/{klvid}", "requestSchema": "DataEncoderKlv", "successSchema": "NoContent", "tag": "encoders" }, { "capabilityGate": "scte35", "method": "DELETE", "operationId": "deleteAllDataEncoderSpliceCommands", "path": "/v2/encoders/data_encoders/{encoderid}/splice_commands", "requestSchema": "", "successSchema": "NoContent", "tag": "encoders" }, { "capabilityGate": "scte35", "method": "GET", "operationId": "listDataEncoderSpliceCommands", "path": "/v2/encoders/data_encoders/{encoderid}/splice_commands", "requestSchema": "", "successSchema": "DataEncoderSpliceCommandListResponse", "tag": "encoders" }, { "capabilityGate": "scte35", "method": "POST", "operationId": "createDataEncoderSpliceCommand", "path": "/v2/encoders/data_encoders/{encoderid}/splice_commands", "requestSchema": "DataEncoderSpliceCommand", "successSchema": "IdResponse", "tag": "encoders" }, { "capabilityGate": "scte35", "method": "DELETE", "operationId": "deleteDataEncoderSpliceCommand", "path": "/v2/encoders/data_encoders/{encoderid}/splice_commands/{splicecommandid}", "requestSchema": "", "successSchema": "NoContent", "tag": "encoders" }, { "capabilityGate": "scte35", "method": "GET", "operationId": "getDataEncoderSpliceCommand", "path": "/v2/encoders/data_encoders/{encoderid}/splice_commands/{splicecommandid}", "requestSchema": "", "successSchema": "DataEncoderSpliceCommand", "tag": "encoders" }, { "capabilityGate": "none", "method": "GET", "operationId": "listVideoEncoders", "path": "/v2/encoders/vid_encoders", "requestSchema": "", "successSchema": "VideoEncoderListResponse", "tag": "encoders" }, { "capabilityGate": "none", "method": "POST", "operationId": "createVideoEncoder", "path": "/v2/encoders/vid_encoders", "requestSchema": "VideoEncoderConfiguration", "successSchema": "VideoEncoderConfiguration", "tag": "encoders" }, { "capabilityGate": "none", "method": "GET", "operationId": "listSyncGroups", "path": "/v2/encoders/vid_encoders/sync_groups", "requestSchema": "", "successSchema": "SyncGroupListResponse", "tag": "encoders" }, { "capabilityGate": "none", "method": "POST", "operationId": "createSyncGroup", "path": "/v2/encoders/vid_encoders/sync_groups", "requestSchema": "SyncGroupConfiguration", "successSchema": "SyncGroupConfiguration", "tag": "encoders" }, { "capabilityGate": "none", "method": "DELETE", "operationId": "deleteSyncGroup", "path": "/v2/encoders/vid_encoders/sync_groups/{syncgroupid}", "requestSchema": "", "successSchema": "NoContent", "tag": "encoders" }, { "capabilityGate": "none", "method": "GET", "operationId": "getSyncGroup", "path": "/v2/encoders/vid_encoders/sync_groups/{syncgroupid}", "requestSchema": "", "successSchema": "SyncGroupConfiguration", "tag": "encoders" }, { "capabilityGate": "none", "method": "PUT", "operationId": "updateSyncGroup", "path": "/v2/encoders/vid_encoders/sync_groups/{syncgroupid}", "requestSchema": "SyncGroupConfiguration", "successSchema": "NoContent", "tag": "encoders" }, { "capabilityGate": "none", "method": "DELETE", "operationId": "deleteVideoEncoder", "path": "/v2/encoders/vid_encoders/{encoderid}", "requestSchema": "", "successSchema": "NoContent", "tag": "encoders" }, { "capabilityGate": "none", "method": "GET", "operationId": "getVideoEncoder", "path": "/v2/encoders/vid_encoders/{encoderid}", "requestSchema": "", "successSchema": "VideoEncoderConfiguration", "tag": "encoders" }, { "capabilityGate": "none", "method": "PUT", "operationId": "updateVideoEncoder", "path": "/v2/encoders/vid_encoders/{encoderid}", "requestSchema": "VideoEncoderConfiguration", "successSchema": "NoContent", "tag": "encoders" }, { "capabilityGate": "none", "method": "GET", "operationId": "listInputChannels", "path": "/v2/in_channels", "requestSchema": "", "successSchema": "InputChannelListResponse", "tag": "inputs" }, { "capabilityGate": "none", "method": "POST", "operationId": "createInputChannel", "path": "/v2/in_channels", "requestSchema": "InputChannelConfiguration", "successSchema": "InputChannelConfiguration", "tag": "inputs" }, { "capabilityGate": "none", "method": "DELETE", "operationId": "deleteInputChannel", "path": "/v2/in_channels/{inputchannelid}", "requestSchema": "", "successSchema": "NoContent", "tag": "inputs" }, { "capabilityGate": "none", "method": "GET", "operationId": "getInputChannel", "path": "/v2/in_channels/{inputchannelid}", "requestSchema": "", "successSchema": "InputChannelConfiguration", "tag": "inputs" }, { "capabilityGate": "none", "method": "PUT", "operationId": "updateInputChannel", "path": "/v2/in_channels/{inputchannelid}", "requestSchema": "InputChannelConfiguration", "successSchema": "NoContent", "tag": "inputs" }, { "capabilityGate": "graphic_overlay", "method": "DELETE", "operationId": "deleteInputChannelOverlayGraphic", "path": "/v2/in_channels/{inputchannelid}/overlay_graphic", "requestSchema": "", "successSchema": "NoContent", "tag": "inputs" }, { "capabilityGate": "graphic_overlay", "method": "GET", "operationId": "getInputChannelOverlayGraphic", "path": "/v2/in_channels/{inputchannelid}/overlay_graphic", "requestSchema": "", "successSchema": "OverlayGraphicResponse", "tag": "inputs" }, { "capabilityGate": "graphic_overlay", "method": "POST", "operationId": "uploadInputChannelOverlayGraphic", "path": "/v2/in_channels/{inputchannelid}/overlay_graphic", "requestSchema": "OverlayGraphicUploadRequest", "successSchema": "NoContent", "tag": "inputs" }, { "capabilityGate": "none", "method": "GET", "operationId": "getInputChannelStatus", "path": "/v2/in_channels/{inputchannelid}/status", "requestSchema": "", "successSchema": "ComponentStatusResponse", "tag": "inputs" }, { "capabilityGate": "none", "method": "GET", "operationId": "listOutStreams", "path": "/v2/out_streams", "requestSchema": "", "successSchema": "OutputStreamListResponse", "tag": "out_streams" }, { "capabilityGate": "none", "method": "POST", "operationId": "createOutStream", "path": "/v2/out_streams", "requestSchema": "OutputStreamConfiguration", "successSchema": "OutputStreamConfiguration", "tag": "out_streams" }, { "capabilityGate": "none", "method": "DELETE", "operationId": "deleteOutStream", "path": "/v2/out_streams/{outputid}", "requestSchema": "", "successSchema": "NoContent", "tag": "out_streams" }, { "capabilityGate": "none", "method": "GET", "operationId": "getOutStream", "path": "/v2/out_streams/{outputid}", "requestSchema": "", "successSchema": "OutputStreamConfiguration", "tag": "out_streams" }, { "capabilityGate": "none", "method": "PUT", "operationId": "updateOutStream", "path": "/v2/out_streams/{outputid}", "requestSchema": "OutputStreamConfiguration", "successSchema": "NoContent", "tag": "out_streams" }, { "capabilityGate": "none", "method": "POST", "operationId": "runOutStreamAction", "path": "/v2/out_streams/{outputid}/action/{actionname}", "requestSchema": "ActionRequest", "successSchema": "ActionResponse", "tag": "out_streams" }, { "capabilityGate": "none", "method": "GET", "operationId": "listStorage", "path": "/v2/storage", "requestSchema": "", "successSchema": "StorageDeviceListResponse", "tag": "storage" }, { "capabilityGate": "none", "method": "GET", "operationId": "getStorage", "path": "/v2/storage/{drivename}/", "requestSchema": "", "successSchema": "StorageDeviceResponse", "tag": "storage" }, { "capabilityGate": "none", "method": "POST", "operationId": "formatStorage", "path": "/v2/storage/{drivename}/format", "requestSchema": "", "successSchema": "PlainTextResponse", "tag": "storage" }, { "capabilityGate": "none", "method": "POST", "operationId": "unmountStorage", "path": "/v2/storage/{drivename}/unmount", "requestSchema": "", "successSchema": "NoContent", "tag": "storage" }, { "capabilityGate": "none", "method": "GET", "operationId": "getSystemConfiguration", "path": "/v2/system", "requestSchema": "", "successSchema": "SystemConfiguration", "tag": "system" }, { "capabilityGate": "none", "method": "PUT", "operationId": "updateSystemConfiguration", "path": "/v2/system", "requestSchema": "SystemConfiguration", "successSchema": "NoContent", "tag": "system" }, { "capabilityGate": "none", "method": "GET", "operationId": "getXmlConfiguration", "path": "/v2/xml", "requestSchema": "", "successSchema": "XmlConfiguration", "tag": "xml" }, { "capabilityGate": "none", "method": "PUT", "operationId": "updateXmlConfiguration", "path": "/v2/xml", "requestSchema": "XmlConfiguration", "successSchema": "NoContent", "tag": "xml" } ], "endpointRegistrySource": "daemon/cmdif/rest_api_registry_v2.def", "fanoutStrategy": { "body": "Use x-videon-testHints.bodyFanoutCandidates; run mandatoryCoverageFanouts first (codec/output_type class coverage).", "createCapacity": "Before POST fanout, evaluate createCapacityPrecondition and skip attempts once limit is reached.", "createRecovery": "When recycleOnCapacity is present, delete an existing entity then retry POST to continue fanout.", "path": "Use x-videon-testHints.pathFanoutCandidates for actionname and other path enums.", "query": "Use x-videon-testHints.queryParameterFanoutCandidates.", "runtimeBounds": "Use suggestedRuntimeProbeEndpoints then read value_range/possible_values from GET responses." }, "flavor": "trogdor", "valueSourceGuide": { "boundedNumericFields": { "description": "After creating an entity, GET it and read value_range at the same JSON path (e.g. bitrate.value_range) for min/max test values.", "fieldName": "value_range" }, "createCapacityChecks": { "description": "Before fanout on POST create operations, evaluate x-videon-testHints.createCapacityPrecondition using the referenced list endpoint. Skip create attempts when capacity is exhausted.", "hintField": "createCapacityPrecondition" }, "createCapacityRecovery": { "description": "If x-videon-testHints.recycleOnCapacity is present, automation should delete one existing entity per strategy and retry create fanout while preserving contract checks.", "hintField": "recycleOnCapacity" }, "runtimeValidationFields": { "possible_values": { "description": "Read-only. Obtain from GET on the entity or list endpoint at the same JSON field path.", "kind": "daemon_get_response", "writableInRequestBody": false }, "value_range": { "description": "Read-only min/max object. Obtain from GET on the entity endpoint at the same JSON field path (e.g. bitrate.value_range).", "kind": "daemon_get_response", "writableInRequestBody": false } }, "writableEnumFields": { "description": "POST/PUT/PATCH use *WriteRequest schemas when applicable. Enum values come from FlatBuffers enums in configuration.fbs.", "schemaSuffix": "WriteRequest" } } } }