scheduleInputs(_:withPluginState:at:)
Tells the host application how many frames from the given input sources your plug-in requires in order to render at the given render time.
Declaration
optional func scheduleInputs(_ inputImageRequests: AutoreleasingUnsafeMutablePointer<NSArray?>?, withPluginState pluginState: Data?, at renderTime: CMTime) throwsParameters
- inputImageRequests:
An NSArray that you fill out with requests for input image sources, input image times, whether to include leading filters, and the parameter IDs you wish to schedule.
- pluginState:
The plug-in state returned by your plug-in’s Pluginstate(_:at:quality:) method.
- renderTime:
The time at which your plug-in will be asked to render with the frames being scheduled.
Mentioned in
Discussion
The host calls this method before rendering. Fill out the inputImageRequests parameter with an array of image requests. Each request represents one frame your plug-in needs to render. These can be frames of the effect source or they can be frames from image well parameters. If you don’t implement this method, the application will assume that a filter needs only the current frame of its effect source.
When instantiating an FxImageTileRequest array using init(source:time:includeFilters:parameterID:), the currently supported keys for FxImageTileRequestSource are:
Key | Description |
|---|---|
Not associated with an effect or parameter. | |
Request frame from the source clip. | |
Request frame from an image well parameter. | |
The output of the plug-in. |
time should indicate the requested CMTime of the input, includeFilters will indicate if the plugin requires frames after leading filter effects have already been applied, and parameterID will indicate the ID of the effect source (0) or image well.