Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Configuration Article | CA-20220907-TP-21

VDG Sense | API | Functions | Client & Server Control

Image Added

View file
nameCA-20220907-TP-21.pdf

Table of Contents

Note: This function requires an API license.

...

This function checks if the supplied time parameter is a valid timestamp. This value is not check to see if it is within the available recording time space. The viewer that executes this function will show the supplied UTC timestamp as local time for that particular system.

Request

Code Block
command=setPlaybackDateTime&divaid=[uid]&time=[timestamp]

parameter

type

remarks

divaid

[UID]

determines the viewer, if ommitted or -1 all viewers are adressed.

time

[timestamp]

UTC timestamp for the playback datetime.

Response

error code

description

remarks

0

Ok

Ok, no error

-4

Invalid timestamp

Invalid datetime format. See Timestamp.

-18

General error

An undefined error occured

Changelog

  • 1.12.3 – Documented if timestamps are local or UTC timestamps.

  • 1.11.3 – Strict checking on starttime and endtime parameter format. Returns -4 on error (see Result Codes).

  • 1.11.1 – Added.