Frame Buffer

A Node object whose type is FRAME_BUFFER. This node is only found on receivers.

Configuration

FrameBufferNodeConfig
{
    "display_mode" : String,
    "width" : Integer,
    "height" : Integer,
    "horiz_offset" : Integer,
    "vert_offset" : Integer,
    "frames_per_second" : Integer,
    "keep_width" : Integer,
    "keep_height" : Integer,
    "viewport_horiz" : Integer,
    "viewport_vert" : Integer,
    "viewport_width" : Integer,
    "viewport_height" : Integer,
    "aspect_ratio_mode" : String,
    "has_auto_wall_configurations" : Boolean,
    "grid_width" : Integer,
    "grid_height" : Integer,
    "grid_index_horiz" : Integer,
    "grid_index_vert" : Integer,
    "bezel_horiz" : Integer,
    "bezel_vert" : Integer
}

Member name	Type	Description
display_mode	String	Frame buffer display mode, which is one of the following: FAST_SWITCHED Full screen fast switch mode GENLOCK_SCALING Full screen zero-frame latency scaling mode WALL_FAST_SWITCHED Fast switch display wall mode WALL_GENLOCKED Zero-frame latency display wall mode MULTIVIEW Multiviewer mode
width	Integer	Video width
height	Integer	Video height
horiz_offset	Integer	Video horizontal offset
vert_offset	Integer	Video vertical offset
frames_per_second	Integer	Frame rate
keep_width	Integer	Width of wall region of interest, in source pixels.
keep_height	Integer	Height of wall region of interest, in source pixels.
viewport_horiz	Integer	Viewport horizontal position. Only relevant in wall display mode (fast switched or genlocked wall).
viewport_vert	Integer	Viewport vertical position. Only relevant in wall display mode (fast switched or genlocked wall).
viewport_width	Integer	Viewport width. Only relevant in wall display mode (fast switched or genlocked wall).
viewport_height	Integer	Viewport height. Only relevant in wall display mode (fast switched or genlocked wall).
aspect_ratio_mode	String	The aspect ratio applied to the output. Options are KEEP, CROP and STRETCH.
has_auto_wall_configurations	Boolean	Whether a source-independent (auto_wall) wall configuration is currently applied.
grid_width	Integer	Total number of columns in the wall grid.
grid_height	Integer	Total number of rows in the wall grid.
grid_index_horiz	Integer	The horizontal index of the display in the wall grid: in a 3x2 wall, the second display across has index 2.
grid_index_vert	Integer	The vertical index of the display in the wall grid: in a 3x2 wall, the first display down has index 1.
bezel_horiz	Integer	The horizontal bezel compensation applied, in pixels.
bezel_vert	Integer	The vertical bezel compensation applied, in pixels.

Status

FrameBufferNodeStatus
{
    "source_video" : VideoFormat
}

Member name	Type	Description
source_video	VideoFormat	Format of video source (full screen and wall modes only)

Inputs

Input name	Configurable	Description
main	No	Video input for full screen and wall modes. Source is a subscription.
multiview	No	Video inputs for the multiviewer. There are multiple inputs with that name (with different indexes), each connected to a subscription.

Example

As returned by get device:

{
    "type" : "FRAME_BUFFER",
    "index" : 0,
    "configuration" : {
        "display_mode" : "FAST_SWITCHED",
        "width" : 1920,
        "height" : 1080,
        "horiz_offset" : 0,
        "vert_offset" : 0,
        "frames_per_second" : 60
    },
    "status" : {
        "source_video" : {
            "width" : 1920,
            "height" : 1080,
            "frames_per_second" : 60,
            "color_space" : "RGB",
            "bits_per_pixel" : 8,
            "scan_mode" : "PROGRESSIVE"
        }
    },
    "inputs" : [
            {
                "name" : "main",
                "index" : 0,
                "configuration" : {},
                "status" : {
                    "source" : {
                        "ref_class" : "SUBSCRIPTION",
                        "ref_type" : "HDMI",
                        "ref_index" : 0
                    }
                }
            },
            {
                "name" : "multiview",
                "index" : 0,
                "configuration" : {},
                "status" : {
                    "source" : {
                        "ref_class" : "SUBSCRIPTION",
                        "ref_type" : "HDMI",
                        "ref_index" : 0
                    }
                }
            },
            {
                "name" : "multiview",
                "index" : 1,
                "configuration" : {},
                "status" : {
                "source" : {
                    "ref_class" : "SUBSCRIPTION",
                    "ref_type" : "HDMI",
                    "ref_index" : 1
                }
            }
            },
            {
                "name" : "multiview",
                "index" : 2,
                "configuration" : {},
                "status" : {
                "source" : {
                "ref_class" : "SUBSCRIPTION",
                "ref_type" : "HDMI",
                "ref_index" : 2
                }
            }
        },
        {
            "name" : "multiview",
            "index" : 3,
            "configuration" : {},
            "status" : {
                "source" : {
                    "ref_class" : "SUBSCRIPTION",
                    "ref_type" : "HDMI",
                    "ref_index" : 3
                }
            }
        }
    ]
}