Platforms to show: All Mac Windows Linux Cross-Platform

Back to CGDisplayStreamEventMBS class.

CGDisplayStreamEventMBS.Constructor(DisplayHandle as Integer, outputWidth as Integer, outputHeight as Integer, pixelFormat as Integer = 0, properties as dictionary = nil)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CoreGraphics MBS MacCG Plugin 16.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Creates a new CGDisplayStream.

This function creates a new CGDisplayStream that is to be used to get a stream of frame updates from a particular display.

DisplayHandle: The CGDirectDisplayID to use as the source for generated frames. (Handle from CGDisplayMBS class)
outputWidth: The output width (in pixels, not points) of the frames to be generated. Must not be zero.
outputWidth: The output height (in pixels, not points) of the frames to be generated. Must not be zero.
pixelFormat: The desired CoreVideo/CoreMedia-style pixel format of the output IOSurfaces. If 0 the plugin will use RGBA.
properties: Any optional properties of the CGDisplayStream.

CGDisplayStreamEventMBS.Start

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CoreGraphics MBS MacCG Plugin 16.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Begin delivering frame updates to the event.

CGDisplayStreamEventMBS.Stop

Type Topic Plugin Version macOS Windows Linux iOS Targets
method CoreGraphics MBS MacCG Plugin 16.1 ✅ Yes ❌ No ❌ No ✅ Yes All
End delivery of frame updates.

After this call returns, the CGDisplayStream callback function will eventually be called with a status of StatusStopped. After that point it is safe to release the object.
It is safe to call this function from within the event, but the previous caveat still applies.

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


The biggest plugin in space...