Details on WriteXML and ReadXML changes in FCSvr 1.5, after the jump...
WriteXML
New to Final Cut Server 1.5 is that ability to have the WriteXML response output the XML file instead of having it output the Title of the asset. This enables a more flexible means of integration with FCSvr and other third party systems. For example previously the FCSvr WriteXML response outputted the .xml using the asset’s or production’s title, So you have have an asset with the filename XPlatformConsulting.mov, who's asset id is 5665, this would output/save a WriteXML with something like This Great Movie.xml because that was the title of the asset. So for development you need to then, determine which Asset "This Great Movie.xml" referred to by matching it's Title to the Asset ID it referenced to The filename that AssetID reference. Then problems occurred if you had Assets or Productions with the same title because they would overwrite each other during output. In short, this was a pain for scripting and application development.
Now you have the option output the WriteXML file using the following naming conventions
Assets - asset_123456.xml
Produciton - production_123456.xml
First this will ensure unique WriteXML files, and allow you to quickly determine, which WriteXML belongs to which asset more easily. Whew. Thanks Apple.
ReadXML
Added to FCSvr 1.5 is the ability to input annotation metadata from external sources via the Final Cut Server ReadXML response. This enables a more flexible means of integration with FCSvr and other third party systems. For example, a third party review and approval systems like MediaSilo or Wiredrive can receive assets and asset metadata via (WriteXML) from FCSvr and can allow users make frame accurate comments and annotations from a web application that can inturn be read by FCSvr.
Also, the ReadXML response can reads annotations metadata from an XML file that was exported from a Final Cut Pro project and can display that annotations metadata metadata in the matching Final Cut Pro project asset in Final Cut Server.
Below is an example of the new annotation fieldNames in ReadXML response for FCSvr 1.5. You’ll notice the following fieldNames
In = Timecode in point Out = Timecode outpoint Annotation = Contents of the Annotation
Another important detail is the fps of the video asset. In this example (30/1) tells us that this video has a frame rate of 29.97. Other examples include (24000,1001) for have a 23.97 fps frame rate.
<?xml version="1.0"?>
<FinalCutServer>
<request reqId="setMd" entityId="/asset/928">
<params>
<annotations>
<annotation>
<mdValue fieldName="User id" dataType="integer">1</mdValue>
<mdValue fieldName="Full name" dataType="string">XPlatform Consulting</mdValue>
<mdValue fieldName="Out" dataType="timecode">01:00:00:13/(30,1)</mdValue>
<mdValue fieldName="Annotation" dataType="string">This is test 2 from ReadXML</mdValue>
<mdValue fieldName="In" dataType="timecode">01:00:00:11/(30,1)</mdValue>
</annotation>
<annotation>
<mdValue fieldName="User id" dataType="integer">1</mdValue>
<mdValue fieldName="Full name" dataType="string">XPlatform Consulting</mdValue>
<mdValue fieldName="Out" dataType="timecode">01:00:00:7/(30,1)</mdValue>
<mdValue fieldName="Annotation" dataType="string">This is test 1 from ReadXML.</mdValue>
<mdValue fieldName="In" dataType="timecode">01:00:00:03/(30,1)</mdValue>
</annotation>
</annotations>
</params>
</request>
</FinalCutServer>