Platforms to show: All Mac Windows Linux Cross-Platform

Back to AVAssetExportSessionMBS class.

AVAssetExportSessionMBS.asset as AVAssetMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The asset with which the export session was initialized. (read-only)

(Read only property)

AVAssetExportSessionMBS.audioMix as AVAudioMixMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Indicates whether non-default audio mixing is enabled for export, and supplies the parameters for audio mixing.

(Read and Write property)

AVAssetExportSessionMBS.audioTimePitchAlgorithm as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 14.0 ✅ Yes ❌ No ❌ No ✅ Yes All
Indicates the processing algorithm used to manage audio pitch for scaled audio edits.

An exception (NSInvalidArgumentException) is raised if this property is set to a value other than the constants defined in Time_Pitch_Algorithm_Settings.

The default value is AVAudioTimePitchAlgorithmSpectral.
Available in OS X v10.9 and later.
(Read and Write property)

AVAssetExportSessionMBS.canPerformMultiplePassesOverSourceMediaData as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 14.4 ✅ Yes ❌ No ❌ No ✅ Yes All
Determines whether the export session can perform multiple passes over the source media to achieve better results.

When the value for this property is true, the export session can produce higher quality results at the expense of longer export times. Setting this property to true may also require the export session to write temporary data to disk during the export. To control the location of temporary data, use the property directoryForTemporaryFiles.

The default value is false. Not all export session configurations can benefit from performing multiple passes over the source media. In these cases, setting this property to true has no effect.

This property cannot be set after the export has started.

Available in Mac OS X 10.10 and newer.
(Read and Write property)

AVAssetExportSessionMBS.customVideoCompositor as AVVideoCompositingMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 14.0 ✅ Yes ❌ No ❌ No ✅ Yes All
Indicates the custom video compositor instance used, if any. (read-only)

The custom video compositor instance that is used during image generation is accessible via this property after the value of videoComposition is set to an AVVideoComposition instance that specifies a custom video compositor class. Any additional communication between the application and that instance of the custom video compositor, if any is required for configuration or other purposes, can only occur once that has happened.

If the value of videoComposition is changed from an AVVideoComposition that specifies a custom video compositor class to another instance of AVVideoComposition that specifies the same custom video compositor class, the instance of the custom video compositor that was previously created will receive the renderContextChanged: message and remain in use for subsequent image generation.

This property is nil if there is no video compositor, or if the internal video compositor is in use.
Available in OS X v10.9 and later.
(Read only property)

AVAssetExportSessionMBS.directoryForTemporaryFiles as FolderItem

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 14.4 ✅ Yes ❌ No ❌ No ✅ Yes All
Specifies a directory that is suitable for containing temporary files generated during the export process.

AVAssetExportSession may need to write temporary files when configured in certain ways, such as when canPerformMultiplePassesOverSourceMediaData is set to true. This property can be used to control where in the filesystem those temporary files are created. All temporary files will be deleted when the export is completed, is canceled, or fails.

When the value of this property is nil, the export session will choose a suitable location when writing temporary files. The default value is nil.

This property cannot be set after the export has started. The export will fail if the URL points to a location that is not a directory, does not exist, is not on the local file system, or if a file cannot be created in this directory (for example, due to insufficient permissions or sandboxing restrictions).

Available in Mac OS X 10.10 and newer.
(Read and Write property)

AVAssetExportSessionMBS.directoryForTemporaryFilesURL as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 14.4 ✅ Yes ❌ No ❌ No ✅ Yes All
Specifies a directory that is suitable for containing temporary files generated during the export process.

AVAssetExportSession may need to write temporary files when configured in certain ways, such as when canPerformMultiplePassesOverSourceMediaData is set to true. This property can be used to control where in the filesystem those temporary files are created. All temporary files will be deleted when the export is completed, is canceled, or fails.

When the value of this property is empty, the export session will choose a suitable location when writing temporary files. The default value is nil.

This property cannot be set after the export has started. The export will fail if the URL points to a location that is not a directory, does not exist, is not on the local file system, or if a file cannot be created in this directory (for example, due to insufficient permissions or sandboxing restrictions).

Available in Mac OS X 10.10 and newer.
(Read and Write property)

AVAssetExportSessionMBS.error as NSErrorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Describes the error that occurred if the export status is AVAssetExportSessionStatusFailed or AVAssetExportSessionStatusCancelled. (read-only)

If there is no error to report, the value of this property is nil.
(Read only property)

AVAssetExportSessionMBS.estimatedOutputFileLength as Int64

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 14.0 ✅ Yes ❌ No ❌ No ✅ Yes All
Indicates the estimated size in bytes of the exported file. (read-only)

Available in OS X v10.9 and later.
(Read only property)

AVAssetExportSessionMBS.Handle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The internal object reference.

(Read and Write property)

AVAssetExportSessionMBS.metadataItemFilter as AVMetadataItemFilterMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 14.0 ✅ Yes ❌ No ❌ No ✅ Yes All
Specifies a filter object to be used during export to determine which metadata items should be transferred from the source asset.

If the value of this key is nil, no filter will be applied. This is the default.

The filter will not be applied to metadata set with via the metadata property. To apply the filter to metadata before it is set on the metadata property, see AVMetadataItem.

Available in OS X v10.9 and later.
(Read and Write property)

AVAssetExportSessionMBS.OutputFile as folderitem

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The file of the export session's output.

(Read and Write property)

AVAssetExportSessionMBS.outputFileType as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The type of file to be written by the session.

The value is a UTI string corresponding to the file type to use when writing the asset. For a list of constants specifying UTIs for standard file types, see AV Foundation Constants Reference.
(Read and Write property)

AVAssetExportSessionMBS.outputURL as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The URL of the export session's output.

(Read and Write property)

AVAssetExportSessionMBS.presetName as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The name of the preset with which the session was initialized. (read-only)

(Read only property)

AVAssetExportSessionMBS.progress as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The progress of the export on a scale from 0 to 1. (read-only)

A value of 0 means the export has not yet begun, 1 means the export is complete.
(Read only property)

AVAssetExportSessionMBS.shouldOptimizeForNetworkUse as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Indicates whether the movie should be optimized for network use.

(Read and Write property)

AVAssetExportSessionMBS.status as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The status of the export session. (read-only)

(Read only property)

AVAssetExportSessionMBS.videoComposition as AVVideoCompositionMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Indicates whether video composition is enabled for export, and supplies the instructions for video composition.

(Read and Write property)

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


The biggest plugin in space...