Exports for User. More...

Enumerations
enum	SceLiveAreaTargetType { SCE_LIVEAREA_TARGET_TYPE_NORMAL = 0 , SCE_LIVEAREA_TARGET_TYPE_RETAIL = 1 }
	LiveArea frame database layer. More...

Functions
int	sceLiveAreaGetStatus (void)
	Poll an asynchronous LiveArea operation.

int	sceLiveAreaReplaceAllSync (const char *contents_path)
	Replace all LiveArea data for the calling title synchronously.

int	sceLiveAreaReplaceAllAsync (const char *contents_path)
	Replace all LiveArea data for the calling title asynchronously.

int	sceLiveAreaReplaceAllForTitleSync (const char contents_path, const char title_id, const SceRtcTick *last_modified)
	Replace all LiveArea data for a title synchronously.

int	sceLiveAreaReplaceAllForTitleAsync (const char contents_path, const char title_id, const SceRtcTick *last_modified)
	Replace all LiveArea data for a title asynchronously.

int	sceLiveAreaUpdateFrameSync (const char format_version, const char frame_xml, SceInt32 frame_xml_length, const char *contents_path, SceLiveAreaTargetType target_type)
	Update one LiveArea frame for the calling title synchronously.

int	sceLiveAreaUpdateFrameAsync (const char format_version, const char frame_xml, SceInt32 frame_xml_length, const char *contents_path, SceLiveAreaTargetType target_type)
	Update one LiveArea frame for the calling title asynchronously.

int	sceLiveAreaUpdateFrameForTitleSync (const char format_version, const char frame_xml, SceInt32 frame_xml_length, const char contents_path, SceLiveAreaTargetType target_type, const char title_id)
	Update one LiveArea frame for a title synchronously.

int	sceLiveAreaUpdateFrameForTitleAsync (const char format_version, const char frame_xml, SceInt32 frame_xml_length, const char contents_path, SceLiveAreaTargetType target_type, const char title_id)
	Update one LiveArea frame for a title asynchronously.

int	sceLiveAreaUpdateFramesForTitleSync (const char format_version, const char const frame_xml_array, SceUInt32 frame_count, const char contents_path, SceLiveAreaTargetType target_type, const char *title_id)
	Update multiple LiveArea frames for a title synchronously.

int	sceLiveAreaUpdateFramesForTitleAsync (const char format_version, const char const frame_xml_array, SceUInt32 frame_count, const char contents_path, SceLiveAreaTargetType target_type, const char *title_id)
	Update multiple LiveArea frames for a title asynchronously.

int	sceLiveAreaGetRevision (SceUInt64 *revision)
	Get the overall LiveArea content revision for the calling title.

int	sceLiveAreaGetFrameRevision (const char frame_id, SceUInt64 revision)
	Get a LiveArea frame revision for the calling title.

int	sceLiveAreaGetFrameUserData (const char frame_id, char buffer, SceSize buffer_size)
	Get the user data associated with a LiveArea frame for the calling title.

int	sceLiveAreaEnableBgAppMode (void)
	Enable foreground-title selection for a background companion application.

Detailed Description

Exports for User.

Using this library in your project

Include the header file in your project:

#include <psp2/livearea.h>

livearea.h

Link the library to the executable:

SceLiveArea_stub SceLiveAreaUtilBgApp_stub

Load the required module:

sceSysmoduleLoadModule(SCE_SYSMODULE_LIVEAREA);

sceSysmoduleLoadModule

int sceSysmoduleLoadModule(SceSysmoduleModuleId id)

Load a module.

SCE_SYSMODULE_LIVEAREA

@ SCE_SYSMODULE_LIVEAREA

Livearea module.

Definition sysmodule.h:62

Enumeration Type Documentation

◆ SceLiveAreaTargetType

enum SceLiveAreaTargetType

LiveArea frame database layer.

Pass the source directory separately to the update function. The paths below are the conventional source locations. Retail frames take precedence over normal frames when both variants of the same frame exist.

Enumerator
SCE_LIVEAREA_TARGET_TYPE_NORMAL	Normal layer, conventionally from `sce_sys/livearea/contents`.
SCE_LIVEAREA_TARGET_TYPE_RETAIL	Retail override layer, usually from `sce_sys/retail/livearea/contents`.

Function Documentation

◆ sceLiveAreaGetStatus()

int sceLiveAreaGetStatus ( void )

Poll an asynchronous LiveArea operation.

Only one LiveArea operation can be pending in a process at a time. SceShell runs the operation independently; this function only checks whether it has finished and returns its result. The final result is returned once, then the pending request is cleared for the process. Later calls report no request until another operation is submitted.

Return values

1	The operation is still pending.
0	The operation completed successfully. The pending request is cleared.
0x80104001	No operation is pending. This is also returned after a final result has already been returned.

Returns: Another negative value is the final error returned by SceShell; returning it also clears the pending request.

◆ sceLiveAreaReplaceAllSync()

int sceLiveAreaReplaceAllSync ( const char * contents_path )

Replace all LiveArea data for the calling title synchronously.

Normally the target is the title associated with the calling process. After sceLiveAreaEnableBgAppMode is called, the target title is instead read from the caller's _fg_title_id LSDB property.

Parameters

[in] contents_path - Directory containing the replacement LiveArea data. The path must contain at most 255 characters.

Note: On retail FW 3.60, this implicit-title variant requires the original source path to begin with app0: or savedata0:. An app0: path under /sce_ is limited to sce_sys/livearea/contents or sce_sys/retail/livearea/contents. Use sceLiveAreaReplaceAllForTitleSync with a non-empty title ID for a source staged under ux0:data.

Return values

0	The replacement completed successfully.
0x80104002	contents_path is NULL or longer than 255 characters.
0x80104003	SceShell could not resolve the source path through the caller's FIOS overlays.
0x8010400B	The source path is not permitted by the implicit-title path policy.

Returns: Another negative error code returned by SceShell or LSDB.

◆ sceLiveAreaReplaceAllAsync()

int sceLiveAreaReplaceAllAsync ( const char * contents_path )

Replace all LiveArea data for the calling title asynchronously.

Normally the target is the title associated with the calling process. After sceLiveAreaEnableBgAppMode is called, the target title is instead read from the caller's _fg_title_id LSDB property.

Poll sceLiveAreaGetStatus to obtain the final result.

Parameters

[in] contents_path - Directory containing the replacement LiveArea data. The path must contain at most 255 characters.

Note: The source-path restrictions documented for sceLiveAreaReplaceAllSync also apply to this function.

You may reuse or free the contents_path string after this function returns, even if the operation is still running.

Return values

0	The operation was submitted.
0x80104001	Another asynchronous operation is still pending.
0x80104002	contents_path is NULL or longer than 255 characters.

Returns: Another negative submission error.

◆ sceLiveAreaReplaceAllForTitleSync()

int sceLiveAreaReplaceAllForTitleSync	(	const char *	contents_path,
		const char *	title_id,
		const SceRtcTick *	last_modified
	)

Replace all LiveArea data for a title synchronously.

Parameters

[in]	contents_path	- Directory containing the replacement LiveArea data. The path must contain at most 255 characters.
[in]	title_id	- Target title ID. If NULL or empty, SceShell normally uses the calling process's title. After sceLiveAreaEnableBgAppMode is called, a NULL or empty value instead selects the title in the caller's `_fg_title_id` LSDB property.
[in]	last_modified	- Modification time to store with the LiveArea data, or NULL to store a zero tick. Exactly eight bytes are copied into the request during the call.

Note: On FW 3.60, selecting the ForTitle export bypasses the implicit app0:/savedata0: source allowlist, independently of whether title_id is empty. This permits externally staged sources such as ux0:data. Supply a non-empty title_id to avoid implicit target resolution.

Return values

0	The replacement completed successfully.
0x80104002	contents_path is NULL or longer than 255 characters.
0x80104003	SceShell could not resolve the source path through the caller's FIOS overlays.

Returns: Another negative error code returned by SceShell or LSDB.

◆ sceLiveAreaReplaceAllForTitleAsync()

int sceLiveAreaReplaceAllForTitleAsync	(	const char *	contents_path,
		const char *	title_id,
		const SceRtcTick *	last_modified
	)

Replace all LiveArea data for a title asynchronously.

Poll sceLiveAreaGetStatus to obtain the final result.

Parameters

[in]	contents_path	- Directory containing the replacement LiveArea data. The path must contain at most 255 characters.
[in]	title_id	- Target title ID. If NULL or empty, SceShell normally uses the calling process's title. After sceLiveAreaEnableBgAppMode is called, a NULL or empty value instead selects the title in the caller's `_fg_title_id` LSDB property.
[in]	last_modified	- Modification time to store with the LiveArea data, or NULL to store a zero tick. Exactly eight bytes are copied into the request during the call.

Note: The source-path and title-resolution behavior documented for sceLiveAreaReplaceAllForTitleSync also applies to this function.

You may reuse or free all input buffers after this function returns, even if the operation is still running.

Return values

0	The operation was submitted.
0x80104001	Another asynchronous operation is still pending.
0x80104002	contents_path is NULL or longer than 255 characters.

Returns: Another negative submission error.

◆ sceLiveAreaUpdateFrameSync()

int sceLiveAreaUpdateFrameSync	(	const char *	format_version,
		const char *	frame_xml,
		SceInt32	frame_xml_length,
		const char *	contents_path,
		SceLiveAreaTargetType	target_type
	)

Update one LiveArea frame for the calling title synchronously.

The frame ID and frame contents are read from the XML document. After sceLiveAreaEnableBgAppMode is called, the target title is read from the caller's _fg_title_id LSDB property.

Parameters

[in]	format_version	- LiveArea XML format version. Must be `"01.00"`.
[in]	frame_xml	- Frame XML document.
[in]	frame_xml_length	- XML size in bytes. A negative value uses the NUL-terminated string length. The resulting size must not exceed 10239 bytes.
[in]	contents_path	- Directory containing assets referenced by the XML. The path must contain at most 255 characters.
[in]	target_type	- One of SceLiveAreaTargetType.

Note: The implicit-title source-path policy documented for sceLiveAreaReplaceAllSync also applies to frame updates.

Return values

0	The frame was updated.
0x80104002	An argument, path length, format version, or target type is invalid.
0x80104004	SceShell could not parse the frame XML.
0x80104009	The XML is longer than 10239 bytes.
0x8010400B	The source path is not permitted by the implicit-title path policy.

Returns: Another negative error code returned by SceShell or LSDB.

◆ sceLiveAreaUpdateFrameAsync()

int sceLiveAreaUpdateFrameAsync	(	const char *	format_version,
		const char *	frame_xml,
		SceInt32	frame_xml_length,
		const char *	contents_path,
		SceLiveAreaTargetType	target_type
	)

Update one LiveArea frame for the calling title asynchronously.

The frame ID and frame contents are read from the XML document. Poll sceLiveAreaGetStatus to obtain the final result. After sceLiveAreaEnableBgAppMode is called, the target title is read from the caller's _fg_title_id LSDB property.

Parameters

[in]	format_version	- LiveArea XML format version. Must be `"01.00"`.
[in]	frame_xml	- Frame XML document.
[in]	frame_xml_length	- XML size in bytes. A negative value uses the NUL-terminated string length. The resulting size must not exceed 10239 bytes.
[in]	contents_path	- Directory containing assets referenced by the XML. The path must contain at most 255 characters.
[in]	target_type	- One of SceLiveAreaTargetType.

Note: The implicit-title source-path policy documented for sceLiveAreaReplaceAllSync also applies to frame updates.

You may reuse or free the XML, path, and other input buffers after this function returns, even if the operation is still running.

Return values

0	The operation was submitted.
0x80104001	Another asynchronous operation is still pending.
0x80104002	An argument, path length, format version, or target type is invalid.
0x80104009	The XML is longer than 10239 bytes.

Returns: Another negative submission error.

◆ sceLiveAreaUpdateFrameForTitleSync()

int sceLiveAreaUpdateFrameForTitleSync	(	const char *	format_version,
		const char *	frame_xml,
		SceInt32	frame_xml_length,
		const char *	contents_path,
		SceLiveAreaTargetType	target_type,
		const char *	title_id
	)

Update one LiveArea frame for a title synchronously.

The frame ID and frame contents are read from the XML document.

Parameters

[in]	format_version	- LiveArea XML format version. Must be `"01.00"`.
[in]	frame_xml	- Frame XML document.
[in]	frame_xml_length	- XML size in bytes. A negative value uses the NUL-terminated string length. The resulting size must not exceed 10239 bytes.
[in]	contents_path	- Directory containing assets referenced by the XML. The path must contain at most 255 characters.
[in]	target_type	- One of SceLiveAreaTargetType.
[in]	title_id	- Target title ID. If NULL or empty, SceShell normally uses the calling process's title. After sceLiveAreaEnableBgAppMode is called, a NULL or empty value instead selects the title in the caller's `_fg_title_id` LSDB property.

Note: Selecting the ForTitle export bypasses the implicit app0:/savedata0: source allowlist, even when title_id is NULL or empty.

Return values

0	The frame was updated.
0x80104002	An argument, path length, format version, or target type is invalid.
0x80104004	SceShell could not parse the frame XML.
0x80104009	The XML is longer than 10239 bytes.

Returns: Another negative error code returned by SceShell or LSDB.

◆ sceLiveAreaUpdateFrameForTitleAsync()

int sceLiveAreaUpdateFrameForTitleAsync	(	const char *	format_version,
		const char *	frame_xml,
		SceInt32	frame_xml_length,
		const char *	contents_path,
		SceLiveAreaTargetType	target_type,
		const char *	title_id
	)

Update one LiveArea frame for a title asynchronously.

The frame ID and frame contents are read from the XML document. Poll sceLiveAreaGetStatus to obtain the final result.

Parameters

[in]	format_version	- LiveArea XML format version. Must be `"01.00"`.
[in]	frame_xml	- Frame XML document.
[in]	frame_xml_length	- XML size in bytes. A negative value uses the NUL-terminated string length. The resulting size must not exceed 10239 bytes.
[in]	contents_path	- Directory containing assets referenced by the XML. The path must contain at most 255 characters.
[in]	target_type	- One of SceLiveAreaTargetType.
[in]	title_id	- Target title ID. If NULL or empty, SceShell normally uses the calling process's title. After sceLiveAreaEnableBgAppMode is called, a NULL or empty value instead selects the title in the caller's `_fg_title_id` LSDB property.

Note: Selecting the ForTitle export bypasses the implicit app0:/savedata0: source allowlist, even when title_id is NULL or empty.

You may reuse or free all input buffers after this function returns, even if the operation is still running.

Return values

0	The operation was submitted.
0x80104001	Another asynchronous operation is still pending.
0x80104002	An argument, path length, format version, or target type is invalid.
0x80104009	The XML is longer than 10239 bytes.

Returns: Another negative submission error.

◆ sceLiveAreaUpdateFramesForTitleSync()

int sceLiveAreaUpdateFramesForTitleSync	(	const char *	format_version,
		const char const	frame_xml_array,
		SceUInt32	frame_count,
		const char *	contents_path,
		SceLiveAreaTargetType	target_type,
		const char *	title_id
	)

Update multiple LiveArea frames for a title synchronously.

Parameters

[in]	format_version	- LiveArea XML format version. Must be `"01.00"`.
[in]	frame_xml_array	- Array of NUL-terminated frame XML documents. Every entry must be non-NULL; FW 3.60 reads each string until its NUL terminator, without a length limit.
[in]	frame_count	- Number of entries in frame_xml_array. Must be nonzero.
[in]	contents_path	- Directory containing assets referenced by the XML. The path must contain at most 255 characters.
[in]	target_type	- One of SceLiveAreaTargetType.
[in]	title_id	- Target title ID. NULL or an empty string selects the title associated with the calling process. Background-application mode is not transmitted for this operation on FW 3.60.

Note: This function always uses the ForTitle source-path policy, including when title_id is NULL or empty.

The complete IPMI request, including the descriptor-size table and each payload rounded up to 16 bytes, must fit in 0x3F00 bytes on FW 3.60.

Return values

0	The frames were updated.
0x80104002	An argument, path length, format version, frame count, or target type is invalid.
0x80104004	SceShell could not parse one of the frame documents.
0x80020588	The serialized IPMI request is larger than 0x3F00 bytes.

Returns: Another negative error code returned by SceShell or LSDB.

◆ sceLiveAreaUpdateFramesForTitleAsync()

int sceLiveAreaUpdateFramesForTitleAsync	(	const char *	format_version,
		const char const	frame_xml_array,
		SceUInt32	frame_count,
		const char *	contents_path,
		SceLiveAreaTargetType	target_type,
		const char *	title_id
	)

Update multiple LiveArea frames for a title asynchronously.

Poll sceLiveAreaGetStatus to obtain the final result.

Parameters

[in]	format_version	- LiveArea XML format version. Must be `"01.00"`.
[in]	frame_xml_array	- Array of NUL-terminated frame XML documents. Every entry must be non-NULL; FW 3.60 reads each string until its NUL terminator, without a length limit.
[in]	frame_count	- Number of entries in frame_xml_array. Must be nonzero.
[in]	contents_path	- Directory containing assets referenced by the XML. The path must contain at most 255 characters.
[in]	target_type	- One of SceLiveAreaTargetType.
[in]	title_id	- Target title ID. NULL or an empty string selects the title associated with the calling process. Background-application mode is not transmitted for this operation on FW 3.60.

Note: This function always uses the ForTitle source-path policy, including when title_id is NULL or empty. The 0x3F00-byte serialized-request limit documented for sceLiveAreaUpdateFramesForTitleSync also applies.

You may reuse or free the pointer array and every XML string after this function returns, even if the operation is still running.

Return values

0	The operation was submitted.
0x80104001	Another asynchronous operation is still pending.
0x80104002	An argument, path length, format version, frame count, or target type is invalid.
0x80020588	The serialized IPMI request is larger than 0x3F00 bytes.

Returns: Another negative submission error.

◆ sceLiveAreaGetRevision()

int sceLiveAreaGetRevision ( SceUInt64 * revision )

Get the overall LiveArea content revision for the calling title.

FW 3.60 queries the LiveArea object currently loaded by SceShell rather than reading the database directly. Background-application mode does not change the target; SceShell always uses the calling application's title. If the object is temporarily unavailable, the query is retried every 16 milliseconds for up to approximately 10 seconds.

Parameters

[out] revision - Receives the revision.

Return values

0	The revision was returned.
0x80104002	revision is NULL.
0x8010400A	The target's loaded LiveArea object is unavailable.

Returns: Another negative error code returned by SceShell.

◆ sceLiveAreaGetFrameRevision()

int sceLiveAreaGetFrameRevision	(	const char *	frame_id,
		SceUInt64 *	revision
	)

Get a LiveArea frame revision for the calling title.

If normal and retail variants exist, the retail frame revision is returned. FW 3.60 queries the LiveArea object currently loaded by SceShell rather than reading the database directly. Background-application mode does not change the target; SceShell always uses the calling application's title. If the object is temporarily unavailable, the query is retried every 16 milliseconds for up to approximately 10 seconds.

Parameters

[in]	frame_id	- Non-empty frame ID.
[out]	revision	- Receives the revision.

Return values

0	The revision was returned.
0x80104002	frame_id is NULL or empty, or revision is NULL.
0x8010400A	The target's loaded LiveArea object or frame is unavailable.

Returns: Another negative error code returned by SceShell.

◆ sceLiveAreaGetFrameUserData()

int sceLiveAreaGetFrameUserData	(	const char *	frame_id,
		char *	buffer,
		SceSize	buffer_size
	)

Get the user data associated with a LiveArea frame for the calling title.

This function queries LSDB directly; it does not require the title's LiveArea object to be loaded. If normal and retail variants exist, the retail frame user data is returned. The result is NUL-terminated. At most min(buffer_size, 1024) - 1 data bytes are returned; FW 3.60 caps a larger requested transfer to 1024 bytes including the terminator. After sceLiveAreaEnableBgAppMode is called, the target title is read from the caller's _fg_title_id LSDB property.

Parameters

[in]	frame_id	- Frame ID. A NULL pointer is invalid; an empty string does not match a frame.
[out]	buffer	- Destination buffer.
[in]	buffer_size	- Destination buffer size. Must be nonzero.

Return values

0	The user-data string was returned.
0x80104002	frame_id or buffer is NULL, or buffer_size is zero.
0x8010400A	No matching frame exists.

Returns: Another negative error code returned by SceShell or LSDB.

◆ sceLiveAreaEnableBgAppMode()

int sceLiveAreaEnableBgAppMode ( void )

Enable foreground-title selection for a background companion application.

By default, an operation without an explicit title ID targets the title associated with the calling process. After this function is called, FW 3.60 treats the caller as a background companion and reads the foreground target title from the caller's _fg_title_id LSDB property. If that lookup does not produce a title ID, an affected operation can fail with 0x801040FF.

This sets a flag shared by all threads in the process to 1. There is no corresponding function to disable it. On FW 3.60 it changes the target for replace-all, single-frame, and frame user-data operations. Revision requests transmit the flag byte but SceShell ignores it, and multi-frame updates do not transmit it.

Warning: This does not put the calling application into the background, register an _fg_title_id relationship, grant additional privileges, or bypass the replace-all source-path policy. A normal foreground application should generally use an explicit-title function instead.

Note: Exported by the SceLiveAreaUtilBgApp library.

Returns: 0 on FW 3.60.

Enumerations

Functions

Detailed Description

Using this library in your project

Enumeration Type Documentation

◆ SceLiveAreaTargetType

Function Documentation

◆ sceLiveAreaGetStatus()

◆ sceLiveAreaReplaceAllSync()

◆ sceLiveAreaReplaceAllAsync()

◆ sceLiveAreaReplaceAllForTitleSync()

◆ sceLiveAreaReplaceAllForTitleAsync()

◆ sceLiveAreaUpdateFrameSync()

◆ sceLiveAreaUpdateFrameAsync()

◆ sceLiveAreaUpdateFrameForTitleSync()

◆ sceLiveAreaUpdateFrameForTitleAsync()

◆ sceLiveAreaUpdateFramesForTitleSync()

◆ sceLiveAreaUpdateFramesForTitleAsync()

◆ sceLiveAreaGetRevision()

◆ sceLiveAreaGetFrameRevision()

◆ sceLiveAreaGetFrameUserData()

◆ sceLiveAreaEnableBgAppMode()