public class AVAssetExportSession extends NSObject
An AVAssetExportSession creates a new timed media resource from the contents of an existing AVAsset in the form described by a specified export preset.
Prior to initializing an instance of AVAssetExportSession, you can invoke +allExportPresets to obtain the complete list of presets available. Use +exportPresetsCompatibleWithAsset: to obtain a list of presets that are compatible with a specific AVAsset.
To configure an export, initialize an AVAssetExportSession with an AVAsset that contains the source media, an AVAssetExportPreset, the output file type, (a UTI string from those defined in AVMediaFormat.h) and the output URL.
After configuration is complete, invoke exportAsynchronouslyWithCompletionHandler: to start the export process. This method returns immediately; the export is performed asynchronously. Invoke the -progress method to check on the progress. Note that in some cases, depending on the capabilities of the device, when multiple exports are attempted at the same time some may be queued until others have been completed. When this happens, the status of a queued export will indicate that it's "waiting".
Whether the export fails, completes, or is cancelled, the completion handler you supply to -exportAsynchronouslyWithCompletionHandler: will be called. Upon completion, the status property indicates whether the export has completed successfully. If it has failed, the value of the error property supplies additional information about the reason for the failure.
| Modifier and Type | Class and Description |
|---|---|
static interface |
AVAssetExportSession.Block_determineCompatibilityOfExportPresetWithAssetOutputFileTypeCompletionHandler |
static interface |
AVAssetExportSession.Block_determineCompatibleFileTypesWithCompletionHandler |
static interface |
AVAssetExportSession.Block_estimateMaximumDurationWithCompletionHandler |
static interface |
AVAssetExportSession.Block_estimateOutputFileLengthWithCompletionHandler |
static interface |
AVAssetExportSession.Block_exportAsynchronouslyWithCompletionHandler |
NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret| Modifier | Constructor and Description |
|---|---|
protected |
AVAssetExportSession(org.moe.natj.general.Pointer peer) |
| Modifier and Type | Method and Description |
|---|---|
static boolean |
accessInstanceVariablesDirectly() |
static NSArray<java.lang.String> |
allExportPresets()
allExportPresets
|
static AVAssetExportSession |
alloc() |
static AVAssetExportSession |
allocWithZone(org.moe.natj.general.ptr.VoidPtr zone) |
AVAsset |
asset()
Indicates the instance of AVAsset with which the AVExportSession was initialized
|
AVAudioMix |
audioMix()
Indicates whether non-default audio mixing is enabled for export and supplies the parameters for audio mixing.
|
java.lang.String |
audioTimePitchAlgorithm()
Indicates the processing algorithm used to manage audio pitch for scaled audio edits.
|
static boolean |
automaticallyNotifiesObserversForKey(java.lang.String key) |
void |
cancelExport()
cancelExport
|
static void |
cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget) |
static void |
cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
org.moe.natj.objc.SEL aSelector,
java.lang.Object anArgument) |
boolean |
canPerformMultiplePassesOverSourceMediaData()
[@property] canPerformMultiplePassesOverSourceMediaData
|
static NSArray<java.lang.String> |
classFallbacksForKeyedArchiver() |
static org.moe.natj.objc.Class |
classForKeyedUnarchiver() |
AVVideoCompositing |
customVideoCompositor()
Indicates the custom video compositor instance used, if any
|
static java.lang.String |
debugDescription_static() |
static java.lang.String |
description_static() |
static void |
determineCompatibilityOfExportPresetWithAssetOutputFileTypeCompletionHandler(java.lang.String presetName,
AVAsset asset,
java.lang.String outputFileType,
AVAssetExportSession.Block_determineCompatibilityOfExportPresetWithAssetOutputFileTypeCompletionHandler handler)
determineCompatibilityOfExportPreset:withAsset:outputFileType:completionHandler:
|
void |
determineCompatibleFileTypesWithCompletionHandler(AVAssetExportSession.Block_determineCompatibleFileTypesWithCompletionHandler handler)
determineCompatibleFileTypesWithCompletionHandler:
|
NSURL |
directoryForTemporaryFiles()
[@property] directoryForTemporaryFiles
|
NSError |
error()
describes the error that occured if the export status is AVAssetExportSessionStatusFailed
|
long |
estimatedOutputFileLength()
Indicates the estimated byte size of exported file.
|
void |
estimateMaximumDurationWithCompletionHandler(AVAssetExportSession.Block_estimateMaximumDurationWithCompletionHandler handler)
estimateMaximumDurationWithCompletionHandler:
|
void |
estimateOutputFileLengthWithCompletionHandler(AVAssetExportSession.Block_estimateOutputFileLengthWithCompletionHandler handler)
estimateOutputFileLengthWithCompletionHandler:
|
void |
exportAsynchronouslyWithCompletionHandler(AVAssetExportSession.Block_exportAsynchronouslyWithCompletionHandler handler)
exportAsynchronouslyWithCompletionHandler:
|
static NSArray<java.lang.String> |
exportPresetsCompatibleWithAsset(AVAsset asset)
exportPresetsCompatibleWithAsset:
|
static AVAssetExportSession |
exportSessionWithAssetPresetName(AVAsset asset,
java.lang.String presetName)
exportSessionWithAsset:presetName:
|
long |
fileLengthLimit()
Indicates the file length that the output of the session should not exceed.
|
static long |
hash_static() |
AVAssetExportSession |
init() |
AVAssetExportSession |
initWithAssetPresetName(AVAsset asset,
java.lang.String presetName)
initWithAsset:presetName:
|
static NSObject.Function_instanceMethodForSelector_ret |
instanceMethodForSelector(org.moe.natj.objc.SEL aSelector) |
static NSMethodSignature |
instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector) |
static boolean |
instancesRespondToSelector(org.moe.natj.objc.SEL aSelector) |
static boolean |
isSubclassOfClass(org.moe.natj.objc.Class aClass) |
static NSSet<java.lang.String> |
keyPathsForValuesAffectingValueForKey(java.lang.String key) |
CMTime |
maxDuration()
Provides an estimate of the maximum duration of exported media that is possible given the source asset, the export preset, and the current value of fileLengthLimit.
|
NSArray<? extends AVMetadataItem> |
metadata()
Specifies an NSArray of AVMetadataItems that are to be written to the output file by the export session.
|
AVMetadataItemFilter |
metadataItemFilter()
Specifies a filter object to be used during export to determine which metadata items should be transferred from the source asset.
|
static AVAssetExportSession |
new_objc() |
java.lang.String |
outputFileType()
Indicates the type of file to be written by the session.
|
NSURL |
outputURL()
Indicates the URL of the export session's output.
|
java.lang.String |
presetName()
Indicates the name of the preset with which the AVExportSession was initialized
|
float |
progress()
Specifies the progress of the export on a scale from 0 to 1.0.
|
static boolean |
resolveClassMethod(org.moe.natj.objc.SEL sel) |
static boolean |
resolveInstanceMethod(org.moe.natj.objc.SEL sel) |
void |
setAudioMix(AVAudioMix value)
Indicates whether non-default audio mixing is enabled for export and supplies the parameters for audio mixing.
|
void |
setAudioTimePitchAlgorithm(java.lang.String value)
Indicates the processing algorithm used to manage audio pitch for scaled audio edits.
|
void |
setCanPerformMultiplePassesOverSourceMediaData(boolean value)
[@property] canPerformMultiplePassesOverSourceMediaData
|
void |
setDirectoryForTemporaryFiles(NSURL value)
[@property] directoryForTemporaryFiles
|
void |
setFileLengthLimit(long value)
Indicates the file length that the output of the session should not exceed.
|
void |
setMetadata(NSArray<? extends AVMetadataItem> value)
Specifies an NSArray of AVMetadataItems that are to be written to the output file by the export session.
|
void |
setMetadataItemFilter(AVMetadataItemFilter value)
Specifies a filter object to be used during export to determine which metadata items should be transferred from the source asset.
|
void |
setOutputFileType(java.lang.String value)
Indicates the type of file to be written by the session.
|
void |
setOutputURL(NSURL value)
Indicates the URL of the export session's output.
|
void |
setShouldOptimizeForNetworkUse(boolean value)
indicates that the output file should be optimized for network use, e.g.
|
void |
setTimeRange(CMTimeRange value)
Specifies a time range to be exported from the source.
|
static void |
setVersion_static(long aVersion) |
void |
setVideoComposition(AVVideoComposition value)
Indicates whether video composition is enabled for export and supplies the instructions for video composition.
|
boolean |
shouldOptimizeForNetworkUse()
indicates that the output file should be optimized for network use, e.g.
|
long |
status()
indicates the status of the export session
|
static org.moe.natj.objc.Class |
superclass_static() |
NSArray<java.lang.String> |
supportedFileTypes()
Indicates the types of files the target can write, according to the preset the target was initialized with.
|
CMTimeRange |
timeRange()
Specifies a time range to be exported from the source.
|
static long |
version_static() |
AVVideoComposition |
videoComposition()
Indicates whether video composition is enabled for export and supplies the instructions for video composition.
|
accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKeyprotected AVAssetExportSession(org.moe.natj.general.Pointer peer)
public static boolean accessInstanceVariablesDirectly()
public static NSArray<java.lang.String> allExportPresets()
Returns all available export preset names.
Returns an array of NSStrings with the names of all available presets. Note that not all presets are compatible with all AVAssets.
public static AVAssetExportSession alloc()
public static AVAssetExportSession allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)
public static void cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
public static void cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
org.moe.natj.objc.SEL aSelector,
java.lang.Object anArgument)
public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()
public static org.moe.natj.objc.Class classForKeyedUnarchiver()
public static java.lang.String debugDescription_static()
public static java.lang.String description_static()
public static void determineCompatibilityOfExportPresetWithAssetOutputFileTypeCompletionHandler(java.lang.String presetName,
AVAsset asset,
java.lang.String outputFileType,
AVAssetExportSession.Block_determineCompatibilityOfExportPresetWithAssetOutputFileTypeCompletionHandler handler)
Performs an inspection on the compatibility of an export preset, AVAsset and output file type. Calls the completion handler with YES if the arguments are compatible; NO otherwise.
Not all export presets are compatible with all AVAssets and file types. This method can be used to query compatibility. In order to ensure that the setup and running of an export operation will succeed using a given preset no significant changes (such as adding or deleting tracks) should be made to the asset between retrieving compatible identifiers and performing the export operation.
presetName - An NSString specifying the name of the preset template for the export.asset - An AVAsset object that is intended to be exported.outputFileType - An AVFileType indicating a file type to check; or nil, to query whether there are any compatible types.handler - A block called with the compatibility result.public static NSArray<java.lang.String> exportPresetsCompatibleWithAsset(AVAsset asset)
Returns only the identifiers compatible with the given AVAsset object.
Not all export presets are compatible with all AVAssets. For example an video only asset is not compatible with an audio only preset. This method returns only the identifiers for presets that will be compatible with the given asset. A client should pass in an AVAsset that is ready to be exported. In order to ensure that the setup and running of an export operation will succeed using a given preset no significant changes (such as adding or deleting tracks) should be made to the asset between retrieving compatible identifiers and performing the export operation. This method will access the tracks property of the AVAsset to build the returned NSArray. To avoid blocking the calling thread, the tracks property should be loaded using the AVAsynchronousKeyValueLoading protocol before calling this method.
asset - An AVAsset object that is intended to be exported.public static AVAssetExportSession exportSessionWithAssetPresetName(AVAsset asset, java.lang.String presetName)
Returns an instance of AVAssetExportSession for the specified source asset and preset.
If the specified asset belongs to a mutable subclass of AVAsset, AVMutableComposition or AVMutableMovie, the results of any export-related operation are undefined if you mutate the asset after the operation commences. These operations include but are not limited to: 1) testing the compatibility of export presets with the asset, 2) calculating the maximum duration or estimated length of the output file, and 3) the export operation itself.
asset - An AVAsset object that is intended to be exported.presetName - An NSString specifying the name of the preset template for the export.public static long hash_static()
public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
public static NSMethodSignature instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)
public static boolean instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)
public static boolean isSubclassOfClass(org.moe.natj.objc.Class aClass)
public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)
public static AVAssetExportSession new_objc()
public static boolean resolveClassMethod(org.moe.natj.objc.SEL sel)
public static boolean resolveInstanceMethod(org.moe.natj.objc.SEL sel)
public static void setVersion_static(long aVersion)
public static org.moe.natj.objc.Class superclass_static()
public static long version_static()
public AVAsset asset()
public AVAudioMix audioMix()
public java.lang.String audioTimePitchAlgorithm()
public boolean canPerformMultiplePassesOverSourceMediaData()
Determines whether the export session can perform multiple passes over the source media to achieve better results.
When the value for this property is YES, the export session can produce higher quality results at the expense of longer export times. Setting this property to YES 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 NO. Not all export session configurations can benefit from performing multiple passes over the source media. In these cases, setting this property to YES has no effect.
This property cannot be set after the export has started.
public void cancelExport()
Cancels the execution of an export session.
Cancel can be invoked when the export is running.
public AVVideoCompositing customVideoCompositor()
public void determineCompatibleFileTypesWithCompletionHandler(AVAssetExportSession.Block_determineCompatibleFileTypesWithCompletionHandler handler)
Performs an inspection on the AVAsset and Preset the object was initialized with to determine a list of file types the ExportSession can write.
This method is different than the supportedFileTypes property in that it performs an inspection of the AVAsset in order to determine its compatibility with each of the session's supported file types.
handler - Called when the inspection completes with an array of file types the ExportSession can write. Note that this may have a count of zero.public NSURL directoryForTemporaryFiles()
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 YES. 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).
public NSError error()
public long estimatedOutputFileLength()
public void exportAsynchronouslyWithCompletionHandler(AVAssetExportSession.Block_exportAsynchronouslyWithCompletionHandler handler)
Starts the asynchronous execution of an export session.
Initiates an asynchronous export operation and returns immediately.
handler - If internal preparation for export fails, the handler will be invoked synchronously.
The handler may also be called asynchronously after -exportAsynchronouslyWithCompletionHandler: returns,
in the following cases:
1) if a failure occurs during the export, including failures of loading, re-encoding, or writing media data to the output,
2) if -cancelExport is invoked,
3) if export session succeeds, having completely written its output to the outputURL.
In each case, AVAssetExportSession.status will signal the terminal state of the asset reader, and if a failure occurs, the NSError
that describes the failure can be obtained from the error property.public long fileLengthLimit()
public AVAssetExportSession init()
public AVAssetExportSession initWithAssetPresetName(AVAsset asset, java.lang.String presetName)
Initialize an AVAssetExportSession with the specified preset and set the source to the contents of the asset.
If the specified asset belongs to a mutable subclass of AVAsset, AVMutableComposition or AVMutableMovie, the results of any export-related operation are undefined if you mutate the asset after the operation commences. These operations include but are not limited to: 1) testing the compatibility of export presets with the asset, 2) calculating the maximum duration or estimated length of the output file, and 3) the export operation itself.
asset - An AVAsset object that is intended to be exported.presetName - An NSString specifying the name of the preset template for the export.public CMTime maxDuration()
public NSArray<? extends AVMetadataItem> metadata()
public AVMetadataItemFilter metadataItemFilter()
public java.lang.String outputFileType()
public NSURL outputURL()
public java.lang.String presetName()
public float progress()
public void setAudioMix(AVAudioMix value)
public void setAudioTimePitchAlgorithm(java.lang.String value)
public void setCanPerformMultiplePassesOverSourceMediaData(boolean value)
Determines whether the export session can perform multiple passes over the source media to achieve better results.
When the value for this property is YES, the export session can produce higher quality results at the expense of longer export times. Setting this property to YES 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 NO. Not all export session configurations can benefit from performing multiple passes over the source media. In these cases, setting this property to YES has no effect.
This property cannot be set after the export has started.
public void setDirectoryForTemporaryFiles(NSURL value)
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 YES. 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).
public void setFileLengthLimit(long value)
public void setMetadata(NSArray<? extends AVMetadataItem> value)
public void setMetadataItemFilter(AVMetadataItemFilter value)
public void setOutputFileType(java.lang.String value)
public void setOutputURL(NSURL value)
public void setShouldOptimizeForNetworkUse(boolean value)
public void setTimeRange(CMTimeRange value)
public void setVideoComposition(AVVideoComposition value)
public boolean shouldOptimizeForNetworkUse()
public long status()
public NSArray<java.lang.String> supportedFileTypes()
public CMTimeRange timeRange()
public AVVideoComposition videoComposition()
public void estimateMaximumDurationWithCompletionHandler(AVAssetExportSession.Block_estimateMaximumDurationWithCompletionHandler handler)
Starts the asynchronous execution of estimating the maximum duration of the export based on the asset, preset, and fileLengthLimit associated with the export session.
If fileLengthLimit is not set on the export session, fileLengthLimit will be assumed to be the maximum file size specified by the preset (if any); else infinite.
handler - A block called with the estimated maximum duration, or kCMTimeInvalid if an error occurs. The error parameter will be non-nil if an error occurs.public void estimateOutputFileLengthWithCompletionHandler(AVAssetExportSession.Block_estimateOutputFileLengthWithCompletionHandler handler)
Starts the asynchronous execution of estimating the output file length of the export based on the asset, preset, and timeRange associated with the export session.
If timeRange is not set on the export session, timeRange will be assumed to be the full time range of the asset.
handler - A block called with the estimated output file length in bytes, if it can be accurately determined; 0 otherwise. The error parameter will be non-nil if an error occurs.