NVIDIA DeepStream SDK API Reference

9.1 Release
sources/libs/nvmsgconv_audio/nvmsgconv.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2020-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: Apache-2.0
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
26 #ifndef NVMSGCONV_H_
27 #define NVMSGCONV_H_
28 
29 
30 #include "nvdsmeta_schema.h"
31 #include <glib.h>
32 
33 #ifdef __cplusplus
34 extern "C"
35 {
36 #endif
37 
41 typedef struct NvDsMsg2pCtx {
44 
46  gpointer privData;
47 } NvDsMsg2pCtx;
48 
62 NvDsMsg2pCtx* nvds_msg2p_ctx_create (const gchar *file, NvDsPayloadType type);
63 
70 
86 nvds_msg2p_generate (NvDsMsg2pCtx *ctx, NvDsEvent *events, guint size);
87 
105 NvDsPayload**
106 nvds_msg2p_generate_multiple (NvDsMsg2pCtx *ctx, NvDsEvent *events, guint size, guint *payloadCount);
107 
114 void nvds_msg2p_release (NvDsMsg2pCtx *ctx, NvDsPayload *payload);
115 
116 #ifdef __cplusplus
117 }
118 #endif
119 #endif /* NVMSGCONV_H_ */
NvDsPayload
Holds payload metadata.
Definition: sources/includes/nvdsmeta_schema.h:488
nvds_msg2p_generate
NvDsPayload * nvds_msg2p_generate(NvDsMsg2pCtx *ctx, NvDsEvent *events, guint size)
This function will parse the NvDsEventMsgMeta and will generate message payload.
nvds_msg2p_release
void nvds_msg2p_release(NvDsMsg2pCtx *ctx, NvDsPayload *payload)
This function should be called to release memory allocated for payload.
NvDsMsg2pCtx::payloadType
NvDsPayloadType payloadType
type of payload to be generated.
Definition: sources/libs/nvmsgconv/nvmsgconv.h:42
nvds_msg2p_ctx_create
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...
_NvDsEvent
Holds event information.
Definition: sources/includes/nvdsmeta_schema.h:468
NvDsPayloadType
NvDsPayloadType
Defines payload type flags.
Definition: sources/includes/nvdsmeta_schema.h:95
NvDsMsg2pCtx::privData
gpointer privData
private to component.
Definition: sources/libs/nvmsgconv/nvmsgconv.h:45
nvds_msg2p_generate_multiple
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.
NvDsMsg2pCtx
NvDsMsg2pCtx is structure for library context.
Definition: sources/libs/nvmsgconv/nvmsgconv.h:40
NvDsMsg2pCtx
struct NvDsMsg2pCtx NvDsMsg2pCtx
NvDsMsg2pCtx is structure for library context.
nvds_msg2p_ctx_destroy
void nvds_msg2p_ctx_destroy(NvDsMsg2pCtx *ctx)
Release the resources allocated during context creation.