Skip to content

Scrypted Documentation / ScryptedInterfaceMethod

Enumeration: ScryptedInterfaceMethod ​

Enumeration Members ​

listen ​

listen: "listen"


probe ​

probe: "probe"


setMixins ​

setMixins: "setMixins"


setName ​

setName: "setName"


setRoom ​

setRoom: "setRoom"


setType ​

setType: "setType"


getPluginJson ​

getPluginJson: "getPluginJson"


turnOff ​

turnOff: "turnOff"


turnOn ​

turnOn: "turnOn"


setBrightness ​

setBrightness: "setBrightness"


getTemperatureMaxK ​

getTemperatureMaxK: "getTemperatureMaxK"


getTemperatureMinK ​

getTemperatureMinK: "getTemperatureMinK"


setColorTemperature ​

setColorTemperature: "setColorTemperature"


setRgb ​

setRgb: "setRgb"


setHsv ​

setHsv: "setHsv"


pressButton ​

pressButton: "pressButton"


sendNotification ​

sendNotification: "sendNotification"


start ​

start: "start"


stop ​

stop: "stop"


pause ​

pause: "pause"


resume ​

resume: "resume"


dock ​

dock: "dock"


setTemperature ​

setTemperature: "setTemperature"


setTemperatureUnit ​

setTemperatureUnit: "setTemperatureUnit"


getPictureOptions ​

getPictureOptions: "getPictureOptions"


takePicture ​

takePicture: "takePicture"


getAudioStream ​

getAudioStream: "getAudioStream"


setAudioVolumes ​

setAudioVolumes: "setAudioVolumes"


startDisplay ​

startDisplay: "startDisplay"


stopDisplay ​

stopDisplay: "stopDisplay"


getVideoStream ​

getVideoStream: "getVideoStream"


getVideoStreamOptions ​

getVideoStreamOptions: "getVideoStreamOptions"


getPrivacyMasks ​

getPrivacyMasks: "getPrivacyMasks"


setPrivacyMasks ​

setPrivacyMasks: "setPrivacyMasks"


getVideoTextOverlays ​

getVideoTextOverlays: "getVideoTextOverlays"


setVideoTextOverlay ​

setVideoTextOverlay: "setVideoTextOverlay"


getRecordingStream ​

getRecordingStream: "getRecordingStream"


getRecordingStreamCurrentTime ​

getRecordingStreamCurrentTime: "getRecordingStreamCurrentTime"


getRecordingStreamOptions ​

getRecordingStreamOptions: "getRecordingStreamOptions"


getRecordingStreamThumbnail ​

getRecordingStreamThumbnail: "getRecordingStreamThumbnail"


deleteRecordingStream ​

deleteRecordingStream: "deleteRecordingStream"


setRecordingActive ​

setRecordingActive: "setRecordingActive"


ptzCommand ​

ptzCommand: "ptzCommand"


getRecordedEvents ​

getRecordedEvents: "getRecordedEvents"


getVideoClip ​

getVideoClip: "getVideoClip"


getVideoClips ​

getVideoClips: "getVideoClips"


getVideoClipThumbnail ​

getVideoClipThumbnail: "getVideoClipThumbnail"


removeVideoClips ​

removeVideoClips: "removeVideoClips"


setVideoStreamOptions ​

setVideoStreamOptions: "setVideoStreamOptions"


startIntercom ​

startIntercom: "startIntercom"


stopIntercom ​

stopIntercom: "stopIntercom"


lock ​

lock: "lock"


unlock ​

unlock: "unlock"


addPassword ​

addPassword: "addPassword"


getPasswords ​

getPasswords: "getPasswords"


removePassword ​

removePassword: "removePassword"


activate ​

activate: "activate"


deactivate ​

deactivate: "deactivate"


isReversible ​

isReversible: "isReversible"


closeEntry ​

closeEntry: "closeEntry"


openEntry ​

openEntry: "openEntry"


getDevice ​

getDevice: "getDevice"


releaseDevice ​

releaseDevice: "releaseDevice"


adoptDevice ​

adoptDevice: "adoptDevice"


discoverDevices ​

discoverDevices: "discoverDevices"


createDevice ​

createDevice: "createDevice"


getCreateDeviceSettings ​

getCreateDeviceSettings: "getCreateDeviceSettings"


reboot ​

reboot: "reboot"


getRefreshFrequency ​

getRefreshFrequency: "getRefreshFrequency"


refresh ​

refresh: "refresh"


getMediaStatus ​

getMediaStatus: "getMediaStatus"


load ​

load: "load"


seek ​

seek: "seek"


skipNext ​

skipNext: "skipNext"


skipPrevious ​

skipPrevious: "skipPrevious"


convert ​

convert: "convert"


convertMedia ​

convertMedia: "convertMedia"


getSettings ​

getSettings: "getSettings"


putSetting ​

putSetting: "putSetting"


armSecuritySystem ​

armSecuritySystem: "armSecuritySystem"


disarmSecuritySystem ​

disarmSecuritySystem: "disarmSecuritySystem"


setAirPurifierState ​

setAirPurifierState: "setAirPurifierState"


getReadmeMarkdown ​

getReadmeMarkdown: "getReadmeMarkdown"


getOauthUrl ​

getOauthUrl: "getOauthUrl"


onOauthCallback ​

onOauthCallback: "onOauthCallback"


canMixin ​

canMixin: "canMixin"


getMixin ​

getMixin: "getMixin"


releaseMixin ​

releaseMixin: "releaseMixin"


onRequest ​

onRequest: "onRequest"


onConnection ​

onConnection: "onConnection"


onPush ​

onPush: "onPush"


run ​

run: "run"


eval ​

eval: "eval"


loadScripts ​

loadScripts: "loadScripts"


saveScript ​

saveScript: "saveScript"


forkInterface ​

forkInterface: "forkInterface"


trackObjects ​

trackObjects: "trackObjects"


getDetectionInput ​

getDetectionInput: "getDetectionInput"


getObjectTypes ​

getObjectTypes: "getObjectTypes"


detectObjects ​

detectObjects: "detectObjects"


generateObjectDetections ​

generateObjectDetections: "generateObjectDetections"


getDetectionModel ​

getDetectionModel: "getDetectionModel"


setHumidity ​

setHumidity: "setHumidity"


setFan ​

setFan: "setFan"


startRTCSignalingSession ​

startRTCSignalingSession: "startRTCSignalingSession"


createRTCSignalingSession ​

createRTCSignalingSession: "createRTCSignalingSession"


getScryptedUserAccessControl ​

getScryptedUserAccessControl: "getScryptedUserAccessControl"


generateVideoFrames ​

generateVideoFrames: "generateVideoFrames"


connectStream ​

connectStream: "connectStream"


getTTYSettings ​

getTTYSettings: "getTTYSettings"


getChatCompletion ​

getChatCompletion: "getChatCompletion"


streamChatCompletion ​

streamChatCompletion: "streamChatCompletion"


callLLMTool ​

callLLMTool: "callLLMTool"


getLLMTools ​

getLLMTools: "getLLMTools"