VALT Module - Revision history

IVSWikiBlue: /* Parameters */

2020-05-27T18:02:41Z

‎Parameters

IVSWikiBlue: /* Parameters */

2020-05-27T18:02:30Z

‎Parameters

IVSWikiBlue: /* Parameters */

2020-05-27T18:01:43Z

‎Parameters

IVSWikiBlue: /* creategroup */

2020-05-27T16:32:32Z

‎creategroup

IVSWikiBlue at 16:23, 27 May 2020

2020-05-27T16:23:42Z

IVSWikiBlue: Created page with "==valtauth== ===Usage=== Connects to the Valt server, and returns an authentication token. ===Parameters===

valtauth(https,server,username,password)

{| class="wiki..."

2020-05-22T15:55:42Z

Created page with "==valtauth== ===Usage=== Connects to the Valt server, and returns an authentication token. ===Parameters=== <pre>valtauth(https,server,username,password)</pre> {| class="wiki..."

New page

==valtauth==
===Usage===
Connects to the Valt server, and returns an authentication token.

===Parameters===
<pre>valtauth(https,server,username,password)</pre>
{| class="wikitable"
|-
|Parameter
|Type
|Value
|-
|https
|Boolean
|True if the server uses HTTPS, otherwise False.
|-
|server
|String
|IP address or DNS name of the Valt application server.
|-
|username
|String
|Valt Username.
|-
|password
|String
|Valt Password.
|}
===Example===
<pre>auth = valt.valtauth(True,'valt.example.com','admin','admin')</pre>

==isrecording==
===Usage===
''Deprecated''<br/>Checks the state of a room and returns True if it is recording, or False if it is not.
===Parameters===
<pre>isrecording(https,server,accesstoken,room)</pre>
{| class="wikitable"
|-
|Parameter
|Type
|Value
|-
|https
|Boolean
|True if the server uses HTTPS, otherwise False.
|-
|server
|String
|IP address or DNS name of the Valt application server.
|-
|accesstoken
|String
|The authentication token returned by the function valtauth.
|-
|room
|Integer
|The room number of the room in the Valt application. This must be the actual room ID number, not the room name. This can be obtained from the database.
|}
===Example===
<pre>if valt.isrecording(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4):</pre>

==getrecordingid==
===Usage===
If the room is currently recording, it returns the ID of the active recording. You should check if the room is recording using the isrecording function prior to getting the recording ID.
===Parameters===
<pre>getrecordingid(https,server,accesstoken,room)</pre>
{| class="wikitable"
|-
|Parameter
|Type
|Value
|-
|https
|Boolean
|True if the server uses HTTPS, otherwise False.
|-
|server
|String
|IP address or DNS name of the Valt application server.
|-
|accesstoken
|String
|The authentication token returned by the function '''valtauth'''.
|-
|room
|Integer
|The room number of the room in the Valt application. This must be the actual room ID number, not the room name. This can be obtained from the database.
|}
===Example===
<pre>current_recording = valt.getrecording(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4)</pre>

==startrecording==
===Usage===
Starts a new recording in the specified room.
===Parameters===
<pre>startrecording(https,server,accesstoken,room,name)</pre>
{| class="wikitable"
|-
|Parameter
|Type
|Value
|-
|https
|Boolean
|True if the server uses HTTPS, otherwise False.
|-
|server
|String
|IP address or DNS name of the Valt application server.
|-
|accesstoken
|String
|The authentication token returned by the function '''valtauth'''.
|-
|room
|Integer
|The room number of the room in the Valt application. This must be the actual room ID number, not the room name. This can be obtained from the database.
|-
|name
|String
|The name that will be associated with the recording in Valt.
|}
===Example===
<pre>valt.startrecording(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4,"My Recording")</pre>

==stoprecording==
===Usage===
Stops the current recording in the specified room.
===Parameters===
<pre>stoprecording(https,server,accesstoken,room)</pre>
{| class="wikitable"
|-
|Parameter
|Type
|Value
|-
|https
|Boolean
|True if the server uses HTTPS, otherwise False.
|-
|server
|String
|IP address or DNS name of the Valt application server.
|-
|accesstoken
|String
|The authentication token returned by the function '''valtauth'''.
|-
|room
|Integer
|The room number of the room in the Valt application. This must be the actual room ID number, not the room name. This can be obtained from the database.
|}
===Example===
<pre>valt.stoprecording(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4)</pre>

==pauserecording==
===Usage===
Pauses the current recording in the specified room.
===Parameters===
<pre>pauserecording(https,server,accesstoken,room)</pre>
{| class="wikitable"
|-
|Parameter
|Type
|Value
|-
|https
|Boolean
|True if the server uses HTTPS, otherwise False.
|-
|server
|String
|IP address or DNS name of the Valt application server.
|-
|accesstoken
|String
|The authentication token returned by the function '''valtauth'''.
|-
|room
|Integer
|The room number of the room in the Valt application. This must be the actual room ID number, not the room name. This can be obtained from the database.
|}
===Example===
<pre>valt.pauserecording(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4)</pre>

==resumerecording==
===Usage===
Unpauses the current recording in the specified room.
===Parameters===
<pre>resumerecording(https,server,accesstoken,room)</pre>
{| class="wikitable"
|-
|Parameter
|Type
|Value
|-
|https
|Boolean
|True if the server uses HTTPS, otherwise False.
|-
|server
|String
|IP address or DNS name of the Valt application server.
|-
|accesstoken
|String
|The authentication token returned by the function '''valtauth'''.
|-
|room
|Integer
|The room number of the room in the Valt application. This must be the actual room ID number, not the room name. This can be obtained from the database.
|}
===Example===
<pre>valt.resumerecording(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4)</pre>

==addmarker==
===Usage===
Adds a marker to the recording in progress in the specified room.
===Parameters===
<pre>addmarker(https,server,accesstoken,room,markername,color)</pre>
{| class="wikitable"
|-
|Parameter
|Type
|Value
|-
|https
|Boolean
|True if the server uses HTTPS, otherwise False.
|-
|server
|String
|IP address or DNS name of the Valt application server.
|-
|accesstoken
|String
|The authentication token returned by the function '''valtauth'''.
|-
|room
|Integer
|The room number of the room in the Valt application. This must be the actual room ID number, not the room name. This can be obtained from the database.
|-
|markername
|String
|Name for the marker in the Valt application.
|-
|color
|String
|Color for the marker, valid values are white, gray, red, yellow, purple, cyan, blue, green, and orange.
|}
===Example===
<pre>valt.addmarker(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4,"My Marker","red")</pre>

==getrecordingtime==
===Usage===
Returns the current time value of the recording in the specified room. Primarily used by the add marker function to specify the time for the marker.
===Parameters===
<pre>getrecordingtime(https,server,accesstoken,room)</pre>
{| class="wikitable"
|-
|Parameter
|Type
|Value
|-
|https
|Boolean
|True if the server uses HTTPS, otherwise False.
|-
|server
|String
|IP address or DNS name of the Valt application server.
|-
|accesstoken
|String
|The authentication token returned by the function '''valtauth'''.
|-
|room
|Integer
|The room number of the room in the Valt application. This must be the actual room ID number, not the room name. This can be obtained from the database.
|}
===Example===
<pre>current_recording_time = valt.getrecordingtime(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4)</pre>

==ispaused==
===Usage===
''Deprecated''<br/>Checks the state of a room and returns True if it is paused, or False if it is not.

===Parameters===
<pre>ispaused(https,server,accesstoken,room)</pre>
{| class="wikitable"
|-
|Parameter
|Type
|Value
|-
|https
|Boolean
|True if the server uses HTTPS, otherwise False.
|-
|server
|String
|IP address or DNS name of the Valt application server.
|-
|accesstoken
|String
|The authentication token returned by the function '''valtauth'''.
|-
|room
|Integer
|The room number of the room in the Valt application. This must be the actual room ID number, not the room name. This can be obtained from the database.
|}
===Example===
<pre>if valt.ispaused(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4):</pre>

==islocked==
===Usage===
''Deprecated''<br/>Checks the state of a room and returns True if it is locked and False if it is not.

===Parameters===
<pre>islocked(https,server,accesstoken,room)</pre>
{| class="wikitable"
|-
|Parameter
|Type
|Value
|-
|https
|Boolean
|True if the server uses HTTPS, otherwise False.
|-
|server
|String
|IP address or DNS name of the Valt application server.
|-
|accesstoken
|String
|The authentication token returned by the function '''valtauth'''.
|-
|room
|Integer
|The room number of the room in the Valt application. This must be the actual room ID number, not the room name. This can be obtained from the database.
|}
===Example===
<pre>if valt.islocked(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4):</pre>

==getcameras==
===Usage===
Returns a nested list, containing details for the cameras in the specified room. Primarily used with the AXIS module to enable/disable privacy mode on cameras.
===Parameters===
<pre>getcameras,server,accesstoken,room)</pre>
{| class="wikitable"
|-
|Parameter
|Type
|Value
|-
|https
|Boolean
|True if the server uses HTTPS, otherwise False.
|-
|server
|String
|IP address or DNS name of the Valt application server
|-
|accesstoken
|String
|The authentication token returned by the function '''valtauth'''.
|-
|room
|Integer
|The room number of the room in the Valt application. This must be the actual room ID number, not the room name. This can be obtained from the database.
|}
===Example===
<pre>cameras = valt.getcameras(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4)</pre>

==getschedule==
===Usage===
Returns a nested list of all upcoming schedules for the specified room. The returned list contains the start and end time for each schedule.
===Parameters===
<pre>getschedule(https,server,accesstoken,room)</pre>
{| class="wikitable"
|-
|Parameter
|Type
|Value
|-
|https
|Boolean
|True if the server uses HTTPS, otherwise False.
|-
|server
|String
|IP address or DNS name of the Valt application server.
|-
|accesstoken
|String
|The authentication token returned by the function '''valtauth'''.
|-
|room
|Integer
|The room number of the room in the Valt application. This must be the actual room ID number, not the room name. This can be obtained from the database.
|}
===Example===
<pre>schedules = valt.getschedule(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4)</pre>

==getroomname==
===Usage===
Returns the name of the room in VALT.
===Parameters===
<pre>getroomname(https,server,accesstoken,room)</pre>
{| class="wikitable"
|-
|Parameter
|Type
|Value
|-
|https
|Boolean
|True if the server uses HTTPS, otherwise False.
|-
|server
|String
|IP address or DNS name of the Valt application server.
|-
|accesstoken
|String
|The authentication token returned by the function '''valtauth'''.
|-
|room
|Integer
|The room number of the room in the Valt application. This must be the actual room ID number, not the room name. This can be obtained from the database.
|}
===Example===
<pre>roomname = valt.getroomname(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4)</pre>

==getroomstatus==
===Usage===
Returns a value indicating the current status of the room. This should be used instead of islocked, ispaused, or isrecording as it also includes better error handling.
{| class="wikitable"
|-
|Room Status
|Return Value
|-
|ERROR
|0
|-
|Available
|1
|-
|Recording
|2
|-
|Paused
|3
|-
|Locked
|4
|}

===Parameters===
<pre>getroomstatus(https,server,accesstoken,room)</pre>
{| class="wikitable"
|-
|Parameter
|Type
|Value
|-
|https
|Boolean
|True if the server uses HTTPS, otherwise False.
|-
|server
|String
|IP address or DNS name of the Valt application server.
|-
|accesstoken
|String
|The authentication token returned by the function '''valtauth'''.
|-
|room
|Integer
|The room number of the room in the Valt application. This must be the actual room ID number, not the room name. This can be obtained from the database.
|}
===Example===
<pre>roomstatus = valt.getroomstatus(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4)</pre>

@@ Line 493: / Line 493: @@
 {| class="wikitable"
 |-
-|Parameter
+!Parameter
-|Type
+!Type
-|Value
+!Value
-|Required
+!Required
 |-
 |https
@@ Line 503: / Line 503: @@
 |Yes
 |-
-|Server
+|server
 |String
 |IP address or DNS name of the VALT application server.
 |Yes
 |-
-|Access Token
+|accesstoken
 |String
 |The authentication token returned by the function '''valtauth'''.
@@ Line 514: / Line 514: @@
 |-
 |Group name
+|String
+|The name that will be given the to group in VALT.
+|Yes
 |-
-|Information Template
+|infoid
+|Int
+|The id number of the information template that will be assigned to the group as the default.
+|Yes
 |-
-|Marker Template
+|markerid
+|Int
+|The id number of the marker template that will be assigned to the group as the default.
+|Yes
 |-
 |rights
+|List (of strings)
+|All the rights that should be granted to the new group in VALT.
+|No
 |-
 |max_record_duration
+|Int
+|The maximum record duration in minutes.
+|No
 |-
 |rooms
+|List (of ints)
+|Room ids the new group should be granted access to in VALT.
+|No
 |-
 |video_access_users
+|List (of ints)
+|User ids the new group should be granted video access to in VALT.
+|No
 |-
 |video_access_groups
+|List (of ints)
+|Group ids the new group should be granted video access to in VALT.
+|No
 |-
 |retention_type
+|String
+|Retention Type (Valid Values: infinitely, until, days, hours, minutes)
+|No
 |-
 |retention_until
+|String
+|Date formatted as MM-DD-YYYY
+|No
 |-
 |retention_for
+|Int
+|Value in hours, minutes, or days (as specified by retention_type) the video will retained for.
+|No
 |}
 ===Example===
-<pre>auth = valt.valtauth(True,'valt.example.com','admin','admin')</pre>
+<pre>valt.creategroup(https,server,auth,splitline[0],30,71,rights=rightslist,max_record_duration=180,video_access_users=[14,15,17],video_access_groups=[2,6],retention_type="days",retention_for=365)</pre>

@@ Line 491: / Line 491: @@
 ===Parameters===
-<pre>valtauth(https,server,username,password)</pre>
+<pre>creategroup(https,server,accesstoken,groupname,infoid,markerid)</pre>
 {| class="wikitable"
 |-
@@ Line 569: / Line 569: @@
 |No
 |}
 ===Example===
 <pre>valt.creategroup(https,server,auth,splitline[0],30,71,rights=rightslist,max_record_duration=180,video_access_users=[14,15,17],video_access_groups=[2,6],retention_type="days",retention_for=365)</pre>

← Older revision		Revision as of 16:23, 27 May 2020
Line 484:		Line 484:
	===Example===		===Example===
	<pre>roomstatus = valt.getroomstatus(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4)</pre>		<pre>roomstatus = valt.getroomstatus(True,'valt.example.com','3e2c3e461736ce73830ed8d6d9d5dae6',4)</pre>
		+
		+	==creategroup==
		+	===Usage===
		+	Connects to the VALT server and creates a user group with the specified rights, templates, retention period, and video access.
		+
		+	===Parameters===
		+	<pre>valtauth(https,server,username,password)</pre>
		+	{\| class="wikitable"
		+	\|-
		+	\|Parameter
		+	\|Type
		+	\|Value
		+	\|Required
		+	\|-
		+	\|https
		+	\|Boolean
		+	\|True if the server uses HTTPS, otherwise False.
		+	\|Yes
		+	\|-
		+	\|Server
		+	\|String
		+	\|IP address or DNS name of the VALT application server.
		+	\|Yes
		+	\|-
		+	\|Access Token
		+	\|String
		+	\|The authentication token returned by the function '''valtauth'''.
		+	\|Yes
		+	\|-
		+	\|Group name
		+	\|
		+	\|
		+	\|
		+	\|-
		+	\|Information Template
		+	\|
		+	\|
		+	\|
		+	\|-
		+	\|Marker Template
		+	\|
		+	\|
		+	\|
		+	\|-
		+	\|rights
		+	\|
		+	\|
		+	\|
		+	\|-
		+	\|max_record_duration
		+	\|
		+	\|
		+	\|
		+	\|-
		+	\|rooms
		+	\|
		+	\|
		+	\|
		+	\|-
		+	\|video_access_users
		+	\|
		+	\|
		+	\|
		+	\|-
		+	\|video_access_groups
		+	\|
		+	\|
		+	\|
		+	\|-
		+	\|retention_type
		+	\|
		+	\|
		+	\|
		+	\|-
		+	\|retention_until
		+	\|
		+	\|
		+	\|
		+	\|-
		+	\|retention_for
		+	\|
		+	\|
		+	\|
		+	\|}
		+	===Example===
		+	<pre>auth = valt.valtauth(True,'valt.example.com','admin','admin')</pre>