Skip to content

Commit 0092d4b

Browse files
JulusianCopilot
andauthored
Update packages/companion-surface-base/src/surface-api/plugin.ts
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 146eba4 commit 0092d4b

File tree

1 file changed

+5
-1
lines changed
  • packages/companion-surface-base/src/surface-api

1 file changed

+5
-1
lines changed

packages/companion-surface-base/src/surface-api/plugin.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,11 @@ export interface DiscoveredSurfaceInfo<TInfo> {
9595
export interface DetectionSurfaceInfo<TInfo> extends DiscoveredSurfaceInfo<TInfo> {
9696
/**
9797
* A stable unique identifier for the device.
98-
* Typically the device path if usb.
98+
*
99+
* This is the same logical concept that other interfaces may refer to as `devicePath`,
100+
* but is named `deviceHandle` here because, depending on the transport or platform,
101+
* it may not literally be a filesystem path. For USB devices it will typically be the
102+
* device path, while for other transports it can be another stable identifier.
99103
*/
100104
deviceHandle: string
101105
}

0 commit comments

Comments
 (0)