mxOmfCreateOmfSdk()

 

Create (instantiate and initilize) the SDK

 

 mxOmfCreateOmfSdk() creates the base instantiation of the SDK.

 It results in a returned pointer to the SDK, used (passed in) to all

 subsequent calls to the SDK functions.

 

 Callbacks and Settings

 You must provide an initialized MxOmfAppIFInfo_t struct with all

 callback handlers and mxOmfInSettings_t and/or mxOmfOutSettings_t

 as required.

 See MxOmfAppIFInfo_t

 See OmfSup.cpp >> OmfSetAppInterface1() of MaxOmfSdkDemo

 See CMaxOmfSdkDemoDoc::OnOpenDocument() of MaxOmfSdkDemo

 

 Product ID Prefix

 If you are creating the SDK for export purpose you must provide a valid

 Product ID Prefix in the

 pMxOmfAppIFInfo_t->m_mxOmfProductID_t->m_lProductOmfUIDPrefix member.

 This will be used as the mxOmfUID_t->prefix value of the exported Omf Mob

 identiies. See Using Unique Identifiers

 if param nMxOmfPurpose equals MXOMF_PURPOSE_EXPORT or MXOMF_PURPOSE_IMPORTEXPORT

 and pMxOmfAppIFInfo_t->m_mxOmfProductID_t->m_lProductOmfUIDPrefix equals

 0, 42 (Avid), or 444 (Protools), MXOMFERR_INVALIDPREFIXVALUE is returned.

 

 Use mxOmfDeleteOmfSdk() to destroy the SDK.

 

 Params:

  int nMxOmfPurpose - Intended useage, instantiate for import, export, or both.

                      One of MXOMF_PURPOSE_IMPORT or MXOMF_PURPOSE_EXPORT or

                      MXOMF_PURPOSE_IMPORTEXPORT - recommended

  mxOmfAppIFInfo_t* pmxOmfAppIFInfo_t - Function pointers to client (your)

                                      callback handlers

                                      see mxOmfAppIFInfo_t

 

 Returns:

  MXOMFERR_HANDLENOTNULL - hMxOmfHdl is not NULL - it must be

  MXOMFERR_CALLBACKPARAMNULL - you need to provide initialized mxOmfAppIFInfo_t

                                                      see mxOmfAppIFInfo_t

  MXOMFERR_INVALIDPURPOSEPARAM - requires one of the MXOMF_PURPOSE_xx values

  MXOMFERR_INVALIDPREFIXVALUE - see Product ID Prefix and Using Unique Identifiers

  MXOMFERR_NOMEM - new COmfSdk object failed

  MXOMFERR_BADLISTINIT - hope you never see this

  MXOMFERR_SECURITY - security handler callback absent or failed

  MXOMFERR_NONE - happy

 

 Usage:

    See CMaxOmfSdkDemoApp::m_MxOmfProductID_t

    See CMaxOmfSdkDemoOmfDoc::m_MxOmfAppIFInfo_t

    See CMaxOmfSdkDemoOmfDoc::OnOpenDocument()

 

 

OMFDLL_EXPORT

MXOMFERROR mxOmfCreateOmfSdk(mxOmfAppIFInfo_t* pMxOmfAppIFInfo_t = NULL);