EdlMax MaxOmfSdk Omf Toolkit API

Documentation and API Reference
 

November  2005

http://www.edlmax.com/

This Help file accompanies MaxOmfSdk and the MaxOmfSdkDemo example application project. It is derived from the primary documentation source – the MxOmfSdk.h header file itself - it is intended as a general guide and may not be up to date. Please refer to MxOmfSdk.h for current version documentation

MaxOmfSdk is a development toolset for implementing Omf and Ale within your application. It manages compositions at 30, 25, and 24fps, including 3:2 pull-down projects, and supports embedded audio media. MaxOmfSdk is a Windows dll with an extern "C" API, providing functions for opening and writing Omf and Ale files, extracting and populating edit data, and evoking consolidation and processing.

Contents:

EdlMax MaxOmfSdk Omf Toolkit

MaxOmfSdk

Documentation Guide

MaxOmfSdk Overview

Client Application and SDK Builds

Edit Data Representation

Edit Data API

Unique Identifiers

Track Mapping - Track (Channel) Availability and Mapping

Embedded Audio Media

MaxOmfSdk API Reference

Data Types

MXOMFERROR

mxOmfErrorStruct

Windows Defines

extern "C" dll function export declaration

General defines

Handle to MaxOmfSdk

MXOMF_NOTTC

MXOMF_TIMECODE

MXOMF_NOSPEED

MXOMF_SDKPURPOSE type

MXOMF_BYTEORDER type

MXOMF_OMFVERSION type

MXOMF_TVSTND type

MXOMF_TCT type

MXOMF_CH type

MXOMF_EVENT type

MXOMF_MEDIAFORMAT_IN

MXOMF_MEDIAFORMAT_OUT

MXOMF_FPS

MXOMF_AUDIOSAMPLERATE type

MXOMF_SO

MXOMF_FILMTAPEFPS

MXOMF_EDLFRMT

MXOMF_PRODUCTRELEASETYPE

MXOMF_FILESYS

MXOMF_PATHFORMAT

MXOMF_FILEEXT

mxOmfVersionType_t

mxOmfProductVersion_t

mxOmfProductID_t

mxOmfRational_t

mxOmfUID_t

mxChans_t

OmfErrHandler()

OmfStatusDispHandler()

OmfMsgHandler()

OmfTraceHandler()

OmfConfirmHandler()

OmfProgressHandler()

OmfSecurityHandler()

mxAleCustomHeadings_t;

mxOmfInSettings_t

mxOmfOutSettings_t

MxOmfAppIFInfo_t

OmfSetAppInterface2()

mxOmfProjectInfo_t

mxOmfTrackInfo_t

mxOmfEventInfo_t

mxOmfMasterInfo_t

mxOmfFileInfo_t

mxOmfTapeInfo_t

mxOmfEventAndSourceInfo_t

mxOmfEventAbbreviatedInfo_t

mxOmfOutputStatistics_t

Functions

mxOmfCreateOmfSdk()

mxOmfDeleteOmfSdk()

mxOmfCopyAllData()

mxOmfOpenOmf()

mxOmfParseOmf()

mxOmfCompleteOmf()

mxOmfStartSave()

mxOmfOpenSave()

mxOmfMakeOmf()

mxOmfSaveAle()

mxOmfGetNextAleLineOut()

mxOmfClearMxOmfInSettings()

mxOmfClearMxOmfOutSettings()

mxOmfGetProjectInfoToInSettings()

mxOmfGetProjectInfoToOutSettings()

mxOmfUpdateOrganizationIn()

mxOmfUpdateOrganizationOut()

mxOmfClearTapeInfo()

mxOmfClearFileInfo()

mxOmfClearMasterInfo()

mxOmfClearEventInfo()

mxOmfClearTrackInfo()

mxOmfClearEventAndSourceInfo()

mxOmfClearTrackEventAndSourceInfo()

mxOmfClearProjectInfo()

mxOmfGetProjectInfo()

mxOmfSetProjectInfo()

mxOmfCopyMasterInfo()

mxOmfGetNextTapeInfo()

mxOmfGetNextFileInfo()

mxOmfGetNextMasterInfo()

mxOmfGetTapeOfCurrentMaster()

mxOmfGetFileInfoByMasterChannel()

mxOmfGetNextTrackInfo()

mxOmfGetNextSourceClipInfo()

mxOmfGetNextEventAndSourceInfo()

mxOmfGetNextPrevEventAbbreviatedInfo()

mxOmfGetNextNextEventAbbreviatedInfo()

mxOmfGetNextNextNextEventAbbreviatedInfo()

mxOmfEventAppendOnChan()

mxOmfMasterAppendUnique()

mxOmfFileAppendByChannelUnique()

mxOmfTapeAppendUnique()

mxOmfTapeAppendUniqueByTapeName()

mxOmfCompleteOmfInput()

mxOmfAudioTransferListAppendUnique()

mxOmfClearAudioTansferList()

mxOmfTransferAllAudio()

mxOmfUIDClear()

mxIsOmfUIDEqual()

mxGUID2MxOmfUID()

mxOmfUID2String()

mxOmfGetSdkVersion()

mxOmfGetOmfErrorAsString()

mxOmfGetLastErr()

mxOmfGetSdkVersionUtil()

mxOmfTc2TcStringUtil()

mxOmfTcString2TcUtil()

mxOmfVerifyValidTCStringUtil()

mxOmfTct2TvStndUtil()

mxOmfClearMxChans_tUtil()

mxOmfCopyMxChans_tUtil()

mxOmfIsUIDEqualUtil()

mxOmfIsUIDNilUtil()

mxOmfUIDClearUtil()

mxOmfUIDCopyUtil()

mxProjectInfoGetFormatedText()

mxTrackInfoGetFormatedText()

mxEventInfoGetFormatedText()

mxMasterInfoGetFormatedText()

mxFileInfoGetFormatedText()

mxTapeInfoGetFormatedText()