Package apple.avfoundation

Class AVAssetImageGenerator

  • All Implemented Interfaces:
    NSObject
    public class AVAssetImageGenerator
extends NSObject
    API-Since: 4.0

    • Constructor Detail

      • AVAssetImageGenerator

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

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

      • assetImageGeneratorWithAsset

        public static AVAssetImageGenerator assetImageGeneratorWithAsset​(@NotNull
                                                                 @NotNull 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​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

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

      • classFallbacksForKeyedArchiver

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

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull 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()

      • 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

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

      • 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

        @Nullable
public @Nullable 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

        @NotNull
public @NotNull AVAsset asset()
        Indicates the instance of AVAsset with which the AVAssetImageGenerator was initialized API-Since: 6.0

      • 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

        @Nullable
@Deprecated
public @Nullable CGImageRef copyCGImageAtTimeActualTimeError​(CMTime requestedTime,
                                                             @Nullable
                                                             @Nullable CMTime actualTime,
                                                             @Nullable
                                                             @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        Deprecated.
        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. API-Since: 4.0 Deprecated-Since: 100000.0
        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

        @Nullable
public @Nullable AVVideoCompositing customVideoCompositor()
        Indicates the custom video compositor instance used, if any API-Since: 7.0

      • generateCGImagesAsynchronouslyForTimesCompletionHandler

        public void generateCGImagesAsynchronouslyForTimesCompletionHandler​(@NotNull
                                                                    @NotNull NSArray<? extends NSValue> requestedTimes,
                                                                    @NotNull
                                                                    @NotNull 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.

      • initWithAsset

        public AVAssetImageGenerator initWithAsset​(@NotNull
                                           @NotNull 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()
        API-Since: 5.0

      • 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. API-Since: 5.0

      • setApertureMode

        public void setApertureMode​(@Nullable
                            @Nullable 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)
        API-Since: 5.0

      • 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. API-Since: 5.0

      • setVideoComposition

        public void setVideoComposition​(@Nullable
                                @Nullable AVVideoComposition value)
        [@property] 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. This property throws an exception if a video composition is set with any of the following property values: - "renderScale" is not equal to one - "renderSize" width or height is less than zero - "frameDuration" is invalid or less than or equal to zero - "sourceTrackIDForFrameTiming" is less than zero

      • videoComposition

        @Nullable
public @Nullable AVVideoComposition videoComposition()
        [@property] 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. This property throws an exception if a video composition is set with any of the following property values: - "renderScale" is not equal to one - "renderSize" width or height is less than zero - "frameDuration" is invalid or less than or equal to zero - "sourceTrackIDForFrameTiming" is less than zero

      • generateCGImageAsynchronouslyForTimeCompletionHandler

        public void generateCGImageAsynchronouslyForTimeCompletionHandler​(CMTime requestedTime,
                                                                  @NotNull
                                                                  @NotNull AVAssetImageGenerator.Block_generateCGImageAsynchronouslyForTimeCompletionHandler handler)
        generateCGImageAsynchronouslyForTime:completionHandler: Returns a CGImageRef for an asset at or near the specified time. The client will receive exactly one handler callback for requestedTime. 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. If image generation succeeds, the `image` parameter to the completion handler will be non-NULL and the `error` parameter will be nil. If image generation fails or was cancelled, the `image` parameter will be NULL and the `error` parameter will describe what went wrong. For cancelled images, the returned error will be AVErrorOperationCancelled. API-Since: 16.0
        Parameters:
        requestedTime - A CMTime, specifying the asset time at which an image is requested.
        handler - A block that will be called when the image request is complete.

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.