VPI - Vision Programming Interface

1.0 Release

Payload

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

Typedefs

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

Functions

VPIStatus vpiPayloadGetBackend (VPIPayload payload, VPIBackend *backend)
 Returns the backend 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

◆ vpiPayloadDestroy()

void vpiPayloadDestroy ( VPIPayload  payload)

#include <vpi/Stream.h>

Deallocates the payload object and all associated resources.

Parameters
[in]payloadpayload handle

◆ vpiPayloadGetBackend()

VPIStatus vpiPayloadGetBackend ( VPIPayload  payload,
VPIBackend backend 
)

#include <vpi/Stream.h>

Returns the backend associated with a payload.

Parameters
[in]payloadPayload to be queried
[out]backendThe backend associated with a payload
Returns
an error code on failure else VPI_SUCCESS