StreamConfiguration class
Options for stream configuration.
Used with CaptureStream.updateConfiguration for changing stream config at
runtime.
Constructors
- StreamConfiguration({FrameSize frameSize = const FrameSize.zero(), FrameRate frameRate = const FrameRate.fps60(), PixelRect? sourceRect, bool showsCursor = true, QueueDepth queueDepth = const QueueDepth.depth5(), bool capturesAudio = false, bool excludesCurrentProcessAudio = false, bool captureMicrophone = false, bool? scalesToFit, PixelRect? destinationRect, bool? preservesAspectRatio, int? pixelFormat, String? colorSpaceName, CaptureResolution captureResolution = CaptureResolution.automatic})
-
const
Properties
- captureMicrophone → bool
-
When true, microphone input is included in the audio capture.
final
- captureResolution → CaptureResolution
-
Output resolution / quality tier for the live stream.
final
- capturesAudio → bool
-
When true, system audio is captured and available on
CaptureStream.audioStream.final - colorSpaceName → String?
-
Optional color space name (e.g. kCGColorSpaceSRGB). null or empty =
default.
final
- destinationRect → PixelRect?
-
When set, specifies the output subset in the pixel coordinate system.
final
- excludesCurrentProcessAudio → bool
-
When true, this application's audio is excluded from capture.
final
- frameRate → FrameRate
-
Target capture frame rate.
final
- frameSize → FrameSize
-
Capture output frame dimensions.
FrameSize.zero leaves sizing to the native layer (0×0 in the
Objective-C bridge).
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- pixelFormat → int?
-
Optional Core Video pixel format (
CVPixelFormatTypeasint).nullor0= default. Full list ofkCVPixelFormatType_*values: Pixel format identifiers; type: CVPixelFormatType.final - preservesAspectRatio → bool?
-
When set, controls whether the stream preserves the aspect ratio of the
source pixel data.
final
- queueDepth → QueueDepth
-
Frame queue depth.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scalesToFit → bool?
-
When set, controls whether the output is scaled to fit the provided
width and height.
final
- showsCursor → bool
-
final
- sourceRect → PixelRect?
-
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited