Application Album (caps:u) service IPC wrapper. More...

#include "../types.h"
#include "../sf/service.h"
#include "../services/caps.h"
#include "../services/acc.h"

Functions
Result	capsuInitialize (void)
	Initialize caps:u. Only available on [5.0.0+].

void	capsuExit (void)
	Exit caps:u.

Service *	capsuGetServiceSession (void)
	Gets the Service for caps:u.

Service *	capsuGetServiceSession_Accessor (void)
	Gets the Service for IAlbumAccessorApplicationSession, only initialized after capsuOpenAlbumMovieStream was used (unaffected by using capsuCloseAlbumMovieStream).

Result	capsuGetAlbumFileListDeprecated1 (CapsApplicationAlbumFileEntry entries, s32 count, CapsContentType type, const CapsAlbumFileDateTime start_datetime, const CapsAlbumFileDateTime end_datetime, s32 total_entries)
	Gets a listing of CapsApplicationAlbumFileEntry.

Result	capsuGetAlbumFileListDeprecated2 (CapsApplicationAlbumFileEntry entries, s32 count, CapsContentType type, const CapsAlbumFileDateTime start_datetime, const CapsAlbumFileDateTime end_datetime, AccountUid uid, s32 total_entries)
	Gets a listing of CapsApplicationAlbumFileEntry, where the AlbumFile has an UserId which matches the input one.

Result	capsuGetAlbumFileList3 (CapsApplicationAlbumEntry entries, s32 count, CapsContentType type, const CapsAlbumFileDateTime start_datetime, const CapsAlbumFileDateTime end_datetime, s32 total_entries)
	Gets a listing of CapsApplicationAlbumEntry.

Result	capsuGetAlbumFileList4 (CapsApplicationAlbumEntry entries, s32 count, CapsContentType type, const CapsAlbumFileDateTime start_datetime, const CapsAlbumFileDateTime end_datetime, AccountUid uid, s32 total_entries)
	Gets a listing of CapsApplicationAlbumEntry, where the AlbumFile has an UserId which matches the input one.

Result	capsuDeleteAlbumFile (CapsContentType type, const CapsApplicationAlbumFileEntry *entry)
	Deletes the specified AlbumFile.

Result	capsuGetAlbumFileSize (const CapsApplicationAlbumFileEntry entry, u64 size)
	Gets the filesize for the entire specified AlbumFile.

Result	capsuLoadAlbumScreenShotImage (s32 width, s32 height, CapsScreenShotAttributeForApplication attr, void userdata, size_t userdata_maxsize, u32 userdata_size, void image, size_t image_size, void workbuf, size_t workbuf_size, const CapsApplicationAlbumFileEntry entry, const CapsScreenShotDecodeOption *option)
	Load the ScreenShotImage for the specified AlbumFile.

Result	capsuLoadAlbumScreenShotThumbnailImage (s32 width, s32 height, CapsScreenShotAttributeForApplication attr, void userdata, size_t userdata_maxsize, u32 userdata_size, void image, size_t image_size, void workbuf, size_t workbuf_size, const CapsApplicationAlbumFileEntry entry, const CapsScreenShotDecodeOption *option)
	Load the ScreenShotThumbnailImage for the specified AlbumFile.

Result	capsuPrecheckToCreateContents (CapsContentType type, u64 unk)
	PrecheckToCreateContents.

Result	capsuOpenAlbumMovieStream (u64 stream, const CapsApplicationAlbumFileEntry entry)
	Opens an AlbumMovieStream.

Result	capsuCloseAlbumMovieStream (u64 stream)
	Closes an AlbumMovieStream.

Result	capsuGetAlbumMovieStreamSize (u64 stream, u64 *size)
	Gets the data size of an AlbumMovieStream.

Result	capsuReadAlbumMovieStream (u64 stream, s64 offset, void buffer, size_t size, u64 actual_size)
	Reads data from an AlbumMovieStream.

Result	capsuGetAlbumMovieStreamBrokenReason (u64 stream)
	Gets the BrokenReason for an AlbumMovieStream.

Detailed Description

Application Album (caps:u) service IPC wrapper.

This is only usable with AlbumFiles associated with the current host Application.

Author: yellows8

Copyright: libnx Authors

Function Documentation

◆ capsuCloseAlbumMovieStream()

Result capsuCloseAlbumMovieStream ( u64 stream )

Closes an AlbumMovieStream.

Parameters

[in] stream Stream handle.

◆ capsuDeleteAlbumFile()

Result capsuDeleteAlbumFile	(	CapsContentType	type,
		const CapsApplicationAlbumFileEntry *	entry
	)

Deletes the specified AlbumFile.

Parameters

[in]	type	CapsContentType, must match CapsContentType_ExtraMovie.
[in]	entry	CapsApplicationAlbumFileEntry

◆ capsuGetAlbumFileList3()

Result capsuGetAlbumFileList3	(	CapsApplicationAlbumEntry *	entries,
		s32	count,
		CapsContentType	type,
		const CapsAlbumFileDateTime *	start_datetime,
		const CapsAlbumFileDateTime *	end_datetime,
		s32 *	total_entries
	)

Gets a listing of CapsApplicationAlbumEntry.

Note: Only available on [7.0.0+], on prior sysvers use capsuGetAlbumFileListDeprecated1 instead.

Parameters

[out]	entries	Output array of CapsApplicationAlbumEntry.
[in]	count	Max size of the output array in entries.
[in]	type	CapsContentType
[in]	start_datetime	Start CapsAlbumFileDateTime, when NULL the default is used.
[in]	end_datetime	End CapsAlbumFileDateTime, when NULL the default is used.
[out]	total_entries	Total output entries.

◆ capsuGetAlbumFileList4()

Result capsuGetAlbumFileList4	(	CapsApplicationAlbumEntry *	entries,
		s32	count,
		CapsContentType	type,
		const CapsAlbumFileDateTime *	start_datetime,
		const CapsAlbumFileDateTime *	end_datetime,
		AccountUid	uid,
		s32 *	total_entries
	)

Gets a listing of CapsApplicationAlbumEntry, where the AlbumFile has an UserId which matches the input one.

Note: Only available on [7.0.0+], on prior sysvers use capsuGetAlbumFileListDeprecated2 instead.

Parameters

[out]	entries	Output array of CapsApplicationAlbumEntry.
[in]	count	Max size of the output array in entries.
[in]	type	CapsContentType
[in]	start_datetime	Start CapsAlbumFileDateTime, when NULL the default is used.
[in]	end_datetime	End CapsAlbumFileDateTime, when NULL the default is used.
[in]	uid	AccountUid
[out]	total_entries	Total output entries.

◆ capsuGetAlbumFileListDeprecated1()

Result capsuGetAlbumFileListDeprecated1	(	CapsApplicationAlbumFileEntry *	entries,
		s32	count,
		CapsContentType	type,
		const CapsAlbumFileDateTime *	start_datetime,
		const CapsAlbumFileDateTime *	end_datetime,
		s32 *	total_entries
	)

Gets a listing of CapsApplicationAlbumFileEntry.

Note: On [6.0.0+] this uses GetAlbumFileList1AafeAruidDeprecated, otherwise this uses GetAlbumFileList0AafeAruidDeprecated.; This is an old version of capsuGetAlbumFileList3.

Parameters

[out]	entries	Output array of CapsApplicationAlbumFileEntry.
[in]	count	Max size of the output array in entries.
[in]	type	CapsContentType
[in]	start_datetime	Start CapsAlbumFileDateTime, when NULL the default is used.
[in]	end_datetime	End CapsAlbumFileDateTime, when NULL the default is used.
[out]	total_entries	Total output entries.

◆ capsuGetAlbumFileListDeprecated2()

Result capsuGetAlbumFileListDeprecated2	(	CapsApplicationAlbumFileEntry *	entries,
		s32	count,
		CapsContentType	type,
		const CapsAlbumFileDateTime *	start_datetime,
		const CapsAlbumFileDateTime *	end_datetime,
		AccountUid	uid,
		s32 *	total_entries
	)

Gets a listing of CapsApplicationAlbumFileEntry, where the AlbumFile has an UserId which matches the input one.

Note: Only available on [6.0.0+].; This is an old version of capsuGetAlbumFileList4.

Parameters

[out]	entries	Output array of CapsApplicationAlbumFileEntry.
[in]	count	Max size of the output array in entries.
[in]	type	CapsContentType
[in]	start_datetime	Start CapsAlbumFileDateTime, when NULL the default is used.
[in]	end_datetime	End CapsAlbumFileDateTime, when NULL the default is used.
[in]	uid	AccountUid
[out]	total_entries	Total output entries.

◆ capsuGetAlbumFileSize()

Result capsuGetAlbumFileSize	(	const CapsApplicationAlbumFileEntry *	entry,
		u64 *	size
	)

Gets the filesize for the entire specified AlbumFile.

Parameters

[in]	entry	CapsApplicationAlbumFileEntry
[out]	size	Output filesize.

◆ capsuGetAlbumMovieStreamBrokenReason()

Result capsuGetAlbumMovieStreamBrokenReason ( u64 stream )

Gets the BrokenReason for an AlbumMovieStream.

Note: Official sw doesn't use this.

Parameters

[in] stream Stream handle.

◆ capsuGetAlbumMovieStreamSize()

Result capsuGetAlbumMovieStreamSize	(	u64	stream,
		u64 *	size
	)

Gets the data size of an AlbumMovieStream.

Parameters

[in]	stream	Stream handle.
[out]	size	Size of the actual MP4, without the JPEG at the end.

◆ capsuLoadAlbumScreenShotImage()

Result capsuLoadAlbumScreenShotImage	(	s32 *	width,
		s32 *	height,
		CapsScreenShotAttributeForApplication *	attr,
		void *	userdata,
		size_t	userdata_maxsize,
		u32 *	userdata_size,
		void *	image,
		size_t	image_size,
		void *	workbuf,
		size_t	workbuf_size,
		const CapsApplicationAlbumFileEntry *	entry,
		const CapsScreenShotDecodeOption *	option
	)

Load the ScreenShotImage for the specified AlbumFile.

Parameters

[out]	width	Output image width. Optional, can be NULL.
[out]	height	Output image height. Optional, can be NULL.
[out]	attr	CapsScreenShotAttributeForApplication
[out]	userdata	Output buffer containing the UserData. Optional, can be NULL. This buffer is cleared to 0 using userdata_maxsize, prior to doing the memcpy.
[in]	userdata_maxsize	Max size of the userdata buffer. Optional, can be 0.
[out]	userdata_size	Userdata size field, clamped to max size sizeof(CapsApplicationData::userdata) when needed.
[out]	image	RGBA8 image output buffer.
[in]	image_size	Image buffer size, should be at least large enough for RGBA8 1280x720.
[out]	workbuf	Work buffer, cleared to 0 by the cmd before it returns.
[in]	workbuf_size	Work buffer size, must be at least the size of the JPEG within the AlbumFile.
[in]	entry	CapsApplicationAlbumFileEntry
[in]	option	CapsScreenShotDecodeOption

◆ capsuLoadAlbumScreenShotThumbnailImage()

Result capsuLoadAlbumScreenShotThumbnailImage	(	s32 *	width,
		s32 *	height,
		CapsScreenShotAttributeForApplication *	attr,
		void *	userdata,
		size_t	userdata_maxsize,
		u32 *	userdata_size,
		void *	image,
		size_t	image_size,
		void *	workbuf,
		size_t	workbuf_size,
		const CapsApplicationAlbumFileEntry *	entry,
		const CapsScreenShotDecodeOption *	option
	)

Load the ScreenShotThumbnailImage for the specified AlbumFile.

Parameters

[out]	width	Output image width. Optional, can be NULL.
[out]	height	Output image height. Optional, can be NULL.
[out]	attr	CapsScreenShotAttributeForApplication
[out]	userdata	Output buffer containing the UserData. Optional, can be NULL. This buffer is cleared to 0 using userdata_maxsize, prior to doing the memcpy.
[in]	userdata_maxsize	Max size of the userdata buffer. Optional, can be 0.
[out]	userdata_size	Userdata size field, clamped to max size sizeof(CapsApplicationData::userdata) when needed.
[out]	image	RGBA8 image output buffer.
[in]	image_size	Image buffer size, should be at least large enough for RGBA8 320x180.
[out]	workbuf	Work buffer, cleared to 0 by the cmd before it returns.
[in]	workbuf_size	Work buffer size, must be at least the size of the JPEG within the AlbumFile.
[in]	entry	CapsApplicationAlbumFileEntry
[in]	option	CapsScreenShotDecodeOption

◆ capsuOpenAlbumMovieStream()

Result capsuOpenAlbumMovieStream	(	u64 *	stream,
		const CapsApplicationAlbumFileEntry *	entry
	)

Opens an AlbumMovieStream.

Note: This opens IAlbumAccessorApplicationSession if not previously opened, it's closed during capsuExit.; Up to 4 streams can be open at the same time. Multiple streams can be open at the same time for the same CapsApplicationAlbumFileEntry.

Parameters

[out]	stream	Stream handle.
[in]	entry	CapsApplicationAlbumFileEntry

◆ capsuPrecheckToCreateContents()

Result capsuPrecheckToCreateContents	(	CapsContentType	type,
		u64	unk
	)

PrecheckToCreateContents.

Official sw only uses this with CapsContentType_ExtraMovie.

Parameters

[in]	type	CapsContentType
[in]	unk	Unknown.

◆ capsuReadAlbumMovieStream()

Result capsuReadAlbumMovieStream	(	u64	stream,
		s64	offset,
		void *	buffer,
		size_t	size,
		u64 *	actual_size
	)

Reads data from an AlbumMovieStream.

Note: offset(+size) must not be negative. offset and size must be aligned to 0x40000-bytes.; When offset(+size) goes beyond the size from capsuGetAlbumMovieStreamSize, the regions of the buffer which goes beyond that are cleared to 0, and actual_size is still set to the input size.

Parameters

[in]	stream	Stream handle.
[in]	offset	Offset.
[out]	Output	data buffer.
[in]	size	Data buffer size.
[out]	actual_size	Actual read size.

Functions

Detailed Description

Function Documentation

◆ capsuCloseAlbumMovieStream()

◆ capsuDeleteAlbumFile()

◆ capsuGetAlbumFileList3()

◆ capsuGetAlbumFileList4()

◆ capsuGetAlbumFileListDeprecated1()

◆ capsuGetAlbumFileListDeprecated2()

◆ capsuGetAlbumFileSize()

◆ capsuGetAlbumMovieStreamBrokenReason()

◆ capsuGetAlbumMovieStreamSize()

◆ capsuLoadAlbumScreenShotImage()

◆ capsuLoadAlbumScreenShotThumbnailImage()

◆ capsuOpenAlbumMovieStream()

◆ capsuPrecheckToCreateContents()

◆ capsuReadAlbumMovieStream()