maxon.FileFormatInterface¶

Description¶

maxon.FileFormatInterface allows to implement and register file formats with its detection algorithm.

The maxon.FileFormats registry allows to register any format (e.g. FileFormats.Browsable, FileFormats.ImageJpg…).

Parent Class:

Child Class:

Detect(url, probeStream, flags)

Checks if the given URL or stream supports this file format.

FileFormatInterface.Detect(url, probeStream, flags)¶

Checks if the given URL or stream supports this file format.

Parameters

url (maxon.Url) – maxon.Url to check.
probeStream (Optional[maxon.InputStreamRef]) – Optional stream to read file content from.
flags (maxon.FILEFORMATDETECTIONFLAGS) – Detection flags.

Returns

True if the URL or stream fits this file format implementation.

Return type

bool

Category	Option	Description
Query	Words and phrases	Search is case-insensitive. Put a phrase in quotes for an exact match. Quoted phrases require every word and disable fuzzy matching.
Terms	OR / AND	Choose whether to match any term or require all terms.
Fuzzy	On / Off	Toggle approximate and prefix matches. Quoted phrases always use strict matching.
Results	Sparse / Dense	Sparse groups multiple hits for one entity and hides its owned API members when the class or module itself matches. Dense lists each match separately.
Sort by	Type / Relevance	Group results by entity type then rank within each group, or rank all results by relevance.
Content	All / API / Manuals / Examples / Resources	Search all documentation, API documentation, manuals, the examples index, or the resources index. Code examples embedded in other sections retain their own content area.
Entity	All / Page / Module / Class / Function / Attribute / Description / Node / Symbol / Icon	Page covers results without a specific entity type. Resource entity types are available with All or Resources; API entity types are available with All or API.
Location	All / Text / Code / Name / Signature	Text covers everything outside code, names, and signatures. Name and Signature are available with All or API.