
Smart Device Management (SDM) API 支持所有旧版 Nest Cam。 这些设备会返回 CAMERA 设备类型:
sdm.devices.types.CAMERA
Google Nest Doorbell(旧版)和 Google Nest Hub Max 也用作摄像头,具有类似的特征,但它们分别会返回 DOORBELL 和 DISPLAY 这两种设备类型。
如需详细了解这些设备类型独有的功能,请参阅门铃和显示设备指南。
特征
参考
以下特征、命令或事件与此设备相关:
特征 | 说明 | 命令 | 事件 |
---|---|---|---|
相机事件图片 | 此特征属于支持通过事件生成图片的所有设备。 | 生成图片 | |
相机图片 | 此特征属于支持拍摄图片的任何设备。 | ||
相机直播 | 此特征属于支持直播的任何设备。 | GenerateRtspStream ExtendRtspStream StopRtspStream | |
相机移动 | 此特征属于支持移动侦测事件的任何设备。 | 动画 | |
摄像头人物 | 此特征属于支持人员检测事件的任何设备。 | 人员 | |
相机声音 | 此特征属于支持声音检测事件的所有设备。 | 声音 | |
信息 | 此特征属于与设备相关的信息的任何设备。 |
JSON
GET 响应中缺少某个特征,表明相应特征或功能目前不适用于设备。如需了解详情,请参阅设备类型。
{ "type" : "sdm.devices.types.CAMERA", "traits" : { "sdm.devices.traits.CameraEventImage" : {}, "sdm.devices.traits.CameraImage" : { "maxImageResolution" : { "width" : 1280, "height" : 960 } }, "sdm.devices.traits.CameraLiveStream" : { "maxVideoResolution" : { "width" : 640, "height" : 480 }, "videoCodecs" : ["H264"], "audioCodecs" : ["AAC"], "supportedProtocols" : ["WEB_RTC"] }, "sdm.devices.traits.CameraMotion" : {}, "sdm.devices.traits.CameraPerson" : {}, "sdm.devices.traits.CameraSound" : {}, "sdm.devices.traits.Info" : { "customName" : "My device" } } }
处理相机事件
以下事件可由 CAMERA 设备类型、配有摄像头的 DOORBELL 或 DISPLAY 触发,例如 Google Nest Doorbell(旧版)或 Google Nest Hub Max:类型 | 元素 | 说明 |
---|---|---|
事件 | CameraMotion 特征的 Motion 事件 | 摄像头检测到侦测到移动。 |
事件 | CameraPerson 特征的 Person 事件 | 摄像头检测到有人。 |
事件 | CameraSound 特征的 Sound 事件 | 摄像头已检测到声音。 |
载荷
{ "eventId" : "cd0e5f49-48d0-446d-b896-2e87f11a03d6",
"timestamp" : "2019-01-01T00:00:01Z",
"resourceUpdate" : { "name" : "enterprises/project-id/devices/device-id", "events" : { "sdm.devices.events.CameraMotion.Motion
" : { "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...", "eventId" : "ErramsaXTiTecl3JXwvKDETX3s...", } } } "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
"resourceGroup" : [ "enterprises/project-id/devices/device-id" ] }
eventId
。此命令会返回与事件相关的相机图片的下载网址:
请求
POST /enterprises/project-id/devices/device-id:executeCommand
{
"command" : "sdm.devices.commands.CameraEventImage.GenerateImage
",
"params" : {
"eventId" : "QgG261YHjgTw82Cpcqzrmxl4qt..."
}
}
响应
{ "results" : { "url" : "https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...", "token" : "g.0.eventToken" } }
下载相机图片
使用具有基本授权的 HTTP 授权标头中的 token
从 GenerateImage 命令响应对 url
进行 GET 调用,以下载相机图片:
curl -H "Authorization: Basic g.0.eventToken" \
https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...
使用 width
或 height
查询参数自定义下载图片的分辨率。您只需指定其中一个参数即可。另一个参数会根据相机的宽高比自动缩放。
例如,如果相机的宽高比为 4:3,如需下载分辨率为 480 x 360 的相机图片,请指定宽度或高度:
宽度
curl -H "Authorization: Basic g.0.eventToken" \
https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?width=480
身高
curl -H "Authorization: Basic g.0.eventToken" \
https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?height=360
下载网址也存在其他限制:
- 如果网址中提供了这两个参数,则系统会使用
width
并忽略height
。 - 如果网址中均未提供该参数,系统会为
width
选择默认值 480。
如需了解图像属性,请参阅 CameraImage 特征。
访问直播
您可以访问摄像头直播。此设备支持以下流格式:
- RTSP
如需查看相机的完整列表和支持的流式传输格式,请参阅支持的设备。
如需访问直播,请使用CameraLiveStream特征的相应“生成流”命令。Format
RTSP
对于 RTSP 流,CameraLiveStream 特征命令的 GenerateRtspStream 命令会返回流网址和相关的 streamToken
:
请求
POST /enterprises/project-id/devices/device-id:executeCommand
{
"command" : "sdm.devices.commands.CameraLiveStream.GenerateRtspStream
",
"params" : {}
}
响应
{ "results" : { "streamUrls" : { "rtspUrl" : "rtsps://someurl.com/CjY5Y3VKaTZwR3o4Y19YbTVfMF...?auth=g.0.streamingToken" }, "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...", "streamToken" : "g.0.streamingToken", "expiresAt" : "2018-01-04T18:30:00.000Z" } }
然后使用直播网址访问摄像头直播:
rtsps://someurl.com/CjY5Y3VKaTZwR3o4Y19YbTVfMF...?auth=g.0.streamingToken
RTSP 直播网址不能在客户端之间共享。流网址一次只能由一个客户端使用。如果多个客户端想同时通过同一个摄像头进行流式传输,则必须为每个客户端发送 RTSP 命令,且各个客户端必须使用各自的视频流网址。
延长直播时间
摄像头直播会话的有效期只有 5 分钟。如果您需要延长直播的生命周期,请针对生成的直播格式使用 CameraLiveStream 特征的相应扩展Format直播命令。
RTSP
如需扩展 RTSP 流,请使用 CameraLiveStream 特征命令的 ExtendRtspStream 命令获取新的 streamExtensionToken
和 streamToken
值:
请求
POST /enterprises/project-id/devices/device-id:executeCommand
{
"command" : "sdm.devices.commands.CameraLiveStream.ExtendRtspStream
",
"params" : {
"streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
}
}
响应
{ "results" : { "streamExtensionToken" : "dGNUlTU2CjY5Y3VKaTZwR3o4Y1...", "streamToken" : "g.0.newStreamingToken", "expiresAt" : "2018-01-04T18:30:00.000Z" } }
使用以下新值更新直播网址以继续观看直播:
rtsps://someurl.com/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?auth=g.0.newStreamingToken
停止直播
只要您不再使用摄像头直播,就应该停止该视频流,并使该视频流失效。为此,请对生成的流格式使用CameraLiveStream特征的相应 Format 停止流命令。
RTSP
如需停止 RTSP 流,请使用令牌通过 CameraLiveStream 特征命令的 StopRtspStream 命令失效:
请求
POST /enterprises/project-id/devices/device-id:executeCommand
{
"command" : "sdm.devices.commands.CameraLiveStream.StopRtspStream
",
"params" : {
"streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
}
}
响应
{}
错误
可能会返回与此设备相关的以下错误代码:
错误消息 | RPC | 问题排查 |
---|---|---|
相机图片已不再可供下载。 | DEADLINE_EXCEEDED |
活动图片将在活动发布 30 秒后过期。请务必在过期之前下载图片。 |
活动 ID 不属于相机。 | FAILED_PRECONDITION |
使用相机事件返回的正确 eventID 。 |
如需查看 API 错误代码的完整列表,请参阅 API 错误代码参考。