PackageTransferWatcher - stingray.PackageTransferWatcher namespace reference - Stingray Lua API Reference
Description
Interface for monitoring streaming installs on Xbox One.
Other related reference items 
Functions
 |
completed ( watch_id ) : boolean Use this function to monitor chunk install completion.
|
watch_id : | integer? | Id returned by stingray.PackageTransferWatcher.watch_specific_chunks The ? notation indicates that this type is optional: there may be zero or one instances of it. |
boolean |
True if completed |
You can call this with a watch_id to get information of specific chunks or you can call this without any parameters to know if the entire transfer is finished.
| |
destroy ( )This destroys the PackageTransferWatcher, freeing up system resources.
|
| This function does not accept any parameters. |
| This function does not return any values. |
Other related reference items
| |
init ( )Initializes the PackageTransferWatcher.
|
| This function does not accept any parameters. |
| This function does not return any values. |
This must be called before the rest of the interface can be used.
Call stingray.PackageTransferWatcher.destroy when you are finished with the install to free up system resources.
| |
last_completed_chunks ( ) : integer*Returns chunks that have finished their install since last time this function was called.
|
| This function does not accept any parameters. |
integer* |
Completed chunks The * notation indicates that there may be zero or more instances of the specified type. |
Note that a chunk can be returned multiple times if it is watched with stingray.PackageTransferWatcher.watch_specific_chunks.
| |
progress ( watch_id ) : integerUse this function to monitor progress of the streaming install.
|
watch_id : | integer? | Id returned by stingray.PackageTransferWatcher.watch_specific_chunks The ? notation indicates that this type is optional: there may be zero or one instances of it. |
integer |
Completion percentage, from 0 to 100 |
You can call this with a watch_id to get the progress of specific chunks or you can call this without any parameters to get information on all chunks.
| |
stop_watching_chunks ( watch_id )Call this function when finished watching specific chunks.
|
watch_id : | integer | Id returned by stingray.PackageTransferWatcher.watch_specific_chunks |
| This function does not return any values. |
Other related reference items
| |
transfer_status ( ) : integerCall this to get the transfer status of the streaming install.
|
| This function does not accept any parameters. |
integer |
Will be one of the stingray.TransferStatus constants. |
Note that this should be called only when needed, at most once per frame.
| |
watch_specific_chunks ( chunks ) : integerUse this to monitor progress and completion of a group of chunks.
|
chunks : | integer+ | One or more chunks to watch The + notation indicates that there may be one or more instances of the specified type. |
integer |
Id of the watched group, used when calling other parts of the PackageTransferWatcher interface. Referred to as watch_id |
Use stingray.PackageTransferWatcher.stop_watching_chunks to stop wathcing the specified chunks when it's no longer needed.
Other related reference items