obs-websocket中SetSceneItemTransform接口的注意事项

问题现象分析

在obs-websocket 5.4.2版本中，开发者报告了一个关于SetSceneItemTransform接口的异常行为。当尝试通过WebSocket请求修改场景项的宽度(width)属性时，虽然服务器返回了错误响应"Failed"，但实际上场景项的宽度确实被成功修改了。

技术背景

obs-websocket是OBS Studio的一个插件，提供了通过WebSocket协议远程控制OBS的接口。SetSceneItemTransform是其中一个重要接口，用于修改场景项的各种变换属性。

问题根源

经过分析，这个问题源于对接口参数理解的偏差。虽然GetSceneItemTransform接口返回的数据中包含width、height、sourceWidth和sourceHeight等属性，但这些属性在SetSceneItemTransform接口中实际上是只读的。

正确的使用方法

要正确修改场景项的大小，应该使用scaleX和scaleY参数，而不是直接修改width或height。这是因为：

1. OBS内部使用缩放因子(scale)而非绝对尺寸来控制场景项大小
2. width/height等属性是计算得出的结果值，不是直接可设置的参数
3. 直接修改这些属性可能导致不可预期的行为

开发建议

1. 仔细阅读接口文档，区分可写属性和只读属性
2. 使用GetSceneItemTransform获取当前状态时，注意哪些属性可以用于设置
3. 修改尺寸时优先考虑使用scaleX/scaleY参数
4. 处理响应时，即使操作看似成功，也应尊重API返回的状态码

总结

这个案例提醒我们，在使用API时不能仅凭返回数据的结构来推断可设置的参数，而应该严格遵循接口文档的说明。obs-websocket的SetSceneItemTransform接口设计上区分了可写和只读属性，这是为了保持接口的清晰性和一致性。开发者在使用时应当注意这一设计特点，避免误用只读属性。