Data container

Classes
struct	face_sdk__data_container
	The data container handle. The data container helps face_sdk to manage a data. More...

Typedefs
typedef FACE_SDK_EXTERN_C_BEGIN struct face_sdk__data_container	face_sdk__data_container_t
	The data container handle. The data container helps face_sdk to manage a data. More...

Functions
bool	face_sdk__data_container__get_addr (const face_sdk__data_container_t *data_container, uint64_t *addr)
	Retrieves face_sdk__data_container_t object address * *. More...
bool	face_sdk__load_data_container_from_file (const uint8_t *file_name, uint64_t file_name_size, face_sdk__data_container_t **data_container)
	Loads a data container from file. More...
bool	face_sdk__load_data_container (const uint8_t *data, uint64_t data_size, face_sdk__data_container_t **data_container)
	Loads a data container from memory. More...
void	face_sdk__data_container_free (face_sdk__data_container_t *data_container)
	Destroys face_sdk__data_container object. More...

Detailed Description

Typedef Documentation

face_sdk__data_container_t

typedef FACE_SDK_EXTERN_C_BEGIN struct face_sdk__data_container face_sdk__data_container_t

The data container handle. The data container helps face_sdk to manage a data.

Data container is for internal usage. The FaceSDK loads files from known paths (see Known paths).
If it's not acceptable you may use face_sdk__load_data_container_from_file() and face_sdk__load_data_container() functions for loading files from specified paths or from memory.

Function Documentation

face_sdk__data_container__get_addr()

bool face_sdk__data_container__get_addr	(	const face_sdk__data_container_t *	data_container,
		uint64_t *	addr
	)

Retrieves face_sdk__data_container_t object address * *.

Parameters

[in]	data_container	face_sdk__data_container_t object *
[out]	addr	Object address * *

Returns

true on success, false on failure. See last_error

face_sdk__data_container_free()

void face_sdk__data_container_free

(

face_sdk__data_container_t *

data_container

)

Destroys face_sdk__data_container object.

Parameters

[in]

data_container

Data Container object

face_sdk__load_data_container()

bool face_sdk__load_data_container	(	const uint8_t *	data,
		uint64_t	data_size,
		face_sdk__data_container_t **	data_container
	)

Loads a data container from memory.

Parameters

[in]	data	Binary data with saved data_container
[in]	data_size	Data buffer size
[out]	data_container	Data Container object

Returns

true on success, false on failure. See last_error

face_sdk__load_data_container_from_file()

bool face_sdk__load_data_container_from_file	(	const uint8_t *	file_name,
		uint64_t	file_name_size,
		face_sdk__data_container_t **	data_container
	)

Loads a data container from file.

Parameters

[in]	file_name	String containing path to a file. See text_encoding
[in]	file_name_size	Size in bytes of file_name string

Returns

true on success, false on failure. See last_error