Dynamsoft Panorama - API Reference
Functions
Results Functions

Functions

DPS_API int DPS_GetFinalResults (void *hStitcher, PanoramaResultArray **pResult)
 
DPS_API int DPS_GetRunningState (void *hStitcher, RunningState *pRunningState)
 
DPS_API int DPS_GetCompleteResultImage (PanoramaResult *pResult, DMBitmap **completeImage)
 
DPS_API void DPS_FreeDMBitmap (DMBitmap **pBmp)
 
DPS_API void DPS_FreePanoramaResults (PanoramaResultArray **pPresult)
 

Function Documentation

◆ DPS_FreeDMBitmap()

DPS_API void DPS_FreeDMBitmap ( DMBitmap **  pBmp)

Frees memory allocated for complete panorama result.

Parameters
[in]pBmpThe bmp image.
Code Snippet:
void* panorama = DPS_CreateInstance();
DPS_InitLicense(panorama, "t0260NwAAAHV***************");
int ret = DPS_StartPanoramaStitchingByBuffer(panorama, 1080, 1920, 3240, DPS_IPF_RGB_888);
DPS_AppendNewFrameByBuffer(panorama, pBuffer, 0);
PanoramaResultArray* pResult = NULL;
DPS_GetFinalResults(panorama, &pResult);
DMBitmap* completeImage = NULL;
DPS_GetCompleteResultImage((pResult->panoramaResult[0]), &completeImage);
DPS_FreeDMBitmap(&completeImage);
See also
C Functions

◆ DPS_FreePanoramaResults()

DPS_API void DPS_FreePanoramaResults ( PanoramaResultArray **  pPresult)

Frees memory allocated for stitched image and panorama result.

Parameters
[in]pPresultThe struct of panorama result array.
Code Snippet:
void* panorama = DPS_CreateInstance();
DPS_InitLicense(panorama, "t0260NwAAAHV***************");
int ret = DPS_StartPanoramaStitchingByBuffer(panorama, 1080, 1920, 3240, DPS_IPF_RGB_888);
DPS_AppendNewFrameByBuffer(panorama, pBuffer, 0);
DPS_GetFinalResults(panorama, &pResult);
See also
C Functions

◆ DPS_GetCompleteResultImage()

DPS_API int DPS_GetCompleteResultImage ( PanoramaResult pResult,
DMBitmap **  completeImage 
)

Gets the complete result image and barcodes.

Parameters
[in]pResultThe output panorama result which should be showed.
[in,out]completeImageThe output complete result image.
Returns
Returns error code. Returns 0 if the function operates successfully. You can call DPS_GetErrorString() to get detailed error message.
Code Snippet:
void* panorama = DPS_CreateInstance();
DPS_InitLicense(panorama, "t0260NwAAAHV***************");
int ret = DPS_StartPanoramaStitchingByBuffer(panorama, 1080, 1920, 3240, DPS_IPF_RGB_888);
DPS_AppendNewFrameByBuffer(panorama, pBuffer, 0);
PanoramaResultArray* pResult = NULL;
DPS_GetFinalResults(panorama, &pResult);
DMBitmap* completeImage = NULL;
DPS_GetCompleteResultImage((pResult->panoramaResult[0]), &completeImage);
DPS_FreeDMBitmap(&completeImage);
See also
C Functions

◆ DPS_GetFinalResults()

DPS_API int DPS_GetFinalResults ( void *  hStitcher,
PanoramaResultArray **  pResult 
)

Gets the result image and barcodes.

Parameters
[in]hStitcherHandle of the Panorama instance.
[in,out]pResultThe output panorama result array.
Returns
Returns error code. Returns 0 if the function operates successfully. You can call DPS_GetErrorString() to get detailed error message.
Code Snippet:
void* panorama = DPS_CreateInstance();
DPS_InitLicense(panorama, "t0260NwAAAHV***************");
int ret = DPS_StartPanoramaStitchingByBuffer(panorama, 1080, 1920, 3240, DPS_IPF_RGB_888);
DPS_AppendNewFrameByBuffer(panorama, pBuffer, 0);
PanoramaResultArray* pResult = NULL;
DPS_GetFinalResults(panorama, &pResult);
DMBitmap* completeImage = NULL;
DPS_GetCompleteResultImage((pResult->panoramaResult[0]), &completeImage);
DPS_FreeDMBitmap(&completeImage);
Remarks:
DPS_StopPanoramaStitching() has to be successfully called before calling this method.
See also
C Functions

◆ DPS_GetRunningState()

DPS_API int DPS_GetRunningState ( void *  hStitcher,
RunningState pRunningState 
)

Gets running state of Panorama program.

Parameters
[in]hStitcherHandle of the Panorama instance.
[in,out]pRunningStateThe struct of running state.
Returns
Returns error code. Returns 0 if the function operates successfully. You can call DPS_GetErrorString() to get detailed error message.Possible returns are: DPS_OK; DPSERR_INPUT_NULL_POINTER;
Code Snippet:
void* panorama = DPS_CreateInstance();
DPS_InitLicense(panorama, "t0260NwAAAHV***************");
RunningState pRunningState;
int ret = DPS_StartPanoramaStitchingByBuffer(panorama, 1080, 1920, 3240, DPS_IPF_RGB_888);
DPS_AppendNewFrameByBuffer(panorama, pBuffer, 0);
DPS_GetRunningState(panorama, &pRunningState);
See also
C Functions