NVIDIA DeepStream: Message Schema Generation Library Interface
Description: This file specifies the NVIDIA DeepStream message schema generation library interface.
Definition in file nvmsgconv_audio/nvmsgconv.h.
Go to the source code of this file.
Data Structures | |
struct | NvDsMsg2pCtx |
NvDsMsg2pCtx is structure for library context. More... | |
Typedefs | |
typedef struct NvDsMsg2pCtx | NvDsMsg2pCtx |
NvDsMsg2pCtx is structure for library context. More... | |
Functions | |
NvDsMsg2pCtx * | nvds_msg2p_ctx_create (const gchar *file, NvDsPayloadType type) |
This function initializes the library with user defined options mentioned in the file and returns the handle to the context. More... | |
void | nvds_msg2p_ctx_destroy (NvDsMsg2pCtx *ctx) |
Release the resources allocated during context creation. More... | |
NvDsPayload * | nvds_msg2p_generate (NvDsMsg2pCtx *ctx, NvDsEvent *events, guint size) |
This function will parse the NvDsEventMsgMeta and will generate message payload. More... | |
NvDsPayload ** | nvds_msg2p_generate_multiple (NvDsMsg2pCtx *ctx, NvDsEvent *events, guint size, guint *payloadCount) |
This function will parse the NvDsEventMsgMeta and will generate multiple message payloads. More... | |
void | nvds_msg2p_release (NvDsMsg2pCtx *ctx, NvDsPayload *payload) |
This function should be called to release memory allocated for payload. More... | |
typedef struct NvDsMsg2pCtx NvDsMsg2pCtx |
NvDsMsg2pCtx is structure for library context.
NvDsMsg2pCtx* nvds_msg2p_ctx_create | ( | const gchar * | file, |
NvDsPayloadType | type | ||
) |
This function initializes the library with user defined options mentioned in the file and returns the handle to the context.
Static fields which should be part of message payload can be added to file instead of frame metadata.
[in] | file | name of file to read static properties from. |
[in] | type | type of payload to be generated. |
void nvds_msg2p_ctx_destroy | ( | NvDsMsg2pCtx * | ctx | ) |
Release the resources allocated during context creation.
[in] | ctx | pointer to library context. |
NvDsPayload* nvds_msg2p_generate | ( | NvDsMsg2pCtx * | ctx, |
NvDsEvent * | events, | ||
guint | size | ||
) |
This function will parse the NvDsEventMsgMeta and will generate message payload.
Payload will be combination of static values read from configuration file and dynamic values received in meta. Payload will be generated based on the NvDsPayloadType type provided in context creation (e.g. Deepstream, Custom etc.).
[in] | ctx | pointer to library context. |
[in] | events | pointer to array of event objects. |
[in] | size | number of objects in array. |
NvDsPayload** nvds_msg2p_generate_multiple | ( | NvDsMsg2pCtx * | ctx, |
NvDsEvent * | events, | ||
guint | size, | ||
guint * | payloadCount | ||
) |
This function will parse the NvDsEventMsgMeta and will generate multiple message payloads.
Payloads will be combination of static values read from configuration file and dynamic values received in meta. Payloads will be generated based on the NvDsPayloadType type provided in context creation (e.g. Deepstream, Custom etc.).
[in] | ctx | pointer to library context. |
[in] | events | pointer to array of event objects. |
[in] | size | number of objects in array. |
[out] | payloadCount | number of payloads being returned by the function. |
void nvds_msg2p_release | ( | NvDsMsg2pCtx * | ctx, |
NvDsPayload * | payload | ||
) |
This function should be called to release memory allocated for payload.
[in] | ctx | pointer to library context. |
[in] | payload | pointer to object that needs to be released. |