stingray.PlayGo namespace reference

Description

Interface to access PlayGo on PS4.

Other related reference items

Core

Functions

chunk_id_list ( ) : integer[]?, integer? Returns chunks IDs for the Application package.

Parameters

This function does not accept any parameters.

Returns

integer[]?	The List of Chunk IDs if succeeded, nil if not. The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown. The ? notation indicates that this type is optional: there may be zero or one instances of it.
integer?	nil if succeeded, one of the PlayGo error codes if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.

close ( ) : integer?, integer? Closes the PlayGo package for the application and also frees all API resources.

Parameters

This function does not accept any parameters.

Returns

integer?	nil if close of the package succeeded, one of the PlayGo error codes if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.
integer?	nil if termination of the PlayGo API succeeded, one of the PlayGo error codes if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.

eta ( ) : number?, integer? Returns ETA for the application package.

Parameters

This function does not accept any parameters.

Returns

number?	ETA for the package (in seconds) if succeed, nil if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.
integer?	nil if succeeded, one of the PlayGo error codes if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.

install_speed ( ) : integer?, integer? Returns the Install Speed for the application package.

Parameters

This function does not accept any parameters.

Returns

integer?	Install Speed if succeeded, nil if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.
integer?	nil if succeeded, one of the PlayGo error codes if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Will be one of the values of the Stingray.PlayGo.InstallSpeed enum.

locus_list ( ) : integer[]?, integer? Returns a list of locations for the chunks of this package.

Parameters

This function does not accept any parameters.

Returns

integer[]?	Table of locii if succeeded, nil if not. The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown. The ? notation indicates that this type is optional: there may be zero or one instances of it.
integer?	nil if succeeded, one of the PlayGo error codes if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Each entry will be one of the values of the stingray.PlayGo.Locus enum.

open ( buffer_size ) : integer? Initializes PlayGo resources and opens the Application's PlayGo package.

Parameters

buffer_size :

integer?

The size in bytes you wish to dedicate to PlayGo, only specify if you're not happy with the system default. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

integer?

nil if succeeded, one of the PlayGo error codes if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.

prefetch ( chunk_ids, min_locus ) : integer? This function adds or moves the specified chunks to the beginning of the PlayGo to-do list.

Parameters

chunk_ids :	integer[]	A table containing the chunk_ids to prefetch. The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.
min_locus :	integer	Specify the locus where you want to place the chunks. If a chunk is currently placed at the same locus as the specified locus or placed at a better locus (that will take shorter time to access) than the specified locus, it will not be added to the to-do list or moved to the beginning of the list.

Returns

integer?

nil if succeeded, one of the PlayGo error codes if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.

The installation processing will be performed in order from the beginning of the to-do list, so when the next required chunk changes for reasons such as the user selecting a scenario, this function can be used to prioritize that chunk for installation.

progress ( chunk_ids ) : table?, integer? Returns, for each chunk: size downloaded, total size to download (both in bytes).

Returns

table?	Contains the progress (in bytes) and the total size (in bytes) of each chunk. nil if the operation failed. The ? notation indicates that this type is optional: there may be zero or one instances of it.
integer?	nil if succeeded, one of the PlayGo error codes if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.

request_next_chunk ( ) : integer? This function changes the locus for the chunk at the beginning of the PlayGo to-do list to SCE_PLAYGO_LOCUS_LOCAL_FAST (state where the chunk is in fast local storage).

Parameters

This function does not accept any parameters.

Returns

integer?

nil if succeeded, one of the PlayGo error codes if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Use this function during development when using the PlayGo emulation file system and you want to control the state of the chunk.

set_install_speed ( speed ) : integer? Returns the result of setting the Install Speed for the Application Package.

Parameters

speed :

integer

Must be one of one of the values of the Stingray.PlayGo.InstallSpeed enum.

Returns

integer?

nil if succeeded, one of the PlayGo error codes if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.

set_todo_list ( todo_list ) : integer? Sets the todo list of chunks to download.

Parameters

todo_list :

table

A table containing pairs of chunk_ids and the corresponding locus, e.g. {0, stingray.PlayGo.Locus.LOCAL_FAST, 1, stingray.PlayGo.Locus.LOCAL_SLOW, 2, stingray.PlayGo.Locus.LOCAL_FAST}).

Returns

integer?

nil if succeeded, one of the PlayGo error codes if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.

snapshot ( filename ) : integer? This function exports the PlayGo chunk state to a file in the host file system.

Parameters

filename :

string

The path of the file to write.

Returns

integer?

nil if succeeded, one of the PlayGo error codes if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Use this function when you want to retain the chunk state during usage of the PlayGo emulation file system for development.

todo_list ( ) : table?, integer? Returns the Todo List for the package.

Parameters

This function does not accept any parameters.

Returns

table?	The Todo List (each element contains a ChunkID and a Locus for that Chunk). nil if the operation failed. The ? notation indicates that this type is optional: there may be zero or one instances of it.
integer?	nil if succeeded, one of the PlayGo error codes if not. The ? notation indicates that this type is optional: there may be zero or one instances of it.