libnx  v4.2.0
Functions
capsa.h File Reference

Album Accessor (caps:a) service IPC wrapper. More...

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

Go to the source code of this file.

Functions

Result capsaInitialize (void)
 Initialize caps:a.
 
void capsaExit (void)
 Exit caps:a.
 
ServicecapsaGetServiceSession (void)
 Gets the Service for caps:a.
 
ServicecapsaGetServiceSession_Accessor (void)
 Gets the Service for IAlbumAccessorSession, only initialized after capsaOpenAlbumMovieStream was used (unaffected by using capsaCloseAlbumMovieStream).
 
Result capsaGetAlbumFileCount (CapsAlbumStorage storage, u64 *count)
 Gets the amount of files at a AlbumStorage. More...
 
Result capsaGetAlbumFileList (CapsAlbumStorage storage, u64 *out, CapsAlbumEntry *entries, u64 count)
 Gets a listing of CapsAlbumEntry, where the AlbumFile's storage matches the input one. More...
 
Result capsaLoadAlbumFile (const CapsAlbumFileId *file_id, u64 *out_size, void *filebuf, u64 filebuf_size)
 Loads a file into the specified buffer. More...
 
Result capsaDeleteAlbumFile (const CapsAlbumFileId *file_id)
 Deletes an AlbumFile corresponding to the specified CapsAlbumFileId. More...
 
Result capsaStorageCopyAlbumFile (const CapsAlbumFileId *file_id, CapsAlbumStorage dst_storage)
 Copies an AlbumFile to the specified CapsAlbumStorage. More...
 
Result capsaIsAlbumMounted (CapsAlbumStorage storage, bool *is_mounted)
 Gets the mount status of the specified CapsAlbumStorage. More...
 
Result capsaGetAlbumUsage (CapsAlbumStorage storage, CapsAlbumUsage2 *out)
 Returns the AlbumUsage for a specified CapsAlbumStorage. More...
 
Result capsaGetAlbumFileSize (const CapsAlbumFileId *file_id, u64 *size)
 Gets the size for the specified AlbumFile. More...
 
Result capsaLoadAlbumFileThumbnail (const CapsAlbumFileId *file_id, u64 *out_size, void *image, u64 image_size)
 Load the Thumbnail for the specified AlbumFile. More...
 
Result capsaLoadAlbumScreenShotImage (u64 *width, u64 *height, const CapsAlbumFileId *file_id, void *image, u64 image_size, void *workbuf, u64 workbuf_size)
 Load the ScreenShotImage for the specified AlbumFile. More...
 
Result capsaLoadAlbumScreenShotThumbnailImage (u64 *width, u64 *height, const CapsAlbumFileId *file_id, void *image, u64 image_size, void *workbuf, u64 workbuf_size)
 Load the ScreenShotThumbnailImage for the specified AlbumFile. More...
 
Result capsaGetAlbumEntryFromApplicationAlbumEntry (CapsAlbumEntry *entry, const CapsApplicationAlbumEntry *application_entry, u64 application_id)
 Load an CapsAlbumEntry from a CapsApplicationAlbumEntry and an ApplicationId. More...
 
Result capsaLoadAlbumScreenShotImageEx (u64 *width, u64 *height, const CapsAlbumFileId *file_id, const CapsScreenShotDecodeOption *opts, void *image, u64 image_size, void *workbuf, u64 workbuf_size)
 Load the ScreenShotImage for the specified AlbumFile. More...
 
Result capsaLoadAlbumScreenShotThumbnailImageEx (u64 *width, u64 *height, const CapsAlbumFileId *file_id, const CapsScreenShotDecodeOption *opts, void *image, u64 image_size, void *workbuf, u64 workbuf_size)
 Load the ScreenShotThumbnailImage for the specified AlbumFile. More...
 
Result capsaLoadAlbumScreenShotImageEx0 (u64 *width, u64 *height, CapsScreenShotAttribute *attr, const CapsAlbumFileId *file_id, const CapsScreenShotDecodeOption *opts, void *image, u64 image_size, void *workbuf, u64 workbuf_size)
 Load the ScreenShotImage for the specified AlbumFile. More...
 
Result capsaGetAlbumUsage3 (CapsAlbumStorage storage, CapsAlbumUsage3 *out)
 Returns the AlbumUsage for a specified CapsAlbumStorage. More...
 
Result capsaGetAlbumMountResult (CapsAlbumStorage storage)
 Returns the result for a AlbumStorage mount. More...
 
Result capsaGetAlbumUsage16 (CapsAlbumStorage storage, u8 flags, CapsAlbumUsage16 *out)
 Returns the AlbumUsage for a specified CapsAlbumStorage. More...
 
Result capsaGetMinMaxAppletId (bool *success, u64 *min, u64 *max)
 Returns the start and end of the Applet Id range. More...
 
Result capsaGetAlbumFileCountEx0 (CapsAlbumStorage storage, u8 flags, u64 *count)
 Gets the amount of files of the specified type at a AlbumStorage. More...
 
Result capsaGetAlbumFileListEx0 (CapsAlbumStorage storage, u8 flags, u64 *out, CapsAlbumEntry *entries, u64 count)
 Gets a listing of CapsAlbumEntry, where the AlbumFile's storage and type matches the input one. More...
 
Result capsaGetLastOverlayScreenShotThumbnail (CapsAlbumFileId *file_id, u64 *out_size, void *image, u64 image_size)
 Returns the image from the last shown ScreenShot Overlay. More...
 
Result capsaGetLastOverlayMovieThumbnail (CapsAlbumFileId *file_id, u64 *out_size, void *image, u64 image_size)
 Returns the image from the last shown Movie Overlay. More...
 
Result capsaGetAutoSavingStorage (CapsAlbumStorage *storage)
 Gets the currently set autosaving storage. More...
 
Result capsaGetRequiredStorageSpaceSizeToCopyAll (CapsAlbumStorage dst_storage, CapsAlbumStorage src_storage, u64 *out)
 Gets required size to copy all files from one Storage to another. More...
 
Result capsLoadAlbumScreenShotThumbnailImageEx0 (u64 *width, u64 *height, CapsScreenShotAttribute *attr, const CapsAlbumFileId *file_id, const CapsScreenShotDecodeOption *opts, void *image, u64 image_size, void *workbuf, u64 workbuf_size)
 Load the ScreenShotThumbnailImage for the specified AlbumFile. More...
 
Result capsaLoadAlbumScreenShotImageEx1 (const CapsAlbumFileId *file_id, const CapsScreenShotDecodeOption *opts, CapsLoadAlbumScreenShotImageOutput *out, void *image, u64 image_size, void *workbuf, u64 workbuf_size)
 Load the ScreenShotImage for the specified AlbumFile. More...
 
Result capsaLoadAlbumScreenShotThumbnailImageEx1 (const CapsAlbumFileId *file_id, const CapsScreenShotDecodeOption *opts, CapsLoadAlbumScreenShotImageOutput *out, void *image, u64 image_size, void *workbuf, u64 workbuf_size)
 Load the ScreenShotThumbnailImage for the specified AlbumFile. More...
 
Result capsaForceAlbumUnmounted (CapsAlbumStorage storage)
 Unmounts the specified AlbumStorage. More...
 
Result capsaResetAlbumMountStatus (CapsAlbumStorage storage)
 Resets mount status for the specified AlbumStorage. More...
 
Result capsaRefreshAlbumCache (CapsAlbumStorage storage)
 Refreshs Album Cache for the specified AlbumStorage. More...
 
Result capsaGetAlbumCache (CapsAlbumStorage storage, CapsAlbumCache *cache)
 Gets the AlbumCache of the specified AlbumStorage. More...
 
Result capsaGetAlbumCacheEx (CapsAlbumStorage storage, CapsAlbumFileContents contents, CapsAlbumCache *cache)
 Gets the AlbumCache for the specified type of the specified AlbumStorage. More...
 
Result capsaGetAlbumEntryFromApplicationAlbumEntryAruid (CapsAlbumEntry *entry, const CapsApplicationAlbumEntry *application_entry)
 Load an CapsAlbumEntry from a CapsApplicationAlbumEntry and an AppletResourceUserId. More...
 
Result capsaOpenAlbumMovieStream (u64 *stream, const CapsAlbumFileId *file_id)
 Opens an AlbumMovieStream. More...
 
Result capsaCloseAlbumMovieStream (u64 stream)
 Closes an AlbumMovieStream. More...
 
Result capsaGetAlbumMovieStreamSize (u64 stream, u64 *size)
 Gets the data size of an AlbumMovieStream. More...
 
Result capsaReadMovieDataFromAlbumMovieReadStream (u64 stream, s64 offset, void *buffer, size_t size, u64 *actual_size)
 Reads data from an AlbumMovieStream. More...
 
Result capsaGetAlbumMovieReadStreamBrokenReason (u64 stream)
 Gets the BrokenReason for an AlbumMovieStream. More...
 
Result capsaGetAlbumMovieReadStreamImageDataSize (u64 stream, u64 *size)
 Gets the data size of an Image taken from an AlbumMovieStream. More...
 
Result capsaReadImageDataFromAlbumMovieReadStream (u64 stream, s64 offset, void *buffer, size_t size, u64 *actual_size)
 Reads data of an Image taken from an AlbumMovieStream. More...
 
Result capsaReadFileAttributeFromAlbumMovieReadStream (u64 stream, CapsScreenShotAttribute *attr)
 Gets the file attribute of an AlbumMovieStream. More...
 

Detailed Description

Album Accessor (caps:a) service IPC wrapper.

Author
Behemoth

Function Documentation

◆ capsaCloseAlbumMovieStream()

Result capsaCloseAlbumMovieStream ( u64  stream)

Closes an AlbumMovieStream.

Note
Only available on [4.0.0+].
Parameters
[in]streamStream handle.

◆ capsaDeleteAlbumFile()

Result capsaDeleteAlbumFile ( const CapsAlbumFileId file_id)

Deletes an AlbumFile corresponding to the specified CapsAlbumFileId.

Parameters
[in]file_idCapsAlbumFileId

◆ capsaForceAlbumUnmounted()

Result capsaForceAlbumUnmounted ( CapsAlbumStorage  storage)

Unmounts the specified AlbumStorage.

Parameters
[in]storageCapsAlbumStorage

◆ capsaGetAlbumCache()

Result capsaGetAlbumCache ( CapsAlbumStorage  storage,
CapsAlbumCache cache 
)

Gets the AlbumCache of the specified AlbumStorage.

Note
Stubbed on [4.0.0+].
use capsaGetAlbumCacheEx instead.
Parameters
[in]storageCapsAlbumStorage
[out]cacheCapsAlbumCache

◆ capsaGetAlbumCacheEx()

Result capsaGetAlbumCacheEx ( CapsAlbumStorage  storage,
CapsAlbumFileContents  contents,
CapsAlbumCache cache 
)

Gets the AlbumCache for the specified type of the specified AlbumStorage.

Parameters
[in]storageCapsAlbumStorage
[in]contentsCapsAlbumFileContents
[out]cacheCapsAlbumCache

◆ capsaGetAlbumEntryFromApplicationAlbumEntry()

Result capsaGetAlbumEntryFromApplicationAlbumEntry ( CapsAlbumEntry entry,
const CapsApplicationAlbumEntry application_entry,
u64  application_id 
)

Load an CapsAlbumEntry from a CapsApplicationAlbumEntry and an ApplicationId.

Note
Only available on [2.0.0+].
Parameters
[out]entryCapsAlbumEntry
[in]application_entryCapsApplicationAlbumEntry
[in]application_idApplicationId

◆ capsaGetAlbumEntryFromApplicationAlbumEntryAruid()

Result capsaGetAlbumEntryFromApplicationAlbumEntryAruid ( CapsAlbumEntry entry,
const CapsApplicationAlbumEntry application_entry 
)

Load an CapsAlbumEntry from a CapsApplicationAlbumEntry and an AppletResourceUserId.

Note
Only available on [2.0.0+].
Parameters
[out]entryCapsAlbumEntry
[in]application_entryCapsApplicationAlbumEntry

◆ capsaGetAlbumFileCount()

Result capsaGetAlbumFileCount ( CapsAlbumStorage  storage,
u64 count 
)

Gets the amount of files at a AlbumStorage.

Parameters
[in]storageCapsAlbumStorage
[out]countAmount of files.

◆ capsaGetAlbumFileCountEx0()

Result capsaGetAlbumFileCountEx0 ( CapsAlbumStorage  storage,
u8  flags,
u64 count 
)

Gets the amount of files of the specified type at a AlbumStorage.

Note
Only available on [5.0.0+].
Parameters
[in]storageCapsAlbumStorage
[in]flagsCapsAlbumFileContentsFlag
[out]countAmount of files.

◆ capsaGetAlbumFileList()

Result capsaGetAlbumFileList ( CapsAlbumStorage  storage,
u64 out,
CapsAlbumEntry entries,
u64  count 
)

Gets a listing of CapsAlbumEntry, where the AlbumFile's storage matches the input one.

Parameters
[in]storageCapsAlbumStorage
[out]outTotal output entries.
[out]entriesOutput array of CapsAlbumEntry.
[in]countReserved entry count.

◆ capsaGetAlbumFileListEx0()

Result capsaGetAlbumFileListEx0 ( CapsAlbumStorage  storage,
u8  flags,
u64 out,
CapsAlbumEntry entries,
u64  count 
)

Gets a listing of CapsAlbumEntry, where the AlbumFile's storage and type matches the input one.

Note
Only available on [5.0.0+].
Parameters
[in]storageCapsAlbumStorage
[in]flagsCapsAlbumFileContentsFlag
[out]outTotal output entries.
[out]entriesOutput array of CapsAlbumEntry.
[in]countReserved entry count.

◆ capsaGetAlbumFileSize()

Result capsaGetAlbumFileSize ( const CapsAlbumFileId file_id,
u64 size 
)

Gets the size for the specified AlbumFile.

Parameters
[in]file_idCapsAlbumFileId
[out]sizeSize of the file.

◆ capsaGetAlbumMountResult()

Result capsaGetAlbumMountResult ( CapsAlbumStorage  storage)

Returns the result for a AlbumStorage mount.

Note
Only available on [4.0.0+].
Parameters
[in]storageCapsAlbumStorage

◆ capsaGetAlbumMovieReadStreamBrokenReason()

Result capsaGetAlbumMovieReadStreamBrokenReason ( u64  stream)

Gets the BrokenReason for an AlbumMovieStream.

Note
Official sw doesn't use this.
Only available on [4.0.0+].
Parameters
[in]streamStream handle.

◆ capsaGetAlbumMovieReadStreamImageDataSize()

Result capsaGetAlbumMovieReadStreamImageDataSize ( u64  stream,
u64 size 
)

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

Note
Only available on [4.0.0+].
Parameters
[in]streamStream handle.
[out]sizeExpected size of an Image.

◆ capsaGetAlbumMovieStreamSize()

Result capsaGetAlbumMovieStreamSize ( u64  stream,
u64 size 
)

Gets the data size of an AlbumMovieStream.

Note
Only available on [4.0.0+].
Parameters
[in]streamStream handle.
[out]sizeSize of the actual MP4, without the JPEG at the end.

◆ capsaGetAlbumUsage()

Result capsaGetAlbumUsage ( CapsAlbumStorage  storage,
CapsAlbumUsage2 out 
)

Returns the AlbumUsage for a specified CapsAlbumStorage.

Parameters
[in]storageCapsAlbumStorage
[out]outCapsAlbumUsage2

◆ capsaGetAlbumUsage16()

Result capsaGetAlbumUsage16 ( CapsAlbumStorage  storage,
u8  flags,
CapsAlbumUsage16 out 
)

Returns the AlbumUsage for a specified CapsAlbumStorage.

Note
Only available on [4.0.0+].
Parameters
[in]storageCapsAlbumStorage
[in]flagsCapsAlbumFileContentsFlag
[out]outCapsAlbumUsage16

◆ capsaGetAlbumUsage3()

Result capsaGetAlbumUsage3 ( CapsAlbumStorage  storage,
CapsAlbumUsage3 out 
)

Returns the AlbumUsage for a specified CapsAlbumStorage.

Note
Only available on [4.0.0+].
Parameters
[in]storageCapsAlbumStorage
[out]outCapsAlbumUsage3

◆ capsaGetAutoSavingStorage()

Result capsaGetAutoSavingStorage ( CapsAlbumStorage storage)

Gets the currently set autosaving storage.

Note
Wrapper around setsysGetPrimaryAlbumStorage but defaults to NAND if SD isn't available.
Parameters
[out]storageCapsAlbumStorage

◆ capsaGetLastOverlayMovieThumbnail()

Result capsaGetLastOverlayMovieThumbnail ( CapsAlbumFileId file_id,
u64 out_size,
void *  image,
u64  image_size 
)

Returns the image from the last shown Movie Overlay.

Note
Only available on [4.0.0+].
Parameters
[out]file_idCapsAlbumFileId
[out]out_sizeSize of the thumbnail image. Always 0x5100.
[out]imageRGBA8 image output buffer.
[in]image_sizeImage buffer size, should be at least large enough for RGBA8 96×54.

◆ capsaGetLastOverlayScreenShotThumbnail()

Result capsaGetLastOverlayScreenShotThumbnail ( CapsAlbumFileId file_id,
u64 out_size,
void *  image,
u64  image_size 
)

Returns the image from the last shown ScreenShot Overlay.

Parameters
[out]file_idCapsAlbumFileId
[out]out_sizeSize of the thumbnail image. Always 0x5100.
[out]imageRGBA8 image output buffer.
[in]image_sizeImage buffer size, should be at least large enough for RGBA8 96×54.

◆ capsaGetMinMaxAppletId()

Result capsaGetMinMaxAppletId ( bool *  success,
u64 min,
u64 max 
)

Returns the start and end of the Applet Id range.

Note
Only available on [6.0.0+].
Parameters
[out]successReturns bool over whether the call was handled or not.
[out]minMimimum applet id. Always 0x0100000000001000
[out]maxMaximum applet id. Always 0x0100000000001FFF

◆ capsaGetRequiredStorageSpaceSizeToCopyAll()

Result capsaGetRequiredStorageSpaceSizeToCopyAll ( CapsAlbumStorage  dst_storage,
CapsAlbumStorage  src_storage,
u64 out 
)

Gets required size to copy all files from one Storage to another.

Parameters
[in]dst_storageCapsAlbumStorage
[in]src_storageCapsAlbumStorage
[out]outRequired storage space size.

◆ capsaIsAlbumMounted()

Result capsaIsAlbumMounted ( CapsAlbumStorage  storage,
bool *  is_mounted 
)

Gets the mount status of the specified CapsAlbumStorage.

Parameters
[in]storageCapsAlbumStorage
[out]is_mountedBoolean over whether the storage is mounted or not.

◆ capsaLoadAlbumFile()

Result capsaLoadAlbumFile ( const CapsAlbumFileId file_id,
u64 out_size,
void *  filebuf,
u64  filebuf_size 
)

Loads a file into the specified buffer.

Parameters
[in]file_idCapsAlbumFileId
[out]out_sizeSize of the AlbumFile.
[out]filebufFile output buffer.
[in]filebuf_sizeSize of the filebuf.

◆ capsaLoadAlbumFileThumbnail()

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

Load the Thumbnail for the specified AlbumFile.

Note
Will always be 320x180.
Parameters
[in]file_idCapsAlbumFileId
[out]out_sizeSize of the Thumbnail.
[out]imageJPEG image output buffer.
[in]image_sizeImage buffer size.

◆ capsaLoadAlbumScreenShotImage()

Result capsaLoadAlbumScreenShotImage ( u64 width,
u64 height,
const CapsAlbumFileId file_id,
void *  image,
u64  image_size,
void *  workbuf,
u64  workbuf_size 
)

Load the ScreenShotImage for the specified AlbumFile.

Note
Only available on [2.0.0+].
Parameters
[out]widthOutput image width. Optional, can be NULL.
[out]heightOutput image height. Optional, can be NULL.
[in]file_idCapsAlbumFileId
[out]imageRGBA8 image output buffer.
[in]image_sizeImage buffer size, should be at least large enough for RGBA8 1280x720.
[out]workbufWork buffer, cleared to 0 by the cmd before it returns.
[in]workbuf_sizeWork buffer size, must be at least the size of the JPEG within the AlbumFile.

◆ capsaLoadAlbumScreenShotImageEx()

Result capsaLoadAlbumScreenShotImageEx ( u64 width,
u64 height,
const CapsAlbumFileId file_id,
const CapsScreenShotDecodeOption opts,
void *  image,
u64  image_size,
void *  workbuf,
u64  workbuf_size 
)

Load the ScreenShotImage for the specified AlbumFile.

Note
Only available on [3.0.0+].
Parameters
[out]widthOutput image width. Optional, can be NULL.
[out]heightOutput image height. Optional, can be NULL.
[in]file_idCapsAlbumFileId
[in]optsCapsScreenShotDecodeOption
[out]imageRGBA8 image output buffer.
[in]image_sizeImage buffer size, should be at least large enough for RGBA8 1280x720.
[out]workbufWork buffer, cleared to 0 by the cmd before it returns.
[in]workbuf_sizeWork buffer size, must be at least the size of the JPEG within the AlbumFile.

◆ capsaLoadAlbumScreenShotImageEx0()

Result capsaLoadAlbumScreenShotImageEx0 ( u64 width,
u64 height,
CapsScreenShotAttribute attr,
const CapsAlbumFileId file_id,
const CapsScreenShotDecodeOption opts,
void *  image,
u64  image_size,
void *  workbuf,
u64  workbuf_size 
)

Load the ScreenShotImage for the specified AlbumFile.

Note
Only available on [3.0.0+].
Parameters
[out]widthOutput image width. Optional, can be NULL.
[out]heightOutput image height. Optional, can be NULL.
[out]attrCapsScreenShotAttribute
[in]file_idCapsAlbumFileId
[in]optsCapsScreenShotDecodeOption
[out]imageRGBA8 image output buffer.
[in]image_sizeImage buffer size, should be at least large enough for RGBA8 1280x720.
[out]workbufWork buffer, cleared to 0 by the cmd before it returns.
[in]workbuf_sizeWork buffer size, must be at least the size of the JPEG within the AlbumFile.

◆ capsaLoadAlbumScreenShotImageEx1()

Result capsaLoadAlbumScreenShotImageEx1 ( const CapsAlbumFileId file_id,
const CapsScreenShotDecodeOption opts,
CapsLoadAlbumScreenShotImageOutput out,
void *  image,
u64  image_size,
void *  workbuf,
u64  workbuf_size 
)

Load the ScreenShotImage for the specified AlbumFile.

Note
Only available on [4.0.0+].
Parameters
[in]file_idCapsAlbumFileId
[in]optsCapsScreenShotDecodeOption
[out]outCapsLoadAlbumScreenShotImageOutput
[out]imageRGBA8 image output buffer.
[in]image_sizeImage buffer size, should be at least large enough for RGBA8 1280x720.
[out]workbufWork buffer, cleared to 0 by the cmd before it returns.
[in]workbuf_sizeWork buffer size, must be at least the size of the JPEG within the AlbumFile.

◆ capsaLoadAlbumScreenShotThumbnailImage()

Result capsaLoadAlbumScreenShotThumbnailImage ( u64 width,
u64 height,
const CapsAlbumFileId file_id,
void *  image,
u64  image_size,
void *  workbuf,
u64  workbuf_size 
)

Load the ScreenShotThumbnailImage for the specified AlbumFile.

Note
Only available on [2.0.0+].
Parameters
[out]widthOutput image width. Optional, can be NULL.
[out]heightOutput image height. Optional, can be NULL.
[in]file_idCapsAlbumFileId
[out]imageRGBA8 image output buffer.
[in]image_sizeImage buffer size, should be at least large enough for RGBA8 320x180.
[out]workbufWork buffer, cleared to 0 by the cmd before it returns.
[in]workbuf_sizeWork buffer size, must be at least the size of the JPEG within the AlbumFile.

◆ capsaLoadAlbumScreenShotThumbnailImageEx()

Result capsaLoadAlbumScreenShotThumbnailImageEx ( u64 width,
u64 height,
const CapsAlbumFileId file_id,
const CapsScreenShotDecodeOption opts,
void *  image,
u64  image_size,
void *  workbuf,
u64  workbuf_size 
)

Load the ScreenShotThumbnailImage for the specified AlbumFile.

Note
Only available on [3.0.0+].
Parameters
[out]widthOutput image width. Optional, can be NULL.
[out]heightOutput image height. Optional, can be NULL.
[in]file_idCapsAlbumFileId
[in]optsCapsScreenShotDecodeOption
[out]imageRGBA8 image output buffer.
[in]image_sizeImage buffer size, should be at least large enough for RGBA8 320x180.
[out]workbufWork buffer, cleared to 0 by the cmd before it returns.
[in]workbuf_sizeWork buffer size, must be at least the size of the JPEG within the AlbumFile.

◆ capsaLoadAlbumScreenShotThumbnailImageEx1()

Result capsaLoadAlbumScreenShotThumbnailImageEx1 ( const CapsAlbumFileId file_id,
const CapsScreenShotDecodeOption opts,
CapsLoadAlbumScreenShotImageOutput out,
void *  image,
u64  image_size,
void *  workbuf,
u64  workbuf_size 
)

Load the ScreenShotThumbnailImage for the specified AlbumFile.

Note
Only available on [4.0.0+].
Parameters
[in]file_idCapsAlbumFileId
[in]optsCapsScreenShotDecodeOption
[out]outCapsLoadAlbumScreenShotImageOutput
[out]imageRGBA8 image output buffer.
[in]image_sizeImage buffer size, should be at least large enough for RGBA8 320x180.
[out]workbufWork buffer, cleared to 0 by the cmd before it returns.
[in]workbuf_sizeWork buffer size, must be at least the size of the JPEG within the AlbumFile.

◆ capsaOpenAlbumMovieStream()

Result capsaOpenAlbumMovieStream ( u64 stream,
const CapsAlbumFileId file_id 
)

Opens an AlbumMovieStream.

Note
This opens IAlbumAccessorSession if not previously opened, it's closed during capsaExit.
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]streamStream handle.
[in]entryCapsAlbumFileId

◆ capsaReadFileAttributeFromAlbumMovieReadStream()

Result capsaReadFileAttributeFromAlbumMovieReadStream ( u64  stream,
CapsScreenShotAttribute attr 
)

Gets the file attribute of an AlbumMovieStream.

Note
Only available on [4.0.0+].
Parameters
[in]streamStream handle.
[out]attrCapsScreenShotAttribute

◆ capsaReadImageDataFromAlbumMovieReadStream()

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

Reads data of an Image taken from an AlbumMovieStream.

Note
Only available on [4.0.0+].
Parameters
[in]streamStream handle.
[in]offsetOffset.
[out]Outputdata buffer.
[in]sizeData buffer size.
[out]actual_sizeActual read size.

◆ capsaReadMovieDataFromAlbumMovieReadStream()

Result capsaReadMovieDataFromAlbumMovieReadStream ( 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 capsaGetAlbumMovieStreamSize, 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]streamStream handle.
[in]offsetOffset.
[out]Outputdata buffer.
[in]sizeData buffer size.
[out]actual_sizeActual read size.

◆ capsaRefreshAlbumCache()

Result capsaRefreshAlbumCache ( CapsAlbumStorage  storage)

Refreshs Album Cache for the specified AlbumStorage.

Parameters
[in]storageCapsAlbumStorage

◆ capsaResetAlbumMountStatus()

Result capsaResetAlbumMountStatus ( CapsAlbumStorage  storage)

Resets mount status for the specified AlbumStorage.

Note
Mounts the Storage if available.
Parameters
[in]storageCapsAlbumStorage

◆ capsaStorageCopyAlbumFile()

Result capsaStorageCopyAlbumFile ( const CapsAlbumFileId file_id,
CapsAlbumStorage  dst_storage 
)

Copies an AlbumFile to the specified CapsAlbumStorage.

Parameters
[in]file_idCapsAlbumFileId
[in]dst_storageCapsAlbumStorage

◆ capsLoadAlbumScreenShotThumbnailImageEx0()

Result capsLoadAlbumScreenShotThumbnailImageEx0 ( u64 width,
u64 height,
CapsScreenShotAttribute attr,
const CapsAlbumFileId file_id,
const CapsScreenShotDecodeOption opts,
void *  image,
u64  image_size,
void *  workbuf,
u64  workbuf_size 
)

Load the ScreenShotThumbnailImage for the specified AlbumFile.

Note
Only available on [3.0.0+].
Parameters
[out]widthOutput image width. Optional, can be NULL.
[out]heightOutput image height. Optional, can be NULL.
[out]attrCapsScreenShotAttribute
[in]file_idCapsAlbumFileId
[in]optsCapsScreenShotDecodeOption
[out]imageRGBA8 image output buffer.
[in]image_sizeImage buffer size, should be at least large enough for RGBA8 320x180.
[out]workbufWork buffer, cleared to 0 by the cmd before it returns.
[in]workbuf_sizeWork buffer size, must be at least the size of the JPEG within the AlbumFile.