Returns the most recently received string currently cached by the Metadata Manager. The call is stateless so multiple clients may each poll for metadata with no impact on each other. This may result in getting the same string multiple times if no new string has arrived.

This function has the following parameters:

Parameter Name Mandatory Default Value Description
localStreamName false null Name of the incoming stream from which the associated metadata will be returned. Default most recent
streamId false 0 Identifies the particular stream from which the associated metadata will be returned. Default most recent
noWrap false 0 false If true, the returned string will not have the CLI JSON wrapping

An example of the getMetadata interface is:

getMetadata localStreamName=test noWrap=1

Example:

API Call:

getMetadata localStreamName=bunny

JSON Response:

{
"data":"{\"EMS\":{\"type\":\"json\",\"timestamp\":46125},\"data\":{\"lat\":\"32.809668\",\"lon\":\"-117.255317\",\"alt\":\"44.7\",\"speed\":\"20\",\"dir\":\"300\"}}",
"description":"Metadata",
"status":"SUCCESS"
}

API Call:

getMetadata localStreamName=bunny noWrap=1

JSON Response:

{
"EMS":{
    "type":"json",
    "timestamp":12042
	},
"data":{
    "lat":"32.809668",
    "lon":"-117.2 55317",
    "alt":"44.7",
    "speed":"50",
    "dir":"300"
	}
}

The JSON response contains the following details:

  • data – The data to parse
    • type -
    • timestamp -
    • lat -
    • lon -
    • alt -
    • speed -
    • dir -
  • description – Describes the result of parsing/executing the command
  • status – SUCCESS if the command was parsed and executed successfully, FAIL if not