grass valley developers

Home > APIs > AppServer API > Examples > File Transfers > Transfer Item properties

Transfer Item properties

The following are properties of a transfer which can be retrieved calling the TransferQueue's GetXfrItemProperty() function

state 0 = pending, 1 = transferring, 2 = completed, 3 = error, 4 = aborted
percentage transfer percentage complete
averagerate average transfer rate
currentrate current transfer rate
bytestransferred bytes transferred so far
fieldstransferred fields transferred so far
totalbytes total bytes
totalfields total fields
errorcode error code if transfer fails - see "state" above and Grass Valley K2 error codesGrass Valley K2 Error Codes

See Transfer a File for an example of how to query the properties of a transfer.