Net-X-Code Version 7 API Guide
Total Page:16
File Type:pdf, Size:1020Kb
Net-X-Code Version 7 API Guide Jan 22nd, 2021 © 2010-2021 Drastic Technologies Ltd. All Rights Reserved Net-X-Code API 1 Table of Contents Introduction.........................................................................................................7 Theory of Operation...............................................................................................8 Typical Applications............................................................................................9 Changes In Version 7 API:.................................................................................10 Command And Return Structure/Format..............................................................10 Command Elements.........................................................................................11 Return Elements..............................................................................................12 Command – general.........................................................................................13 Active..........................................................................................................................................13 TestFunc.....................................................................................................................................13 netxbase=version.......................................................................................................................13 Return – bad/malformed request................................................................................................14 Return – shutdown.....................................................................................................................14 Command - get...............................................................................................14 Client Count................................................................................................................................14 Client IP......................................................................................................................................14 Number Of Groups.....................................................................................................................15 Attributes/Request Info...............................................................................................................15 Stream States.....................................................................................................16 previewenable............................................................................................................................23 preview.......................................................................................................................................23 pts............................................................................................................................................... 24 datarate......................................................................................................................................25 property......................................................................................................................................26 status..........................................................................................................................................28 streamstate.................................................................................................................................29 state............................................................................................................................................31 xmldisable...................................................................................................................................32 autostart.....................................................................................................................................33 getDiscontinuities.......................................................................................................................33 getCopyInOut.............................................................................................................................34 Tape PFR using the command line........................................................................................36 getFirstAndLastTimecode...........................................................................................................37 Command – Copy, Convert and PFR....................................................................38 set – initiate copy/convert/pfr......................................................................................................38 set/get – cardinfo (camera card clip lists)....................................................................................40 set/get – clipfiles (files included in a clip)....................................................................................43 set/get – metdata (file information and metadata in XMP format)...............................................50 Parameters:...........................................................................................................................57 copylimit.....................................................................................................................................61 get - status/completion................................................................................................................62 Typical Proxy, Convert and PFR Session...............................................................68 Scenario 1 – full access..............................................................................................................68 Scenario 2 – tape restore...........................................................................................................69 Scenario 3 – cloud restore..........................................................................................................69 Scenario 4 – in line conversions.................................................................................................69 PFR File Best Practices......................................................................................69 Net-X-Code API 2 Self Contained............................................................................................................................70 Multiple Stream Files..................................................................................................................70 Multiple Files Per Stream............................................................................................................70 Avid OP-Atom – Special Case....................................................................................................70 Sequences..................................................................................................................................70 Command - set................................................................................................71 start............................................................................................................................................ 71 startstream..................................................................................................................................71 stop.............................................................................................................................................72 restart.........................................................................................................................................72 xmldisable...................................................................................................................................73 autostart.....................................................................................................................................73 add............................................................................................................................................. 74 remove.......................................................................................................................................76 starttc/endtc................................................................................................................................76 delete..........................................................................................................................................76 proxymode..................................................................................................................................77 proxyfiletype...............................................................................................................................77 proxycompression......................................................................................................................78 proxydatarate..............................................................................................................................78 tsenable......................................................................................................................................78 tsdir.............................................................................................................................................79 tsfile............................................................................................................................................79 SETTINGS.......................................................................................................79