| synopsis || return value || arguments || prev || next |

kdu_serve_target::find_roi

Java: Kdu_serve_target::Find_roi

virtual int find_roi( int stream_id, const char * roi_name=NULL)

Java: int Find_roi( int stream_id, String roi_name)

[Declared in "../apps/kdu_server/kdu_serve.h"]

Go to class description.


Synopsis

Tries to match the supplied roi_name string with a known region of interest, as defined by the codestream whose index is given by stream_id. If a match is found, the function returns a positive integer identifier, which may be used to retrieve further details about the ROI. Otherwise, the function returns 0.


Return Value

A valid ROI is always strictly positive. 0 indicates that there was no match.

Arguments

stream_id [int]

roi_name [const char *]

If NULL, the function returns the index of a default (or dynamically assigned ROI). If none exists, the function again returns 0.


| top || synopsis || return value || arguments || prev || next |