git.sesse.net Git - casparcg/blob - source/query-commands.rst

   1 **************\r
   2 Query Commands\r
   3 **************\r
   4 \r
   5 ====\r
   6 CINF\r
   7 ====\r
   8 Returns information about a mediafile.\r
   9 \r
  10 Syntax::\r
  11 \r
  12         CINF [filename:string]\r
  13                 \r
  14 Example::\r
  15 \r
  16         <<< CINF movie\r
  17         >>> ...\r
  18 \r
  19 ===\r
  20 CLS\r
  21 ===\r
  22 Lists all media files.\r
  23 \r
  24 Syntax::\r
  25 \r
  26         CLS\r
  27                 \r
  28 Example::\r
  29 \r
  30         <<< CLS\r
  31         >>> ...\r
  32         \r
  33 ===\r
  34 TLS\r
  35 ===\r
  36 Lists all template files.\r
  37 \r
  38 Syntax::\r
  39 \r
  40         TLS\r
  41                 \r
  42 Example::\r
  43 \r
  44         <<< TLS\r
  45         >>> ...\r
  46         \r
  47 =======\r
  48 VERSION\r
  49 =======\r
  50 Returns the version of specified component.\r
  51 \r
  52 Syntax::\r
  53 \r
  54         VERSION SERVER\r
  55     VERSION FLASH\r
  56     VERSION TEMPLATEHOST\r
  57                 \r
  58 Example::\r
  59 \r
  60         <<< VERSION\r
  61         >>> ...\r
  62         <<< VERSION FLASH\r
  63         >>> ...\r
  64         \r
  65 ====\r
  66 INFO\r
  67 ====\r
  68 Returns xml-formatted information about the server.\r
  69 \r
  70 INFO TEMPLATE:  Reads meta-data from a flash-template.\r
  71 INFO PATHS:     Returns configured paths.\r
  72 INFO SYSTEM:    Returns information about the system.\r
  73 INFO CONFIG:    Return the configuration.\r
  74 INFO:           Returns a list of channels (not xml-formatted due to compatibility issues with older clients).\r
  75 INFO 1:         Returns information about specified channl.\r
  76 INFO 1-1:       Returns information about specified layer.\r
  77 CG 1 INFO       Returns information about flash-producer running on specified channel.\r
  78 \r
  79 \r
  80 Syntax::\r
  81 \r
  82     INFO TEMPLATE [filename:string]\r
  83     INFO PATHS\r
  84     INFO SYSTEM\r
  85     INFO CONFIG\r
  86     INFO \r
  87     INFO [channel:int]\r
  88     INFO [channel:int]-[layer:int]\r
  89     CG [channel:int] INFO\r
  90                 \r
  91 Example::\r
  92 \r
  93         <<< INFO\r
  94         >>> ...\r
  95         <<< INFO 1\r
  96         >>> ...\r
  97         <<< INFO 1-1\r
  98         >>> ...\r
  99         <<< INFO TEMPLATE my_table_template\r
 100         >>> ...\r