|
Mako 7.5.0 API
|
|
Mako 7.5.0 API
|
JawsMako encompasses an API that is intended to provide a simpler and more flexible interface than that provided by its predecessor, EDL. It allows for simplified access to supported input types, providing easy APIs for accessing document assemblies, documents and pages, and for performing common tasks. It also provides methods of managing the amount of memory used by JawsMako. More...
Classes | |
| class | IEDLClassFactory |
| EDL Factory Interface allows one part of the EDL infrastructure to register class creation methods identified by either GUIDs and /or names (strings) and then another part of the EDL infrastructure to request the creation of instances of one or more of these classes by quoting the same GUID or name. More... | |
| class | CClassParams |
| EDL Object Interface. More... | |
| class | IEDLObject |
| IEDLObject is an abstract base class that is used by all classes that are intended to be created via an EDL class factory. More... | |
| class | IEDLTempStoreObject |
| A mechanism for storing and accessing temporary data for use with Jaws Mako. More... | |
| class | IEDLTempStore |
| A self-cleaning area for storage of temporary data in the form of streams. One per session, obtainable from an ISession. Exceptions of type IEDLError are thrown on failures. More... | |
| class | ISession |
| EDL session class. More... | |
| class | IRunnable |
| Interface to filter's runnable classes. More... | |
| class | CClassID |
| An object to represent a 128-bit globally unique ID. More... | |
| class | JawsMako::IJawsMako |
| An instance of the IJawsMako library. Only one instance of this object is currently allowed. This class may also be used as both an EDL factory and an EDL session, and passed to any EDL API that requires these objects. More... | |
| class | JawsMako::CTemporaryStoreParameters |
| Allows the temporary storage parameters to be optionally overridden. More... | |
Functions | |
| static JAWSMAKO_API IJawsMakoPtr | JawsMako::IJawsMako::create (const U8String &tempDir=U8String(""), const U8String &cacheDir=U8String(""), const CTemporaryStoreParameters &tempStoreParams=CTemporaryStoreParameters(), const std::map< std::string, std::string > &initialParams=std::map< std::string, std::string >()) |
| Create an IJawsMako instance. Only one may be created at any one time. | |
JawsMako encompasses an API that is intended to provide a simpler and more flexible interface than that provided by its predecessor, EDL. It allows for simplified access to supported input types, providing easy APIs for accessing document assemblies, documents and pages, and for performing common tasks. It also provides methods of managing the amount of memory used by JawsMako.
Errors are handled through exceptions of type JawsMako::IError which is currently a synonym for EDL::IEDLError.
|
static |
Create an IJawsMako instance.
Only one may be created at any one time.
| tempDir | An absolute path to a directory JawsMako can use to store temporary files. If a non-empty string is passed, the directory must exist. If an empty string is passed, JawsMako will choose an appropriate temporary location based on the host operating system. |
| cacheDir | An absolute path to a directory where JawsMako may persistently store cached information. If an empty string is passed, JawsMako will choose an appropriate location based on the host operating system. If a directory is passed it must exist. |
| tempStoreParams | The desired temporary store parameters. See CTemporaryStoreParams for details. |
| initialParams | The set of initial parameters for the JawsMako instance. Currently this is used for licensing. |