HCDF IEEE 1722 Extension Specification Browser

Element Attribute Has children (click to expand) Leaf node Defined in another tab (click to switch)
  • <avtp-capabilities> Element
    Device-level AVTP capability declaration. Lists which AVTP subtypes (aaf, cvf, rvf, tscf, etc.) and ACF message types (can, gpio, sensor, etc.) the device can produce or consume. At most one per extension block.
  • <avtp-stream> Element
    [0..*]
    Per-stream 1722 framing configuration. One element per stream that uses IEEE 1722 transport. Each references a stream name from the HCDF stream profile and specifies the AVTP subtype and format-specific parameters.
  • <subtype> Element
    [0..*]
    Values: aaf | cvf | rvf | crf | tscf | ntscf | aef | sdi
    An AVTP subtype this device supports (e.g., aaf, cvf, tscf). List all subtypes the device can produce or consume.
  • <acf-type> Element
    [0..*]
    Values: can | can-brief | lin | mdio | gpio | spi | i2c | sensor | aecp | ancillary
    An ACF message type this device supports (e.g., can, gpio, sensor). ACF types are relevant when the device uses TSCF or NTSCF streams. List all ACF types the device can originate or process.
  • type Attribute
    Type: can | can-brief | lin | mdio | gpio | spi | i2c | sensor | aecp | ancillary (required) — The ACF message type carried by this stream (e.g., "can", "gpio", "sensor"). Must match one of the device's declared acf-type capabilities.
  • bus Attribute
    Type: xs:string — Optional reference to an HCDF bus name being tunneled over this stream. For example, if this stream tunnels CAN frames from the "drive-bus" CAN-FD bus, set bus="drive-bus". Enables agents to trace the bus-to-stream mapping.
  • channels Attribute
    Type: xs:unsignedInt — Number of audio channels in the stream (e.g., 2 for stereo, 8 for a microphone array, 32 for a mixing bus).
  • sample-rate Attribute
    Type: xs:unsignedInt — Audio sample rate in Hz (e.g., 48000 for professional audio, 96000 for high-resolution recording, 16000 for voice).
  • bit-depth Attribute
    Type: xs:unsignedInt — Bits per sample per channel (e.g., 16, 24, or 32). Higher bit depth increases dynamic range at the cost of bandwidth.
  • format Attribute
    Type: xs:string — Audio encoding format: "pcm-int" (integer PCM, most common), "pcm-float" (IEEE 754 floating-point PCM), or "aes3" (AES3/SPDIF encapsulation for professional audio interconnect).
  • format Attribute
    Type: xs:string — Video compression format: "h264" (H.264/AVC NAL unit transport), "mjpeg" (Motion JPEG frame-by-frame), or "jpeg2000" (JPEG 2000 wavelet compression for high-quality video).
  • profile Attribute
    Type: xs:string — Optional codec profile. For H.264: "baseline" (low complexity, no B-frames), "main" (B-frames, CABAC), "high" (8x8 transforms, high bitrate). Ignored for MJPEG and JPEG2000.
  • pixel-format Attribute
    Type: xs:string — Pixel format of the raw video stream: "rgb24" (8-bit RGB), "yuv422" (4:2:2 chroma subsampling), "yuv420" (4:2:0 chroma subsampling), "bayer-rggb" (Bayer mosaic for machine vision), "mono8" (8-bit grayscale), "mono16" (16-bit grayscale for depth or thermal imaging).
  • stream Attribute
    Type: xs:string (required) — Reference to a stream name defined in the HCDF stream profile (.streams.xml). This links the 1722 framing configuration to the stream's bandwidth, latency, and endpoint declarations.
  • subtype Attribute
    Type: aaf | cvf | rvf | crf | tscf | ntscf | aef | sdi (required) — The AVTP subtype used for this stream's framing. Determines the wire format and which child configuration element is expected (aaf for AAF, cvf for CVF, rvf for RVF, acf for TSCF/NTSCF).
  • timestamp Attribute
    Type: xs:boolean, default="true" — Whether this stream uses AVTP presentation timestamps (default: true). Presentation timestamps enable synchronized playback across multiple listeners. Set to false for best-effort streams where precise timing is not required.
  • <acf> Element
    ACF configuration for TSCF/NTSCF control streams. Specifies which ACF message type is carried and optionally which HCDF bus is being tunneled. Required when subtype is "tscf" or "ntscf".
  • <aaf> Element
    Audio format configuration for AAF streams. Specifies channels, sample rate, bit depth, and encoding format. Required when subtype is "aaf".
  • <cvf> Element
    Compressed video configuration for CVF streams. Specifies codec and profile. Required when subtype is "cvf".
  • <rvf> Element
    Raw video configuration for RVF streams. Specifies pixel format. Required when subtype is "rvf".