Differences

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

--- http_api [2019/02/27 20:44]
cflintiii [CameraControl]
+++ http_api [2019/06/10 17:38]
johnw
@@ Line 3: / Line 3: @@
 For HE4K-01 / HE4K-R4 / MVE-150 / MVE-100R / SME-01 / DME-02/03/04 use [[:http_api_lua|Z3-TI-http_api]]
 ===== Configuration API Syntax =====
@@ Line 61: / Line 62: @@
 ----
 ===== Encoder Channel Configuration =====
@@ Line 145: / Line 147: @@
 Description: Password for RTMP authentication.
 ==== auth_user ====
@@ Line 150: / Line 153: @@
 Description: Username for RTMP authentication.
 ==== authonoff ====
@@ Line 155: / Line 159: @@
 Description: Enable or disable RTMP authentication. Default: off Possible values: on, off
 ==== channel ====
@@ Line 205: / Line 210: @@
 ==== fprefix ====
 Description: Relative filename for TSFILE or AUX file recording. Note that "fprefix" does NOT include the absolute media path – the "storage" parameter is the proper place to specify the absolute media path.
@@ Line 210: / Line 216: @@
 ==== storage ====
 Absolute path to mounted media device (e.g. /media/sda1/)
@@ Line 215: / Line 222: @@
 ==== telopcharsize ====
 OSD overlay text character size in pixels
-Possible values: 16, 32, or 64
+Possible values: 16, 32, or 64
@@ Line 225: / Line 234: @@
 Enable or disable telop (i.e. OSD overlay of text).
 Possible values: on, off
@@ Line 234: / Line 244: @@
 Where to overlay text in the encoded video
-Possible values:
- top_left
+Possible values: top_left top_right top_center bottom_left bottom_right bottom_center
- top_right
- top_center
- bottom_left
- bottom_right
- bottom_center
@@ Line 339: / Line 344: @@
 Possible values: baseline, main, high
 ==== vprotocol ====
@@ Line 400: / Line 406: @@
 Possible values: on, off
 ==== piplocaton ====
@@ Line 408: / Line 415: @@
 Possible values: top_left, top_right, bottom_left, bottom_right
 ==== vinterlacemode ====
@@ Line 416: / Line 424: @@
 Possible values: combined, separated (H265 only)
 ==== vmulticastdest ====
@@ Line 424: / Line 433: @@
 Possible values: valid multicast addresses
 ==== amulticastdest ====
@@ Line 432: / Line 442: @@
 Possible values: valid multicast addresses
 ==== rtsp_auth_enable ====
@@ Line 449: / Line 460: @@
 Possible values: alpha numeric string
 ==== rtsp_auth_password ====
@@ Line 457: / Line 469: @@
 Possible values: *
 ===== Transport Stream Parameters =====
@@ Line 573: / Line 586: @@
 ===== Global Configuration =====
@@ Line 640: / Line 650: @@
 action=StartChannel&chn=1&vsource=&vres=follow_input&vcodec=h265&vgdr=on&vprofile=high&vratectrl=cbr&vbitrate=2M&vframeratediv=1&vgopsize=60&vprotocol=rtsp&vdest=192.168.0.6:8600&storage=&fprefix=MOV1_%F_%T_&vpid=221&vdelay=1000&pcrpid=521&pcrinterval=50&pmtpid=31&tsrate=3000K&tslowlat=on&feconoff=off&fecrow=1&feccol=5&zixioverhead=15&zixiauthen=off&zixisession=test&zixiuser=user&aenable=on&asource=MICL&acodec=fdk_aaclc&abitrate=128000&asamplerate=48000&aport=8700&apid=120&aptspcr=250&klvenable=off&klvmode=sdi&klvsrc=/dev/gv7601.0&klvpid=35&klvbrate=1000&authonoff=off&auth_user=user&auth_passwd=password&auxonoff=off&filesize=1024M&telopenable=off&teloptext=ENCDEV&teloplocation=top_left&telopcharsize=32&vquality=balanced
 </code>
 ==== StartChannel ====
@@ Line 858: / Line 869: @@
 zoom_wide_var        p (0 (Low) .. 7 (High))
 </code>
 ==== SaveCamera ====
@@ Line 934: / Line 946: @@
 Possible values: auto, manual
 ==== SetIp ====
 === local_ip ===
 IPv4 adresss
 === local_netmask ===
 IPv4 netmask
 === default_gw ===
 IPv4 default gateway
 === local_dnsip ===
 DNS server primary
 === local dnsip2 ===
 DNS server secondary
 === do_autostart ===
 Control automatic stream start after bootup
-Possible values:   1 = do autostart   0 = do not autostart
+Possible values: 1 = do autostart 0 = do not autostart
 === enc_adv_setting ===
 Control appearance of advanced settings on WebUI
-Possible values:  off, on
+Possible values: off, on
 ==== SetDisplay ====
 Controls composite output (passthru video from camera)
 === disp_std ===
 Set display standard for composite output
 Possible values; auto, ntsc, pal
@@ Line 1055: / Line 1086: @@
-In the case of text overlay this would be the source text for png overlay this is the path to the png on the encoder.  Images must be uploaded to board to be used.
+In the case of text overlay this would be the source text for png overlay this is the path to the png on the encoder. Images must be uploaded to board to be used.
@@ Line 1106: / Line 1137: @@
 <font 12.8px/Arial, sans-serif;;#000000;;inherit font-family: Arial, sans-serif; font-weight: bold; font-size: 12.8px;>var</font>
-Variable to modify dynamically.  Possible values: vratediv, vrate, gop, analog_gain, telop_text, pip_enable, pip_location, startmulticast, stopmulticast
+Variable to modify dynamically. Possible values: vratediv, vrate, gop, analog_gain, telop_text, pip_enable, pip_location, startmulticast, stopmulticast
@@ Line 1161: / Line 1192: @@
 Enable/Disable remote access to terminal server.
 ==== SetZFinderEnable ====
@@ Line 1169: / Line 1201: @@
 Enable/Disable zfinder support.
 ===== Encoder Actions (POST) =====
 ==== SetEncoder ====
@@ Line 1178: / Line 1210: @@
 Write encoder settings to active preset. See Python example code for Seting Configuration below
 ==== EncoderStatus ====
@@ Line 1185: / Line 1218: @@
-To read the result, you need to POST the "stats" control as shown\\
+To read the result, you need to POST the “stats” control as shown%%\%% in the Python example code below.
-in the Python example code below.
@@ Line 1195: / Line 1227: @@
-To read the result, you need to POST the "stats" control as shown\\
+To read the result, you need to POST the “stats” control as shown%%\%% in the Python example code below.
-in the Python example code below.
@@ Line 1205: / Line 1236: @@
-To read the result, you need to POST the “stats” control as shown\\
+To read the result, you need to POST the “stats” control as shown%%\%% in the Python example code below.
-in the Python example code below.
@@ Line 1215: / Line 1245: @@
-To read the result, you need to POST the “stats” control as shown\\
+To read the result, you need to POST the “stats” control as shown%%\%% in the Python example code below.
-in the Python example code below.
@@ Line 1248: / Line 1277: @@
 requests.post(server_url, data=new_cfg)
 </code>
 ===== Reading Statistics =====

Wiki

User Tools

Site Tools

Differences

Page Tools