Differences

This shows you the differences between two versions of the page.

--- http_api [2025/01/07 16:51]
cflintiii [dec]
+++ http_api [2025/01/07 18:17] (current)
cflintiii [UpdateTerm]
@@ Line 20582: / Line 20582: @@
 ----
-==== UpdateTerm ====
-----
-Control serial port terminal server for VISCA
-== Parameters: ==
-----
-//**data**//  Parse the JSON formatted data and retrieve the terminal server values.
-//**term_mode**//  Possible values: client, server
-//**term_protocol**//  Possible values: clearchannel, telnet
-//**term_localport**//  Local TCP port (for server mode)
-//**term_servaddr**//  Remote IP address (for client mode only)
-//**term_servport**//  Remote TCP port (for client mode only)
-//**term_data_bits**//  number of data bits.
-//**term_parity**//  Possible values: None, Odd, Even, Mark, Space
-//**term_stop_bits**//  Stop bits sent at the end of every character.
-//**term_baudrate**//  Possible values: 9600, 19200, 38400, 57600, 115200
-//**term_devicefile**//  device fine name
-//**term_function**//  functionality
-== Returns: ==
-----
-JSON formatted table with values below
-**//ret//**  Custom return code of the HTTP POST request. 0 on success, 1 on failure.
-**//status//**  String describing the failure when **ret** is 1. "OK" on success.
-----
-==== user_add ====
-----
-Add a new user in the Database.
-== Parameters: ==
-----
-//**Name**//  Get new user name
-//**Level**//  Get the level of permission for the new user name. Possible value: 0 to 7.
-//**Password**//  Get the password for the new user name.
-== Returns: ==
-----
-JSON formatted table with values below
-**//ret//**  Custom return code of the HTTP POST request. 0 on success, 1 on failure.
-**//status//**  String describing the failure when **ret** is 1. "OK" on success.
-----
-==== user_remove ====
-----
-Remove the user from the database.
-== Parameters: ==
-----
-//**data **//  Parse the JSON formatted data and retrieve the user name.
-== Returns: ==
-----
-JSON formatted table with values below
-**//ret//**  Custom return code of the HTTP POST request. 0 on success, 1 on failure.
-**//status//**  String describing the failure when **ret** is 1. "OK" on success.
-----
-==== user_update_level ====
-----
-Update/change the level of permission to the given user name.
-== Parameters: ==
-----
-//**data **//  Parse the JSON formatted data and retrieve the user name and level of the permission.
-== Returns: ==
-----
-JSON formatted table with values below
-**//ret//**  Custom return code of the HTTP POST request. 0 on success, 1 on failure.
-**//status//**  String describing the failure when **ret** is 1. "OK" on success.
-----
-==== user_update_password ====
-----
-Update/change the password to the given user name.
-== Parameters: ==
-----
-//**data **//  Parse the JSON formatted data and retrieve the user name and password.
-== Returns: ==
-----
-JSON formatted table with values below
-**//ret//**  Custom return code of the HTTP POST request. 0 on success, 1 on failure.
-**//status//**  String describing the failure when **ret** is 1. "OK" on success.
-----
-==== download_remove ====
-----
-<code html4strict>
-http://Encoder_IP/cgi-bin/control.cgi?action=download_remove&data=FILENAME
-http://192.168.0.120/cgi-bin/control.cgi?action=download_remove&data=/media/sda/MOV1_000040.mp4
-</code>
-remove the downloaded media content from the usb drive or sd card.
-== Parameters: ==
-----
-//**data **//  Filename from the downloaded media content to be removed from the removable media device.
-== Returns: ==
-----
-JSON formatted table with values below
-**//ret//**  Custom return code of the HTTP POST request. 0 on success, 1 on failure.
-**//status//**  String describing the failure when **ret** is 1. "OK" on success.
-----
-===== Generic Control (GET) =====
-==== 8021x ====
-----
-Get the exthernet 802x information from the Database.
-=== Parameters: ===
-----
-=== Returns: ===
-----
-JSON formatted table with values below
-//**ret**//  Custom return code of the HTTP GET request. 0 on success, -1 on failure.
-//**interface**//  TEXT,
-**//enable//**  TEXT.
-//**eap**//  TEXT.
-**//anonymous_identity//**  TEXT.
-//**identity**//  TEXT.
-//**password**//  TEXT.
-//**private_key_password**//  TEXT.
-----
-==== GetCronJobs ====
-----
-Get the schedule job from the Database.
-=== Parameters: ===
-----
-=== Returns: ===
-----
-JSON formatted table with values below
-//**ret**//  Custom return code of the HTTP GET request. 0 on success, -1 on failure.
-**//enable//**  INTEGER,
-//**cron**//  TEXT.
-//**func**//  TEXT.
-**//func_args//**  TEXT.
-//**type**//  TEXT.
-//**minutes**//  INTEGER.
-//**hours**//  INTEGER.
-//**day**//  INTEGER.
-//**month**//  INTEGER.
-//**cron**//  TEXT.
-----
-==== GetNFSMount ====
-----
-Get the Network File Sharing mounted infromation from the device.
-=== Parameters: ===
-----
-=== Returns: ===
-----
-JSON formatted table with values below
-//**ret**//  Custom return code of the HTTP GET request. 0 on success, -1 on failure.
-**//mounted//**  TEXT,
-----
-==== aspect_info ====
-----
-Get the video resolution for the current channel from the Database and calculate the aspect ratio.
-=== Parameters: ===
-----
-//**chn**//  Get the encoder channel number. The default is encoder channel 1. Select between encoder channels. Possible values: 1, 2, 3, or 4.
-=== Returns: ===
-----
-JSON formatted table with values below
-//**ret**//  Custom return code of the HTTP GET request. 0 on success, -1 on failure.
-//**numerator**//  INTEGER,
-//**denominator**//  INTEGER.
-----
-==== boardinfo ====
-----
-Get the board and model information from the Database.
-=== Parameters: ===
-----
-=== Returns: ===
-----
-JSON formatted table with values below
-//**ret**//  Custom return code of the HTTP GET request. 0 on success, -1 on failure.
-//**logo_enable**//  TEXT,
-//**logo_filename**//  TEXT.
-//**logo_width**//  INTEGER.
-//**logo_height**//  INTEGER.
-//**logo_blob**//  BLOB.
-//**ico_blob**//  BLOB.
-//**model_enable**//  TEXT.
-//**model_name**//  TEXT.
-----
-==== cam_state ====
-----
-Get the current camera state information from the Database.
-=== Parameters: ===
-----
-=== Returns: ===
-----
-JSON formatted table with values below
-//**ret**//  Custom return code of the HTTP GET request. 0 on success, -1 on failure.
-//**preset**//  TEXT,
-//**enc_channels**//  TEXT.
-//**opmode**//  TEXT.
-//**enc_current_preset**//  TEXT.
-//**dec_current_preset**//  TEXT.
-----
-==== camera ====
-----
-Get the current camera settings from the Database.
-=== Parameters: ===
-----
-//**chn**//  Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.
-=== Returns: ===
-----
-JSON formatted table with values below
-//**ret**//  Custom return code of the HTTP GET request. 0 on success, -1 on failure.
-//**zoom_direct_value**//  INTEGER.
-//**white_balance_mode**//  TEXT.
-//**color_gain**//  INTEGER.
-//**color_hue**//  INTEGER.
-//**chroma_suppress**//  INTEGER.
-//**wb_manual_rgain_direct**//  INTEGER.
-//**wb_manual_bgain_direct**//  INTEGER.
-//**visca_localport**//  TEXT.
-//**optical_zoom_only**//  BOOL. 0 or 1.
-//**focus_direct_value**//  INTEGER.
-//**manual_focus**//  TEXT.
-//**flexio_localport**//  TEXT.
-//**exposure_mode**//  INTEGER.
-//**shutter**//  INTEGER.
-//**iris**//  INTEGER.
-//**gain**//  INTEGER.
-//**high_sensitivity**//  INTEGER.
-//**hlc_level**//  INTEGER.
-//**hlc_level_mask**//  INTEGER.
-//**stable_zoom**//  INTEGER.
-//**eflip**//  INTEGER.
-//**lr_reverse**//  INTEGER.
-//**monitor_mode**//  TEXT.
-//**genlock_source**//  INTEGER.
-//**manual_icr**//  TEXT.
-//**zoom_step_size**//  INTEGER.
-//**focus_step_size**//  INTEGER.
-//**img_freeze**//  INTEGER.
-//**hr_mode**//  INTEGER.
-//**img_stabilizer**//  INTEGER.
-//**img_bw**//  INTEGER.
-//**nr_2d_level**//  INTEGER.
-//**nr_3d_level**//  INTEGER.
-//**icr_threshold**//  INTEGER.
-//**slow_shutter**//  BOOL. 0 or 1.
-//**slow_shutter_limit**//  INTEGER.
-//**flicker_reduction**//  BOOL. 0 or 1.
-//**img_stabilizer_level**//  INTEGER.
-//**wide_dynamic_range**//  TEXT.
-//**ve_brightness**//  TEXT.
-//**ve_compensation_type**//  TEXT.
-//**ve_compensation_level**//  TEXT.
-//**tab_index**//  TEXT.
-//**imgvflip**//  INTEGER.
-//**imghflip**//  INTEGER.
-//**imgrotate**//  INTEGER.
-----
-==== camera_exposure ====
-----
-Get the current camera exposure values from the visca camera.
-=== Parameters: ===
-----
-//**chn**//  Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.
-=== Returns: ===
-----
-JSON formatted table with values below
-//**ret**//  Custom return code of the HTTP GET request. 0 on success, -1 on failure.
-//**ae_mode**//  TEXT,
-//**shutter**//  TEXT.
-//**iris**//  TEXT.
-//**gain_inquiry**//  TEXT.
-//**sensitivity**//  TEXT.
-//**hls_inquiry**//  TEXT.
-//**min_shutter**//  INTEGER.
-//**max_shutter**//  INTEGER.
-//**shutter_label**//  TEXT.
-//**min_iris**//  INTEGER.
-//**max_iris **//  INTEGER.
-//**iris_label**//  TEXT.
-//**min_gain**//  INTEGER.
-//**max_gain**//  INTEGER.
-//**gain_label**//  TEXT.
-----
-==== camera_monitor_mode ====
-----
-Get the current camera monitor mode values from the visca camera.
-=== Parameters: ===
-----
-//**chn**//  Get the channel number. The default is Camera 1. Select between connected cameras. Possible values: 1 = Camera 1, 2 = Camera 2.
-=== Returns: ===
-----
-JSON formatted table with values below
-//**ret**//  Custom return code of the HTTP GET request. 0 on success, -1 on failure.
-//**modes**//  TEXT.
-//**current_mode**//  TEXT.
-----

Wiki

User Tools

Site Tools

Differences

Page Tools