Roassetfetcherprogressevent, Roassetpool – BrightSign Object Reference Manual (FW 5.1) User Manual
Page 182
174
roAssetFetcherProgressEvent
This event is generated by the roAssetFetcher object at regular intervals during file downloads. Use
the
roAssetFetcher.SetFileProgressIntervalSeconds()
method to customize how often progress events are generated.
The ifAssetFetcherProgressEvent interface provides the following:
•
GetFileName() As String: Returns the name of the file associated with the event. The file name is retrieved
from the sync spec associated with the roAssetFetcher that generated the event.
•
GetFileIndex() As Integer: Returns the zero-based index from the sync spec of the file associated with the
event.
•
GetFileCount() As Integer: Returns the total number of files within the sync spec.
•
GetCurrentFileTransferredMegabytes() As Integer: Returns the number of transferred megabytes
belonging to the file associated with the event.
•
GetCurrentFileSizeMegabytes() As Integer: Returns the size of the file associated with the event.
•
GetCurrentFilePercentage() As Float: Returns a floating-point number representing the download
percentage of the file associated with the event.
The ifUserData interface provides the following:
•
SetUserData(user_data As Object): Sets the user data that will be returned when events are raised.
•
GetUserData() As Object: Returns the user data that has previously been set via SetUserData(). It will
return Invalid if no data has been set.