getSetting: Get the specified properties

Function Description:

Get the specified properties of the device.

Corresponding JS API:
getSetting(<Display>);
Whether to support multiple devices:

No

Resource Information:

Method GET
URL .../devices/:device/settings
Requires authentication? Yes


Method Parameters:

Parameter Type Required Description
device String Yes ID value of the device


Response Parameters:

A JSON string representing an array of objects with the following fields:

Field Type Description
status Boolean Return true for success and null for failure
value String If the value of status is a null object, an error message or empty string is returned.
If the value of status is true,it returns the device's settings properties;
  • display_mode: Int. Display mode.
    1 – indicates that the display mode is HA1;
    2 – indicates that the display mode is HA2;
    3 – indicates that the display mode is Comp;
  • display_quality: Int. Display quality.
    1 – High;
    2 – Medium;
    3 - Low;
  • display_accl: Int. Acceleration mode.
    1 – GDI;
    2 – DirectX;
    3 - OpenGL;
  • display_hw_decode: Int. Whether to use hardware decoding.
    1 – Yes;
    0 – No;
  • display_resolution_mode: Int. Resolution mode.
    1 - 480p;
    2 - 640p;
    3 - 720p;
    4 - 1080p;
  • display_resolution: String. The width and height of the screen, such as: "720*1280".
  • display_orientation: Int. The display orientation of the screen.
    1 – Portrait;
    2 – Landscape;


Request Example:
http://localhost:8090/TotalControl/v1/devices/device@1116106541/settings?token=270eq7lXQK8bXYsJ
Response Example:

If this API executes successfully, it returns:

{
    "status": true, 
    "value": {
        "display_mode": 1, 
        "display_quality": 2, 
        "display_accl": 2, 
        "display_hw_decode": "1", 
        "display_resolution_mode": 2, 
        "display_orientation": 1, 
        "display_resolution": "1080*1920"
    }
}

If the value of HTTP status code is 200, but the value of status is a null object, it returns:

{
    "status": null,
    "value": "<Error message>"
}


Example:

Warm tip:
Get the token needed for Total Control script development,see here.
Get the id value of the master device, see here.

RingoJS Example:
// Import the packages
var {request} = require("ringo/httpclient");
var base64 = require("ringo/base64");

// The username and password are separated by a single : and sent on the wire base64 encoded
var userpass = base64.encode("sigma:3D391497");

// First step: Get the API token
var gettoken = request({
	method: "GET",
	url: "http://localhost:8090/TotalControl/v1/login",
	headers: {
		"Authorization": userpass
	}
});
var ret_token = JSON.parse(gettoken.content); 
var token = ret_token.value.token; 
print("//The value of token is:" + token);

// Second step: Get the device id value of the master device
var getdevice = request({
	method: "GET",
	url: "http://localhost:8090/TotalControl/v1/devices/main?token=" + token
});
var device = JSON.parse(getdevice.content).id; 
print("//The value of device ID is:"+ device);

// Third step: Execute this REST API
var resp = request({
	method: "GET",
	url: "http://localhost:8090/TotalControl/v1/devices/" + device + "/settings",
	data: {
		"token": token,
	}
});
var obj = JSON.parse(resp.content); 
ret =obj.status;
if (ret == true) {
	print("//Executed successfully,Return value: \n"+resp.content);	
} else if (ret != true & resp.status == 200){
	print("An error message is returned: "+resp.content);
} else {
	print("This API failed to execute.");
}
The running result of the RingoJS:

If it executes successfully, it will return:

//The value of token is:U44Gyjs36755b7Kp

//The value of device ID is:device@230441652

//Executed successfully,Return value: 
{"status":true,"value":{"display_mode":2,"display_quality":1,"display_accl":1,"display_hw_decode":1,"display_resolution_mode":2,"display_orientation":1,"display_resolution":"720*1280"}}
Python Example:
#!/user/bin/python
#-*- coding:utf-8 -*-
import base64
import requests

# The username and password are separated by a single : and sent on the wire base64 encoded
user_pass = 'sigma:3D391497'
encodeStr = base64.b64encode(user_pass.encode("UTF-8"))

# First step: Get the API token
LoginUrl = "http://localhost:8090/TotalControl/v1/login"
response = requests.get(LoginUrl, headers={'Authorization':encodeStr})
print("Get the token,Return value: ",response.json())
token = response.json()['value']['token']
print("The value of token is: ",token)

# Second step: Get the device id value of the master device
if token is not None:
    GetDeviceUrl = "http://localhost:8090/TotalControl/v1/devices/main?token=" + token
    response = requests.get(url=GetDeviceUrl)
    print("Get the device id,Return value: ", response.json())
    device = response.json()['id']
    print("The value of device id is: ", device)
    if device is not None:
        # Third step: Execute this REST API
        APIUrl = "http://localhost:8090/TotalControl/v1/devices/" + device + "/settings"
        data = {
            "token": token
        }
        response = requests.get(url=APIUrl, params=data)
        ret = response.json()['status']
        # Determine if this REST API is executed successfully
        if ret is True:
            print("Executed successfully,Return value: ", response.json())
        elif response.status_code == 200 and ret is not True:
            print("An error message is returned: ",response.json())
        else:
            print("This API failed to execute.")
    else:
        print("Failed to get device id.")
else:
    print("Failed to get token.")
The running result of the python:

If it executes successfully, it will return:

Get the token,Return value:  {'status': True, 'value': {'token': 'U44Gyjs36755b7Kp'}}
The value of token is:  U44Gyjs36755b7Kp
Get the device id,Return value:  {'id': 'device@230441652'}
The value of device id is:  device@230441652
Executed successfully,Return value:  {'status': True, 'value': {'display_mode': 2, 'display_quality': 1, 'display_accl': 1, 'display_hw_decode': 1, 'display_resolution_mode': 2, 'display_orientation': 1, 'display_resolution': '720*1280'}}