LDWS Info Endpoints

8 min

get /v1/info/ returns basic player information request example get /api/v1/info/ http/1 1 host {{playerip} authorization {{digestauth}} response body serial \string\ the serial number of the player model \string\ the model number of the device (e g "xd234") connectiontype \string\ the currently active network interface, which can be either "ethernet" or "wifi" ethernet \object\ an object containing information about the ethernet connection this property will only be available if there's a valid ethernet connection on the player the object can contain the following properties ipv4 \object\ an object containing information about the ipv4 configuration the object can contain the following properties address \string\ the assigned ipv4 address netmask \string\ the ipv4 network mask family \string\ ipv4 mac \string\ the mac address of the network interface internal \bool\ true if the network interface is a loopback or similar interface that is not remotely accessible; otherwise false cidr \string\ the assigned ipv4 address with the routing prefix in cidr notation if the netmask is invalid, this property is set to null ipv6 \object\ an object containing information about the ipv6 configuration address \string\ the assigned ipv6 address netmask \string\ the ipv6 network mask family \string\ ipv6 mac \string\ the mac address of the network interface internal \bool\ true if the network interface is a loopback or similar interface that is not remotely accessible; otherwise false cidr \string\ the assigned ipv6 address with the routing prefix in cidr notation if the netmask is invalid, this property is set to null bootversion \string\ the current version of the boot loader fwversion \string\ the current version of firmware installed on the player uptime \string\ the amount of time (as a human readable string) that the player has been powered on and working correctly uptimeseconds \int\ the amount of time (in seconds) that the player has been powered on and working correctly extensions \extension\[ ]\ an array of extension objects describing firmware extensions currently installed on the player blessings \blessing\[ ]\ an array of blessing objects describing proprietary codecs that are currently authorized on the player response example expand { "route" "/v1/info", "method" "get", "data" { "result" { "serial" "re433d006644", "uptime" "30 minutes", "uptimeseconds" 1832, "model" "xd1035", "fwversion" "9 0 97", "bootversion" "9 0 85", "family" "cobra", "isplayer" true, "power" { "result" { "battery" "absent", "source" "ac", "switch mode" "hard" } }, "poe" { "result" { "status" "inactive" } }, "extensions" { "result" { "extensions" \[] } }, "blessings" { "result" { "ac3" false, "eac3" false } }, "networking" { "result" { "description" "test player", "name" "xd5 re433d006644" } }, "bvnpipelines" { "result" { "pipelines" \[] } }, "bvncomponents" { "result" { "components" \[] } }, "hardware features" { "hdmi" true, "component video" false, "vga" false, "two channel audio" true, "ethernet" true, "usb" true, "serial port 0" true, "serial port 1" false, "gpio connector" true, "svc button" true, "reset button" true, "rtc" true, "settings rom" false, "microsd" false, "sdhc" true, "six channel audio" false, "ir blaster" true, "wifi" false, "serial port 2" false, "audio input" false, "cec" true, "battery" false, "portrait lcd" false, "hdmi input" false, "digital tuner" false, "spdif" true, "audio input loopback" false, "msata" false, "ac3" false, "eac3" false, "onboard storage" true, "no 4k decode" false, "no bluetooth" false, "no poe" false, "internal storage only" false, "disable packet capture" false, "disable bsn cloud" false, "brightear" false, "disable dws" false }, "api features" { "video" true }, "active features" { "legacydws" true }, "connectiontype" "eth0", "ethernet" \[ { "interfacename" "eth0", "interfacetype" "ethernet", "ipv4" \[ { "address" "123 456 7 890", "netmask" "255 255 255 0", "family" "ipv4", "mac" "90\ ac 3f 2a 01 79", "internal" false, "cidr" "192 168 1 174/24" } ], "ipv6" \[ { "address" "2600 1700\ dac0 2060 23", "netmask" "ffff\ ffff\ ffff\ ffff\ ffff\ ffff\ ffff\ ffff", "family" "ipv6", "mac" "90\ ac 3f 2a 01 79", "internal" false, "cidr" "2600 1700\ dac0 2060 23/128", "scopeid" 0 }, { "address" "2600 1700\ dac0 2060 92ac 3fff\ fe2a 179", "netmask" "ffff\ ffff\ ffff\ ffff ", "family" "ipv6", "mac" "90\ ac 3f 2a 01 79", "internal" false, "cidr" "2600 1700\ dac0 2060 92ac 3fff\ fe2a 179/64", "scopeid" 0 }, { "address" "fe80 92ac 3fff\ fe2a 179", "netmask" "ffff\ ffff\ ffff\ ffff ", "family" "ipv6", "mac" "90\ ac 3f 2a 01 79", "internal" false, "cidr" "fe80 92ac 3fff\ fe2a 179/64", "scopeid" 2 } ] } ], "wireless" \[], "interfaces" \[], "bsnce" true } } } get /v1/time/ retrieves the date and time as configured on the player the date/time value is formatted as "yyyy mm dd hh\ mm\ ss \<timezone>" request example get /api/v1/time/ http/1 1 host {{playerip}} authorization {{digestauth}} response example { "route" "/v1/time", "method" "get", "data" { "result" { "time" "2018 10 18 14 34 34 pdt", "timezone mins" null, "timezone name" "america/los angeles", "timezone abbr" "pdt", "year" 2018, "month" 10, "date" 18, "hour" 14, "minute" 34, "second" 34, "millisecond" 569 } } } put /v1/time/ sets the time on the player request body date \string\ the recommended format is " yyyy mm dd " time \string\ the recommended format is " hh\ mm " applytimezone \bool\ this value decides if the date and time passed is in utc or not (the default is false) request example put /api/v1/time/ http/1 1 host {{playerip}} authorization {{digestauth}} content type application/json content length 117 this is the example request body { "data" { "time" "22 00 00", "date" "2023 11 07", "applytimezone" true } } response example { "data" { "result" true } } get /v1/video mode/ returns the current video mode of the player request example get /api/v1/video mode/ http/1 1 host {{playerip}} authorization {{digestauth}} response body width \int\ the screen width height \int\ the screen height frames \int\ the frame rate 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 docid\ qq734nqz0hcwni0unsdmp 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 } } } }