GetExampleRecord
Returns an example record for a specified output track of a specified analysis engine. Media Server returns an example in XML format and a Lua representation of the record.
Type: synchronous
Parameter | Description | Required |
---|---|---|
EngineType
|
The analysis engine to return an example record for. This parameter accepts the same values as the Type configuration parameter. If you omit this parameter, Media Server returns examples for all analysis engines. | No |
Track
|
The name of the output track to return an example record for. If you omit this parameter, Media Server returns examples for each track. | No |
Example
The following example returns an example record for the Result
track of a FaceDetect
analysis engine:
http://localhost:14000/action=GetExampleRecord&EngineType=FaceDetect&Track=Result
Media Server includes an XSL template that you can apply to the response, to make it easier to read:
http://localhost:14000/action=GetExampleRecord&EngineType=FaceDetect &Track=Result &Template=getExampleRecord
If you omit the EngineType
and Track
parameters, Media Server returns an example for each track of each analysis engine:
http://localhost:14000/action=GetExampleRecord
Response
The following is a sample response from the action:
http://localhost:14000/action=GetExampleRecord&EngineType=Keyframe&Track=Result
<autnresponse> <action>GETEXAMPLERECORD</action> <response>SUCCESS</response> <responsedata> <engines> <engine> <type>KeyFrame</type> <tracks> <track> <name>Result</name> <exampleLua> { trackname = 'exampleEngine.Result', KeyFrameData = { id = { uuid = '28a4a6c8-f80f-486e-9a9b-acb26d3f0fd3', }, }, UUIDData = { uuid = '28a4a6c8-f80f-486e-9a9b-acb26d3f0fd3', }, timestamp = { duration = '1000000', startTime = '0', peakTime = '0', endTime = '1000000', } } </exampleLua> <exampleXML> <record> <timestamp> <startTime iso8601="1970-01-01T00:00:00Z">0</startTime> <duration iso8601="PT00H00M01.000000S">1000000</duration> <peakTime iso8601="1970-01-01T00:00:00Z">0</peakTime> <endTime iso8601="1970-01-01T00:00:01Z">1000000</endTime> </timestamp> <trackname>exampleEngine.Result</trackname> <KeyFrameData> <id>28a4a6c8-f80f-486e-9a9b-acb26d3f0fd3</id> </KeyFrameData> </record> </exampleXML> </track> </tracks> </engine> </engines> </responsedata> </autnresponse>