apple.avfoundation

Class AVAssetImageGenerator

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.avfoundation.AVAssetImageGenerator

All Implemented Interfaces:

NSObject

public class AVAssetImageGenerator
extends NSObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AVAssetImageGenerator.Block_generateCGImagesAsynchronouslyForTimesCompletionHandler

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AVAssetImageGenerator(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method and Description
static boolean	accessInstanceVariablesDirectly()
static AVAssetImageGenerator	alloc()
static AVAssetImageGenerator	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
java.lang.String	apertureMode() Specifies the aperture mode for the generated image.
boolean	appliesPreferredTrackTransform() Specifies whether or not to apply the track's preferredTransform (see -[AVAssetTrack preferredTransform]) when extracting an image from the asset.
AVAsset	asset() Indicates the instance of AVAsset with which the AVAssetImageGenerator was initialized
static AVAssetImageGenerator	assetImageGeneratorWithAsset(AVAsset asset) assetImageGeneratorWithAsset:
static boolean	automaticallyNotifiesObserversForKey(java.lang.String key)
void	cancelAllCGImageGeneration() cancelAllCGImageGeneration
static void	cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
static void	cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)
static NSArray<java.lang.String>	classFallbacksForKeyedArchiver()
static org.moe.natj.objc.Class	classForKeyedUnarchiver()
CGImageRef	copyCGImageAtTimeActualTimeError(CMTime requestedTime, CMTime actualTime, org.moe.natj.general.ptr.Ptr<NSError> outError) copyCGImageAtTime:actualTime:error:
AVVideoCompositing	customVideoCompositor() Indicates the custom video compositor instance used, if any
static java.lang.String	debugDescription_static()
static java.lang.String	description_static()
void	generateCGImagesAsynchronouslyForTimesCompletionHandler(NSArray<? extends NSValue> requestedTimes, AVAssetImageGenerator.Block_generateCGImagesAsynchronouslyForTimesCompletionHandler handler) generateCGImagesAsynchronouslyForTimes:completionHandler:
static long	hash_static()
AVAssetImageGenerator	init()
AVAssetImageGenerator	initWithAsset(AVAsset asset) initWithAsset:
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)
CGSize	maximumSize() Specifies the maximum dimensions for generated image.
static AVAssetImageGenerator	new_objc()
CMTime	requestedTimeToleranceAfter()
CMTime	requestedTimeToleranceBefore() The actual time of the generated images will be within the range [requestedTime-toleranceBefore, requestedTime+toleranceAfter] and may differ from the requested time for efficiency.
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
void	setApertureMode(java.lang.String value) Specifies the aperture mode for the generated image.
void	setAppliesPreferredTrackTransform(boolean value) Specifies whether or not to apply the track's preferredTransform (see -[AVAssetTrack preferredTransform]) when extracting an image from the asset.
void	setMaximumSize(CGSize value) Specifies the maximum dimensions for generated image.
void	setRequestedTimeToleranceAfter(CMTime value)
void	setRequestedTimeToleranceBefore(CMTime value) The actual time of the generated images will be within the range [requestedTime-toleranceBefore, requestedTime+toleranceAfter] and may differ from the requested time for efficiency.
static void	setVersion_static(long aVersion)
void	setVideoComposition(AVVideoComposition value) Specifies the video composition to use when extracting images from assets with multiple video tracks.
static org.moe.natj.objc.Class	superclass_static()
static long	version_static()
AVVideoComposition	videoComposition() Specifies the video composition to use when extracting images from assets with multiple video tracks.

Methods inherited from class apple.NSObject

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, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject

equals, toString

Methods inherited from class org.moe.natj.general.NativeObject

finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AVAssetImageGenerator

protected AVAssetImageGenerator(org.moe.natj.general.Pointer peer)

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static AVAssetImageGenerator alloc()

allocWithZone

public static AVAssetImageGenerator allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)

assetImageGeneratorWithAsset

public static AVAssetImageGenerator assetImageGeneratorWithAsset(AVAsset asset)

assetImageGeneratorWithAsset:

Returns an instance of AVAssetImageGenerator for use with the specified asset.

This method may succeed even if the asset possesses no visual tracks at the time of initialization. Clients may wish to test whether an asset has any tracks with the visual characteristic via -[AVAsset tracksWithMediaCharacteristic:].

Note also that assets that belong to a mutable subclass of AVAsset, AVMutableComposition or AVMutableMovie, may gain visual tracks after initialization of an associated AVAssetImageGenerator.

However, the results of image generation are undefined if mutations of the asset occur while images are being generated.

AVAssetImageGenerator will use the default enabled video track(s) to generate images.

Parameters:

asset - The asset from which images will be extracted.

Returns:

An instance of AVAssetImageGenerator

automaticallyNotifiesObserversForKey

public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)

cancelPreviousPerformRequestsWithTarget

public static void cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)

cancelPreviousPerformRequestsWithTargetSelectorObject

public static void cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

classFallbacksForKeyedArchiver

public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

classForKeyedUnarchiver

public static org.moe.natj.objc.Class classForKeyedUnarchiver()

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

hash_static

public static long hash_static()

instanceMethodForSelector

public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)

instanceMethodSignatureForSelector

public static NSMethodSignature instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)

instancesRespondToSelector

public static boolean instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)

isSubclassOfClass

public static boolean isSubclassOfClass(org.moe.natj.objc.Class aClass)

keyPathsForValuesAffectingValueForKey

public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)

new_objc

public static AVAssetImageGenerator new_objc()

resolveClassMethod

public static boolean resolveClassMethod(org.moe.natj.objc.SEL sel)

resolveInstanceMethod

public static boolean resolveInstanceMethod(org.moe.natj.objc.SEL sel)

setVersion_static

public static void setVersion_static(long aVersion)

superclass_static

public static org.moe.natj.objc.Class superclass_static()

version_static

public static long version_static()

apertureMode

public java.lang.String apertureMode()

Specifies the aperture mode for the generated image. Default is AVAssetImageGeneratorApertureModeCleanAperture.

appliesPreferredTrackTransform

public boolean appliesPreferredTrackTransform()

Specifies whether or not to apply the track's preferredTransform (see -[AVAssetTrack preferredTransform]) when extracting an image from the asset. Default is NO. Only rotation by 90, 180, or 270 degrees is supported.

asset

public AVAsset asset()

Indicates the instance of AVAsset with which the AVAssetImageGenerator was initialized

cancelAllCGImageGeneration

public void cancelAllCGImageGeneration()

cancelAllCGImageGeneration

Cancels all outstanding image generation requests.

Calls the handler block with AVAssetImageGeneratorCancelled for each image time in every previous invocation of -generateCGImagesAsynchronouslyForTimes:completionHandler: for which images have not yet been supplied.

copyCGImageAtTimeActualTimeError

public CGImageRef copyCGImageAtTimeActualTimeError(CMTime requestedTime,
                                                   CMTime actualTime,
                                                   org.moe.natj.general.ptr.Ptr<NSError> outError)

copyCGImageAtTime:actualTime:error:

Returns a CFRetained CGImageRef for an asset at or near the specified time.

Returns the CGImage synchronously. Ownership follows the Create Rule.

Because of the nature of timed audiovisual media, generating an image may take significant time. AVAssetImageGenerator may have to block the calling thread in order to do so. In order to avoid blocking, clients can use -generateCGImagesAsynchronouslyForTimes:completionHandler: to request that one or more images be generated asynchronously and to be notified when they become available.

On iOS and tvOS, it is particularly important to avoid blocking. To preserve responsiveness, a synchronous request that blocks for too long (eg, a request to generate an image from an asset on a slow HTTP server) may lead to media services being reset.

Parameters:

requestedTime - The time at which the image of the asset is to be created.

actualTime - A pointer to a CMTime to receive the time at which the image was actually generated. If you are not interested in this information, pass NULL.

outError - An error object describing the reason for failure, in the event that this method returns NULL.

Returns:

A CGImageRef.

customVideoCompositor

public AVVideoCompositing customVideoCompositor()

Indicates the custom video compositor instance used, if any

generateCGImagesAsynchronouslyForTimesCompletionHandler

public void generateCGImagesAsynchronouslyForTimesCompletionHandler(NSArray<? extends NSValue> requestedTimes,
                                                                    AVAssetImageGenerator.Block_generateCGImagesAsynchronouslyForTimesCompletionHandler handler)

generateCGImagesAsynchronouslyForTimes:completionHandler:

Returns a series of CGImageRefs for an asset at or near the specified times.

Employs an efficient "batch mode" for getting images in time order. The client will receive exactly one handler callback for each requested time in requestedTimes. Changes to generator properties (snap behavior, maximum size, etc...) will not affect outstanding asynchronous image generation requests. The generated image is not retained. Clients should retain the image if they wish it to persist after the completion handler returns.

Parameters:

requestedTimes - An NSArray of NSValues, each containing a CMTime, specifying the asset times at which an image is requested.

handler - A block that will be called when an image request is complete.

init

public AVAssetImageGenerator init()

Overrides:

init in class NSObject

initWithAsset

public AVAssetImageGenerator initWithAsset(AVAsset asset)

initWithAsset:

Initializes an instance of AVAssetImageGenerator for use with the specified asset.

This method may succeed even if the asset possesses no visual tracks at the time of initialization. Clients may wish to test whether an asset has any tracks with the visual characteristic via -[AVAsset tracksWithMediaCharacteristic:].

Note also that assets that belong to a mutable subclass of AVAsset, AVMutableComposition or AVMutableMovie, may gain visual tracks after initialization of an associated AVAssetImageGenerator.

However, the results of image generation are undefined if mutations of the asset occur while images are being generated.

AVAssetImageGenerator will use the default enabled video track(s) to generate images.

Parameters:

asset - The asset from which images will be extracted.

Returns:

An instance of AVAssetImageGenerator

maximumSize

public CGSize maximumSize()

Specifies the maximum dimensions for generated image. Default (CGSizeZero) is the asset's unscaled dimensions. AVAssetImageGenerator will scale images such that they fit within the defined bounding box. Images will never be scaled up. The aspect ratio of the scaled image will be defined by the apertureMode property.

requestedTimeToleranceAfter

public CMTime requestedTimeToleranceAfter()

requestedTimeToleranceBefore

public CMTime requestedTimeToleranceBefore()

The actual time of the generated images will be within the range [requestedTime-toleranceBefore, requestedTime+toleranceAfter] and may differ from the requested time for efficiency. Pass kCMTimeZero for both toleranceBefore and toleranceAfter to request frame-accurate image generation; this may incur additional decoding delay. Default is kCMTimePositiveInfinity.

setApertureMode

public void setApertureMode(java.lang.String value)

Specifies the aperture mode for the generated image. Default is AVAssetImageGeneratorApertureModeCleanAperture.

setAppliesPreferredTrackTransform

public void setAppliesPreferredTrackTransform(boolean value)

Specifies whether or not to apply the track's preferredTransform (see -[AVAssetTrack preferredTransform]) when extracting an image from the asset. Default is NO. Only rotation by 90, 180, or 270 degrees is supported.

setMaximumSize

public void setMaximumSize(CGSize value)

Specifies the maximum dimensions for generated image. Default (CGSizeZero) is the asset's unscaled dimensions. AVAssetImageGenerator will scale images such that they fit within the defined bounding box. Images will never be scaled up. The aspect ratio of the scaled image will be defined by the apertureMode property.

setRequestedTimeToleranceAfter

public void setRequestedTimeToleranceAfter(CMTime value)

setRequestedTimeToleranceBefore

public void setRequestedTimeToleranceBefore(CMTime value)

The actual time of the generated images will be within the range [requestedTime-toleranceBefore, requestedTime+toleranceAfter] and may differ from the requested time for efficiency. Pass kCMTimeZero for both toleranceBefore and toleranceAfter to request frame-accurate image generation; this may incur additional decoding delay. Default is kCMTimePositiveInfinity.

setVideoComposition

public void setVideoComposition(AVVideoComposition value)

Specifies the video composition to use when extracting images from assets with multiple video tracks. If no videoComposition is specified, only the first enabled video track will be used. If a videoComposition is specified, the value of appliesPreferredTrackTransform is ignored.

videoComposition

public AVVideoComposition videoComposition()

Specifies the video composition to use when extracting images from assets with multiple video tracks. If no videoComposition is specified, only the first enabled video track will be used. If a videoComposition is specified, the value of appliesPreferredTrackTransform is ignored.