Track item set

Classes
struct	face_sdk__track_item_set
	Track item set. More...

Typedefs
typedef struct face_sdk__track_item_set	face_sdk__track_item_set_t
	Track item set.

Functions
bool	face_sdk__make_track_item_set (face_sdk__track_item_set_t **set)
	Makes face_sdk__track_item_set_t collection with items of type face_sdk__track_item_t. More...
bool	face_sdk__track_item_set__get_size (const face_sdk__track_item_set_t *set, uint64_t *value)
	Retrieves number of items stored in collection. More...
bool	face_sdk__track_item_set__get_at (const face_sdk__track_item_set_t *set, uint64_t pos, face_sdk__track_item_t **item)
	Retrieves item by index. More...
bool	face_sdk__track_item_set__set_at (face_sdk__track_item_set_t *set, uint64_t pos, const face_sdk__track_item_t *item)
	Sets item by index. More...
bool	face_sdk__track_item_set__append (face_sdk__track_item_set_t *set, const face_sdk__track_item_t *item)
	Appends item into collection. More...
bool	face_sdk__track_item_set__remove_at (face_sdk__track_item_set_t *set, uint64_t pos)
	Removes item by index. More...
bool	face_sdk__track_item_set__clear (face_sdk__track_item_set_t *set)
	Removes all items from collection. More...
bool	face_sdk__track_item_set__get_addr (const face_sdk__track_item_set_t *set, uint64_t *addr)
	Retrieves face_sdk__track_item_set_t object address. More...
void	face_sdk__track_item_set_free (face_sdk__track_item_set_t *set)
	Destroys face_sdk__track_item_set_t object. More...

Detailed Description

Function Documentation

face_sdk__make_track_item_set()

bool face_sdk__make_track_item_set

(

face_sdk__track_item_set_t **

set

)

Makes face_sdk__track_item_set_t collection with items of type face_sdk__track_item_t.

Parameters

[out]

track_item_set

face_sdk__track_item_set_t object

Returns

true on success, false on failure. See last_error

face_sdk__track_item_set__append()

bool face_sdk__track_item_set__append	(	face_sdk__track_item_set_t *	set,
		const face_sdk__track_item_t *	item
	)

Appends item into collection.

Parameters

[in]	track_item_set	face_sdk__track_item_set_t object
[in]	item	Item

Returns

true on success, false on failure. See last_error

face_sdk__track_item_set__clear()

bool face_sdk__track_item_set__clear

(

face_sdk__track_item_set_t *

set

)

Removes all items from collection.

Parameters

[in]

track_item_set

face_sdk__track_item_set_t object

Returns

true on success, false on failure. See last_error

face_sdk__track_item_set__get_addr()

bool face_sdk__track_item_set__get_addr	(	const face_sdk__track_item_set_t *	set,
		uint64_t *	addr
	)

Retrieves face_sdk__track_item_set_t object address.

Parameters

[in]	track_item_set	face_sdk__track_item_set_t object
[out]	addr	Object address

Returns

true on success, false on failure. See last_error

face_sdk__track_item_set__get_at()

bool face_sdk__track_item_set__get_at	(	const face_sdk__track_item_set_t *	set,
		uint64_t	pos,
		face_sdk__track_item_t **	item
	)

Retrieves item by index.

Parameters

[in]	track_item_set	face_sdk__track_item_set_t object
[in]	pos	Item index
[out]	value	Item

Returns

true on success, false on failure. See last_error

face_sdk__track_item_set__get_size()

bool face_sdk__track_item_set__get_size	(	const face_sdk__track_item_set_t *	set,
		uint64_t *	value
	)

Retrieves number of items stored in collection.

Parameters

[in]	track_item_set	face_sdk__track_item_set_t object
[out]	value	Items count

Returns

true on success, false on failure. See last_error

face_sdk__track_item_set__remove_at()

bool face_sdk__track_item_set__remove_at	(	face_sdk__track_item_set_t *	set,
		uint64_t	pos
	)

Removes item by index.

Parameters

[in]	track_item_set	face_sdk__track_item_set_t object
[in]	pos	Item index

Returns

true on success, false on failure. See last_error

face_sdk__track_item_set__set_at()

bool face_sdk__track_item_set__set_at	(	face_sdk__track_item_set_t *	set,
		uint64_t	pos,
		const face_sdk__track_item_t *	item
	)

Sets item by index.

Parameters

[in]	track_item_set	face_sdk__track_item_set_t object
[in]	pos	Item index
[in]	item	Item object

Returns

true on success, false on failure. See last_error

face_sdk__track_item_set_free()

void face_sdk__track_item_set_free

(

face_sdk__track_item_set_t *

set

)

Destroys face_sdk__track_item_set_t object.

Parameters

[in]

track_item_set

face_sdk__track_item_set_t object