Platforms to show: All Mac Windows Linux Cross-Platform
Back to QCCompositionMBS class.
QCCompositionMBS.compositionWithData(data as MemoryBlock) as QCCompositionMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
data: The contents of a file created with the Quartz Composer developer tool.
Returns a Quartz Composer composition object or nil if there is an error.
See also:
QCCompositionMBS.compositionWithData(data as string) as QCCompositionMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
data: The contents of a file created with the Quartz Composer developer tool.
Returns a Quartz Composer composition object or nil if there is an error.
See also:
QCCompositionMBS.compositionWithFile(file as folderitem) as QCCompositionMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
file: A path to a file created with the Quartz Composer developer tool (.qtz extension).
Returns a Quartz Composer composition object or nil if there is an error.
See also:
QCCompositionMBS.compositionWithFile(path as string) as QCCompositionMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
file: A path to a file created with the Quartz Composer developer tool (.qtz extension).
Returns a Quartz Composer composition object or nil if there is an error.
See also:
QCCompositionMBS.QCCompositionAttributeBuiltInKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
The key for the composition origin. The associated value is a Boolean value.
True indicates the composition is built-in (provided by OS X).
QCCompositionMBS.QCCompositionAttributeCategoryKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
The composition category. The associated value is a category constant. See Categories.
QCCompositionMBS.QCCompositionAttributeCopyrightKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
The key for composition copyright information.
The associated value is a string.
QCCompositionMBS.QCCompositionAttributeDescriptionKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
The key for the composition description.
The associated value is a string.
QCCompositionMBS.QCCompositionAttributeHasConsumersKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
The key for a composition that has consumer patches. The associated value is a Boolean value.
True indicates that the composition has consumers.
QCCompositionMBS.QCCompositionAttributeIsTimeDependentKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
The key for the composition time dependency. The associated value is a Boolean value. True indicates that the composition is time dependent.
QCCompositionMBS.QCCompositionAttributeNameKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
The key for the composition name.
The associated value is a string.
QCCompositionMBS.QCCompositionCategoryDistortion as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A composition that produces a distortion effect.
QCCompositionMBS.QCCompositionCategoryStylize as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A composition that produces a stylize effect.
QCCompositionMBS.QCCompositionCategoryUtility as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A utility composition.
QCCompositionMBS.QCCompositionInputAudioPeakKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A number input port whose key is inputAudioPeak. The value must be in the [0,1] range as a mono signal with no decay applied.
QCCompositionMBS.QCCompositionInputAudioSpectrumKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A structure input port whose key is inputAudioSpectrum. The structure must contain 16 values in the [0,1] range representing 16 spectrum bands of the mono signal from low to high frequencies with no decay applied.
QCCompositionMBS.QCCompositionInputDestinationImageKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
An image input port whose key is inputDestinationImage.
QCCompositionMBS.QCCompositionInputImageKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
An image input port whose key is inputImage.
QCCompositionMBS.QCCompositionInputPaceKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A number input port whose key is inputPace. The value must be in the [0,1] range.
QCCompositionMBS.QCCompositionInputPreviewModeKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A Boolean input port whose key is inputPreviewMode. When the value of this input port is set to TRUE, the composition that provides this port must be able to run in a low-quality mode that produces a preview of the composition.
QCCompositionMBS.QCCompositionInputPrimaryColorKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A color input port whose key is inputPrimaryColor.
QCCompositionMBS.QCCompositionInputScreenImageKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
An image input port whose key is inputScreenImage.
QCCompositionMBS.QCCompositionInputSecondaryColorKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A color input port whose key is inputSecondaryColor.
QCCompositionMBS.QCCompositionInputSourceImageKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
An image input port whose key is inputSourceImage.
QCCompositionMBS.QCCompositionInputTrackInfoKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A structure input port whose key is inputTrackInfo. The structure contains optional entries, such as "name", "artist", "album", "duration", "artwork", and so on.
QCCompositionMBS.QCCompositionInputTrackPositionKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A number input port whose key is inputTrackPosition. The value must be expressed in seconds.
QCCompositionMBS.QCCompositionInputTrackSignalKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A Boolean input port whose key is inputTrackSignal.
QCCompositionMBS.QCCompositionInputXKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A number input port whose key is inputX. The value must be normalized to the image width with the origin on the left.
QCCompositionMBS.QCCompositionInputYKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A number input port whose key is inputY. The value must be normalized to the image height with the origin at the bottom.
QCCompositionMBS.QCCompositionOutputImageKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
An image output port whose key is outputImage.
QCCompositionMBS.QCCompositionOutputWebPageURLKey as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A string output port whose key is outputWebPageURL.
QCCompositionMBS.QCCompositionProtocolGraphicAnimation as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A composition that renders a generic graphical animation. It has the option to use QCCompositionInputPrimaryColorKey for the primary color of the animation, QCCompositionInputSecondaryColorKey for the secondary color of the animation, QCCompositionInputPaceKey for the global pace of the animation, and QCCompositionInputPreviewModeKey to indicate if the animation should run in lower-quality for preview purposes.
Available in OS X v10.5 and later.
QCCompositionMBS.QCCompositionProtocolGraphicTransition as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A composition that performs a transition between two images, using a transition time in range of 0 to 1. A conforming composition must use the input keys QCCompositionInputSourceImageKey for the starting image and QCCompositionInputDestinationImageKey for the image to transition to. The composition can optionally use QCCompositionInputPreviewModeKey to indicate if the animation should run in lower-quality for preview purposes.
QCCompositionMBS.QCCompositionProtocolImageFilter as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A composition that applies an effect to a source image. A conforming composition must use the input key QCCompositionInputImageKey for the source image and QCCompositionOutputImageKey for the output image. The composition can optionally use QCCompositionInputXKey to specify the X position of the center point of the effect, QCCompositionInputYKey to specify the Y position of the center point of the effect, andQCCompositionInputPreviewModeKey to indicate if the animation should run in lower-quality for preview purposes.
QCCompositionMBS.QCCompositionProtocolMusicVisualizer as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A composition that acts as a visualizer for music. A conforming composition must use the input key QCCompositionInputAudioPeakKey for the instantaneous audio peak and the QCCompositionInputAudioSpectrumKey for the instantaneous audio spectrum. It can optionally use the QCCompositionInputTrackInfoKey to indicate it receives information about the current track and the QCCompositionInputTrackSignalKey to indicate the start of a new track.
Available in OS X v10.5 and later.
QCCompositionMBS.QCCompositionProtocolScreenSaver as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
shared method | Quartz Composer | MBS MacControls Plugin | 15.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
A composition that can be used as a screen saver. The composition has the option to use QCCompositionInputScreenImageKey for a screenshot image of the screen that the screen saver runs on, QCCompositionInputPreviewModeKey to indicate if the animation should run in lower-quality for preview purposes, and QCCompositionOutputWebPageURLKey for a URL to open in the default web browser when screen saver exits (only allowed if screen saver password is disabled).
Available in OS X v10.5 and later.
The items on this page are in the following plugins: MBS MacControls Plugin.