getViewerMacroList

Note: This function requires an API license.

Obtains a list of all viewer macro’s. These macro’s can be executed with the executeMacro command.

Request

command=getViewerMacroList

Response

<result errorcode="0">
  <macros count="[number]">
    <macro>
      <macroid>[UID]</macroid>
      <name>[string]</name>
      <type>[string]</type>
      <valid>[boolean]</valid>
      <status>[string]</status>
    </macro>
    ...
  </macros>
 </result>
node value remarks
/result
@errorcode [number] See error codes below
/result/macros
@count [number] The number of macros
/result/macros/macro
macroid [UID] unique id of the macro
name [string] the unique user defined name of the macro
type [string] type of the macro 'viewer' or 'server'
valid [boolean]
status [string] 'Active' or 'Inactive'

See Also

Changelog

  • 2.2.1 – added