{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"open-api","parameters":{"macroParams":{"showDownloadButton":{"value":"true"},"__bodyContent":{"value":"openapi: 3.0.1\ninfo:\n description: These REST APIs provide several remote control and management operations\n on the H200 Enable Enterprise Media Player.\n title: Enable Enterprise Local Management Server\n version: 3.3.0\nservers:\n- url: \"http://{host}:8090/api/v2\"\n variables:\n host:\n default: api.aminocom.com\n- url: \"https://{host}:10444/api/v2\"\n variables:\n host:\n default: api.aminocom.com\ntags:\n- description: List current available APIs in YAML format\n name: API\n- description: Manage user applications\n name: System - Application Management\n- description: Query and control audio status from system\n name: System - Audio Settings\n- description: Query status of device lock. Locking or unlocking the device\n name: System - Device Lock control\n- description: Retrieve diagnostic information of the STB\n name: System - Diagnostic API\n- description: Fetch all network info on STB\n name: System - Network API\n- description: Manage power control state\n name: System - Power State\n- description: Capture and download screenshot from the system\n name: System - Screenshot\n- description: Return storage information\n name: System - Storage Info API\n- description: System information query and system control\n name: System - General Operation\npaths:\n /commandScheduler/schedule:\n post:\n description: execute command(s) at a specified time on the device\n operationId: schedule\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/CommandScheduler'\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/CommandSchedulerId'\n description: OK\n \"400\":\n description: Bad request\n summary: Schedule command(s) to be executed on the device\n tags:\n - Command Scheduler\n /commandScheduler/schedule/{id}:\n delete:\n description: cancel the scheduled command(s) on the device\n operationId: cancel\n parameters:\n - description: \"Cancel the scheduled command(s) if it is not executed. If the\\\n \\ schedule id does not exist, an error will be returned.\"\n in: path\n name: id\n required: true\n schema:\n type: string\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad request\n \"404\":\n description: Invalid input\n summary: Cancel scheduled command(s)\n tags:\n - Command Scheduler\n get:\n description: get the execution status/results of the scheduled command(s) from\n the device\n operationId: getCommandStatus\n parameters:\n - description: Schedule id\n in: path\n name: id\n required: true\n schema:\n type: string\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/CommandScheduler'\n description: OK\n \"400\":\n description: Bad request\n \"404\":\n description: Invalid input\n summary: Get status of the scheduled command(s).\n tags:\n - Command Scheduler\n /commandScheduler/schedules:\n get:\n description: get the list of schedule id\n operationId: getScheduleList\n responses:\n \"200\":\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/CommandSchedulerId'\n description: OK\n summary: Get the list of scheduled command(s).\n tags:\n - Command Scheduler\n /debug/bugreports:\n get:\n description: \"Returns an array of bug reports, including the date created, filename,\\\n \\ size and status. Returns an empty array if no bug reports exist.\"\n operationId: getReportList\n responses:\n \"200\":\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/BugReport'\n description: OK\n summary: Get list of bug reports\n tags:\n - Debug Utilities\n /debug/bugreports/generate:\n post:\n description: Start generating a new bug report\n operationId: generate\n responses:\n \"200\":\n description: OK\n summary: Initiate bugreport generation\n tags:\n - Debug Utilities\n /debug/bugreports/{name}:\n get:\n description: Returns the bug report with the specified filename as a ZIP file.\n Returns a 404 error if the bug report does not exist.\n operationId: getReportZip\n parameters:\n - in: path\n name: name\n required: true\n schema:\n type: string\n description: The filename of the bug report to download.\n example: bugreport-H200-QTT8.201201.002-2023-06-13-09-51-59.zip\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bug report is still generating\n \"404\":\n description: Bug report not found\n summary: Download generated bug report\n tags:\n - Debug Utilities\n /debug/logcat:\n get:\n description: Retrieves the complete current logcat circular buffer.\n operationId: logcat\n responses:\n \"200\":\n content:\n text/plain:\n schema:\n type: string\n example: \"03-29 03:10:15.145 3559 3559 I vold : Vold 3.0 (the\\\n \\ awakening) firing up\"\n description: OK\n summary: Get logcat buffer.\n tags:\n - Debug Utilities\n /device/hardwareModel:\n get:\n description: Retrieves hardware model in number.\n operationId: getHardwareModel\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/HardwareModelResponse'\n description: OK\n summary: Get hardware model of STB.\n tags:\n - Device Information\n /device/hdmi:\n get:\n description: \"Returns HDMI Information, refer to schema of returned data below\"\n operationId: getHdmiInfo\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/HdmiInfo'\n description: Returns HDMI Information\n summary: Get HDMI Information\n tags:\n - Device Information\n /device/hdmiCec/standbyMode:\n get:\n description: \"The standby mode to retrieve. Valid values are `off`, `tv2stb`,\\\n \\ `stb2tv`, or `both`\"\n operationId: getStandbyMode\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/HdmiStandbyMode'\n description: OK\n summary: Get the HDMI CEC standby mode of the device\n tags:\n - Device HDMI CEC control\n put:\n description: \"This API endpoint allows you to set the HDMI CEC standby mode\\\n \\ of the device. Setting the standby mode to 'both' , 'tv2stb' or 'stb2tv'\\\n \\ will enable HDMI CEC.\"\n operationId: setStandbyMode\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/HdmiStandbyMode'\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Set the HDMI CEC standby mode of the device\n tags:\n - Device HDMI CEC control\n /device/hdmiCec/tv:\n get:\n description: \"The device is an array of name for all connected devices. Empty\\\n \\ String for no device connected or that device does not support HDMI CEC.\\\n \\ active_port will be 0 if failed to get active source of TV, e.g. TV not\\\n \\ support CEC or not connect with HDMI. active_port may not reporting correctly\\\n \\ until TV switching input when multiple devices connected.400 Bad request\\\n \\ will be returned if STB does not enable HDMI CEC.\"\n operationId: getConnectedDevices\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/TVStatus'\n description: OK\n \"400\":\n description: \"Bad Request, HDMI CEC is not enabled\"\n summary: Get TV status via HDMI CEC\n tags:\n - Device HDMI CEC control\n put:\n description: \"Update the power mode of the TV. Set the value to `true` to turn\\\n \\ on the TV or `false` to turn it off. Set power mode of TV to `true` will\\\n \\ switch the active input of HDMI port to STB.Switch the active input of HDMI\\\n \\ port for the TV. Note that this action can only be performed if a device\\\n \\ is currently connected to the specified HDMI port.If HDMI CEC is not enabled,\\\n \\ this action will enable it.\"\n operationId: setTV\n requestBody:\n content:\n application/json:\n examples:\n Update TV output:\n description: Update TV output\n value:\n active_port: 4\n Update TV power status:\n description: Update TV power status\n value:\n power_on: false\n Update both TV output and power status together:\n description: Update both TV output and power status together\n value:\n active_port: 1\n power_on: true\n schema:\n anyOf:\n - $ref: '#/components/schemas/HdmiPort'\n - $ref: '#/components/schemas/HdmiPowerMode'\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Update power mode and active HDMI port for TV via HDMI CEC\n tags:\n - Device HDMI CEC control\n /device/hdmiCec/tv/cycleInput:\n post:\n operationId: cycleTVInput\n responses:\n \"200\":\n description: OK\n summary: \"Cycle through the available inputs on the TV. If HDMI CEC is not enabled,\\\n \\ this action will enable it.\"\n tags:\n - Device HDMI CEC control\n /device/hdmiCec/tv/volumeDown:\n post:\n description: \"If HDMI CEC is not enabled, this action will enable it.\"\n operationId: volumeDown\n responses:\n \"200\":\n description: OK\n summary: Simulate pressing the 'volume down' button on the TV 5 times to reduce\n the volume.\n tags:\n - Device HDMI CEC control\n /device/hdmiCec/tv/volumeUp:\n post:\n description: \"If HDMI CEC is not enabled, this action will enable it.\"\n operationId: volumeUp\n responses:\n \"200\":\n description: OK\n summary: Simulate pressing the 'volume up' button on the TV 5 times to increase\n the volume.\n tags:\n - Device HDMI CEC control\n /device/macAddress:\n get:\n description: Retrieves mac address in the format of XX:XX:XX:XX:XX:XX.\n operationId: getMacAddress\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/MacAddressResponse'\n description: OK\n summary: Get MAC address of STB.\n tags:\n - Device Information\n /device/serialNumber:\n get:\n description: \"Retrieves serial number in the format of {product number}-{device\\\n \\ serial}.\"\n operationId: getSerialNumber\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/SerialNumberResponse'\n description: OK\n summary: Get serial number of STB.\n tags:\n - Device Information\n /firmware/upgrade:\n post:\n description: Upgrade the device from the specified URI.\n operationId: upgrade\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/UpgradeRequest'\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Initiate upgrade from URI.\n tags:\n - Firmware Management\n /input/irControl:\n get:\n description: Retrieves status that enable or not\n operationId: getIrControlStatus\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/IrControlResponse'\n description: OK\n summary: Get current IR control status\n tags:\n - Input\n put:\n description: Enable or disable IR control\n operationId: putIrControlStatus\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/IrControlRequest'\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Set current IR control status\n tags:\n - Input\n /input/key:\n post:\n description: Inject keycode(s) into Android Input Subsystem. Will be forward\n to either global or local handler depending on the keycode and any key remap.\n See https://developer.android.com/reference/android/view/KeyEvent\n operationId: sendKey\n requestBody:\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/Key'\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Inject keycode(s).\n tags:\n - Input\n /openapi.yaml:\n get:\n operationId: getOpenAPIFile\n responses:\n \"200\":\n content:\n text/plain:\n schema:\n type: string\n example: string\n description: OK\n summary: Get API document in yaml format.\n tags:\n - API\n /system:\n get:\n description: Returns system uptime in milliseconds\n operationId: getSystemInfoResponse\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/SystemInfo'\n description: Return system uptime in milliseconds\n summary: Query system uptime\n tags:\n - System - General Operation\n /system/application:\n get:\n description: Retrieves array of information of applications installed.\n operationId: getApplicationList\n parameters:\n - description: \"Possible value: running, stopped, and paused\"\n example: running\n in: query\n name: state\n schema:\n type: string\n responses:\n \"200\":\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/Application'\n description: OK\n \"400\":\n description: Bad Request\n summary: Get list of Android applications installed.\n tags:\n - System - Application Management\n /system/application/install:\n post:\n description: Install / Re-Install / Downgrade APK on the device.\n operationId: installPackageByUpload\n parameters:\n - description: \"Possible value: reinstall, downgrade\\n- reinstall, install the\\\n \\ package without clear package data\\n- downgrade, downgrade the package\\\n \\ and clear package data\\n- (empty), install the package if package is not\\\n \\ installed, or the installed version is higher\"\n example: reinstall\n in: query\n name: option\n schema:\n type: string\n requestBody:\n content:\n application/vnd.android.package-archive:\n schema:\n type: string\n format: binary\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Install / Re-Install / Downgrade APK on the device.\n tags:\n - System - Application Management\n /system/application/install-via-url:\n post:\n description: Install / Re-Install / Downgrade APK on the device.\n operationId: installPackageByUrl\n parameters:\n - description: \"Possible value: reinstall, downgrade\\n- reinstall, install the\\\n \\ package without clear package data\\n- downgrade, downgrade the package\\\n \\ and clear package data\\n- (empty), install the package if package is not\\\n \\ installed, or the installed version is higher\"\n example: reinstall\n in: query\n name: option\n schema:\n type: string\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/SystemApplicationInstallRequestBody'\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Install / Re-Install / Downgrade APK on the device.\n tags:\n - System - Application Management\n /system/application/{app}:\n get:\n description: Retrieves information of the installed package.\n operationId: getApplication\n parameters:\n - description: package name\n in: path\n name: app\n required: true\n schema:\n type: string\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Application'\n description: OK\n \"404\":\n description: Not Found\n summary: Get the information of a installed Android package.\n tags:\n - System - Application Management\n /system/application/{app}/clear:\n post:\n description: Clear all data of the installed package.\n operationId: clearPackageDataByName\n parameters:\n - description: package name\n in: path\n name: app\n required: true\n schema:\n type: string\n responses:\n \"200\":\n description: OK\n \"404\":\n description: Not Found\n \"500\":\n description: Internal Server Error\n summary: Clear the data of a installed Android package.\n tags:\n - System - Application Management\n /system/application/{app}/force-stop:\n post:\n description: Forcing the installed package to stop.\n operationId: forceStopPackageByName\n parameters:\n - description: package name\n in: path\n name: app\n required: true\n schema:\n type: string\n responses:\n \"200\":\n description: OK\n \"404\":\n description: Not Found\n \"500\":\n description: Internal Server Error\n summary: Forcing of a installed running Android package to stop\n tags:\n - System - Application Management\n /system/application/{app}/uninstall:\n post:\n description: Uninstall Android package from the device.\n operationId: uninstallPackageByName\n parameters:\n - description: package name\n in: path\n name: app\n required: true\n schema:\n type: string\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n \"404\":\n description: Not Found\n summary: Uninstall a installed Android package.\n tags:\n - System - Application Management\n /system/audio/mute:\n get:\n description: Returns current mute status.\n operationId: getMute\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Mute'\n description: Return current mute status\n summary: Get mute status\n tags:\n - System - Audio Settings\n put:\n description: \"Apply mute status from the request body.\\n\\nThe field, mute, is\\\n \\ a boolean.\\n\\n\"\n operationId: applyMute\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Mute'\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Mute'\n description: Modify mute settings successful and return the current mute\n status\n \"400\":\n description: 'Bad request due to:
1. mute cannot be parsed into\n a boolean value '\n summary: Modify mute setting\n tags:\n - System - Audio Settings\n /system/audio/volume:\n get:\n description: |-\n Returns volume information.\n\n Note that return value is in percentage.\n operationId: getVolume\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Volume'\n description: Return volume information\n summary: Get volume\n tags:\n - System - Audio Settings\n put:\n description: \"Apply volume settings from the request body.\\n\\nThe field, volume,\\\n \\ is a integer.\\n\\nthe valid volume range is between 0 to 100, inclusive.\\n\\\n \\nNote that return value is in percentage.\\n\\n\"\n operationId: applyVolume\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Volume'\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Volume'\n description: Modify volume settings successful and return the current volume\n setting\n \"400\":\n description: Bad request due to:
1. volume is out of 0 to 100
2.\n volume cannot be parsed into a numeric value\n summary: Modify volume setting\n tags:\n - System - Audio Settings\n /system/deeplink:\n post:\n description: Send a intent for Android system to launch a new activity.\n operationId: sendIntent\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/LaunchIntent'\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Send an Android launch intent.\n tags:\n - System - General Operation\n /system/diagnostic:\n get:\n description: \"Currently returns information about general, interface, network,\\\n \\ Wifi, launcher, zero screen app, and rcu\\n\\nThe Diagnostic Info has no definitive\\\n \\ schema, but rather Engage display whatever info passed by the STB\\n\\nThe\\\n \\ format is defined as follows:\\n\\n- Each JSONObject in root level act as\\\n \\ a new section in the diagnostic panel\\n\\n - Each field inside the object\\\n \\ has its own row\\n\\n - The key act as the bold header for the row\\n\\n -\\\n \\ The value can be:\\n\\n - A String, representing a single column\\n -\\\n \\ An Array of String, representing multiple columns\\n\\n\\nA common format for\\\n \\ a section of individual information (e.g. Network):\\n\\n{ \\\"Row Header 1\\\"\\\n : \\\"Value\\\", \\\"Row Header 2\\\": \\\"Another Value\\\" }\\n\\n\\nA common format for\\\n \\ a section of common objects (e.g. RCU):\\n\\n{ \\\"\\\": [\\\"Column Header 1\\\"\\\n , \\\"Column Header 2\\\"], \\\"Row Header 1\\\": [\\\"Value 1\\\", \\\"Value 2\\\"], \\\"Row\\\n \\ Header 2\\\": [\\\"Value 1\\\", \\\"Value 2\\\"] }\"\n operationId: getDiagnosticInfo\n responses:\n \"200\":\n description: Returns all diagnostic information\n summary: Get all diagnostic information\n tags:\n - System - Diagnostic API\n /system/lock:\n post:\n description: \"Lock the device, and return the current device lock status.

If\\\n \\ empty request body is received, the lock message will be retrieved through\\\n \\ INI.\"\n operationId: lockDevice\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DeviceLockRequest'\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DeviceLockStatus'\n description: \"Locking device succeed, returns device lock status\"\n \"400\":\n description: Bad request due to:
1. invalid request body
2. fail to\n validate the image URL due to unreachable
3. fail to validate the image\n URL because its Content-Type header does not start with 'image/'
4.\n fail to validate the image URL because its Content-Length header is greater\n than 10 MB\n summary: Request to lock the device\n tags:\n - System - Device Lock control\n /system/lock_status:\n get:\n description: Returns device lock status\n operationId: getDeviceLockStatus\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DeviceLockStatus'\n description: Returns device lock status\n summary: Query status of device lock\n tags:\n - System - Device Lock control\n /system/network:\n get:\n description: Retrieve detailed information of network(s) on the STB\n operationId: getNetworkInfo\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/NetworkInterfaceDetailsResponse'\n description: Returns Network Information\n summary: Get Network Information\n tags:\n - System - Network API\n /system/power:\n get:\n description: Get the current power status of the device.\n operationId: powerStatus\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/PowerResponse'\n description: OK\n summary: Power Status\n tags:\n - System - Power State\n /system/power/activate:\n post:\n description: Set the device from standby mode to active mode\n operationId: powerActivate\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Power Activation\n tags:\n - System - Power State\n /system/power/standby:\n post:\n description: Set the device from active mode into standby mode\n operationId: powerStandby\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Power Standby\n tags:\n - System - Power State\n /system/prop:\n get:\n description: Returns Android System Property as specified by key.\n operationId: getProp\n parameters:\n - example: persist.sys.timezone\n in: query\n name: key\n required: true\n schema:\n type: string\n responses:\n \"200\":\n content:\n text/plain:\n schema:\n type: string\n example: persist.sys.timezone=Asia/Hong_Kong\n description: OK\n \"400\":\n description: Bad Request\n summary: Get system property.\n tags:\n - System - General Operation\n put:\n description: \"Sets the provided value into the Android Property as specified\\\n \\ in key. There are limitations of property that can be set. It is limited\\\n \\ by SE policy. You can add new properties under the existing domain, e.g.\\\n \\ persist.sys., persist.vendor.amino.\"\n operationId: setProp\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/KeyValuePair'\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Set property value.\n tags:\n - System - General Operation\n /system/reboot:\n post:\n description: Reboots the device immediately without prompt.\n operationId: reboot\n responses:\n \"200\":\n description: OK\n summary: Reboot device.\n tags:\n - System - General Operation\n /system/rotation:\n get:\n description: Obtain the orientation of the device's screen\n operationId: getSystemOrientation\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RotationResponse'\n description: OK\n summary: Get system orientation\n tags:\n - System - General Operation\n put:\n description: Configure the orientation of the device's screen\n operationId: setSystemOrientation\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RotationChangeRequest'\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n \"409\":\n description: Conflict\n summary: Set the system orientation\n tags:\n - System - General Operation\n /system/screenshot:\n get:\n description: Returns a list of all available screenshots.\n operationId: getImages\n responses:\n \"200\":\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/Screenshot'\n description: OK\n summary: Get all available screenshots\n tags:\n - System - Screenshot\n /system/screenshot/capture:\n post:\n description: \"Captures a new screenshot. If the number of screenshots exceeds\\\n \\ 10, the oldest screenshot will be automatically deleted.\"\n operationId: capture\n responses:\n \"200\":\n description: OK\n \"500\":\n description: Internal Server Error\n \"503\":\n description: Device or resource busy\n summary: Capture a new screenshot\n tags:\n - System - Screenshot\n /system/screenshot/{id}:\n get:\n description: \"Returns the screenshot with the specified ID. Use ID=0 to get\\\n \\ the latest screenshot, or ID=9 to get the oldest screenshot.\"\n operationId: getImage\n parameters:\n - description: ID of the screenshot to retrieve\n in: path\n name: id\n required: true\n schema:\n type: integer\n format: int32\n responses:\n \"200\":\n content:\n '*/*':\n schema:\n $ref: '#/components/schemas/Screenshot'\n description: OK\n \"404\":\n description: Not found\n summary: Get information about a specific screenshot\n tags:\n - System - Screenshot\n /system/screenshot/{id}/image:\n get:\n description: \"Returns the raw image data for a specific screenshot. Use ID=0\\\n \\ to get the latest screenshot, or ID=9 to get the oldest screenshot.\"\n operationId: returnImage\n parameters:\n - description: ID of the screenshot to retrieve\n in: path\n name: id\n required: true\n schema:\n type: integer\n format: int32\n responses:\n \"200\":\n content:\n image/jpeg:\n schema:\n type: string\n format: binary\n description: OK\n \"404\":\n description: Not found\n summary: Get the raw image data for a specific screenshot\n tags:\n - System - Screenshot\n /system/spacemgr:\n get:\n description: \"Returns storage information, represented in bytes\"\n operationId: getStorageInfo\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/StorageInfo'\n description: Return storage information\n summary: Get storage information\n tags:\n - System - Storage Info API\n /system/unlock:\n post:\n description: \"Unlock the device, and return the current device lock status\"\n operationId: unlockDevice\n responses:\n \"200\":\n content:\n application/json:\n example:\n locked: false\n schema:\n $ref: '#/components/schemas/DeviceLockStatus'\n description: \"Unlocking device succeed, returns device lock status\"\n summary: Request to unlock the device\n tags:\n - System - Device Lock control\n /zapper/changeChannel:\n post:\n description: \"Built-in Zapper Application will be restarted and attempt to tune\\\n \\ to the specified channel by name or desc. If the channel name or desc is\\\n \\ not found, it will tune to the channel configured from the Lineup File.\"\n operationId: changeChannel\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ZapperChannelChange'\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Change channel on zapper.\n tags:\n - Zapper\n /zapper/channels:\n get:\n description: \"Complete channel lineup will be returns in JSON format or empty\\\n \\ json object {} if no channels have been provisioned.\"\n operationId: getAllChannels\n responses:\n \"200\":\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Channels'\n description: OK\n summary: Returns complete channel lineup.\n tags:\n - Zapper\n post:\n description: Add a new channel to the lineup. If the channel already exists\n then an error will be returned.\n operationId: addNewChannel\n requestBody:\n content:\n application/json:\n schema:\n oneOf:\n - $ref: '#/components/schemas/ChannelV1'\n - $ref: '#/components/schemas/ChannelV2'\n - $ref: '#/components/schemas/ChannelV3'\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Adds new channel to the lineup.\n tags:\n - Zapper\n /zapper/channels/{name}:\n delete:\n operationId: deleteChannel\n parameters:\n - description: Delete the channel for number provided as name param. If the\n channel does not exist and error will be returned.\n in: path\n name: name\n required: true\n schema:\n type: string\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Delete the channel.\n tags:\n - Zapper\n get:\n operationId: getChannelByName\n parameters:\n - description: Return the channel object for number provided as name param.\n in: path\n name: name\n required: true\n schema:\n type: string\n responses:\n \"200\":\n content:\n application/json:\n schema:\n oneOf:\n - $ref: '#/components/schemas/ChannelV1'\n - $ref: '#/components/schemas/ChannelV2'\n - $ref: '#/components/schemas/ChannelV3'\n description: OK\n \"400\":\n description: Bad Request\n summary: Get the channel info.\n tags:\n - Zapper\n put:\n operationId: editChannelInfo\n parameters:\n - description: Update the channel object for number provided as name param.\n If the channel does not exist and error will be returned.\n in: path\n name: name\n required: true\n schema:\n type: string\n requestBody:\n content:\n application/json:\n schema:\n oneOf:\n - $ref: '#/components/schemas/ChannelV1'\n - $ref: '#/components/schemas/ChannelV2'\n - $ref: '#/components/schemas/ChannelV3'\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Create or change the channel info of a channel.\n tags:\n - Zapper\n /zapper/tuneToUrl:\n post:\n description: \"Provide channel lineup entry and force tune the channel zapper\\\n \\ to tune to the entry without persisting. Upon Ch+/- the channel zapper will\\\n \\ continue going through the lineup if configured. If NO channel lineup has\\\n \\ been configured, CH+/- will have no effect and the Forced Tuned URL will\\\n \\ continue to play.\"\n operationId: tuneToUrl\n requestBody:\n content:\n application/json:\n schema:\n oneOf:\n - $ref: '#/components/schemas/ChannelV1'\n - $ref: '#/components/schemas/ChannelV2'\n - $ref: '#/components/schemas/ChannelV3'\n responses:\n \"200\":\n description: OK\n \"400\":\n description: Bad Request\n summary: Force tune to video URL.\n tags:\n - Zapper\ncomponents:\n schemas:\n Application:\n type: object\n properties:\n app_label:\n type: string\n description: Display name of application.\n example: Browser\n in_system_image:\n type: boolean\n description: Whether the application is part of system image.\n example: true\n launch_intent:\n $ref: '#/components/schemas/LaunchIntent'\n package_name:\n type: string\n description: Package name of application.\n example: com.aminocom.browser\n state:\n type: string\n description: Running state of application\n enum:\n - running\n - stopped\n - paused\n example: running\n storage:\n $ref: '#/components/schemas/Storage'\n version:\n type: string\n description: Version number of application\n example: \"1.0\"\n BugReport:\n type: object\n properties:\n date:\n type: string\n description: \"The date and time when the bug report was taken, in ISO 8601\\\n \\ format.\"\n example: 2023-06-13T09:53:40Z\n name:\n type: string\n description: The filename of the bug report.\n example: bugreport-H200-QTT8.201201.002-2023-06-13-09-51-59.zip\n size:\n type: integer\n format: int64\n description: The size of the bug report file in bytes.\n example: 3828208\n status:\n type: string\n description: The status of the bug report.\n enum:\n - generating\n - available\n example: generating\n Channel:\n type: object\n oneOf:\n - $ref: '#/components/schemas/ChannelV1'\n - $ref: '#/components/schemas/ChannelV2'\n - $ref: '#/components/schemas/ChannelV3'\n ChannelV1:\n type: object\n properties:\n addr:\n type: string\n example: 233.22.133.1\n desc:\n type: string\n example: UDP 1\n drm_session_type:\n type: string\n example: persistent\n encrypting_request_header:\n type: object\n additionalProperties:\n type: string\n example: \"{'header_a':'a'}\"\n example: \"{'header_a':'a'}\"\n encrypting_server:\n type: string\n example: http://demo.aminocom.com/license\n encryption_type:\n type: string\n example: com.widevine.alpha\n igmpv3_addr_list:\n type: array\n items:\n type: string\n example: 198.51.100.42\n igmpv3_mode:\n type: string\n enum:\n - asm\n - include\n - exclude\n example: asm\n loop_on_end:\n type: boolean\n description: set true to replay the video upon video end.\n example: false\n name:\n type: string\n example: \"101\"\n port:\n type: integer\n format: int32\n example: 8110\n maximum: 65536\n minimum: 1\n retry_on_error:\n type: boolean\n description: \"set true to re-tune the this channel when there is ERROR event,\\\n \\ set false to tune to the next channel upon error.\"\n example: false\n starting:\n type: boolean\n description: set true to specify the 1st channel being played after boot\n example: true\n type:\n type: string\n enum:\n - udp\n - igmpv3\n - nativedash\n - rtsp\n - http\n - srt\n - https\n example: udp\n required:\n - addr\n - name\n - type\n ChannelV2:\n type: object\n properties:\n desc:\n type: string\n example: UDP 1\n drm_session_type:\n type: string\n example: persistent\n encrypting_request_header:\n type: object\n additionalProperties:\n type: string\n example: \"{'header_a':'a'}\"\n example: \"{'header_a':'a'}\"\n encrypting_server:\n type: string\n example: http://demo.aminocom.com/license\n encryption_type:\n type: string\n example: com.widevine.alpha\n loop_on_end:\n type: boolean\n description: set true to replay the video upon video end.\n example: false\n name:\n type: string\n example: \"101\"\n retry_on_error:\n type: boolean\n description: \"set true to re-tune the this channel when there is ERROR event,\\\n \\ set false to tune to the next channel upon error.\"\n example: false\n starting:\n type: boolean\n description: set true to specify the 1st channel being played after boot\n example: true\n url:\n type: string\n description: Full URL as EnableJS API Player.setSource()\n example: udp://233.22.133.100:8110?prog_id=2&disable_av_sync=true\n required:\n - name\n - url\n ChannelV3:\n type: object\n properties:\n desc:\n type: string\n example: UDP 1\n drm_session_type:\n type: string\n example: persistent\n encrypting_request_header:\n type: object\n additionalProperties:\n type: string\n example: \"{'header_a':'a'}\"\n example: \"{'header_a':'a'}\"\n encrypting_server:\n type: string\n example: http://demo.aminocom.com/license\n encryption_type:\n type: string\n example: com.widevine.alpha\n loop_on_end:\n type: boolean\n description: set true to replay the video upon video end.\n example: false\n name:\n type: string\n example: \"101\"\n retry_on_error:\n type: boolean\n description: \"set true to re-tune the this channel when there is ERROR event,\\\n \\ set false to tune to the next channel upon error.\"\n example: false\n starting:\n type: boolean\n description: set true to specify the 1st channel being played after boot\n example: true\n url:\n type: array\n items:\n type: string\n description: Array of String contains full URL as EnableJS API Player.setSource()\n example: \"[\\\"udp://233.22.133.100:8110\\\",\\\"udp://233.22.133.101:8110\\\"\\\n ]\"\n maxLength: 4\n minLength: 1\n required:\n - name\n - url\n Channels:\n type: object\n properties:\n channels:\n type: array\n items:\n $ref: '#/components/schemas/Channel'\n Command:\n type: object\n properties:\n method:\n type: string\n description: Request method\n example: POST\n params:\n type: object\n description: command arguments\n example: \"\\\"volume\\\":{\\\"left\\\":\\\"50\\\", \\\"right\\\":\\\"50\\\"}\"\n payload:\n type: object\n example: \"{\\\"locked\\\":false},\"\n readOnly: true\n status:\n type: integer\n format: int32\n example: 200\n readOnly: true\n timeout:\n type: integer\n format: int32\n description: \"in milliseconds, how long to wait for the response from the\\\n \\ device. Default is 10000 (10s)\"\n example: 1000\n url:\n type: string\n description: api url\n example: /system/audio\n required:\n - method\n - url\n CommandScheduler:\n type: object\n properties:\n apiBaseUrl:\n type: string\n description: Base url to be append to url of the command.\n example: http://localhost:8090\n commands:\n type: array\n items:\n $ref: '#/components/schemas/Command'\n execTs:\n type: integer\n format: int64\n description: \"epoch time to execute the command(s). The Execution Time will\\\n \\ add and minus a threshold (10 seconds) to become a time range, then\\\n \\ compare it with the system clock time to determine the actions.\"\n example: 1678430761\n inSeq:\n type: boolean\n description: execute the command(s) sequentially\n example: true\n status:\n type: integer\n format: int32\n example: 200\n readOnly: true\n statusPayload:\n type: string\n example: success\n readOnly: true\n required:\n - apiBaseUrl\n CommandSchedulerId:\n type: object\n properties:\n id:\n type: integer\n format: int32\n example: 100\n DeviceLockRequest:\n type: object\n properties:\n image:\n type: string\n description: The lock image URL.
Content-Type header shall start with\n 'image/' and Content-Length header shall be smaller than or equal to 10\n MB.\n example: https://xxx/device_lock.png\n message:\n type: string\n description: \"The lock message.
If the image field does not exist, the\\\n \\ lock screen will show message defined here.
If message = empty string,\\\n \\ the lock message will be retrieved through INI.\"\n example: Your device has been locked\n DeviceLockStatus:\n type: object\n properties:\n locked:\n type: boolean\n ExtrasConfig:\n type: object\n description: Additional parameters to be passed in JSON format.\n properties:\n configA:\n type: boolean\n example: true\n configB:\n type: string\n example: String\n configC:\n type: integer\n format: int32\n example: 123\n HardwareModelResponse:\n type: object\n properties:\n hardwareModel:\n type: string\n example: \"107\"\n HdmiInfo:\n type: object\n properties:\n cec_one_touch_play:\n type: string\n example: \"off\"\n cec_remote_control:\n type: string\n example: tv2stb\n cec_standby:\n type: string\n example: \"off\"\n connected:\n type: boolean\n example: true\n current_resolution:\n type: string\n example: 1920x1080\n hdcp_enabled:\n type: boolean\n example: true\n hdcp_success:\n type: string\n example: \"Yes\"\n hdcp_version:\n type: string\n example: V1\n max_audio_pcm_channels:\n type: integer\n format: int32\n example: 2\n monitor_name:\n type: string\n example: MStar\n preferred_resolution:\n type: string\n example: 2160p30hz\n supported_3D_resolution:\n type: array\n example:\n - '480i60hz TopBottom SidebySide '\n - '576i50hz TopBottom SidebySide '\n items:\n type: string\n supported_deep_color_formats:\n type: string\n example: --\n supported_eotf_formats:\n type: string\n example: --\n supported_resolution:\n type: array\n example:\n - 480i60hz\n - 576i50hz\n items:\n type: string\n HdmiPort:\n type: object\n properties:\n active_port:\n type: integer\n format: int32\n example: 1\n required:\n - active_port\n HdmiPowerMode:\n type: object\n properties:\n power_on:\n type: boolean\n example: false\n required:\n - power_on\n HdmiStandbyMode:\n type: object\n properties:\n mode:\n type: string\n description: The standby command communication between TV and STB\n enum:\n - tv2stb\n - stb2tv\n - both\n - \"off\"\n required:\n - mode\n IrControlRequest:\n type: object\n properties:\n enable:\n type: boolean\n example: true\n required:\n - enable\n IrControlResponse:\n type: object\n properties:\n ircontrol:\n type: boolean\n example: true\n Key:\n type: object\n properties:\n delay:\n type: integer\n format: int32\n example: 500\n keycode:\n type: integer\n format: int32\n example: 166\n required:\n - keycode\n KeyValuePair:\n type: object\n properties:\n key:\n type: string\n example: persist.sys.amino.hdmi.cec.one_touch_play\n value:\n type: string\n example: \"on\"\n required:\n - key\n - value\n LaunchIntent:\n type: object\n properties:\n action:\n type: string\n description: Action Name.\n example: android.intent.action.VIEW\n activity:\n type: string\n description: Classname inside of the application package.\n example: com.aminocom.browser.MainActivity\n data:\n type: string\n description: Data or uri.\n example: https://www.yahoo.com\n extras:\n $ref: '#/components/schemas/ExtrasConfig'\n package:\n type: string\n description: Explicit package id should be target to instead of broadcast.\n example: com.aminocom.browser\n packageName:\n type: string\n description: Deprecated. Keep for compatibility. Please use package.\n MacAddressResponse:\n type: object\n properties:\n macAddress:\n type: string\n example: 5C:0F:FB:11:F1:6E\n Mute:\n type: object\n properties:\n mute:\n type: boolean\n NetworkInterfaceDetails:\n type: object\n properties:\n active:\n type: boolean\n dhcp_server:\n type: string\n description: Only available for wlan / on Android R+\n dns:\n type: array\n items:\n type: string\n gateway:\n type: string\n ip_address:\n type: string\n ip_type:\n type: string\n description: Only available for wlan / on Android R+\n link_capability:\n type: boolean\n linking:\n type: string\n mac_address:\n type: string\n member_interfaces:\n type: array\n items:\n type: string\n netmask:\n type: string\n nic_name:\n type: string\n nic_type:\n type: string\n transmission_mode:\n type: string\n NetworkInterfaceDetailsResponse:\n type: object\n properties:\n current_active_wan:\n type: string\n description: Name of current active interface\n nic:\n type: array\n items:\n $ref: '#/components/schemas/NetworkInterfaceDetails'\n num_of_nic:\n type: integer\n format: int32\n description: Number of network interface in total\n PowerResponse:\n type: object\n properties:\n status:\n type: string\n enum:\n - active\n - standby\n example: active\n RotationChangeRequest:\n type: object\n properties:\n rotation:\n type: integer\n format: int32\n description: \"Degree in clockwise:

0: 0 degree
1: 90 degree
2:\\\n \\ 180 degree
3: 270 degree\"\n example: 0\n required:\n - rotation\n RotationResponse:\n type: object\n properties:\n rotation:\n type: integer\n format: int32\n description: \"Degree in clockwise:

0: 0 degree
1: 90 degree
2:\\\n \\ 180 degree
3: 270 degree\"\n example: 0\n Screenshot:\n type: object\n properties:\n filename:\n type: string\n description: The filename of the screenshot resource.\n example: screenshot_2023-04-20_16-26-52-747.jpg\n timestamp:\n type: string\n description: \"The timestamp when the screenshot was captured, in format:\\\n \\ EEE MMM dd HH:mm:ss zzz yyyy\"\n example: Thu Apr 20 18:08:48 GMT+08:00 2023\n uri:\n type: string\n description: The URI of the screenshot resource.\n example: http://localhost:8090/api/v2/system/screenshot/0/image\n SerialNumberResponse:\n type: object\n properties:\n serialNumber:\n type: string\n example: 107-12345678\n Storage:\n type: object\n description: Storage used\n properties:\n app:\n type: integer\n format: int64\n description: The size of the app (in byte)\n example: 8192\n cache:\n type: integer\n format: int64\n description: The size of all cached data (int byte)\n example: 516096\n data:\n type: integer\n format: int64\n description: The size of all data (in byte)\n example: 1146881\n StorageInfo:\n type: object\n properties:\n free:\n type: string\n example: \"2000000000\"\n total:\n type: string\n example: \"4000000000\"\n SystemApplicationInstallRequestBody:\n type: object\n properties:\n url:\n type: string\n SystemInfo:\n type: object\n properties:\n uptime:\n type: integer\n format: int64\n description: System uptime in milliseconds\n TVStatus:\n type: object\n properties:\n active_port:\n type: integer\n format: int32\n description: \"The HDMI port number is/to activate. 1 means HDMI 1, 0 for\\\n \\ unknown.\"\n example: 1\n maximum: 4\n minimum: 0\n device:\n type: array\n description: List of device names connected to TV\n example:\n - H200\n - \"\"\n - \"\"\n - \"\"\n items:\n type: string\n description: List of device names connected to TV\n example: \"[\\\"H200\\\",\\\"\\\",\\\"\\\",\\\"\\\"]\"\n readOnly: true\n readOnly: true\n power_status:\n type: integer\n format: int32\n description: \"The power status of TV. 0: TV off, 1: TV on, 2: unknown (HDMI\\\n \\ not connected), 3: unknown (HDMI connected but STB standby), 4: unknown\\\n \\ (HDMI connected and STB not in standby, but no CEC data replied), 5:\\\n \\ unknown (others)\"\n enum:\n - 0\n - 1\n - 2\n - 3\n - 4\n - 5\n readOnly: true\n UpgradeRequest:\n type: object\n properties:\n uri:\n type: string\n example: http://www.webstorage.com/25.5.2021.3.zip\n required:\n - uri\n Volume:\n type: object\n properties:\n volume:\n type: integer\n format: int32\n maximum: 100\n minimum: 0\n ZapperChannelChange:\n type: object\n example:\n name: \"2\"\n properties:\n desc:\n type: string\n name:\n type: string\n"}},"macroMetadata":{"macroId":{"value":"0fadf5c7-da57-40d7-b693-83f39db0c129"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://confluence-open-api.herokuapp.com/images/open-api-icon.png"}}],"title":"Open API (Swagger) Documentation"}},"localId":"fffa4a86-37de-4daa-b034-f6e89fb80647"}}],"version":1}

EELM OpenAPI - 3.3.0