getStatusTypes

Get a list of all supported status types.

Note: This function requires an API license.

Obtains a list of all supported status types. The lists consists of name and description pairs. The name can be used in streamStatus.

Request

command=getStatusTypes

Response

<result errorcode="0">
  <statustypes count="[number]">
    <statustype>
      <name>[string]</name>
      <description>[string]</description>
    </statustype>
    ...
  </statustypes>
 </result>
node value remarks
/result
@errorcode [number] See error codes below
/result/statustypes
@count [number] The number of status types
/result/statustypes/statustype
name [string] the name, as used in streamStatus
description [string] a system defined description of the status type
error code description remarks
0 Ok Ok, no error
-18 General error An undefined error occured

See Also

Changelog

  • 2.5.1 – Added