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

jp2_input_box::set_codestream_scope

Java: Jp2_input_box::Set_codestream_scope

virtual bool set_codestream_scope( kdu_long codestream_id, bool need_main_header=true)

Java: boolean Set_codestream_scope( long codestream_id, boolean need_main_header)

[Declared in "../apps/compressed_io/jp2.h"]

Go to class description.


Synopsis

This function may be used only with caching data sources and then only if the box is currently open, having a box-type of jp2_codestream_4cc (i.e., a contiguous code-stream box).

If the object supports the KDU_SOURCE_CAP_CACHED capability and the supplied codestream_id lies in the range of code-stream identifiers offered by the placeholder box which was used to construct this interface, the function sets the current read scope to the main header of the indicated code-stream.


Return Value

The function returns true only if the above conditions are satisfied and, either the whole of the main header is available in the cache, or the need_main_header argument is false (not the default).

Arguments

codestream_id [kdu_long]

need_main_header [bool]


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