capsc.h File Reference

Album Control (caps:c) service IPC wrapper. More...

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

Go to the source code of this file.

Data Structures
struct	CapsApplicationId

Functions
Result	capscInitialize (void)
	Initialize caps:c.
void	capscExit (void)
	Exit caps:c.
Service *	capscGetServiceSession (void)
	Gets the Service for caps:c.
Result	capscNotifyAlbumStorageIsAvailable (CapsAlbumStorage storage)
	Notify the service that a storage is now available.
Result	capscNotifyAlbumStorageIsUnAvailable (CapsAlbumStorage storage)
	Notify the service that a storage is now unavailable.
Result	capscRegisterAppletResourceUserId (u64 appletResourceUserId, const CapsApplicationId *application_id)
	Register an applet for later usage.
Result	capscUnregisterAppletResourceUserId (u64 appletResourceUserId, const CapsApplicationId *application_id)
	Unregister an applet.
Result	capscGetApplicationIdFromAruid (CapsApplicationId *application_id, u64 aruid)
	Get an ApplicationId that corresponds to an AppletResourceUserId.
Result	capscCheckApplicationIdRegistered (u64 application_id)
	Checks whether an ApplicationId is registered.
Result	capscGenerateCurrentAlbumFileId (const CapsApplicationId *application_id, CapsAlbumFileContents contents, CapsAlbumFileId *file_id)
	Generate an AlbumFileId based on parameters and current time.
Result	capscGenerateApplicationAlbumEntry (CapsApplicationAlbumEntry *appEntry, const CapsAlbumEntry *entry, u64 application_id)
	Generate an ApplicationAlbumEntry based on parameters.
Result	capscSaveAlbumScreenShotFile (const CapsAlbumFileId *file_id, const void *buffer, u64 buffer_size)
	Save a jpeg image.
Result	capscSaveAlbumScreenShotFileEx (const CapsAlbumFileId *file_id, u64 version, u64 makernote_offset, u64 makernote_size, const void *buffer, u64 buffer_size)
	Save a jpeg image.
Result	capscSetOverlayScreenShotThumbnailData (const CapsAlbumFileId *file_id, const void *image, u64 image_size)
	Sets thumbnail data for the last taken screenshot.
Result	capscSetOverlayMovieThumbnailData (const CapsAlbumFileId *file_id, const void *image, u64 image_size)
	Sets thumbnail data for the last recorded movie.
Result	capscOpenAlbumMovieReadStream (u64 *stream, const CapsAlbumFileId *file_id)
	Opens an AlbumMovieReadStream.
Result	capscCloseAlbumMovieStream (u64 stream)
	Closes an AlbumMovieReadStream.
Result	capscGetAlbumMovieStreamSize (u64 stream, u64 *size)
	Gets the data size of an AlbumMovieReadStream.
Result	capscReadMovieDataFromAlbumMovieReadStream (u64 stream, u64 offset, void *buffer, size_t size, u64 *actual_size)
	Reads data from an AlbumMovieReadStream.
Result	capscGetAlbumMovieReadStreamBrokenReason (u64 stream)
	Gets the BrokenReason for an AlbumMovieReadStream.
Result	capscGetAlbumMovieReadStreamImageDataSize (u64 stream, u64 *size)
	Gets the data size of an Image taken from an AlbumMovieReadStream.
Result	capscReadImageDataFromAlbumMovieReadStream (u64 stream, u64 offset, void *buffer, size_t size, u64 *actual_size)
	Reads data of an Image taken from an AlbumMovieReadStream.
Result	capscReadFileAttributeFromAlbumMovieReadStream (u64 stream, CapsScreenShotAttribute *attribute)
	Gets the file attribute of an AlbumMovieReadStream.
Result	capscOpenAlbumMovieWriteStream (u64 *stream, const CapsAlbumFileId *file_id)
	Opens an AlbumMovieWriteStream.
Result	capscFinishAlbumMovieWriteStream (u64 stream)
	Finish write to AlbumMovieWriteStream.
Result	capscCommitAlbumMovieWriteStream (u64 stream)
	Closes a finished AlbumMovieWriteStream.
Result	capscDiscardAlbumMovieWriteStream (u64 stream)
	Closes an AlbumMovieWriteStream in any state.
Result	capscDiscardAlbumMovieWriteStreamNoDelete (u64 stream)
	Closes an AlbumMovieWriteStream in any state without deleting the temporary file.
Result	capscCommitAlbumMovieWriteStreamEx (u64 stream, CapsAlbumEntry *entry)
	Closes a finished AlbumMovieWriteStream.
Result	capscStartAlbumMovieWriteStreamDataSection (u64 stream)
	Start AlbumMovieWriteStream data section.
Result	capscEndAlbumMovieWriteStreamDataSection (u64 stream)
	End AlbumMovieWriteStream data section.
Result	capscStartAlbumMovieWriteStreamMetaSection (u64 stream)
	Start AlbumMovieWriteStream meta section.
Result	capscEndAlbumMovieWriteStreamMetaSection (u64 stream)
	End AlbumMovieWriteStream meta section.
Result	capscReadDataFromAlbumMovieWriteStream (u64 stream, u64 offset, void *buffer, u64 size, u64 *actual_size)
	Reads data from an AlbumMovieWriteStream.
Result	capscWriteDataToAlbumMovieWriteStream (u64 stream, u64 offset, const void *buffer, u64 size)
	Write data to an AlbumMovieWriteStream.
Result	capscWriteMetaToAlbumMovieWriteStream (u64 stream, u64 offset, const void *buffer, u64 size)
	Write meta data to an AlbumMovieWriteStream.
Result	capscGetAlbumMovieWriteStreamBrokenReason (u64 stream)
	Gets the BrokenReason for an AlbumMovieWriteStream.
Result	capscGetAlbumMovieWriteStreamDataSize (u64 stream, u64 *size)
	Gets the data size of an AlbumMovieWriteStream.
Result	capscSetAlbumMovieWriteStreamDataSize (u64 stream, u64 size)
	Sets the data size of an AlbumMovieWriteStream.

Detailed Description

Album Control (caps:c) service IPC wrapper.

Author

Behemoth

Copyright

libnx Authors

Function Documentation

capscCheckApplicationIdRegistered()

Result capscCheckApplicationIdRegistered

(

u64

application_id

)

Checks whether an ApplicationId is registered.

Note

Only available on [2.0.0+].

Parameters

[in]

application_id

ApplicationId.

capscCloseAlbumMovieStream()

Result capscCloseAlbumMovieStream

(

u64

stream

)

Closes an AlbumMovieReadStream.

Note

Only available on [4.0.0+].

Parameters

[in]

stream

Stream handle.

capscCommitAlbumMovieWriteStream()

Result capscCommitAlbumMovieWriteStream

(

u64

stream

)

Closes a finished AlbumMovieWriteStream.

Note

Only available on [4.0.0+].

Parameters

[in]

stream

Stream handle.

capscCommitAlbumMovieWriteStreamEx()

Result capscCommitAlbumMovieWriteStreamEx	(	u64	stream,
		CapsAlbumEntry *	entry
	)

Closes a finished AlbumMovieWriteStream.

Note

Only available on [4.0.0+].

Parameters

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

capscDiscardAlbumMovieWriteStream()

Result capscDiscardAlbumMovieWriteStream

(

u64

stream

)

Closes an AlbumMovieWriteStream in any state.

Note

Only available on [4.0.0+].

Parameters

[in]

stream

Stream handle.

capscDiscardAlbumMovieWriteStreamNoDelete()

Result capscDiscardAlbumMovieWriteStreamNoDelete

(

u64

stream

)

Closes an AlbumMovieWriteStream in any state without deleting the temporary file.

Note

Only available on [4.0.0+].

Parameters

[in]

stream

Stream handle.

capscEndAlbumMovieWriteStreamDataSection()

Result capscEndAlbumMovieWriteStreamDataSection

(

u64

stream

)

End AlbumMovieWriteStream data section.

Note

Only available on [4.0.0+].

Parameters

[in]

stream

Stream handle.

capscEndAlbumMovieWriteStreamMetaSection()

Result capscEndAlbumMovieWriteStreamMetaSection

(

u64

stream

)

End AlbumMovieWriteStream meta section.

Note

Only available on [4.0.0+].

Parameters

[in]

stream

Stream handle.

capscFinishAlbumMovieWriteStream()

Result capscFinishAlbumMovieWriteStream

(

u64

stream

)

Finish write to AlbumMovieWriteStream.

Note

Copies file from save to destination storage and deletes the temporary file.

Only available on [4.0.0+].

Parameters

[in]

stream

Stream handle.

capscGenerateApplicationAlbumEntry()

Result capscGenerateApplicationAlbumEntry	(	CapsApplicationAlbumEntry *	appEntry,
		const CapsAlbumEntry *	entry,
		u64	application_id
	)

Generate an ApplicationAlbumEntry based on parameters.

Note

Output will be different between Shim Version 0 and 1.

Only available on [2.0.0+].

Parameters

[out]	appEntry	CapsApplicationAlbumEntry
[in]	entry	CapsAlbumEntry
[in]	application_id	ApplicationId.

capscGenerateCurrentAlbumFileId()

Result capscGenerateCurrentAlbumFileId	(	const CapsApplicationId *	application_id,
		CapsAlbumFileContents	contents,
		CapsAlbumFileId *	file_id
	)

Generate an AlbumFileId based on parameters and current time.

Parameters

[in]

application_id

ApplicationId.

Note

Only available on [2.0.0+].

Parameters

[in]	contents	CapsAlbumFileContents
[out]	file_id	CapsAlbumFileId

capscGetAlbumMovieReadStreamBrokenReason()

Result capscGetAlbumMovieReadStreamBrokenReason

(

u64

stream

)

Gets the BrokenReason for an AlbumMovieReadStream.

Note

Official sw doesn't use this.

Only available on [4.0.0+].

Parameters

[in]

stream

Stream handle.

capscGetAlbumMovieReadStreamImageDataSize()

Result capscGetAlbumMovieReadStreamImageDataSize	(	u64	stream,
		u64 *	size
	)

Gets the data size of an Image taken from an AlbumMovieReadStream.

Note

Only available on [4.0.0+].

Parameters

[in]	stream	Stream handle.
[out]	size	Expected size of an Image.

capscGetAlbumMovieStreamSize()

Result capscGetAlbumMovieStreamSize	(	u64	stream,
		u64 *	size
	)

Gets the data size of an AlbumMovieReadStream.

Note

Only available on [4.0.0+].

Parameters

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

capscGetAlbumMovieWriteStreamBrokenReason()

Result capscGetAlbumMovieWriteStreamBrokenReason

(

u64

stream

)

Gets the BrokenReason for an AlbumMovieWriteStream.

Note

Only available on [4.0.0+].

Parameters

[in]

stream

Stream handle.

capscGetAlbumMovieWriteStreamDataSize()

Result capscGetAlbumMovieWriteStreamDataSize	(	u64	stream,
		u64 *	size
	)

Gets the data size of an AlbumMovieWriteStream.

Note

Only available on [4.0.0+].

Parameters

[in]	stream	Stream handle.
[out]	size	Size of the data section.

capscGetApplicationIdFromAruid()

Result capscGetApplicationIdFromAruid	(	CapsApplicationId *	application_id,
		u64	aruid
	)

Get an ApplicationId that corresponds to an AppletResourceUserId.

Note

Returns value set by capscRegisterAppletResourceUserId.

Only available on [2.0.0+].

Parameters

[out]	application_id	ApplicationId.
[in]	appletResourceUserId	AppletResourceUserId.

capscNotifyAlbumStorageIsAvailable()

Result capscNotifyAlbumStorageIsAvailable

(

CapsAlbumStorage

storage

)

Notify the service that a storage is now available.

Note

This will result in capsrv mounting the image directory on that storage medium.

Parameters

[in]

storage

CapsAlbumStorage

capscNotifyAlbumStorageIsUnAvailable()

Result capscNotifyAlbumStorageIsUnAvailable

(

CapsAlbumStorage

storage

)

Notify the service that a storage is now unavailable.

Note

This will result in capsrv unmounting the image directory on that storage medium.

Parameters

[in]

storage

CapsAlbumStorage

capscOpenAlbumMovieReadStream()

Result capscOpenAlbumMovieReadStream	(	u64 *	stream,
		const CapsAlbumFileId *	file_id
	)

Opens an AlbumMovieReadStream.

Note

This opens IAlbumControlSession if not previously opened, it's closed during capscExit.

Up to 4 streams can be open at the same time. Multiple streams can be open at the same time for the same CapsAlbumFileId.

Only available on [4.0.0+].

Parameters

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

capscOpenAlbumMovieWriteStream()

Result capscOpenAlbumMovieWriteStream	(	u64 *	stream,
		const CapsAlbumFileId *	file_id
	)

Opens an AlbumMovieWriteStream.

Note

This opens IAlbumControlSession if not previously opened, it's closed during capsaExit.

Up to 2 streams can be open at the same time.

Only available on [4.0.0+].

Parameters

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

capscReadDataFromAlbumMovieWriteStream()

Result capscReadDataFromAlbumMovieWriteStream	(	u64	stream,
		u64	offset,
		void *	buffer,
		u64	size,
		u64 *	actual_size
	)

Reads data from an AlbumMovieWriteStream.

Note

offset(+size) must not be negative. offset and size must be aligned to 0x40000-bytes.

When offset(+size) goes beyond the size from capscGetAlbumMovieStreamSize, the regions of the buffer which goes beyond that are cleared to 0, and actual_size is still set to the input size.

Only available on [4.0.0+].

Parameters

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

capscReadFileAttributeFromAlbumMovieReadStream()

Result capscReadFileAttributeFromAlbumMovieReadStream	(	u64	stream,
		CapsScreenShotAttribute *	attribute
	)

Gets the file attribute of an AlbumMovieReadStream.

Note

Only available on [4.0.0+].

Parameters

[in]	stream	Stream handle.
[out]	attr	CapsScreenShotAttribute

capscReadImageDataFromAlbumMovieReadStream()

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

Reads data of an Image taken from an AlbumMovieReadStream.

Note

Only available on [4.0.0+].

Parameters

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

capscReadMovieDataFromAlbumMovieReadStream()

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

Reads data from an AlbumMovieReadStream.

Note

offset(+size) must not be negative. offset and size must be aligned to 0x40000-bytes.

When offset(+size) goes beyond the size from capscGetAlbumMovieStreamSize, the regions of the buffer which goes beyond that are cleared to 0, and actual_size is still set to the input size.

Only available on [4.0.0+].

Parameters

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

capscRegisterAppletResourceUserId()

Result capscRegisterAppletResourceUserId	(	u64	appletResourceUserId,
		const CapsApplicationId *	application_id
	)

Register an applet for later usage.

Note

Called at application launch by the system.

Will generate a random AES-256 key for this application for use on Shim-Version 0.

Only available on [2.0.0+].

Parameters

[in]	appletResourceUserId	AppletResourceUserId.
[in]	application_id	ApplicationId.

capscSaveAlbumScreenShotFile()

Result capscSaveAlbumScreenShotFile	(	const CapsAlbumFileId *	file_id,
		const void *	buffer,
		u64	buffer_size
	)

Save a jpeg image.

Note

Only available on [2.0.0-3.0.2].

Parameters

[in]	file_id	CapsAlbumFileId
[in]	buffer	JPEG image buffer.
[in]	buffer_size	Size of the JPEG image.

capscSaveAlbumScreenShotFileEx()

Result capscSaveAlbumScreenShotFileEx	(	const CapsAlbumFileId *	file_id,
		u64	version,
		u64	makernote_offset,
		u64	makernote_size,
		const void *	buffer,
		u64	buffer_size
	)

Save a jpeg image.

Note

Only available on [4.0.0+].

Version 3 as of [9.1.0].

Parameters

[in]	file_id	CapsAlbumFileId
[in]	version	Revision number.
[in]	makernote_offset	Offset to makernote in JPEG buffer.
[in]	makernote_size	Size of the makernote in JPEG buffer.
[in]	buffer	JPEG image buffer.
[in]	buffer_size	Size of the JPEG image.

capscSetAlbumMovieWriteStreamDataSize()

Result capscSetAlbumMovieWriteStreamDataSize	(	u64	stream,
		u64	size
	)

Sets the data size of an AlbumMovieWriteStream.

Note

Must not be bigger than 2GiB.

Only available on [4.0.0+].

Parameters

[in]	stream	Stream handle.
[out]	size	Size of the data section.

capscSetOverlayMovieThumbnailData()

Result capscSetOverlayMovieThumbnailData	(	const CapsAlbumFileId *	file_id,
		const void *	image,
		u64	image_size
	)

Sets thumbnail data for the last recorded movie.

Note

Only availabe on [4.0.0+].

96×54 Image will get saved.

Parameters

[in]	file_id	CapsAlbumFileId
[in]	image	RGBA8 image buffer.
[in]	image_size	size of the RGBA8 image buffer.

capscSetOverlayScreenShotThumbnailData()

Result capscSetOverlayScreenShotThumbnailData	(	const CapsAlbumFileId *	file_id,
		const void *	image,
		u64	image_size
	)

Sets thumbnail data for the last taken screenshot.

Note

96×54 Image will get saved.

Parameters

[in]	file_id	CapsAlbumFileId
[in]	image	RGBA8 image buffer.
[in]	image_size	size of the RGBA8 image buffer.

capscStartAlbumMovieWriteStreamDataSection()

Result capscStartAlbumMovieWriteStreamDataSection

(

u64

stream

)

Start AlbumMovieWriteStream data section.

Note

Only available on [4.0.0+].

Parameters

[in]

stream

Stream handle.

capscStartAlbumMovieWriteStreamMetaSection()

Result capscStartAlbumMovieWriteStreamMetaSection

(

u64

stream

)

Start AlbumMovieWriteStream meta section.

Note

Only available on [4.0.0+].

Parameters

[in]

stream

Stream handle.

capscUnregisterAppletResourceUserId()

Result capscUnregisterAppletResourceUserId	(	u64	appletResourceUserId,
		const CapsApplicationId *	application_id
	)

Unregister an applet.

Note

Called at application exit by the system.

Only available on [2.0.0+].

Parameters

[in]	appletResourceUserId	AppletResourceUserId.
[in]	application_id	ApplicationId.

capscWriteDataToAlbumMovieWriteStream()

Result capscWriteDataToAlbumMovieWriteStream	(	u64	stream,
		u64	offset,
		const void *	buffer,
		u64	size
	)

Write data to an AlbumMovieWriteStream.

Note

Only available on [4.0.0+].

Parameters

[in]	stream	Stream handle.
[in]	offset	Offset.
[in]	buffer	Input data buffer.
[in]	size	Data buffer size.

capscWriteMetaToAlbumMovieWriteStream()

Result capscWriteMetaToAlbumMovieWriteStream	(	u64	stream,
		u64	offset,
		const void *	buffer,
		u64	size
	)

Write meta data to an AlbumMovieWriteStream.

Note

Only available on [4.0.0+].

Parameters

[in]	stream	Stream handle.
[in]	offset	Offset.
[in]	buffer	Input data buffer.
[in]	size	Data buffer size.