| synopsis || arguments || prev || next |
void add_metareq( kdu_uint32 box_type, int qualifier=KDU_MRQ_DEFAULT, bool priority=false, int byte_limit=INT_MAX, bool recurse=false, kdu_long root_bin_id=0, int max_depth=INT_MAX)
Java: void Add_metareq( long box_type, int qualifier, boolean priority, int byte_limit, boolean recurse, long root_bin_id, int max_depth)
[Declared in "../apps/compressed_io/kdu_client_window.h"]
Use this function to add a new entry to the metareq list. The order of elements in the list is not important. Each element in the list describes a particular box_type of interest. This should either be a valid JP2-family box signature (4 character code) or 0; in the latter case, all box types are implied. The interpretation of the other arguments are described below.
JP2-family box 4 character code, or else 0 (wildcard).
Must be a union of one or more of the flags, KDU_MRQ_ALL, KDU_MRQ_GLOBAL, KDU_MRQ_STREAM and KDU_MRQ_WINDOW. At least one of these flags must be present. The default value, KDU_MRQ_DEFAULT is equivalent to the union of KDU_MRQ_GLOBAL, KDU_MRQ_STREAM and KDU_MRQ_WINDOW. For a detailed explanation of the role played by these qualifiers, see the comments appearing with the kdu_metareq::qualifier member.
True if the boxes described by the new kdu_metareq structure are to be assigned higher priority than image data when the server determines the order in which to transmit information which is relevant to the window request. If false, these boxes will have lower priority than image data (unless the priority is boosted by another record in the metareq list). If no image data is to be returned (see metadata_only), the priority value may still have the effect of causing some high priority metadata to be sent before low priority metadata.
Indicates the maximum number of bytes from the contents of any JP2 box conforming to the new kdu_metareq record, which are of interest to the client. May not be negative. Note that this argument is ignored if recurse is true.
Indicates that the client is also interested in all descendants (via sub-boxes) of any box which matches the box_type and other attributes specified by the various arguments. If true, the byte_limit argument will be ignored, but treated as 0, meaning that the client is assumed to be interested only in the header of boxes which match the box_type and the descendants of such boxes.
Indicates the meta data-bin identifier of the data-bin which is to be used as the root when processing the new kdu_metareq record. If non-zero, the scope of the record is reduced to the set of JP2 boxes which are found in the indicated data-bin or are linked from it via placeholders.
Provides a limit on the maximum depth to which the server is expected to descend within the meta-data tree to find JP2 boxes conforming to the other attributes of this record. A value of 0 means that the client is interested only in boxes which are found at the top level of the data-bin identified by root_bin_id. A value of 1 means that the client is additionally interested in sub-boxes of boxes which are found at the top level of the data-bin identified by root_bin_id; and so forth.