Platforms to show: All Mac Windows Linux Cross-Platform

Back to AVMutableVideoCompositionInstructionMBS class.

AVMutableVideoCompositionInstructionMBS.backgroundColor as Variant

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The background color of the composition.

Value must be CGColorMBS.
Only solid BGRA colors are supported; patterns and other supported colors are ignored. If the rendered pixel buffer does not have alpha, the alpha value of the background color is ignored.

If the background color is nil, the video compositor uses a default background color of opaque black.
(Read and Write computed property)

AVMutableVideoCompositionInstructionMBS.Constructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The constructor.

See also:

AVMutableVideoCompositionInstructionMBS.Constructor(other as AVVideoCompositionInstructionMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method AVFoundation MBS AVFoundation Plugin 15.1 ✅ Yes ❌ No ❌ No ✅ Yes All
The copy constructor to initialize with a mutable copy of the given object.

See also:

AVMutableVideoCompositionInstructionMBS.enablePostProcessing as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Indicates whether post processing is required for the video composition instruction.

If no post processing is required for the whole duration of the video composition instruction, set this property to false to make the composition process more efficient.

The value is true by default.
(Read and Write computed property)

AVMutableVideoCompositionInstructionMBS.layerInstructions as AVVideoCompositionLayerInstructionMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
An array of instances of AVVideoCompositionLayerInstruction that specify how video frames from source tracks should be layered and composed.

Tracks are layered in the composition according to the top-to-bottom order of the layerInstructions array; the track with trackID of the first instruction in the array will be layered on top, with the track with the trackID of the second instruction immediately underneath, and so on.

If the property value is nil, the output is a fill of the background color.

AVMutableVideoCompositionInstructionMBS.setLayerInstructions(items() as AVVideoCompositionLayerInstructionMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Sets an array of instances of AVVideoCompositionLayerInstruction that specify how video frames from source tracks should be layered and composed.

Tracks are layered in the composition according to the top-to-bottom order of the layerInstructions array; the track with trackID of the first instruction in the array will be layered on top, with the track with the trackID of the second instruction immediately underneath, and so on.

If the property value is nil, the output is a fill of the background color.

Some examples using this method:

AVMutableVideoCompositionInstructionMBS.timeRange as CMTimeRangeMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property AVFoundation MBS AVFoundation Plugin 13.2 ✅ Yes ❌ No ❌ No ✅ Yes All
The time range during which the instruction is effective.

If the time range is invalid, the video compositor will ignore it.
(Read and Write computed property)

The items on this page are in the following plugins: MBS AVFoundation Plugin.


The biggest plugin in space...