VPI - Vision Programming Interface

3.2 Release

Payload

Declaration of payload handling functions and types;. More...

Typedefs

typedef struct VPIPayloadImpl * VPIPayload
 A handle to an algorithm payload.
 

Functions

VPIStatus vpiPayloadGetFlags (VPIPayload payload, uint64_t *flags)
 Returns the flags associated with a payload. More...
 
void vpiPayloadDestroy (VPIPayload payload)
 Deallocates the payload object and all associated resources. More...
 

Detailed Description

Declaration of payload handling functions and types;.

Function Documentation

◆ vpiPayloadGetFlags()

VPIStatus vpiPayloadGetFlags ( VPIPayload  payload,
uint64_t *  flags 
)

#include <vpi/Stream.h>

Returns the flags associated with a payload.

Parameters
[in]payloadPayload to be queried.
[out]flagsThe flags associated with a payload.
Return values
VPI_ERROR_INVALID_ARGUMENTOutput flags pointer is NULL.
VPI_SUCCESSOperation executed successfully.

◆ vpiPayloadDestroy()

void vpiPayloadDestroy ( VPIPayload  payload)

#include <vpi/Stream.h>

Deallocates the payload object and all associated resources.

Parameters
[in]payloadPayload handle. Passing NULL is allowed, to which the function simply does nothing.