Grass Valley UIM v.2.1.1 - Manual (Page 147)

February 5, 2008 UIM Instruction Manual 147
The SITE STATUS command
The SITE STATUS command
When the transfer has been initiated, your FTP client can send the ‘SITE STATUS’
command to the K2 FTP Server. Here is how we format the reply string to a ‘SITE
STATUS’ command:
The algorithm is as follows:
1. If there is no session active/queued, SITE STATUS will return a ‘no transfer’
2. If a transfer request was made, SITE STATUS will return a string formatted
according to the above rules
3. After the transfer completes/errors, SITE STATUS will continue to return the last
known status, which is cached by the server
4. The client must explicitly call QUIT/ABOR to clear the status
Profile API
Application writers may choose to use commands from the TekXfr library to manage
transfers through the UIM. The UIM is transparent in these operations, and the
application must be written directly to the Profile video server.
The Profile API commands used to transfer clips are:
• XfrAbort()
• XfrGetActiveTokens()
• XfrGetStatus()
• XfrRequest()
Note that the XfrRequest must include a DestUmlList that can include an ?option.
When a UIM is part of the data stream, only the range option is supported. Neither the
HOT nor the exact options are supported.
Refer to the Profile SDK documentation for more information about the TekXfr
Library and its commands.
sprintf(statusString, "%d %d %I64d %I64d %I64d %I64d %ld %ld",
status, // 0 =>active/in progress, 1 => Error, 2 => Done/complete
hrError, // a DWORD error code, set if above status is equal to 1
nCurBytes, // __int64 value equal to the number of bytes transmitted so far
nTotBytes, // __int64 value equal to the total number of bytes required by this GXF stream
nCurFields, // __int64 value equal to the number of fields transmitted so far
nTotFields, // __int64 value equal to the total number of fields required by this GXF stream
nAvgRate, // long value indicating current bit rate in bytes per second
nLastRate // long value indicating average bit rate in bytes per second);