ImageLoadersRegistry Class

Summary: Represents the image loaders registry.

Module: aspose.imaging

Full Name: aspose.imaging.ImageLoadersRegistry

Properties

NameTypeAccessDescription
registered_descriptors [static]IImageLoaderDescriptor[]rGets the registered descriptors.
registered_formats [static]FileFormatrGets the registered image loading formats.

Methods

NameDescription
create_first_supported_loader(stream, load_options)Creates the first found loader suitable for the specified stream and optionally the loadOptions.
get_first_supported_descriptor(stream, load_options)Gets the fist found supported descriptor suitable for the specified stream and optionally the loadOptions.
get_first_supported_descriptor_by_file_format(file_format)Gets the first supported file format by its type name.
get_first_supported_descriptor_by_type_name(descriptor_type_name)Gets the first supported descriptor by its type name.
register(image_loader_descriptor)Registers the specified image loader descriptor.
register_loader(loader_descriptor)Registers the loader.
unregister_loader(loader_descriptor)Unregisters the loader.

Method: create_first_supported_loader(stream, load_options) [static]

 create_first_supported_loader(stream, load_options) 

Creates the first found loader suitable for the specified stream and optionally the loadOptions.

Parameters:

ParameterTypeDescription
stream_io.BufferedRandomThe stream.
load_optionsLoadOptionsThe load options.

Returns

TypeDescription
IImageLoaderThe loader which supports the specified stream and loadOptions or null if no such loader is found.

Method: get_first_supported_descriptor(stream, load_options) [static]

 get_first_supported_descriptor(stream, load_options) 

Gets the fist found supported descriptor suitable for the specified stream and optionally the loadOptions.

Parameters:

ParameterTypeDescription
stream_io.BufferedRandomThe stream.
load_optionsLoadOptionsThe load options.

Returns

TypeDescription
IImageLoaderDescriptorThe loader descriptor which supports the specified stream and loadOptions or null if no such descriptor is found.

Method: get_first_supported_descriptor_by_file_format(file_format) [static]

 get_first_supported_descriptor_by_file_format(file_format) 

Gets the first supported file format by its type name.

Parameters:

ParameterTypeDescription
file_formatFileFormatThe supported descriptor file format.

Returns

TypeDescription
IImageLoaderDescriptorThe first found loader descriptor or null if not such descriptor is found.

Method: get_first_supported_descriptor_by_type_name(descriptor_type_name) [static]

 get_first_supported_descriptor_by_type_name(descriptor_type_name) 

Gets the first supported descriptor by its type name.

Parameters:

ParameterTypeDescription
descriptor_type_namestringThe descriptor type name.

Returns

TypeDescription
IImageLoaderDescriptorThe first found loader descriptor or null if not such descriptor is found.

Method: register(image_loader_descriptor) [static]

 register(image_loader_descriptor) 

Registers the specified image loader descriptor.

Parameters:

ParameterTypeDescription
image_loader_descriptorIImageLoaderDescriptorThe image loader descriptor.

Method: register_loader(loader_descriptor) [static]

 register_loader(loader_descriptor) 

Registers the loader.

Parameters:

ParameterTypeDescription
loader_descriptorIImageLoaderDescriptorThe loader descriptor to register.

Method: unregister_loader(loader_descriptor) [static]

 unregister_loader(loader_descriptor) 

Unregisters the loader.

Parameters:

ParameterTypeDescription
loader_descriptorIImageLoaderDescriptorThe loader descriptor to unregister.