interaction

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 24, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package interaction is the isolated SDK for the Agentic Interaction JSON-RPC bridge. It knows the native unix-socket transport, discovers the running app with system.describe, exposes method constants and typed request params for the current native surface, and keeps subscription connections alive for streaming RPC methods.

Index

Constants

View Source
const (
	MethodSystemDescribe = "system.describe"
	MethodSystemStatus   = "system.status"
	MethodSystemHealth   = "system.health"

	MethodDevicesList = "devices.list"

	MethodPermissionsStatus                    = "permissions.status"
	MethodPermissionsRequestMicrophone         = "permissions.request_microphone"
	MethodPermissionsRequestAccessibility      = "permissions.request_accessibility"
	MethodPermissionsOpenAccessibilitySettings = "permissions.open_accessibility_settings"

	MethodModelsCatalog             = "models.catalog"
	MethodModelsParakeetEOUStatus   = "models.parakeet_eou.status"
	MethodModelsParakeetEOUEnsure   = "models.parakeet_eou.ensure"
	MethodModelsParakeetEOUDownload = "models.parakeet_eou.download"
	MethodModelsParakeetEOUDelete   = "models.parakeet_eou.delete"
	MethodModelsDownloadJob         = "models.download_job"
	MethodModelsDownloadCancel      = "models.download_cancel"

	MethodTranscriptGet     = "transcript.get"
	MethodTranscriptSet     = "transcript.set"
	MethodTranscriptCopy    = "transcript.copy"
	MethodTranscriptInsert  = "transcript.insert"
	MethodTranscriptProcess = "transcript.process"

	MethodSTTStart             = "stt.start"
	MethodSTTStop              = "stt.stop"
	MethodSTTReset             = "stt.reset"
	MethodSTTStatus            = "stt.status"
	MethodSTTEventsSubscribe   = "stt.events.subscribe"
	MethodSTTEventsUnsubscribe = "stt.events.unsubscribe"
	MethodSTTModelsList        = "stt.models.list"
	MethodSTTModelGet          = "stt.model.get"
	MethodSTTModelSet          = "stt.model.set"
	MethodSTTModelDownload     = "stt.model.download"

	MethodTTSSpeak           = "tts.speak"
	MethodTTSSave            = "tts.save"
	MethodTTSStop            = "tts.stop"
	MethodTTSStatus          = "tts.status"
	MethodTTSVoicesList      = "tts.voices.list"
	MethodTTSConfigGet       = "tts.config.get"
	MethodTTSConfigSet       = "tts.config.set"
	MethodTTSSpeakSelected   = "tts.speak_selected"
	MethodTTSSpeakTranscript = "tts.speak_transcript"

	MethodNotificationAudioCatalog = "notification.audio.catalog"
	MethodNotificationAudioPlay    = "notification.audio.play"
	MethodNotificationAudioStop    = "notification.audio.stop"
	MethodNotificationAudioStatus  = "notification.audio.status"

	MethodAccessibilityStatus            = "accessibility.status"
	MethodAccessibilityRequestPermission = "accessibility.request_permission"
	MethodAccessibilityOpenSettings      = "accessibility.open_settings"
	MethodAccessibilityTreeFocused       = "accessibility.tree.focused"
	MethodAccessibilityTargetsList       = "accessibility.targets.list"
	MethodAccessibilityAppsList          = "accessibility.apps.list"
	MethodAccessibilityInsert            = "accessibility.insert"
	MethodAccessibilityClickInsert       = "accessibility.click_insert"

	MethodScreenClick = "screen.click"

	MethodObservationPermissionStatus  = "observation.permission_status"
	MethodObservationRequestPermission = "observation.request_permission"
	MethodObservationScreenshot        = "observation.screenshot"
	MethodObservationRecordingStart    = "observation.recording.start"
	MethodObservationRecordingStop     = "observation.recording.stop"
	MethodObservationRecordingStatus   = "observation.recording.status"
	MethodObservationRecordingsList    = "observation.recordings.list"
	MethodObservationEventsSubscribe   = "observation.events.subscribe"
	MethodObservationEventsUnsubscribe = "observation.events.unsubscribe"

	MethodAppsOpen     = "apps.open"
	MethodAppsActivate = "apps.activate"
)
View Source
const (
	MethodDiagnosticsStatus            = "diagnostics.status"
	MethodDiagnosticsList              = "diagnostics.list"
	MethodDiagnosticsLog               = "diagnostics.log"
	MethodDiagnosticsAcknowledge       = "diagnostics.acknowledge"
	MethodDiagnosticsResolve           = "diagnostics.resolve"
	MethodDiagnosticsClear             = "diagnostics.clear"
	MethodDiagnosticsEventsSubscribe   = "diagnostics.events.subscribe"
	MethodDiagnosticsEventsUnsubscribe = "diagnostics.events.unsubscribe"

	MethodSTTRealtimeModelsList           = "stt.realtime.models.list"
	MethodSTTRealtimeModelGet             = "stt.realtime.model.get"
	MethodSTTRealtimeModelSet             = "stt.realtime.model.set"
	MethodSTTRealtimeModelDownload        = "stt.realtime.model.download"
	MethodSTTRealtimePrewarm              = "stt.realtime.prewarm"
	MethodSTTRealtimeFileTranscribeStart  = "stt.realtime.file_transcribe.start"
	MethodSTTRealtimeFileTranscribeStatus = "stt.realtime.file_transcribe.status"
	MethodSTTRealtimeFileTranscribeResult = "stt.realtime.file_transcribe.result"
	MethodSTTRealtimeFileTranscribeCancel = "stt.realtime.file_transcribe.cancel"
	MethodSTTRealtimeFileTranscribeList   = "stt.realtime.file_transcribe.list"

	MethodSTTBatchModelsList       = "stt.batch.models.list"
	MethodSTTBatchModelGet         = "stt.batch.model.get"
	MethodSTTBatchModelSet         = "stt.batch.model.set"
	MethodSTTBatchModelDownload    = "stt.batch.model.download"
	MethodSTTBatchModelEnsure      = "stt.batch.model.ensure"
	MethodSTTBatchTranscribeStart  = "stt.batch.transcribe.start"
	MethodSTTBatchTranscribeStatus = "stt.batch.transcribe.status"
	MethodSTTBatchTranscribeResult = "stt.batch.transcribe.result"
	MethodSTTBatchTranscribeCancel = "stt.batch.transcribe.cancel"
	MethodSTTBatchTranscribeList   = "stt.batch.transcribe.list"

	MethodTTSPause  = "tts.pause"
	MethodTTSResume = "tts.resume"

	MethodAccessibilityContextCapture = "accessibility.context.capture"
	MethodAccessibilityContextScreen  = "accessibility.context.screen"
	MethodAccessibilityFind           = "accessibility.find"
	MethodAccessibilityActionPerform  = "accessibility.action.perform"
	MethodAccessibilitySelectionSet   = "accessibility.selection.set"
	MethodAccessibilityTextReplace    = "accessibility.text.replace"
	MethodAccessibilityTextInspect    = "accessibility.text.inspect"

	MethodAppsInstalledList = "apps.installed.list"
	MethodAppsFind          = "apps.find"
)
View Source
const SocketEnv = "AGENTIC_INTERACTION_RPC_SOCKET"

Variables

View Source
var AllMethods = []string{
	MethodSystemDescribe,
	MethodSystemStatus,
	MethodSystemHealth,
	MethodDevicesList,
	MethodPermissionsStatus,
	MethodPermissionsRequestMicrophone,
	MethodPermissionsRequestAccessibility,
	MethodPermissionsOpenAccessibilitySettings,
	MethodModelsCatalog,
	MethodModelsParakeetEOUStatus,
	MethodModelsParakeetEOUEnsure,
	MethodModelsParakeetEOUDownload,
	MethodModelsParakeetEOUDelete,
	MethodModelsDownloadJob,
	MethodModelsDownloadCancel,
	MethodTranscriptGet,
	MethodTranscriptSet,
	MethodTranscriptCopy,
	MethodTranscriptInsert,
	MethodTranscriptProcess,
	MethodSTTStart,
	MethodSTTStop,
	MethodSTTReset,
	MethodSTTStatus,
	MethodSTTEventsSubscribe,
	MethodSTTEventsUnsubscribe,
	MethodSTTModelsList,
	MethodSTTModelGet,
	MethodSTTModelSet,
	MethodSTTModelDownload,
	MethodTTSSpeak,
	MethodTTSSave,
	MethodTTSStop,
	MethodTTSStatus,
	MethodTTSVoicesList,
	MethodTTSConfigGet,
	MethodTTSConfigSet,
	MethodTTSSpeakSelected,
	MethodTTSSpeakTranscript,
	MethodNotificationAudioCatalog,
	MethodNotificationAudioPlay,
	MethodNotificationAudioStop,
	MethodNotificationAudioStatus,
	MethodAccessibilityStatus,
	MethodAccessibilityRequestPermission,
	MethodAccessibilityOpenSettings,
	MethodAccessibilityTreeFocused,
	MethodAccessibilityTargetsList,
	MethodAccessibilityAppsList,
	MethodAccessibilityInsert,
	MethodAccessibilityClickInsert,
	MethodScreenClick,
	MethodObservationPermissionStatus,
	MethodObservationRequestPermission,
	MethodObservationScreenshot,
	MethodObservationRecordingStart,
	MethodObservationRecordingStop,
	MethodObservationRecordingStatus,
	MethodObservationRecordingsList,
	MethodObservationEventsSubscribe,
	MethodObservationEventsUnsubscribe,
	MethodAppsOpen,
	MethodAppsActivate,
}

Functions

func DefaultSocketPath

func DefaultSocketPath() string

Types

type AccessibilityActionParams

type AccessibilityActionParams struct {
	TargetPath         string `json:"target_path"`
	TargetBundleID     string `json:"target_bundle_id,omitempty"`
	TargetPID          *int   `json:"target_pid,omitempty"`
	Action             string `json:"action,omitempty"`
	AllowFallbackClick *bool  `json:"allow_fallback_click,omitempty"`
	FocusPolicy        string `json:"focus_policy,omitempty"`
}

type AccessibilityContextParams

type AccessibilityContextParams struct {
	MaxDepth       *int   `json:"max_depth,omitempty"`
	MaxChildren    *int   `json:"max_children,omitempty"`
	MaxElements    *int   `json:"max_elements,omitempty"`
	TargetBundleID string `json:"target_bundle_id,omitempty"`
	TargetPID      *int   `json:"target_pid,omitempty"`
	IncludePrompt  *bool  `json:"include_prompt,omitempty"`
}

type AccessibilityFindParams

type AccessibilityFindParams struct {
	Query          string `json:"query"`
	Role           string `json:"role,omitempty"`
	Category       string `json:"category,omitempty"`
	MaxResults     *int   `json:"max_results,omitempty"`
	MaxDepth       *int   `json:"max_depth,omitempty"`
	MaxChildren    *int   `json:"max_children,omitempty"`
	MaxElements    *int   `json:"max_elements,omitempty"`
	TargetBundleID string `json:"target_bundle_id,omitempty"`
	TargetPID      *int   `json:"target_pid,omitempty"`
}

type AccessibilitySelectionSetParams

type AccessibilitySelectionSetParams struct {
	TargetPath            string         `json:"target_path"`
	TargetBundleID        string         `json:"target_bundle_id,omitempty"`
	TargetPID             *int           `json:"target_pid,omitempty"`
	Range                 map[string]any `json:"range,omitempty"`
	MatchText             string         `json:"match_text,omitempty"`
	Occurrence            string         `json:"occurrence,omitempty"`
	TargetRegion          string         `json:"target_region,omitempty"`
	Selected              *bool          `json:"selected,omitempty"`
	ClearSiblingSelection *bool          `json:"clear_sibling_selection,omitempty"`
	FocusPolicy           string         `json:"focus_policy,omitempty"`
}

type AccessibilityTextInspectParams

type AccessibilityTextInspectParams struct {
	TargetPath     string         `json:"target_path"`
	TargetBundleID string         `json:"target_bundle_id,omitempty"`
	TargetPID      *int           `json:"target_pid,omitempty"`
	Range          map[string]any `json:"range,omitempty"`
	MatchText      string         `json:"match_text,omitempty"`
	Occurrence     string         `json:"occurrence,omitempty"`
	TargetRegion   string         `json:"target_region,omitempty"`
	FocusPolicy    string         `json:"focus_policy,omitempty"`
}

type AccessibilityTextReplaceParams

type AccessibilityTextReplaceParams struct {
	TargetPath      string `json:"target_path"`
	TargetBundleID  string `json:"target_bundle_id,omitempty"`
	TargetPID       *int   `json:"target_pid,omitempty"`
	FindText        string `json:"find_text"`
	ReplacementText string `json:"replacement_text"`
	Occurrence      string `json:"occurrence,omitempty"`
	TargetRegion    string `json:"target_region,omitempty"`
	PreserveStyle   *bool  `json:"preserve_style,omitempty"`
	FocusPolicy     string `json:"focus_policy,omitempty"`
}

type ApplicationActivateParams

type ApplicationActivateParams struct {
	PID      *int   `json:"pid,omitempty"`
	BundleID string `json:"bundle_id,omitempty"`
}

type ApplicationFindParams

type ApplicationFindParams struct {
	Query             string `json:"query,omitempty"`
	BundleID          string `json:"bundle_id,omitempty"`
	Name              string `json:"name,omitempty"`
	Path              string `json:"path,omitempty"`
	MaxResults        *int   `json:"max_results,omitempty"`
	IncludeSystemApps *bool  `json:"include_system_apps,omitempty"`
	IncludeUserApps   *bool  `json:"include_user_apps,omitempty"`
}

type ApplicationInventoryParams

type ApplicationInventoryParams struct {
	MaxDepth              *int  `json:"max_depth,omitempty"`
	MaxChildren           *int  `json:"max_children,omitempty"`
	IncludeBackgroundApps *bool `json:"include_background_apps,omitempty"`
}

type ApplicationOpenParams

type ApplicationOpenParams struct {
	Path     string `json:"path,omitempty"`
	BundleID string `json:"bundle_id,omitempty"`
	Name     string `json:"name,omitempty"`
	Activate *bool  `json:"activate,omitempty"`
}

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(socketPath string) *Client

func NewClientFromEnv

func NewClientFromEnv() *Client

func (*Client) AccessibilityActionPerform

func (c *Client) AccessibilityActionPerform(ctx context.Context, params AccessibilityActionParams) (json.RawMessage, error)

func (*Client) AccessibilityAppsList

func (c *Client) AccessibilityAppsList(ctx context.Context, params ApplicationInventoryParams) (json.RawMessage, error)

func (*Client) AccessibilityClickInsert

func (c *Client) AccessibilityClickInsert(ctx context.Context, params CoordinateInsertParams) (json.RawMessage, error)

func (*Client) AccessibilityContextCapture

func (c *Client) AccessibilityContextCapture(ctx context.Context, params AccessibilityContextParams) (json.RawMessage, error)

func (*Client) AccessibilityContextScreen

func (c *Client) AccessibilityContextScreen(ctx context.Context, params AccessibilityContextParams) (json.RawMessage, error)

func (*Client) AccessibilityFind

func (c *Client) AccessibilityFind(ctx context.Context, params AccessibilityFindParams) (json.RawMessage, error)

func (*Client) AccessibilityInsert

func (c *Client) AccessibilityInsert(ctx context.Context, params InsertParams) (json.RawMessage, error)

func (*Client) AccessibilityOpenSettings

func (c *Client) AccessibilityOpenSettings(ctx context.Context) (json.RawMessage, error)

func (*Client) AccessibilityRequestPermission

func (c *Client) AccessibilityRequestPermission(ctx context.Context) (json.RawMessage, error)

func (*Client) AccessibilitySelectionSet

func (c *Client) AccessibilitySelectionSet(ctx context.Context, params AccessibilitySelectionSetParams) (json.RawMessage, error)

func (*Client) AccessibilityStatus

func (c *Client) AccessibilityStatus(ctx context.Context) (json.RawMessage, error)

func (*Client) AccessibilityTargetsList

func (c *Client) AccessibilityTargetsList(ctx context.Context, params TreeParams) (json.RawMessage, error)

func (*Client) AccessibilityTextInspect

func (c *Client) AccessibilityTextInspect(ctx context.Context, params AccessibilityTextInspectParams) (json.RawMessage, error)

func (*Client) AccessibilityTextReplace

func (c *Client) AccessibilityTextReplace(ctx context.Context, params AccessibilityTextReplaceParams) (json.RawMessage, error)

func (*Client) AccessibilityTreeFocused

func (c *Client) AccessibilityTreeFocused(ctx context.Context, params TreeParams) (json.RawMessage, error)

func (*Client) AppsActivate

func (c *Client) AppsActivate(ctx context.Context, params ApplicationActivateParams) (json.RawMessage, error)

func (*Client) AppsFind

func (c *Client) AppsFind(ctx context.Context, params ApplicationFindParams) (json.RawMessage, error)

func (*Client) AppsInstalledList

func (c *Client) AppsInstalledList(ctx context.Context, params InstalledApplicationsParams) (json.RawMessage, error)

func (*Client) AppsOpen

func (c *Client) AppsOpen(ctx context.Context, params ApplicationOpenParams) (json.RawMessage, error)

func (*Client) Call

func (c *Client) Call(ctx context.Context, method string, params any) (json.RawMessage, error)

func (*Client) CallInto

func (c *Client) CallInto(ctx context.Context, method string, params any, target any) error

func (*Client) Describe

func (c *Client) Describe() Status

func (*Client) DevicesList

func (c *Client) DevicesList(ctx context.Context) (json.RawMessage, error)

func (*Client) DiagnosticsAcknowledge

func (c *Client) DiagnosticsAcknowledge(ctx context.Context, params DiagnosticsIssueParams) (json.RawMessage, error)

func (*Client) DiagnosticsClear

func (c *Client) DiagnosticsClear(ctx context.Context) (json.RawMessage, error)

func (*Client) DiagnosticsEventsSubscribe

func (c *Client) DiagnosticsEventsSubscribe(ctx context.Context, params DiagnosticsEventSubscribeParams, onNotification func(method string, params json.RawMessage)) (*Subscription, error)

func (*Client) DiagnosticsEventsUnsubscribe

func (c *Client) DiagnosticsEventsUnsubscribe(ctx context.Context, params EventUnsubscribeParams) (json.RawMessage, error)

func (*Client) DiagnosticsList

func (c *Client) DiagnosticsList(ctx context.Context, params DiagnosticsListParams) (json.RawMessage, error)

func (*Client) DiagnosticsLog

func (c *Client) DiagnosticsLog(ctx context.Context, params DiagnosticsLogParams) (json.RawMessage, error)

func (*Client) DiagnosticsResolve

func (c *Client) DiagnosticsResolve(ctx context.Context, params DiagnosticsIssueParams) (json.RawMessage, error)

func (*Client) DiagnosticsStatus

func (c *Client) DiagnosticsStatus(ctx context.Context) (json.RawMessage, error)

func (*Client) ModelsCatalog

func (c *Client) ModelsCatalog(ctx context.Context) (json.RawMessage, error)

func (*Client) ModelsDownloadCancel

func (c *Client) ModelsDownloadCancel(ctx context.Context, params ModelJobParams) (json.RawMessage, error)

func (*Client) ModelsDownloadJob

func (c *Client) ModelsDownloadJob(ctx context.Context, params ModelJobParams) (json.RawMessage, error)

func (*Client) ModelsParakeetEOUDelete

func (c *Client) ModelsParakeetEOUDelete(ctx context.Context, params ModelVariantParams) (json.RawMessage, error)

func (*Client) ModelsParakeetEOUDownload

func (c *Client) ModelsParakeetEOUDownload(ctx context.Context, params ModelVariantParams) (json.RawMessage, error)

func (*Client) ModelsParakeetEOUEnsure

func (c *Client) ModelsParakeetEOUEnsure(ctx context.Context, params ModelVariantParams) (json.RawMessage, error)

func (*Client) ModelsParakeetEOUStatus

func (c *Client) ModelsParakeetEOUStatus(ctx context.Context, params ModelVariantParams) (json.RawMessage, error)

func (*Client) NotificationAudioCatalog

func (c *Client) NotificationAudioCatalog(ctx context.Context) (json.RawMessage, error)

func (*Client) NotificationAudioPlay

func (c *Client) NotificationAudioPlay(ctx context.Context, params NotificationAudioPlayParams) (json.RawMessage, error)

func (*Client) NotificationAudioStatus

func (c *Client) NotificationAudioStatus(ctx context.Context) (json.RawMessage, error)

func (*Client) NotificationAudioStop

func (c *Client) NotificationAudioStop(ctx context.Context, params NotificationAudioStopParams) (json.RawMessage, error)

func (*Client) ObservationEventsSubscribe

func (c *Client) ObservationEventsSubscribe(ctx context.Context, params EventSubscribeParams, onNotification func(method string, params json.RawMessage)) (*Subscription, error)

func (*Client) ObservationEventsUnsubscribe

func (c *Client) ObservationEventsUnsubscribe(ctx context.Context, params EventUnsubscribeParams) (json.RawMessage, error)

func (*Client) ObservationPermissionStatus

func (c *Client) ObservationPermissionStatus(ctx context.Context) (json.RawMessage, error)

func (*Client) ObservationRecordingStart

func (c *Client) ObservationRecordingStart(ctx context.Context, params ObservationRecordingStartParams) (json.RawMessage, error)

func (*Client) ObservationRecordingStatus

func (c *Client) ObservationRecordingStatus(ctx context.Context, params ObservationRecordingIDParams) (json.RawMessage, error)

func (*Client) ObservationRecordingStop

func (c *Client) ObservationRecordingStop(ctx context.Context, params ObservationRecordingIDParams) (json.RawMessage, error)

func (*Client) ObservationRecordingsList

func (c *Client) ObservationRecordingsList(ctx context.Context) (json.RawMessage, error)

func (*Client) ObservationRequestPermission

func (c *Client) ObservationRequestPermission(ctx context.Context) (json.RawMessage, error)

func (*Client) ObservationScreenshot

func (c *Client) ObservationScreenshot(ctx context.Context, params ObservationScreenshotParams) (json.RawMessage, error)

func (*Client) PermissionsOpenAccessibilitySettings

func (c *Client) PermissionsOpenAccessibilitySettings(ctx context.Context) (json.RawMessage, error)

func (*Client) PermissionsRequestAccessibility

func (c *Client) PermissionsRequestAccessibility(ctx context.Context) (json.RawMessage, error)

func (*Client) PermissionsRequestMicrophone

func (c *Client) PermissionsRequestMicrophone(ctx context.Context) (json.RawMessage, error)

func (*Client) PermissionsStatus

func (c *Client) PermissionsStatus(ctx context.Context) (json.RawMessage, error)

func (*Client) Refresh

func (c *Client) Refresh(ctx context.Context) error

func (*Client) STTBatchModelDownload

func (c *Client) STTBatchModelDownload(ctx context.Context, params STTModelDownloadParams) (json.RawMessage, error)

func (*Client) STTBatchModelEnsure

func (c *Client) STTBatchModelEnsure(ctx context.Context, params STTModelDownloadParams) (json.RawMessage, error)

func (*Client) STTBatchModelGet

func (c *Client) STTBatchModelGet(ctx context.Context) (json.RawMessage, error)

func (*Client) STTBatchModelSet

func (c *Client) STTBatchModelSet(ctx context.Context, params STTModelSetParams) (json.RawMessage, error)

func (*Client) STTBatchModelsList

func (c *Client) STTBatchModelsList(ctx context.Context) (json.RawMessage, error)

func (*Client) STTBatchTranscribeCancel

func (c *Client) STTBatchTranscribeCancel(ctx context.Context, params STTJobParams) (json.RawMessage, error)

func (*Client) STTBatchTranscribeList

func (c *Client) STTBatchTranscribeList(ctx context.Context) (json.RawMessage, error)

func (*Client) STTBatchTranscribeResult

func (c *Client) STTBatchTranscribeResult(ctx context.Context, params STTJobParams) (json.RawMessage, error)

func (*Client) STTBatchTranscribeStart

func (c *Client) STTBatchTranscribeStart(ctx context.Context, params any) (json.RawMessage, error)

func (*Client) STTBatchTranscribeStatus

func (c *Client) STTBatchTranscribeStatus(ctx context.Context, params STTJobParams) (json.RawMessage, error)

func (*Client) STTEventsSubscribe

func (c *Client) STTEventsSubscribe(ctx context.Context, params EventSubscribeParams, onNotification func(method string, params json.RawMessage)) (*Subscription, error)

func (*Client) STTEventsUnsubscribe

func (c *Client) STTEventsUnsubscribe(ctx context.Context, params EventUnsubscribeParams) (json.RawMessage, error)

func (*Client) STTModelDownload

func (c *Client) STTModelDownload(ctx context.Context, params STTModelDownloadParams) (json.RawMessage, error)

func (*Client) STTModelGet

func (c *Client) STTModelGet(ctx context.Context) (json.RawMessage, error)

func (*Client) STTModelSet

func (c *Client) STTModelSet(ctx context.Context, params STTModelSetParams) (json.RawMessage, error)

func (*Client) STTModelsList

func (c *Client) STTModelsList(ctx context.Context) (json.RawMessage, error)

func (*Client) STTRealtimeFileTranscribeCancel

func (c *Client) STTRealtimeFileTranscribeCancel(ctx context.Context, params STTJobParams) (json.RawMessage, error)

func (*Client) STTRealtimeFileTranscribeList

func (c *Client) STTRealtimeFileTranscribeList(ctx context.Context) (json.RawMessage, error)

func (*Client) STTRealtimeFileTranscribeResult

func (c *Client) STTRealtimeFileTranscribeResult(ctx context.Context, params STTJobParams) (json.RawMessage, error)

func (*Client) STTRealtimeFileTranscribeStart

func (c *Client) STTRealtimeFileTranscribeStart(ctx context.Context, params any) (json.RawMessage, error)

func (*Client) STTRealtimeFileTranscribeStatus

func (c *Client) STTRealtimeFileTranscribeStatus(ctx context.Context, params STTJobParams) (json.RawMessage, error)

func (*Client) STTRealtimeModelDownload

func (c *Client) STTRealtimeModelDownload(ctx context.Context, params STTModelDownloadParams) (json.RawMessage, error)

func (*Client) STTRealtimeModelGet

func (c *Client) STTRealtimeModelGet(ctx context.Context) (json.RawMessage, error)

func (*Client) STTRealtimeModelSet

func (c *Client) STTRealtimeModelSet(ctx context.Context, params STTModelSetParams) (json.RawMessage, error)

func (*Client) STTRealtimeModelsList

func (c *Client) STTRealtimeModelsList(ctx context.Context) (json.RawMessage, error)

func (*Client) STTRealtimePrewarm

func (c *Client) STTRealtimePrewarm(ctx context.Context) (json.RawMessage, error)

func (*Client) STTReset

func (c *Client) STTReset(ctx context.Context) (json.RawMessage, error)

func (*Client) STTStart

func (c *Client) STTStart(ctx context.Context) (json.RawMessage, error)

func (*Client) STTStatus

func (c *Client) STTStatus(ctx context.Context) (json.RawMessage, error)

func (*Client) STTStop

func (c *Client) STTStop(ctx context.Context) (json.RawMessage, error)

func (*Client) ScreenClick

func (c *Client) ScreenClick(ctx context.Context, params ScreenClickParams) (json.RawMessage, error)

func (*Client) SocketPath

func (c *Client) SocketPath() string

func (*Client) StartSubscription

func (c *Client) StartSubscription(
	ctx context.Context,
	method string,
	params any,
	onNotification func(method string, params json.RawMessage),
) (*Subscription, error)

func (*Client) SystemDescribe

func (c *Client) SystemDescribe(ctx context.Context) (json.RawMessage, error)

func (*Client) SystemHealth

func (c *Client) SystemHealth(ctx context.Context) (json.RawMessage, error)

func (*Client) SystemStatus

func (c *Client) SystemStatus(ctx context.Context) (json.RawMessage, error)

func (*Client) TTSConfigGet

func (c *Client) TTSConfigGet(ctx context.Context) (json.RawMessage, error)

func (*Client) TTSConfigSet

func (c *Client) TTSConfigSet(ctx context.Context, params TTSConfigSetParams) (json.RawMessage, error)

func (*Client) TTSPause

func (c *Client) TTSPause(ctx context.Context) (json.RawMessage, error)

func (*Client) TTSResume

func (c *Client) TTSResume(ctx context.Context) (json.RawMessage, error)

func (*Client) TTSSave

func (c *Client) TTSSave(ctx context.Context, params TTSSynthesizeParams) (json.RawMessage, error)

func (*Client) TTSSpeak

func (c *Client) TTSSpeak(ctx context.Context, params TTSSynthesizeParams) (json.RawMessage, error)

func (*Client) TTSSpeakSelected

func (c *Client) TTSSpeakSelected(ctx context.Context) (json.RawMessage, error)

func (*Client) TTSSpeakTranscript

func (c *Client) TTSSpeakTranscript(ctx context.Context) (json.RawMessage, error)

func (*Client) TTSStatus

func (c *Client) TTSStatus(ctx context.Context) (json.RawMessage, error)

func (*Client) TTSStop

func (c *Client) TTSStop(ctx context.Context) (json.RawMessage, error)

func (*Client) TTSVoicesList

func (c *Client) TTSVoicesList(ctx context.Context) (json.RawMessage, error)

func (*Client) TranscriptCopy

func (c *Client) TranscriptCopy(ctx context.Context) (json.RawMessage, error)

func (*Client) TranscriptGet

func (c *Client) TranscriptGet(ctx context.Context) (json.RawMessage, error)

func (*Client) TranscriptInsert

func (c *Client) TranscriptInsert(ctx context.Context, params OptionalTextParams) (json.RawMessage, error)

func (*Client) TranscriptProcess

func (c *Client) TranscriptProcess(ctx context.Context, params any) (json.RawMessage, error)

func (*Client) TranscriptSet

func (c *Client) TranscriptSet(ctx context.Context, params TextParams) (json.RawMessage, error)

type CoordinateInsertParams

type CoordinateInsertParams struct {
	Text string  `json:"text"`
	X    float64 `json:"x"`
	Y    float64 `json:"y"`
}

type DiagnosticsEventSubscribeParams

type DiagnosticsEventSubscribeParams struct {
	Severities []string `json:"severities,omitempty"`
	Domains    []string `json:"domains,omitempty"`
}

type DiagnosticsIssueParams

type DiagnosticsIssueParams struct {
	IssueID string `json:"issue_id"`
}

type DiagnosticsListParams

type DiagnosticsListParams struct {
	Limit       *int   `json:"limit,omitempty"`
	Severity    string `json:"severity,omitempty"`
	Domain      string `json:"domain,omitempty"`
	Operation   string `json:"operation,omitempty"`
	OperationID string `json:"operation_id,omitempty"`
}

type DiagnosticsLogParams

type DiagnosticsLogParams struct {
	Limit       *int   `json:"limit,omitempty"`
	Severity    string `json:"severity,omitempty"`
	Domain      string `json:"domain,omitempty"`
	Operation   string `json:"operation,omitempty"`
	OperationID string `json:"operation_id,omitempty"`
	Since       string `json:"since,omitempty"`
	MaxBytes    *int   `json:"max_bytes,omitempty"`
}

type EventSubscribeParams

type EventSubscribeParams struct {
	Kinds []string `json:"kinds,omitempty"`
}

type EventUnsubscribeParams

type EventUnsubscribeParams struct {
	SubscriptionID string `json:"subscription_id"`
}

type InsertParams

type InsertParams struct {
	Text              string `json:"text"`
	TargetPath        string `json:"target_path,omitempty"`
	TargetBundleID    string `json:"target_bundle_id,omitempty"`
	TargetAppName     string `json:"target_app_name,omitempty"`
	TargetWindowTitle string `json:"target_window_title,omitempty"`
	TargetPID         *int   `json:"target_pid,omitempty"`
	Mode              string `json:"mode,omitempty"`
	TargetRegion      string `json:"target_region,omitempty"`
	FocusPolicy       string `json:"focus_policy,omitempty"`
}

type InstalledApplicationsParams

type InstalledApplicationsParams struct {
	Query             string `json:"query,omitempty"`
	MaxResults        *int   `json:"max_results,omitempty"`
	IncludeSystemApps *bool  `json:"include_system_apps,omitempty"`
	IncludeUserApps   *bool  `json:"include_user_apps,omitempty"`
}

type ModelJobParams

type ModelJobParams struct {
	ID string `json:"id,omitempty"`
}

type ModelVariantParams

type ModelVariantParams struct {
	Variant string `json:"variant,omitempty"`
}

type NotificationAudioPlayParams

type NotificationAudioPlayParams struct {
	SystemSound string   `json:"system_sound,omitempty"`
	Path        string   `json:"path,omitempty"`
	Event       string   `json:"event,omitempty"`
	Volume      *float64 `json:"volume,omitempty"`
	Interrupt   *bool    `json:"interrupt,omitempty"`
}

type NotificationAudioStopParams

type NotificationAudioStopParams struct {
	All *bool `json:"all,omitempty"`
}

type ObservationRecordingIDParams

type ObservationRecordingIDParams struct {
	RecordingID string `json:"recording_id,omitempty"`
}

type ObservationRecordingStartParams

type ObservationRecordingStartParams struct {
	Target           map[string]any `json:"target,omitempty"`
	SavePath         string         `json:"save_path,omitempty"`
	CountdownSeconds *float64       `json:"countdown_seconds,omitempty"`
	RecordForSeconds *float64       `json:"record_for_seconds,omitempty"`
	FPS              *float64       `json:"fps,omitempty"`
}

type ObservationScreenshotParams

type ObservationScreenshotParams struct {
	Target   map[string]any `json:"target,omitempty"`
	SavePath string         `json:"save_path,omitempty"`
	Format   string         `json:"format,omitempty"`
}

type OptionalTextParams

type OptionalTextParams struct {
	Text string `json:"text,omitempty"`
}

type RPCError

type RPCError struct {
	Code    int             `json:"code"`
	Message string          `json:"message"`
	Data    json.RawMessage `json:"data,omitempty"`
}

func (RPCError) Error

func (e RPCError) Error() string

type STTJobParams

type STTJobParams struct {
	JobID string `json:"job_id"`
}

type STTModelDownloadParams

type STTModelDownloadParams struct {
	Model  string `json:"model,omitempty"`
	Select *bool  `json:"select,omitempty"`
}

type STTModelSetParams

type STTModelSetParams struct {
	Model string `json:"model"`
}

type ScreenClickParams

type ScreenClickParams struct {
	X float64 `json:"x"`
	Y float64 `json:"y"`
}

type Status

type Status struct {
	SchemaVersion string          `json:"schema_version,omitempty"`
	Service       string          `json:"service,omitempty"`
	Endpoint      string          `json:"endpoint,omitempty"`
	Transport     string          `json:"transport,omitempty"`
	Available     bool            `json:"available"`
	Methods       []string        `json:"methods,omitempty"`
	Capabilities  map[string]bool `json:"capabilities,omitempty"`
	LastError     string          `json:"last_error,omitempty"`
}

type Subscription

type Subscription struct {
	SubscriptionID string
	Result         json.RawMessage
	Cancel         func()
}

type TTSConfigSetParams

type TTSConfigSetParams struct {
	Voice             string   `json:"voice,omitempty"`
	VoiceSpeed        *float64 `json:"voice_speed,omitempty"`
	SpeakerID         *int     `json:"speaker_id,omitempty"`
	VariantPreference string   `json:"variant_preference,omitempty"`
	DeEss             *bool    `json:"de_ess,omitempty"`
	CustomLexiconPath string   `json:"custom_lexicon_path,omitempty"`
	CustomVoiceID     string   `json:"custom_voice_id,omitempty"`
	CustomVoicePath   string   `json:"custom_voice_path,omitempty"`
	ChunkCharacters   *int     `json:"chunk_characters,omitempty"`
	SaveWAVArtifacts  *bool    `json:"save_wav_artifacts,omitempty"`
	OutputDevice      string   `json:"output_device,omitempty"`
	Volume            *float64 `json:"volume,omitempty"`
}

type TTSSynthesizeParams

type TTSSynthesizeParams struct {
	Text              string   `json:"text"`
	Provider          string   `json:"provider,omitempty"`
	ModelPath         string   `json:"model_path,omitempty"`
	SavePath          string   `json:"save_path,omitempty"`
	Voice             string   `json:"voice,omitempty"`
	UseMetal          *bool    `json:"use_metal,omitempty"`
	Play              *bool    `json:"play,omitempty"`
	SaveWAV           *bool    `json:"save_wav,omitempty"`
	OutputDevice      string   `json:"output_device,omitempty"`
	Volume            *float64 `json:"volume,omitempty"`
	VoiceSpeed        *float64 `json:"voice_speed,omitempty"`
	SpeakerID         *int     `json:"speaker_id,omitempty"`
	VariantPreference string   `json:"variant_preference,omitempty"`
	DeEss             *bool    `json:"de_ess,omitempty"`
	CustomLexiconPath string   `json:"custom_lexicon_path,omitempty"`
	CustomVoiceID     string   `json:"custom_voice_id,omitempty"`
	CustomVoicePath   string   `json:"custom_voice_path,omitempty"`
	ChunkCharacters   *int     `json:"chunk_characters,omitempty"`
}

type TextParams

type TextParams struct {
	Text string `json:"text"`
}

type TreeParams

type TreeParams struct {
	MaxDepth    *int `json:"max_depth,omitempty"`
	MaxChildren *int `json:"max_children,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL