Platforms to show: All Mac Windows Linux Cross-Platform

Back to SDAVAssetExportSessionMBS class.

SDAVAssetExportSessionMBS.cancelExport

Type Topic Plugin Version macOS Windows Linux iOS Targets
method AVFoundation MBS AVFoundation Plugin 20.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Cancels the execution of an export session.

SDAVAssetExportSessionMBS.Constructor(asset as AVAssetMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method AVFoundation MBS AVFoundation Plugin 20.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Initializes an asset export session with a specified asset and preset.

asset: The asset you want to export.

SDAVAssetExportSessionMBS.exportAsynchronously

Type Topic Plugin Version macOS Windows Linux iOS Targets
method AVFoundation MBS AVFoundation Plugin 20.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Starts the asynchronous execution of an export session.

This method starts an asynchronous export operation and returns immediately. status signals the terminal state of the export session, and if a failure occurs, error describes the problem.

This method calls AVFoundationMBS.exportAsynchronouslyCompleted event later. Tag is passed so you can pass information needed to finish work.

If internal preparation for export fails, event is invoked synchronously. The event may also be called asynchronously, after the method returns, in the following cases:

  • If a failure occurs during the export, including failures of loading, re-encoding, or writing media data to the output.
  • If cancelExport is invoked.
  • After the export session succeeds, having completely written its output to the outputURL.

With tag you can pass any value you like to the event later. This can be for example an object reference or a number in an array. Be aware that the reference to this tag value is kept until the event is called and can cause memory reference cycles.

SDAVAssetExportSessionMBS.exportMT

Type Topic Plugin Version macOS Windows Linux iOS Targets
method AVFoundation MBS AVFoundation Plugin 20.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Starts the synchronous execution of an export session.

Same as exportAsynchronously, but run synchronous, so the plugin waits.

The work is performed on a preemptive thread, so this function does not block the application and can yield time to other Xojo threads. Must be called in a Xojo thread to enjoy benefits. If called in main thread will block, but keep other background threads running.

SDAVAssetExportSessionMBS.metadata as AVMetadataItemMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method AVFoundation MBS AVFoundation Plugin 20.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the metadata to be written to the output file by the export session.

SDAVAssetExportSessionMBS.setMetadata(items() as AVMetadataItemMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method AVFoundation MBS AVFoundation Plugin 20.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Sets the metadata to be written to the output file by the export session.

If the array is empty, any existing metadata in the exported asset will be translated as accurately as possible into the appropriate metadata key space for the output file and written to the output.

The items on this page are in the following plugins: MBS AVFoundation Plugin.


The biggest plugin in space...