Metadata Management

Functions
void	cloudx1_SetMetadata (struct cloudx1_CInstance *instance, const char *key, const char *value)
const char **	cloudx1_GetMetadataInfos (struct cloudx1_CInstance *instance)
void	cloudx1_FreeMetadataInfos (struct cloudx1_CInstance *instance, const char **infos)

Detailed Description

Metadata handling.

Metadata is used on-need, and might be used by extensions modules (Watermarking, Streaming, ...)

Function Documentation

cloudx1_FreeMetadataInfos()

void cloudx1_FreeMetadataInfos	(	struct cloudx1_CInstance *	instance,
		const char **	infos
	)

Frees the information returned by cloudx1_GetMetadataInfos.

Parameters

instance	the instance
infos	the infos

cloudx1_GetMetadataInfos()

const char** cloudx1_GetMetadataInfos

(

struct cloudx1_CInstance *

instance

)

Get information on known metadata keys.

Parameters

instance

the instance

Returns

a list of key,descriptions, null terminated, of known metadata keys used in process and extensions. May be null. Should be freed with cloudx1_FreeMetadataInfos

cloudx1_SetMetadata()

void cloudx1_SetMetadata	(	struct cloudx1_CInstance *	instance,
		const char *	key,
		const char *	value
	)

Adds the specific metadata to the process.

It can come from any thread, and will be used as soon as possible. Setting a null value erase the metadata, which is different from setting an empty string. Initial metadata might be set as soon as instance is created (and before update thread).

Parameters

instance	the instance
key	the metadata key. If key contains a dot (like wm.KEY), it will be sent only to the matching plugin (ie wm here) without the prefix (ie KEY here). Use empty prefix for routing to main only.
value	the metadata value or nullptr to erase it.