Package apple.avfoundation

Class AVMutableVideoComposition

    • Constructor Detail

      • AVMutableVideoComposition

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • 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()

      • videoComposition

        @NotNull
public static @NotNull AVMutableVideoComposition videoComposition()
        videoComposition Returns a new instance of AVMutableVideoComposition. The returned AVMutableVideoComposition will have a frameDuration of kCMTimeZero, a renderSize of {0.0, 0.0}, a nil array of instructions, and a nil animationTool.

      • videoCompositionWithAssetApplyingCIFiltersWithHandler

        @NotNull
@Deprecated
public static @NotNull AVMutableVideoComposition videoCompositionWithAssetApplyingCIFiltersWithHandler​(@NotNull
                                                                                                       @NotNull AVAsset asset,
                                                                                                       @NotNull
                                                                                                       @NotNull AVMutableVideoComposition.Block_videoCompositionWithAssetApplyingCIFiltersWithHandler applier)
        Deprecated.
        videoCompositionWithAsset:applyingCIFiltersWithHandler: Returns a new instance of AVMutableVideoComposition with values and instructions that will apply the specified handler block to video frames represented as instances of CIImage. The returned AVMutableVideoComposition will cause the specified handler block to be called to filter each frame of the asset's first enabled video track. The handler block should use the properties of the provided AVAsynchronousCIImageFilteringRequest and respond using finishWithImage:context: with a "filtered" new CIImage (or the provided source image for no affect). In the event of an error, respond to the request using finishWithError:. The error can be observed via AVPlayerItemFailedToPlayToEndTimeNotification, see AVPlayerItemFailedToPlayToEndTimeErrorKey in notification payload. The client can set sourceTrackIDForFrameTiming to kCMPersistentTrackID_Invalid and frameDuration to an appropriate value in order to specify the maximum output frame rate independent of the source track timing. The video composition will also have the following values for its properties: - The original timing of the asset's first enabled video track will be used. - A renderSize that encompasses the asset's first enabled video track respecting the track's preferredTransform. - A renderScale of 1.0. The default CIContext has the following properties: - iOS: Device RGB color space - macOS: sRGB color space Example usage: playerItem.videoComposition = [AVMutableVideoComposition videoCompositionWithAsset:srcAsset applyingCIFiltersWithHandler: ^(AVAsynchronousCIImageFilteringRequest *request) { NSError *err = nil; CIImage *filtered = myRenderer(request, &err); if (filtered) [request finishWithImage:filtered context:nil]; else [request finishWithError:err]; }]; API-Since: 9.0 Deprecated-Since: 100000.0
        Parameters:
        asset - An instance of AVAsset. For best performance, ensure that the duration and tracks properties of the asset are already loaded before invoking this method.
        Returns:
        An instance of AVMutableVideoComposition.

      • videoCompositionWithPropertiesOfAsset

        @NotNull
@Deprecated
public static @NotNull AVMutableVideoComposition videoCompositionWithPropertiesOfAsset​(@NotNull
                                                                                       @NotNull AVAsset asset)
        Deprecated.
        videoCompositionWithPropertiesOfAsset: Returns a new instance of AVMutableVideoComposition with values and instructions suitable for presenting the video tracks of the specified asset according to its temporal and geometric properties and those of its tracks. The returned AVMutableVideoComposition will have instructions that respect the spatial properties and timeRanges of the specified asset's video tracks. The client can set sourceTrackIDForFrameTiming to kCMPersistentTrackID_Invalid and frameDuration to an appropriate value in order to specify the maximum output frame rate independent of the source track timing. It will also have the following values for its properties: - If the asset has exactly one video track, the original timing of the source video track will be used. If the asset has more than one video track, and the nominal frame rate of any of video tracks is known, the reciprocal of the greatest known nominalFrameRate will be used as the value of frameDuration. Otherwise, a default framerate of 30fps is used. - If the specified asset is an instance of AVComposition, the renderSize will be set to the naturalSize of the AVComposition; otherwise the renderSize will be set to a value that encompasses all of the asset's video tracks. - A renderScale of 1.0. - A nil animationTool. If the specified asset has no video tracks, this method will return an AVMutableVideoComposition instance with an empty collection of instructions. API-Since: 6.0 Deprecated-Since: 100000.0
        Parameters:
        asset - An instance of AVAsset. For best performance, ensure that the duration and tracks properties of the asset are already loaded before invoking this method.
        Returns:
        An instance of AVMutableVideoComposition.

      • colorPrimaries

        @Nullable
public @Nullable java.lang.String colorPrimaries()
        [@property] colorPrimaries Rendering will use these primaries and frames will be tagged as such. If the value of this property is nil then the source's primaries will be propagated and used. Default is nil. Valid values are those suitable for AVVideoColorPrimariesKey. Generally set as a triple along with colorYCbCrMatrix and colorTransferFunction. API-Since: 10.0
        Overrides:
        colorPrimaries in class AVVideoComposition

      • colorTransferFunction

        @Nullable
public @Nullable java.lang.String colorTransferFunction()
        [@property] colorTransferFunction Rendering will use this transfer function and frames will be tagged as such. If the value of this property is nil then the source's transfer function will be propagated and used. Default is nil. Valid values are those suitable for AVVideoTransferFunctionKey. Generally set as a triple along with colorYCbCrMatrix and colorYCbCrMatrix. API-Since: 10.0
        Overrides:
        colorTransferFunction in class AVVideoComposition

      • colorYCbCrMatrix

        @Nullable
public @Nullable java.lang.String colorYCbCrMatrix()
        [@property] colorYCbCrMatrix Rendering will use this matrix and frames will be tagged as such. If the value of this property is nil then the source's matrix will be propagated and used. Default is nil. Valid values are those suitable for AVVideoYCbCrMatrixKey. Generally set as a triple along with colorPrimaries and colorTransferFunction. API-Since: 10.0
        Overrides:
        colorYCbCrMatrix in class AVVideoComposition

      • frameDuration

        public CMTime frameDuration()
        indicates the interval which the video composition, when enabled, should render composed video frames
        Overrides:
        frameDuration in class AVVideoComposition

      • instructions

        @NotNull
public @NotNull NSArray<?> instructions()
        Indicates instructions for video composition via an NSArray of instances of classes implementing the AVVideoCompositionInstruction protocol. For the first instruction in the array, timeRange.start must be less than or equal to the earliest time for which playback or other processing will be attempted (note that this will typically be kCMTimeZero). For subsequent instructions, timeRange.start must be equal to the prior instruction's end time. The end time of the last instruction must be greater than or equal to the latest time for which playback or other processing will be attempted (note that this will often be the duration of the asset with which the instance of AVVideoComposition is associated).
        Overrides:
        instructions in class AVVideoComposition

      • renderScale

        public float renderScale()
        indicates the scale at which the video composition should render. May only be other than 1.0 for a video composition set on an AVPlayerItem API-Since: 4.0
        Overrides:
        renderScale in class AVVideoComposition

      • renderSize

        public CGSize renderSize()
        indicates the size at which the video composition, when enabled, should render
        Overrides:
        renderSize in class AVVideoComposition

      • setAnimationTool

        public void setAnimationTool​(@Nullable
                             @Nullable AVVideoCompositionCoreAnimationTool value)
        indicates a special video composition tool for use of Core Animation; may be nil

      • setColorPrimaries

        public void setColorPrimaries​(@Nullable
                              @Nullable java.lang.String value)
        [@property] colorPrimaries Rendering will use these primaries and frames will be tagged as such. If the value of this property is nil then the source's primaries will be propagated and used. Default is nil. Valid values are those suitable for AVVideoColorPrimariesKey. Generally set as a triple along with colorYCbCrMatrix and colorTransferFunction. API-Since: 10.0

      • setColorTransferFunction

        public void setColorTransferFunction​(@Nullable
                                     @Nullable java.lang.String value)
        [@property] colorTransferFunction Rendering will use this transfer function and frames will be tagged as such. If the value of this property is nil then the source's transfer function will be propagated and used. Default is nil. Valid values are those suitable for AVVideoTransferFunctionKey. Generally set as a triple along with colorYCbCrMatrix and colorYCbCrMatrix. API-Since: 10.0

      • setColorYCbCrMatrix

        public void setColorYCbCrMatrix​(@Nullable
                                @Nullable java.lang.String value)
        [@property] colorYCbCrMatrix Rendering will use this matrix and frames will be tagged as such. If the value of this property is nil then the source's matrix will be propagated and used. Default is nil. Valid values are those suitable for AVVideoYCbCrMatrixKey. Generally set as a triple along with colorPrimaries and colorTransferFunction. API-Since: 10.0

      • setCustomVideoCompositorClass

        public void setCustomVideoCompositorClass​(@Nullable
                                          @Nullable AVVideoCompositing value)
        indicates the custom compositor class to use. If nil, the default, internal video compositor is used API-Since: 7.0

      • setFrameDuration

        public void setFrameDuration​(CMTime value)
        indicates the interval which the video composition, when enabled, should render composed video frames

      • setInstructions

        public void setInstructions​(@NotNull
                            @NotNull NSArray<?> value)
        Indicates instructions for video composition via an NSArray of instances of classes implementing the AVVideoCompositionInstruction protocol. For the first instruction in the array, timeRange.start must be less than or equal to the earliest time for which playback or other processing will be attempted (note that this will typically be kCMTimeZero). For subsequent instructions, timeRange.start must be equal to the prior instruction's end time. The end time of the last instruction must be greater than or equal to the latest time for which playback or other processing will be attempted (note that this will often be the duration of the asset with which the instance of AVVideoComposition is associated).

      • setRenderScale

        public void setRenderScale​(float value)
        indicates the scale at which the video composition should render. May only be other than 1.0 for a video composition set on an AVPlayerItem API-Since: 4.0

      • setRenderSize

        public void setRenderSize​(CGSize value)
        indicates the size at which the video composition, when enabled, should render

      • setSourceTrackIDForFrameTiming

        public void setSourceTrackIDForFrameTiming​(int value)
        If sourceTrackIDForFrameTiming is not kCMPersistentTrackID_Invalid, frame timing for the video composition is derived from the source asset's track with the corresponding ID. This may be used to preserve a source asset's variable frame timing. If an empty edit is encountered in the source asset’s track, the compositor composes frames as needed up to the frequency specified in frameDuration property. API-Since: 11.0

      • sourceTrackIDForFrameTiming

        public int sourceTrackIDForFrameTiming()
        If sourceTrackIDForFrameTiming is not kCMPersistentTrackID_Invalid, frame timing for the video composition is derived from the source asset's track with the corresponding ID. This may be used to preserve a source asset's variable frame timing. If an empty edit is encountered in the source asset’s track, the compositor composes frames as needed up to the frequency specified in frameDuration property. API-Since: 11.0
        Overrides:
        sourceTrackIDForFrameTiming in class AVVideoComposition

      • videoCompositionWithPropertiesOfAssetPrototypeInstruction

        @NotNull
@Deprecated
public static @NotNull AVMutableVideoComposition videoCompositionWithPropertiesOfAssetPrototypeInstruction​(@NotNull
                                                                                                           @NotNull AVAsset asset,
                                                                                                           @NotNull
                                                                                                           @NotNull AVVideoCompositionInstruction prototypeInstruction)
        Deprecated.
        videoCompositionWithPropertiesOfAsset:prototypeInstruction: Returns a new instance of AVMutableVideoComposition with values and instructions suitable for presenting the video tracks of the specified asset according to its temporal and geometric properties and those of its tracks, and also overrides default properties with those from a prototypeInstruction. Also see videoCompositionWithPropertiesOfAsset:. The returned AVVideoComposition will have instructions that respect the spatial properties and timeRanges of the specified asset's video tracks. Anything not pertaining to spatial layout and timing, such as background color for their composition or post-processing behaviors, is eligible to be specified via a prototype instruction. Example: To add a background color, myPrototypeInstruction = [[AVMutableVideoCompositionInstruction alloc] init]; myPrototypeInstruction.backgroundColor = myCGColorRef; // Do not use constant CGColorRef colors here. myVideoComposition = [AVVideoComposition videoCompositionWithPropertiesOfAsset:myAsset prototypeInstruction:myPrototypeInstruction]; API-Since: 13.0 Deprecated-Since: 100000.0
        Parameters:
        asset - An instance of AVAsset. For best performance, ensure that the duration and tracks properties of the asset are already loaded before invoking this method.
        prototypeInstruction - Custom instructions that the client can choose to override.
        Returns:
        An instance of AVMutableVideoComposition.

      • setSourceSampleDataTrackIDs

        public void setSourceSampleDataTrackIDs​(@NotNull
                                        @NotNull NSArray<? extends NSNumber> value)
        List of all track IDs for tracks from which sample data should be presented to the compositor at any point in the overall composition. Currently only tracks of type kCMMediaType_Metadata are allowed to be specified. API-Since: 15.0

      • sourceSampleDataTrackIDs

        @NotNull
public @NotNull NSArray<? extends NSNumber> sourceSampleDataTrackIDs()
        List of all track IDs for tracks from which sample data should be presented to the compositor at any point in the overall composition. Currently only tracks of type kCMMediaType_Metadata are allowed to be specified. API-Since: 15.0
        Overrides:
        sourceSampleDataTrackIDs in class AVVideoComposition

      • videoCompositionWithAssetApplyingCIFiltersWithHandlerCompletionHandler

        public static void videoCompositionWithAssetApplyingCIFiltersWithHandlerCompletionHandler​(@NotNull
                                                                                          @NotNull AVAsset asset,
                                                                                          @NotNull
                                                                                          @NotNull AVMutableVideoComposition.Block_videoCompositionWithAssetApplyingCIFiltersWithHandlerCompletionHandler_1 applier,
                                                                                          @NotNull
                                                                                          @NotNull AVMutableVideoComposition.Block_videoCompositionWithAssetApplyingCIFiltersWithHandlerCompletionHandler_2 completionHandler)
        videoCompositionWithAsset:applyingCIFiltersWithHandler:completionHandler: Vends a new instance of AVMutableVideoComposition with values and instructions that will apply the specified handler block to video frames represented as instances of CIImage. The new AVMutableVideoComposition will cause the specified handler block to be called to filter each frame of the asset's first enabled video track. The handler block should use the properties of the provided AVAsynchronousCIImageFilteringRequest and respond using finishWithImage:context: with a "filtered" new CIImage (or the provided source image for no affect). In the event of an error, respond to the request using finishWithError:. The error can be observed via AVPlayerItemFailedToPlayToEndTimeNotification, see AVPlayerItemFailedToPlayToEndTimeErrorKey in notification payload. The client can set sourceTrackIDForFrameTiming to kCMPersistentTrackID_Invalid and frameDuration to an appropriate value in order to specify the maximum output frame rate independent of the source track timing. The video composition will also have the following values for its properties: - The original timing of the asset's first enabled video track will be used. - A renderSize that encompasses the asset's first enabled video track respecting the track's preferredTransform. - A renderScale of 1.0. The default CIContext has the following properties: - iOS: Device RGB color space - macOS: sRGB color space Example usage: [AVMutableVideoComposition videoCompositionWithAsset:srcAsset applyingCIFiltersWithHandler: ^(AVAsynchronousCIImageFilteringRequest *request) { NSError *err = nil; CIImage *filtered = myRenderer(request, &err); if (filtered) [request finishWithImage:filtered context:nil]; else [request finishWithError:err]; } completionHandler: ^(AVMutableVideoComposition * _Nullable videoComposition, NSError * _Nullable error) { if (videoComposition != nil) { playerItem.videoComposition = videoComposition else { // handle error }]; API-Since: 16.0
        Parameters:
        asset - An instance of AVAsset.
        completionHandler - A block that is invoked when the new video composition has finished being created. If the `videoComposition` parameter is nil, the `error` parameter describes the failure that occurred.

      • videoCompositionWithPropertiesOfAssetCompletionHandler

        public static void videoCompositionWithPropertiesOfAssetCompletionHandler​(@NotNull
                                                                          @NotNull AVAsset asset,
                                                                          @NotNull
                                                                          @NotNull AVMutableVideoComposition.Block_videoCompositionWithPropertiesOfAssetCompletionHandler completionHandler)
        videoCompositionWithPropertiesOfAsset:completionHandler: Vends a new instance of AVMutableVideoComposition with values and instructions suitable for presenting the video tracks of the specified asset according to its temporal and geometric properties and those of its tracks. The new AVMutableVideoComposition will have instructions that respect the spatial properties and timeRanges of the specified asset's video tracks. The client can set sourceTrackIDForFrameTiming to kCMPersistentTrackID_Invalid and frameDuration to an appropriate value in order to specify the maximum output frame rate independent of the source track timing. It will also have the following values for its properties: - If the asset has exactly one video track, the original timing of the source video track will be used. If the asset has more than one video track, and the nominal frame rate of any of video tracks is known, the reciprocal of the greatest known nominalFrameRate will be used as the value of frameDuration. Otherwise, a default framerate of 30fps is used. - If the specified asset is an instance of AVComposition, the renderSize will be set to the naturalSize of the AVComposition; otherwise the renderSize will be set to a value that encompasses all of the asset's video tracks. - A renderScale of 1.0. - A nil animationTool. If the specified asset has no video tracks, this method will return an AVMutableVideoComposition instance with an empty collection of instructions. API-Since: 16.0
        Parameters:
        asset - An instance of AVAsset.
        completionHandler - A block that is invoked when the new video composition has finished being created. If the `videoComposition` parameter is nil, the `error` parameter describes the failure that occurred.

      • videoCompositionWithPropertiesOfAssetPrototypeInstructionCompletionHandler

        public static void videoCompositionWithPropertiesOfAssetPrototypeInstructionCompletionHandler​(@NotNull
                                                                                              @NotNull AVAsset asset,
                                                                                              @NotNull
                                                                                              @NotNull AVVideoCompositionInstruction prototypeInstruction,
                                                                                              @NotNull
                                                                                              @NotNull AVMutableVideoComposition.Block_videoCompositionWithPropertiesOfAssetPrototypeInstructionCompletionHandler completionHandler)
        videoCompositionWithPropertiesOfAsset:prototypeInstruction:completionHandler: Vends a new instance of AVMutableVideoComposition with values and instructions suitable for presenting the video tracks of the specified asset according to its temporal and geometric properties and those of its tracks, and also overrides default properties with those from a prototypeInstruction. Also see videoCompositionWithPropertiesOfAsset:completionHandler:. The new AVMutableVideoComposition will have instructions that respect the spatial properties and timeRanges of the specified asset's video tracks. Anything not pertaining to spatial layout and timing, such as background color for their composition or post-processing behaviors, is eligible to be specified via a prototype instruction. Example: To add a background color, myPrototypeInstruction = [[AVMutableVideoCompositionInstruction alloc] init]; myPrototypeInstruction.backgroundColor = myCGColorRef; // Do not use constant CGColorRef colors here. myVideoComposition = [AVVideoComposition videoCompositionWithPropertiesOfAsset:myAsset prototypeInstruction:myPrototypeInstruction completionHandler:^(AVMutableVideoComposition * _Nullable myVideoComposition, NSError * _Nullable error) { if (myVideoComposition != nil) { // use myVideoComposition } else { // handle error } }]; API-Since: 16.0
        Parameters:
        asset - An instance of AVAsset.
        prototypeInstruction - Custom instructions that the client can choose to override.
        completionHandler - A block that is invoked when the new video composition has finished being created. If the `videoComposition` parameter is nil, the `error` parameter describes the failure that occurred.

      • perFrameHDRDisplayMetadataPolicy

        @NotNull
public @NotNull java.lang.String perFrameHDRDisplayMetadataPolicy()
        [@property] perFrameHDRDisplayMetadataPolicy Configures policy for per frame HDR display metadata on the rendered frame Allows the system to identify situations where HDR metadata can be generated and attached to the rendered video frame. Default is AVVideoCompositionPerFrameHDRDisplayMetadataPolicyPropagate. Any HDR metadata attached to the composed frame will be propagated to the rendered video frames. API-Since: 17.0
        Overrides:
        perFrameHDRDisplayMetadataPolicy in class AVVideoComposition

      • setPerFrameHDRDisplayMetadataPolicy

        public void setPerFrameHDRDisplayMetadataPolicy​(@NotNull
                                                @NotNull java.lang.String value)
        [@property] perFrameHDRDisplayMetadataPolicy Configures policy for per frame HDR display metadata on the rendered frame Allows the system to identify situations where HDR metadata can be generated and attached to the rendered video frame. Default is AVVideoCompositionPerFrameHDRDisplayMetadataPolicyPropagate. Any HDR metadata attached to the composed frame will be propagated to the rendered video frames. API-Since: 17.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.