TakeSourceScreenshot class Null safety
At least embedPictureFormat or saveToFilePath must be specified.
Clients can specify width and height parameters to receive scaled pictures. Aspect ratio is preserved if only one of these two parameters is specified.
- Annotations
Constructors
Properties
- compressionQuality → int?
-
Compression ratio between -1 and 100 to write the image with. -1 is automatic, 1 is smallest file/most compression, 100 is largest file/least compression. Varies with image type.
final
- embedPictureFormat → String?
-
Format of the Data URI encoded picture. Can be "png", "jpg", "jpeg" or "bmp" (or any other value supported by Qt's Image module)
final
- fileFormat → String?
-
Format to save the image file as (one of the values provided in the supported-image-export-formats response field of GetVersion). If not specified, tries to guess based on file extension.
final
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- height → int?
-
Screenshot height. Defaults to the source's base height.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- saveToFilePath → String?
-
Full file path (file extension included) where the captured image is to be saved. Can be in a format different from pictureFormat. Contrary to the docs, can't be a relative path.
final
- sourceName → String?
-
Source name. Note: Since scenes are also sources, you can also provide a scene name. Contrary to the docs, this field is required for the obs-websocket 4.9.1 protocol reference.
final
- width → int?
-
Screenshot width. Defaults to the source's base width.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object. [...]
override
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited