rDWS Video Endpoints

23 min

base url for these endpoints https //ws bsn cloud/rest/v1/ get /video mode/ retrieves the currently active video mode on the player request example get /rest/v1/video mode/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body width \int\ the screen width height \int\ the screen height frames \int\ the framerate scan \string\ the scan method of the video signal, which can be either progressive ("p") or interlaced ("i") name \string\ the full name of the video mode (a full list of modes can be found on this page docid\ qpml112mbhek7lbdguxnv ) isautomode \bool\ a flag indicating whether the video mode was set using auto mode mode \mode{ }\ a mode object that gives additional information about the video output this object can contain the following properties preferred \bool\ a flag indicating whether the video mode is the preferred mode overscan \bool\ a flag indicating whether the video output is using an overscan setting or not modename \string\ the full name of the video mode (a full list of modes can be found on this page docid\ qpml112mbhek7lbdguxnv ) interlaced \bool\ a flag indicating whether the video output is interlaced ( true ) or progressive ( false ) width \int\ the width of the video output height \int\ the height of the video output graphicsplanewidth \int\ the width of the graphics plane graphicsplaneheight \int\ the height of the graphics plane frequency \int\ the frame rate of the video output dropframe \bool\ a flag indicating whether the video timecode utilizes drop frames colorspace \string\ the color space of the video signal ("rgb", "yuv420", or "yuv422") colordepth \string\ the color depth of the video signal ("8bit", "10bit", or "12bit") response example { "route" "/v1/video mode", "method" "get", "data" { "result" { "isautomode" false, "name" "640x480x60p", "width" "640", "height" "480", "frames" "60", "scan" "p", "mode" { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 480, "graphicsplanewidth" 640, "height" 480, "interlaced" false, "modename" "640x480x60p", "overscan" false, "preferred" false, "width" 640 } } } } get /video/{\ connector}/output/{\ device}/ retrieves information about the specified video output segments connector the current value is always hdmi device this value in /video/ urls is currently 0 for single output series 5 players and all series 4 and older players the value can be 0 3 for the xc4055, which has multiple outputs, and 0 or 1 for the xc2055 and xt2145 request example get /rest/v1/video/hdmi/output/0/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body the following fields will be present in the response activemode information about the active video mode on the player attached \bool\ indicates if the hdmi® output is attached or not bestmode \string\ the best video mode for the player the hdmi connector must be attached because it gets details from edid result configuredmode the configured video mode on the player this can be different than activemode edid \string\ returns the edid read string of the display connected to the player if power save is on, zeroes will be returned edid identity parses the above string in a json format for readability requires an hdmi output connected to the player and a display modes list of all available video modes on the player powersavestatus \bool\ indicates the power save status of the display connected to the player resolutions \resolutions\[ ]\ an array of information about the graphics, output, video resolution returns result values for height and width status audiobitspersample \int\ the number of bits per audio sample audiochannelcount \int\ the number of audio channels in the output audioformat \string\ the format of the audio output a "pcm" value indicates that the player is sending decoded output audiosamplerate \int\ the audio sample rate (in hertz) eotf \string\ the current electro optical transfer function (eotf) used by the display the following are possible values "hdr (gamma)" "sdr (gamma)" "smpte 2084 (pq)" "future (bbc/nhk)" "unspecified" outputpowered \bool\ indicates if the display device is on (i e rx powered) outputpresent \bool\ indicates if the hdmi output is connected to a display device or not unstable \bool\ indicates if the display signal is unstable or stable response example expand { "route" "/v1/video/hdmi/output/0/", "method" "get", "data" { "result" { "resolutions" { "video" { "result" { "height" 1080, "width" 1920 } }, "graphics" { "result" { "height" 1080, "width" 1920 } }, "output" { "result" { "height" 1080, "width" 1920 } } }, "edid identity" { "result" { "bt2020rgbsupport" false, "bt2020yccsupport" false, "hdreotfsupport" false, "hdrst2084support" false, "manufacturer" "sam", "monitorname" "samsung", "product" 1293, "sdreotfsupport" false, "serialnumber" 1, "serialnumberstring" "", "textstring" "", "weekofmanufacture" 48, "yearofmanufacture" 2008 } }, "edid" { "result" "00ffffffffffff004c2d0d050100000030120103801009780aee91a3544c99260f5054bdef80714f8100814081809500950fb3000101023a801871382d40582c4500a05a0000001e662150b051001b3040703600a05a0000001e000000fd00184b1a5117000a202020202020000000fc0053414d53554e470a2020202020016b020322f1469004050320222309070783010000e2000fe305030167030c001000b82d011d007251d01e206e285500a05a0000001e011d8018711c1620582c2500a05a0000009e8c0ad08a20e02d10103e9600a05a00000018000000000000000000000000000000000000000000000000000000000000000000000000000000ef00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" }, "attached" { "result" true }, "status" { "result" { "audiobitspersample" 0, "audiochannelcount" 0, "audioformat" "unknown", "audiosamplerate" 0, "outputpowered" true, "outputpresent" true } }, "txhdcpstatus" { "result" { "state" "not required" } }, "modes" { "result" \[ { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 480, "graphicsplanewidth" 640, "height" 480, "interlaced" false, "modename" "640x480x60p", "overscan" false, "preferred" false, "width" 640 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 30, "graphicsplaneheight" 480, "graphicsplanewidth" 720, "height" 480, "interlaced" true, "modename" "720x480x60i", "overscan" true, "preferred" false, "width" 720 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 25, "graphicsplaneheight" 576, "graphicsplanewidth" 720, "height" 576, "interlaced" true, "modename" "720x576x50i", "overscan" true, "preferred" false, "width" 720 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 480, "graphicsplanewidth" 848, "height" 480, "interlaced" false, "modename" "848x480x60p", "overscan" false, "preferred" false, "width" 848 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 600, "graphicsplanewidth" 800, "height" 600, "interlaced" false, "modename" "800x600x60p", "overscan" false, "preferred" false, "width" 800 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 75, "graphicsplaneheight" 600, "graphicsplanewidth" 800, "height" 600, "interlaced" false, "modename" "800x600x75p", "overscan" false, "preferred" false, "width" 800 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 960, "graphicsplanewidth" 960, "height" 960, "interlaced" false, "modename" "960x960x60p", "overscan" false, "preferred" false, "width" 960 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 768, "graphicsplanewidth" 1024, "height" 768, "interlaced" false, "modename" "1024x768x60p", "overscan" false, "preferred" false, "width" 1024 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 75, "graphicsplaneheight" 768, "graphicsplanewidth" 1024, "height" 768, "interlaced" false, "modename" "1024x768x75p", "overscan" false, "preferred" false, "width" 1024 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 768, "graphicsplanewidth" 1280, "height" 768, "interlaced" false, "modename" "1280x768x60p", "overscan" false, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 800, "graphicsplanewidth" 1280, "height" 800, "interlaced" false, "modename" "1280x800x60p", "overscan" false, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 75, "graphicsplaneheight" 800, "graphicsplanewidth" 1280, "height" 800, "interlaced" false, "modename" "1280x800x75p", "overscan" false, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 768, "graphicsplanewidth" 1360, "height" 768, "interlaced" false, "modename" "1360x768x60p", "overscan" false, "preferred" false, "width" 1360 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1280, "graphicsplanewidth" 800, "height" 1280, "interlaced" false, "modename" "800x1280x60p", "overscan" false, "preferred" false, "width" 800 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1920, "graphicsplanewidth" 1200, "height" 1920, "interlaced" false, "modename" "1200x1920x60p", "overscan" false, "preferred" false, "width" 1200 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 768, "graphicsplanewidth" 1366, "height" 768, "interlaced" false, "modename" "1366x768x60p", "overscan" false, "preferred" false, "width" 1366 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 960, "graphicsplanewidth" 1280, "height" 960, "interlaced" false, "modename" "1280x960x60p", "overscan" false, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1024, "graphicsplanewidth" 1280, "height" 1024, "interlaced" false, "modename" "1280x1024x60p", "overscan" false, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 75, "graphicsplaneheight" 1024, "graphicsplanewidth" 1280, "height" 1024, "interlaced" false, "modename" "1280x1024x75p", "overscan" false, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 900, "graphicsplanewidth" 1440, "height" 900, "interlaced" false, "modename" "1440x900x60p", "overscan" false, "preferred" false, "width" 1440 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 75, "graphicsplaneheight" 900, "graphicsplanewidth" 1440, "height" 900, "interlaced" false, "modename" "1440x900x75p", "overscan" false, "preferred" false, "width" 1440 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1050, "graphicsplanewidth" 1400, "height" 1050, "interlaced" false, "modename" "1400x1050x60p", "overscan" false, "preferred" false, "width" 1400 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 75, "graphicsplaneheight" 1050, "graphicsplanewidth" 1400, "height" 1050, "interlaced" false, "modename" "1400x1050x75p", "overscan" false, "preferred" false, "width" 1400 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 1440, "height" 1080, "interlaced" false, "modename" "1440x1080x60p", "overscan" false, "preferred" false, "width" 1440 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1088, "graphicsplanewidth" 1440, "height" 1088, "interlaced" false, "modename" "1440x1088x57p", "overscan" false, "preferred" false, "width" 1440 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 1024, "graphicsplanewidth" 768, "height" 2048, "interlaced" false, "modename" "1536x2048x30p", "overscan" false, "preferred" false, "width" 1536 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 900, "graphicsplanewidth" 1600, "height" 900, "interlaced" false, "modename" "1600x900x60p", "overscan" false, "preferred" false, "width" 1600 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1200, "graphicsplanewidth" 1600, "height" 1200, "interlaced" false, "modename" "1600x1200x60p", "overscan" false, "preferred" false, "width" 1600 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1050, "graphicsplanewidth" 1680, "height" 1050, "interlaced" false, "modename" "1680x1050x60p", "overscan" false, "preferred" false, "width" 1680 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1296, "graphicsplanewidth" 1728, "height" 1296, "interlaced" false, "modename" "1728x1296x60p", "overscan" false, "preferred" false, "width" 1728 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 540, "graphicsplanewidth" 1920, "height" 540, "interlaced" false, "modename" "1920x540x60p", "overscan" false, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 50, "graphicsplaneheight" 1200, "graphicsplanewidth" 1920, "height" 1200, "interlaced" false, "modename" "1920x1200x50p", "overscan" false, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1200, "graphicsplanewidth" 1920, "height" 1200, "interlaced" false, "modename" "1920x1200x60p", "overscan" false, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 672, "graphicsplanewidth" 896, "height" 1344, "interlaced" false, "modename" "1792x1344x60p", "overscan" false, "preferred" false, "width" 1792 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 960, "graphicsplanewidth" 960, "height" 1920, "interlaced" false, "modename" "1920x1920x60p", "overscan" false, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 50, "graphicsplaneheight" 576, "graphicsplanewidth" 1024, "height" 1152, "interlaced" false, "modename" "2048x1152x50p", "overscan" false, "preferred" false, "width" 2048 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 576, "graphicsplanewidth" 1024, "height" 1152, "interlaced" false, "modename" "2048x1152x60p", "overscan" false, "preferred" false, "width" 2048 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 288, "graphicsplanewidth" 2376, "height" 288, "interlaced" false, "modename" "2376x288x60p", "overscan" false, "preferred" false, "width" 2376 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 800, "graphicsplanewidth" 2560, "height" 800, "interlaced" false, "modename" "2560x800x60p", "overscan" false, "preferred" false, "width" 2560 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 480, "graphicsplanewidth" 1280, "height" 960, "interlaced" false, "modename" "2560x960x60p", "overscan" false, "preferred" false, "width" 2560 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 540, "graphicsplanewidth" 1280, "height" 1080, "interlaced" false, "modename" "2560x1080x60p", "overscan" false, "preferred" false, "width" 2560 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 1440, "interlaced" false, "modename" "2560x1440x30p", "overscan" false, "preferred" false, "width" 2560 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 1440, "interlaced" false, "modename" "2560x1440x60p", "overscan" false, "preferred" false, "width" 2560 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 800, "graphicsplanewidth" 1280, "height" 1600, "interlaced" false, "modename" "2560x1600x60p", "overscan" false, "preferred" false, "width" 2560 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 1024, "graphicsplanewidth" 1536, "height" 2048, "interlaced" false, "modename" "3072x2048x30p", "overscan" false, "preferred" false, "width" 3072 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 720, "graphicsplanewidth" 1720, "height" 1440, "interlaced" false, "modename" "3440x1440x30p", "overscan" false, "preferred" false, "width" 3440 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 50, "graphicsplaneheight" 720, "graphicsplanewidth" 1720, "height" 1440, "interlaced" false, "modename" "3440x1440x50p", "overscan" false, "preferred" false, "width" 3440 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 720, "graphicsplanewidth" 1720, "height" 1440, "interlaced" false, "modename" "3440x1440x60p", "overscan" false, "preferred" false, "width" 3440 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 50, "graphicsplaneheight" 576, "graphicsplanewidth" 720, "height" 576, "interlaced" false, "modename" "720x576x50p", "overscan" true, "preferred" false, "width" 720 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 60, "graphicsplaneheight" 480, "graphicsplanewidth" 720, "height" 480, "interlaced" false, "modename" "720x480x59 94p", "overscan" true, "preferred" false, "width" 720 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 480, "graphicsplanewidth" 720, "height" 480, "interlaced" false, "modename" "720x480x60p", "overscan" true, "preferred" false, "width" 720 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 24, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 720, "interlaced" false, "modename" "1280x720x24p", "overscan" true, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 24, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 720, "interlaced" false, "modename" "1280x720x23 976p", "overscan" true, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 25, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 720, "interlaced" false, "modename" "1280x720x25p", "overscan" true, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 50, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 720, "interlaced" false, "modename" "1280x720x50p", "overscan" true, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 60, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 720, "interlaced" false, "modename" "1280x720x59 94p", "overscan" true, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 720, "interlaced" false, "modename" "1280x720x60p", "overscan" true, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 25, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" true, "modename" "1920x1080x50i", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" true, "modename" "1920x1080x59 94i", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" true, "modename" "1920x1080x60i", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 24, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x24p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 24, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x23 976p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 25, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x25p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x29 97p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x30p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 50, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x50p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x59 94p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x60p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 360, "graphicsplanewidth" 1440, "height" 720, "interlaced" false, "modename" "2880x720x60p", "overscan" true, "preferred" false, "width" 2880 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 300, "graphicsplanewidth" 1920, "height" 600, "interlaced" false, "modename" "3840x600x60p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 25, "graphicsplaneheight" 540, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "3840x1080x25p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 540, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "3840x1080x30p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 600, "graphicsplanewidth" 1920, "height" 1200, "interlaced" false, "modename" "3840x1200x30p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 24, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x23 976p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 24, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x24p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 25, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x25p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x29 97p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x30p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 50, "graphicsplaneheight" 540, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "3840x1080x50p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 540, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "3840x1080x60p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 600, "graphicsplanewidth" 1920, "height" 1200, "interlaced" false, "modename" "3840x1200x60p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "yuv420", "dropframe" false, "frequency" 50, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x50p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "yuv420", "dropframe" true, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x59 94p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "yuv420", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x60p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 24, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x23 976p", "overscan" true, "preferred" false, "width" 4096 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 24, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x24p", "overscan" true, "preferred" false, "width" 4096 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 25, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x25p", "overscan" true, "preferred" false, "width" 4096 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x29 97p", "overscan" true, "preferred" false, "width" 4096 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x30p", "overscan" true, "preferred" false, "width" 4096 }, { "colordepth" "8bit", "colorspace" "yuv420", "dropframe" false, "frequency" 50, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x50p", "overscan" true, "preferred" false, "width" 4096 }, { "colordepth" "8bit", "colorspace" "yuv420", "dropframe" true, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x59 94p", "overscan" true, "preferred" false, "width" 4096 }, { "colordepth" "8bit", "colorspace" "yuv420", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x60p", "overscan" true, "preferred" false, "width" 4096 } ] }, "activemode" { "result" { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x60p", "overscan" true, "preferred" false, "width" 1920 } }, "configuredmode" { "result" null }, "bestmode" { "result" "1920x1080x60p" }, "powersavestatus" { "result" false } } } } get /video/{\ connector}/output/{\ device}/edid/ returns the edid information from a compatible monitor/television connected to the video output segments connector the current value is always hdmi device this value in /video/ urls is currently 0 for single output series 5 players and all series 4 and older players the value can be 0 3 for the xc4055, which has multiple outputs, and 0 or 1 for the xc2055 and xt2145 request example get /rest/v1/video/hdmi/output/0/edid/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body result \string\ the edid string result response example { "route" "/v1/video/hdmi/output/0/edid", "method" "get", "data" { "result" "00ffffffffffff004c2d0d050100000030120103801009780aee91a3544c99260f5054bdef80714f8111214081809500950fb3000101023a801871382d40582c4500a05a0000001e662150b051001b3040703600a05a0000001e000000fd00184b1a5117000a202020202020000000fc0053414d53554e470a2020202020016b020322f1469004050320222309070783010000e2000fe305030167030c001000b82d011d007251d01e206e285500a05a0000001e011d8018711c1620582c2500a05a0000009e8c0ad08a20e02d10103e9600a05a00000018000000000000000000000000000000000000000000000000000000000000000000000000000000ef00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" } } get /video/{\ connector}/output/{\ device}/power save/ retrieves the power status of the monitor connected to the player (as reported over edid) segments connector the current value is always hdmi device this value in /video/ urls is currently 0 for single output series 5 players and all series 4 and older players the value can be 0 3 for the xc4055, which has multiple outputs, and 0 or 1 for the xc2055 and xt2145 request example get /rest/v1/video/hdmi/output/0/power save/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body is connected \bool\ indicates whether the monitor is connected to the hdmi output on the player is powered \bool\ indicates whether the monitor is on (for example, rx powered) enabled \bool\ indicates whether power save mode has been enabled on the hdmi/vga output response example { "route" "/v1/video/hdmi/output/0/power save/", "method" "get", "data" { "result" { "is connected" true, "is powered" true, "enabled" false } } } put /video/{\ connector}/output/{\ device}/power save/ enables or disables power save mode on the monitor connected to the player (via hdmi, vga, or component) segments connector the current value is always hdmi device this value in /video/ urls is currently 0 for single output series 5 players and all series 4 and older players the value can be 0 3 for the xc4055, which has multiple outputs, and 0 or 1 for the xc2055 and xt2145 request body parameters enabled \bool\ whether or not power save is enabled request example put /rest/v1/video/hdmi/output/0/power save/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 51 this is the example request body { "data" { "enabled" true } } response body the server will return a success or error message response example { "data" { "result" true }, "route" "/v1/video/hdmi/output/0/power save", "method" "put" } get /video/{\ connector}/output/{\ device}/modes/ retrieves all available video modes on the specified video output segments connector the current value is always hdmi device this value in /video/ urls is currently 0 for single output series 5 players and all series 4 and older players the value can be 0 3 for the xc4055, which has multiple outputs, and 0 or 1 for the xc2055 and xt2145 request example get /rest/v1/video/hdmi/output/0/modes/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body returns an array of video mode objects, each of which contain the following parameters modename \string\ the mode (for example, “1920x1080x60p”) colordepth \string\ the color depth of the video signal colorspace \string\ the color space of the video signal ("rgb", "yuv420", or "yuv422") dropframe \bool\ whether or not the video timecode uses drop frame frequency \int\ the frame rate of the video output width \int\ the width of the video output height \int\ the height of the video output graphicsplanewidth \int\ the width of the graphics plane graphicsplaneheight \int\ the height of the graphics plane interlaced \bool\ whether or not the video output is interlaced overscan \bool\ whether or not the video output is using an overscan setting or not preferred \bool\ whether or not video is the preferred mode response example expand { "route" "/v1/video/hdmi/output/0/modes/", "method" "get", "data" { "result" \[ { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 480, "graphicsplanewidth" 640, "height" 480, "interlaced" false, "modename" "640x480x60p", "overscan" false, "preferred" false, "width" 640 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 30, "graphicsplaneheight" 480, "graphicsplanewidth" 720, "height" 480, "interlaced" true, "modename" "720x480x60i", "overscan" true, "preferred" false, "width" 720 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 25, "graphicsplaneheight" 576, "graphicsplanewidth" 720, "height" 576, "interlaced" true, "modename" "720x576x50i", "overscan" true, "preferred" false, "width" 720 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 480, "graphicsplanewidth" 848, "height" 480, "interlaced" false, "modename" "848x480x60p", "overscan" false, "preferred" false, "width" 848 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 600, "graphicsplanewidth" 800, "height" 600, "interlaced" false, "modename" "800x600x60p", "overscan" false, "preferred" false, "width" 800 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 75, "graphicsplaneheight" 600, "graphicsplanewidth" 800, "height" 600, "interlaced" false, "modename" "800x600x75p", "overscan" false, "preferred" false, "width" 800 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 960, "graphicsplanewidth" 960, "height" 960, "interlaced" false, "modename" "960x960x60p", "overscan" false, "preferred" false, "width" 960 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 768, "graphicsplanewidth" 1024, "height" 768, "interlaced" false, "modename" "1024x768x60p", "overscan" false, "preferred" false, "width" 1024 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 75, "graphicsplaneheight" 768, "graphicsplanewidth" 1024, "height" 768, "interlaced" false, "modename" "1024x768x75p", "overscan" false, "preferred" false, "width" 1024 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 768, "graphicsplanewidth" 1280, "height" 768, "interlaced" false, "modename" "1280x768x60p", "overscan" false, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 800, "graphicsplanewidth" 1280, "height" 800, "interlaced" false, "modename" "1280x800x60p", "overscan" false, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 75, "graphicsplaneheight" 800, "graphicsplanewidth" 1280, "height" 800, "interlaced" false, "modename" "1280x800x75p", "overscan" false, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 768, "graphicsplanewidth" 1360, "height" 768, "interlaced" false, "modename" "1360x768x60p", "overscan" false, "preferred" false, "width" 1360 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1280, "graphicsplanewidth" 800, "height" 1280, "interlaced" false, "modename" "800x1280x60p", "overscan" false, "preferred" false, "width" 800 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1920, "graphicsplanewidth" 1200, "height" 1920, "interlaced" false, "modename" "1200x1920x60p", "overscan" false, "preferred" false, "width" 1200 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 768, "graphicsplanewidth" 1366, "height" 768, "interlaced" false, "modename" "1366x768x60p", "overscan" false, "preferred" false, "width" 1366 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 960, "graphicsplanewidth" 1280, "height" 960, "interlaced" false, "modename" "1280x960x60p", "overscan" false, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1024, "graphicsplanewidth" 1280, "height" 1024, "interlaced" false, "modename" "1280x1024x60p", "overscan" false, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 75, "graphicsplaneheight" 1024, "graphicsplanewidth" 1280, "height" 1024, "interlaced" false, "modename" "1280x1024x75p", "overscan" false, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 900, "graphicsplanewidth" 1440, "height" 900, "interlaced" false, "modename" "1440x900x60p", "overscan" false, "preferred" false, "width" 1440 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 75, "graphicsplaneheight" 900, "graphicsplanewidth" 1440, "height" 900, "interlaced" false, "modename" "1440x900x75p", "overscan" false, "preferred" false, "width" 1440 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1050, "graphicsplanewidth" 1400, "height" 1050, "interlaced" false, "modename" "1400x1050x60p", "overscan" false, "preferred" false, "width" 1400 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 75, "graphicsplaneheight" 1050, "graphicsplanewidth" 1400, "height" 1050, "interlaced" false, "modename" "1400x1050x75p", "overscan" false, "preferred" false, "width" 1400 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 1440, "height" 1080, "interlaced" false, "modename" "1440x1080x60p", "overscan" false, "preferred" false, "width" 1440 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1088, "graphicsplanewidth" 1440, "height" 1088, "interlaced" false, "modename" "1440x1088x57p", "overscan" false, "preferred" false, "width" 1440 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 1024, "graphicsplanewidth" 768, "height" 2048, "interlaced" false, "modename" "1536x2048x30p", "overscan" false, "preferred" false, "width" 1536 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 900, "graphicsplanewidth" 1600, "height" 900, "interlaced" false, "modename" "1600x900x60p", "overscan" false, "preferred" false, "width" 1600 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1200, "graphicsplanewidth" 1600, "height" 1200, "interlaced" false, "modename" "1600x1200x60p", "overscan" false, "preferred" false, "width" 1600 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1050, "graphicsplanewidth" 1680, "height" 1050, "interlaced" false, "modename" "1680x1050x60p", "overscan" false, "preferred" false, "width" 1680 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1296, "graphicsplanewidth" 1728, "height" 1296, "interlaced" false, "modename" "1728x1296x60p", "overscan" false, "preferred" false, "width" 1728 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 540, "graphicsplanewidth" 1920, "height" 540, "interlaced" false, "modename" "1920x540x60p", "overscan" false, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 50, "graphicsplaneheight" 1200, "graphicsplanewidth" 1920, "height" 1200, "interlaced" false, "modename" "1920x1200x50p", "overscan" false, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1200, "graphicsplanewidth" 1920, "height" 1200, "interlaced" false, "modename" "1920x1200x60p", "overscan" false, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 672, "graphicsplanewidth" 896, "height" 1344, "interlaced" false, "modename" "1792x1344x60p", "overscan" false, "preferred" false, "width" 1792 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 960, "graphicsplanewidth" 960, "height" 1920, "interlaced" false, "modename" "1920x1920x60p", "overscan" false, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 50, "graphicsplaneheight" 576, "graphicsplanewidth" 1024, "height" 1152, "interlaced" false, "modename" "2048x1152x50p", "overscan" false, "preferred" false, "width" 2048 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 576, "graphicsplanewidth" 1024, "height" 1152, "interlaced" false, "modename" "2048x1152x60p", "overscan" false, "preferred" false, "width" 2048 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 288, "graphicsplanewidth" 2376, "height" 288, "interlaced" false, "modename" "2376x288x60p", "overscan" false, "preferred" false, "width" 2376 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 800, "graphicsplanewidth" 2560, "height" 800, "interlaced" false, "modename" "2560x800x60p", "overscan" false, "preferred" false, "width" 2560 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 480, "graphicsplanewidth" 1280, "height" 960, "interlaced" false, "modename" "2560x960x60p", "overscan" false, "preferred" false, "width" 2560 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 540, "graphicsplanewidth" 1280, "height" 1080, "interlaced" false, "modename" "2560x1080x60p", "overscan" false, "preferred" false, "width" 2560 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 1440, "interlaced" false, "modename" "2560x1440x30p", "overscan" false, "preferred" false, "width" 2560 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 1440, "interlaced" false, "modename" "2560x1440x60p", "overscan" false, "preferred" false, "width" 2560 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 800, "graphicsplanewidth" 1280, "height" 1600, "interlaced" false, "modename" "2560x1600x60p", "overscan" false, "preferred" false, "width" 2560 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 1024, "graphicsplanewidth" 1536, "height" 2048, "interlaced" false, "modename" "3072x2048x30p", "overscan" false, "preferred" false, "width" 3072 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 720, "graphicsplanewidth" 1720, "height" 1440, "interlaced" false, "modename" "3440x1440x30p", "overscan" false, "preferred" false, "width" 3440 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 50, "graphicsplaneheight" 720, "graphicsplanewidth" 1720, "height" 1440, "interlaced" false, "modename" "3440x1440x50p", "overscan" false, "preferred" false, "width" 3440 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 720, "graphicsplanewidth" 1720, "height" 1440, "interlaced" false, "modename" "3440x1440x60p", "overscan" false, "preferred" false, "width" 3440 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 50, "graphicsplaneheight" 576, "graphicsplanewidth" 720, "height" 576, "interlaced" false, "modename" "720x576x50p", "overscan" true, "preferred" false, "width" 720 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 60, "graphicsplaneheight" 480, "graphicsplanewidth" 720, "height" 480, "interlaced" false, "modename" "720x480x59 94p", "overscan" true, "preferred" false, "width" 720 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 480, "graphicsplanewidth" 720, "height" 480, "interlaced" false, "modename" "720x480x60p", "overscan" true, "preferred" false, "width" 720 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 24, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 720, "interlaced" false, "modename" "1280x720x24p", "overscan" true, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 24, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 720, "interlaced" false, "modename" "1280x720x23 976p", "overscan" true, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 25, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 720, "interlaced" false, "modename" "1280x720x25p", "overscan" true, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 50, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 720, "interlaced" false, "modename" "1280x720x50p", "overscan" true, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 60, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 720, "interlaced" false, "modename" "1280x720x59 94p", "overscan" true, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 720, "graphicsplanewidth" 1280, "height" 720, "interlaced" false, "modename" "1280x720x60p", "overscan" true, "preferred" false, "width" 1280 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 25, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" true, "modename" "1920x1080x50i", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" true, "modename" "1920x1080x59 94i", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" true, "modename" "1920x1080x60i", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 24, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x24p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 24, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x23 976p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 25, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x25p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x29 97p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x30p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 50, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x50p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x59 94p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x60p", "overscan" true, "preferred" false, "width" 1920 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 360, "graphicsplanewidth" 1440, "height" 720, "interlaced" false, "modename" "2880x720x60p", "overscan" true, "preferred" false, "width" 2880 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 300, "graphicsplanewidth" 1920, "height" 600, "interlaced" false, "modename" "3840x600x60p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 25, "graphicsplaneheight" 540, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "3840x1080x25p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 540, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "3840x1080x30p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 600, "graphicsplanewidth" 1920, "height" 1200, "interlaced" false, "modename" "3840x1200x30p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 24, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x23 976p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 24, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x24p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 25, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x25p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x29 97p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x30p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 50, "graphicsplaneheight" 540, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "3840x1080x50p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 540, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "3840x1080x60p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 600, "graphicsplanewidth" 1920, "height" 1200, "interlaced" false, "modename" "3840x1200x60p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "yuv420", "dropframe" false, "frequency" 50, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x50p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "yuv420", "dropframe" true, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x59 94p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "yuv420", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 2160, "interlaced" false, "modename" "3840x2160x60p", "overscan" true, "preferred" false, "width" 3840 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 24, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x23 976p", "overscan" true, "preferred" false, "width" 4096 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 24, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x24p", "overscan" true, "preferred" false, "width" 4096 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 25, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x25p", "overscan" true, "preferred" false, "width" 4096 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" true, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x29 97p", "overscan" true, "preferred" false, "width" 4096 }, { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 30, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x30p", "overscan" true, "preferred" false, "width" 4096 }, { "colordepth" "8bit", "colorspace" "yuv420", "dropframe" false, "frequency" 50, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x50p", "overscan" true, "preferred" false, "width" 4096 }, { "colordepth" "8bit", "colorspace" "yuv420", "dropframe" true, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x59 94p", "overscan" true, "preferred" false, "width" 4096 }, { "colordepth" "8bit", "colorspace" "yuv420", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 2048, "height" 2160, "interlaced" false, "modename" "4096x2160x60p", "overscan" true, "preferred" false, "width" 4096 } ] } } get /video/{\ connector}/output/{\ device}/mode/ retrieves the current video mode on the specified video output segments connector the current value is always hdmi device this value in /video/ urls is currently 0 for single output series 5 players and all series 4 and older players the value can be 0 3 for the xc4055, which has multiple outputs, and 0 or 1 for the xc2055 and xt2145 query string parameters each of these parameters delivers a different mode value best \int\ \optional\ if set to 1, this returns the best mode active \int\ \optional\ if set to 1, this returns the active mode configured \int\ \optional\ if set to 1, this returns the configured mode request examples get /rest/v1/video/hdmi/output/0/mode/?best=1\&destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body isautomode \bool\ whether the mode is set to “auto” name \string\ the name of the video mode same as mode modename below width \string\ the width value of the video mode height \string\ the height value of the video mode frames \string\ the frame rate value of the video mode scan \string\ the scan character value of the video mode mode \object\ the currently configured video mode on the video output with following parameters modename \string\ the mode (for example, “1920x1080x60p”) colordepth \string\ the color depth of the video signal colorspace \string\ the color space of the video signal ("rgb", "yuv420", or "yuv422") dropframe \bool\ whether or not the video timecode uses drop frame frequency \int\ the frame rate of the video output width \int\ the width of the video output height \int\ the height of the video output graphicsplanewidth \int\ the width of the graphics plane graphicsplaneheight \int\ the height of the graphics plane interlaced \bool\ whether or not the video output is interlaced overscan \bool\ whether or not the video output is using an overscan setting or not preferred \bool\ whether or not video is the preferred mode response example { "route" "/v1/video/hdmi/output/0/mode/", "method" "get", "data" { "result" { "isautomode" false, "name" "1920x1080x60p", "width" "1920", "height" "1080", "frames" "60", "scan" "p", "mode" { "colordepth" "8bit", "colorspace" "rgb", "dropframe" false, "frequency" 60, "graphicsplaneheight" 1080, "graphicsplanewidth" 1920, "height" 1080, "interlaced" false, "modename" "1920x1080x60p", "overscan" true, "preferred" false, "width" 1920 } } } } put /video/{\ connector}/output/{\ device}/mode/ changes the video mode docid\ qpml112mbhek7lbdguxnv on the player segments connector the current value is always hdmi device this value in /video/ urls is currently 0 for single output series 5 players and all series 4 and older players the value can be 0 3 for the xc4055, which has multiple outputs, and 0 or 1 for the xc2055 and xt2145 request body parameters a video mode object containing the following value(s) modename \string\ \required\ the mode (for example, “1920x1080x60p”) colordepth \string\ \optional\ the color depth of the video signal colorspace \string\ \optional\ the color space of the video signal ("rgb", "yuv420", or "yuv422") dropframe \bool\ whether or not the video timecode uses drop frame frequency \int\ \optional\ the frame rate of the video output width \int\ \optional\ the width of the video output height \int\ \optional\ the height of the video output graphicsplanewidth \int\ \optional\ the width of the graphics plane graphicsplaneheight \int\ \optional\ the height of the graphics plane interlaced \bool\ \optional\ whether or not the video output is interlaced overscan \bool\ \optional\ whether or not the video output is using an overscan setting or not preferred \bool\ \optional\ whether or not video is the preferred mode request example put /rest/v1/video/hdmi/output/0/mode/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 95 this is the example request body { "data" { "name" { "modename" "640x480x60p" } } } response body the server will return a success or error message a successful response will almost always cause a reboot which will be indicated in the response result \object\ the response object success \bool\ whether or not the operation was successful reboot \bool\ whether or not the player is rebooting response example { "data" { "result" { "success" true, "reboot" true } }, "route" "/v1/video/hdmi/output/0/mode", "method" "put" }