docs/_data/Help/obs.powershell.websocket.GetSourceScreenshot.json

{
  "Synopsis": "Get-OBSSourceScreenshot : GetSourceScreenshot",
  "Description": "Gets a Base64-encoded screenshot of a source.\n\nThe `imageWidth` and `imageHeight` parameters are treated as \"scale to inner\", meaning the smallest ratio will be used and the aspect ratio of the original resolution is kept.\nIf `imageWidth` and `imageHeight` are not specified, the compressed image will use the full resolution of the source.\n\n**Compatible with inputs and scenes.**\n\n\nGet-OBSSourceScreenshot calls the OBS WebSocket with a request of type GetSourceScreenshot.",
  "Parameters": [
    {
      "Name": null,
      "Type": null,
      "Description": "",
      "Required": false,
      "Position": 0,
      "Aliases": null,
      "DefaultValue": null,
      "Globbing": false,
      "PipelineInput": null,
      "variableLength": false
    }
  ],
  "Notes": [
    null
  ],
  "CommandType": "Function",
  "Component": [
    null
  ],
  "Inputs": [
    null
  ],
  "Outputs": [
    null
  ],
  "Links": [
    "https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#getsourcescreenshot"
  ],
  "Examples": []
}