Responding to Apple Events from Final Cut Pro

Responding to Apple Events from Final Cut Pro

Responding to Apple Events from Final Cut Pro Tell Final Cut Pro about the kind of data your users want to receive in your app through a custom share destination.

Overview

An Apple event is a type of interprocess message that can specify complex operations and data. Apple events provide a message transport through which an app can send a request to another app and receive an answer. (For more information about Apple events, see NSAppleEventManager.)

Important The information in this article applies only to situations in which your app is receiving projects or clips from Final Cut Pro through a custom share destination.

Your app must tell Final Cut Pro what kind of information your users want to receive and must provide a location for that data. Final Cut Pro uses the following Apple events (in the order shown) to get this information from your app.

  1. Create Asset. Tells your app to identify a newly created asset object to serve as a placeholder. For more information, see Respond to the Create Asset Apple Event.
  2. Get Location Info Property. Your app should return an asset location record that tells Final Cut Pro where to put the exported output files and indicate whether it wants to receive rendered media, project editing decisions (in FCPXML), or both. For more information, see Respond to the Get Location Info Property Apple Event.
  3. Get Library Info Property. Your app should return a library location record that tells Final Cut Pro where to put the library archive, if your user wants one. For more information, see Respond to the Get Library Info Property Apple Event.
  4. Get Metadata Property. Your app should return a user record containing the share metadata keys and values for the share metadata your users want to receive. For more information, see Respond to the Get Metadata Property Apple Event.
  5. Get Data Options Property . Your app should return a user record with key-value pairs that specify the DTD version and the metadata view to use for the exported files. For more information, see Respond to the Get Data Options Property Apple Event.
  6. Open Document. When the export process is complete, Final Cut Pro sends an Open Document Apple event to notify your app that the export output files are available, and includes URLs to the files. For more information, see Respond to the Open Document Apple Event.

Note The synopsis for each Apple event is represented in AppleScript syntax; for more information, see the AppleScript Language Guide. For more information about handling Apple events in your app, see the Cocoa Scripting Guide.

When responding to Apple events, you should also know how to: