home > partners > developers > video programs

Avid Workgroups Application Programming Interface (API) Program

Avid Interplay APIs

Avid Interplay is an open platform that supports virtually any non-Avid application used in content creation, distribution, and management. Interplay supersedes Avid Unity Productivity Tools but uses the same suite of APIs to carry forward existing integrations, while encouraging new media, metadata, and command exchanges. The following APIs are currently available:

Avid Web Services Program

In order to enable third parties to integrate  their solutions with Avid Interplay a web services interface is available.  By exposing many of the functions that were previously only accessible through the Interplay Access application third parties can now integrate Interplay seamlessly into their customized automated workflow.
» Register for the Web Services SDK.

TransferManager Ingest/Playback Data Handling Module (TM-DHM)

This toolkit enables vendors to create a plug-in that works with Interplay Transfer and TransferManager to perform playback and ingest transfers. Playback and ingest transfers are distinct from standard file transfers in that they first convert a sequence to or from a stream of video frames and audio samples that are then transferred over an IP network. For example, during an ingest session the Transfer application accepts a multiplexed stream of video and audio frames and converts the audio and video stream into an Avid-compatible clip by wrapping them in MXF or OMF format and checking the associated metadata into the Interplay Engine or MediaManager system.

TransferManager Dynamically Extensible Transfer (TM-DET)

TM-DET transfers OMF-wrapped media files (JFIF, DV, I-frame MPEG) to third-party destinations such as a central archive. DET also enables a vendor to restore previously transferred media files back into Avid Unity (“DET Pull”) with Interplay Transfer or TransferManager performing an Interplay Engine or MediaManager check-in (logging media metadata into the centralized database). DET is the appropriate API to use when the target file is already an Avid media file wrapped with MXF or OMF metadata. In order to allow native editing, the media files must be wrapped in MXF or OMF by an Avid editor, ingest device, or TransferManager.

TransferManager Automation (TM-AUTO)

This SDK can be used to automate or control Interplay Transfer or TransferManager functionality via a third-party user interface. Using this interface, third-party products can invoke ingest, TM-DET, playback and workgroup-to-workgroup transfers, as well as monitor status, pause, cancel, resume, and retry transfers.

PAPI SDK

The PAPI SDK is a network protocol that enables third-party applications to see the inventory on Avid AirSpeed or Avid AirSPACE servers and to control functionality such as record, cue, play, stop, and additional functions. Separate versions exist for AirSpeed and AirSPACE, so inquiries should specify which server is to be controlled.   

The Program

The API SDKs are made available pursuant to a Software Development Kit License Agreement from Avid and will typically include the relevant code, documentation, and a sample implementation. Licensing of the SDKs is subject to Avid's approval and discretion. Support contracts for the APIs are available and entitle the licensee to direct personal technical support from Avid engineering. Support contracts are highly recommended when licensing the Interplay SDKs to ensure the integration development is a technical success.

Third-Party Connectivity with Avid Workgroups

Avid Interplay supports virtually any application likely to be used in media content creation, and media import, export, and interoperability is promoted through direct file support or integration with Avid Interplay APIs.