libnx
v4.8.0
|
Application Album (caps:u) service IPC wrapper. More...
#include "../types.h"
#include "../sf/service.h"
#include "../services/caps.h"
#include "../services/acc.h"
Go to the source code of this file.
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. More... | |
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. More... | |
Result | capsuGetAlbumFileList3 (CapsApplicationAlbumEntry *entries, s32 count, CapsContentType type, const CapsAlbumFileDateTime *start_datetime, const CapsAlbumFileDateTime *end_datetime, s32 *total_entries) |
Gets a listing of CapsApplicationAlbumEntry. More... | |
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. More... | |
Result | capsuDeleteAlbumFile (CapsContentType type, const CapsApplicationAlbumFileEntry *entry) |
Deletes the specified AlbumFile. More... | |
Result | capsuGetAlbumFileSize (const CapsApplicationAlbumFileEntry *entry, u64 *size) |
Gets the filesize for the entire specified AlbumFile. More... | |
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. More... | |
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. More... | |
Result | capsuPrecheckToCreateContents (CapsContentType type, u64 unk) |
PrecheckToCreateContents. More... | |
Result | capsuOpenAlbumMovieStream (u64 *stream, const CapsApplicationAlbumFileEntry *entry) |
Opens an AlbumMovieStream. More... | |
Result | capsuCloseAlbumMovieStream (u64 stream) |
Closes an AlbumMovieStream. More... | |
Result | capsuGetAlbumMovieStreamSize (u64 stream, u64 *size) |
Gets the data size of an AlbumMovieStream. More... | |
Result | capsuReadAlbumMovieStream (u64 stream, s64 offset, void *buffer, size_t size, u64 *actual_size) |
Reads data from an AlbumMovieStream. More... | |
Result | capsuGetAlbumMovieStreamBrokenReason (u64 stream) |
Gets the BrokenReason for an AlbumMovieStream. More... | |
Application Album (caps:u) service IPC wrapper.
This is only usable with AlbumFiles associated with the current host Application.
Closes an AlbumMovieStream.
[in] | stream | Stream handle. |
Result capsuDeleteAlbumFile | ( | CapsContentType | type, |
const CapsApplicationAlbumFileEntry * | entry | ||
) |
Deletes the specified AlbumFile.
[in] | type | CapsContentType, must match CapsContentType_ExtraMovie. |
[in] | entry | CapsApplicationAlbumFileEntry |
Result capsuGetAlbumFileList3 | ( | CapsApplicationAlbumEntry * | entries, |
s32 | count, | ||
CapsContentType | type, | ||
const CapsAlbumFileDateTime * | start_datetime, | ||
const CapsAlbumFileDateTime * | end_datetime, | ||
s32 * | total_entries | ||
) |
Gets a listing of CapsApplicationAlbumEntry.
[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. |
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.
See also capssuSaveScreenShotWithUserIds.
[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. |
Result capsuGetAlbumFileListDeprecated1 | ( | CapsApplicationAlbumFileEntry * | entries, |
s32 | count, | ||
CapsContentType | type, | ||
const CapsAlbumFileDateTime * | start_datetime, | ||
const CapsAlbumFileDateTime * | end_datetime, | ||
s32 * | total_entries | ||
) |
Gets a listing of CapsApplicationAlbumFileEntry.
[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. |
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.
See also capssuSaveScreenShotWithUserIds.
[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. |
Result capsuGetAlbumFileSize | ( | const CapsApplicationAlbumFileEntry * | entry, |
u64 * | size | ||
) |
Gets the filesize for the entire specified AlbumFile.
[in] | entry | CapsApplicationAlbumFileEntry |
[out] | size | Output filesize. |
Gets the BrokenReason for an AlbumMovieStream.
[in] | stream | Stream handle. |
Gets the data size of an AlbumMovieStream.
[in] | stream | Stream handle. |
[out] | size | Size of the actual MP4, without the JPEG at the end. |
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.
[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 |
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.
[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 |
Result capsuOpenAlbumMovieStream | ( | u64 * | stream, |
const CapsApplicationAlbumFileEntry * | entry | ||
) |
Opens an AlbumMovieStream.
[out] | stream | Stream handle. |
[in] | entry | CapsApplicationAlbumFileEntry |
Result capsuPrecheckToCreateContents | ( | CapsContentType | type, |
u64 | unk | ||
) |
PrecheckToCreateContents.
Official sw only uses this with CapsContentType_ExtraMovie.
[in] | type | CapsContentType |
[in] | unk | Unknown. |
Result capsuReadAlbumMovieStream | ( | u64 | stream, |
s64 | offset, | ||
void * | buffer, | ||
size_t | size, | ||
u64 * | actual_size | ||
) |
Reads data from an AlbumMovieStream.
[in] | stream | Stream handle. |
[in] | offset | Offset. |
[out] | Output | data buffer. |
[in] | size | Data buffer size. |
[out] | actual_size | Actual read size. |