Google致力於提高黑人社區的種族平等。 怎麼看。
本頁面由 Cloud Translation API 翻譯而成。
Switch to English

相機API

Nest API適用於所有Nest Cam™模型。

用戶可以將多個Nest Cams添加到devices/cameras組, 每個結構最大 。呼叫此數據位置時,可以訪問Nest Cam數據(結構中設備的數據值)。

以下所有值均位於JSON文檔中的每個devices/cameras/ device_id

設備編號

Nest Cam的唯一標識符。

細節
https://developer-api.nest.com/devices/cameras/ device_id /device_id
退貨 string
示例:“ awJo6rH ...”
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

軟件版本

軟件版本。

細節
https://developer-api.nest.com/devices/cameras/ device_id /software_version
退貨 string
示例:“ 4.0”
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

structure_id

結構唯一標識符。

細節
https://developer-api.nest.com/devices/cameras/ device_id /structure_id
退貨 string
示例:“ VqFabWH21nw ...”
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

where_id

唯一的,由Nest生成的標識符,代表name ,即設備的顯示名稱。

詳細了解Nest ThermostatsNest ProtectsNest Cams的名稱

細節
https://developer-api.nest.com/devices/cameras/ device_id /where_id
退貨 string
示例:“ d6reb_OZTM ...”
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

where_name

設備的顯示名稱。與Nest Cam where_id 。可以是我們提供的列表中的任何房間名稱,也可以是自定義名稱。詳細了解Nest ThermostatsNest ProtectsNest Cams的名稱

細節
https://developer-api.nest.com/devices/cameras/ device_id /where_name
退貨 string
示例:“走廊”
訪問 只讀
可用於 相機讀取/ v3
相機讀取+圖像/ v4
相機讀/寫/ v3
相機讀/寫+圖像/ v4

名稱

顯示設備名稱;可以是我們提供的列表中的任何房間名稱,也可以是自定義名稱。

細節
https://developer-api.nest.com/devices/cameras/ device_id /name
退貨 string
示例:“走廊”
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

name_long

設備的長顯示名稱。包括由用戶或通過wheres創建的自定義(標籤)。

細節
https://developer-api.nest.com/devices/cameras/ device_id /name_long
退貨 string
示例:“走廊嵌套凸輪(樓上)”
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

在線

Nest服務的設備連接狀態。

細節
https://developer-api.nest.com/devices/cameras/ device_id /is_online
退貨 boolean
值:true,false
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

is_streaming

攝像機狀態,可以打開並正在動態流式傳輸視頻,也可以關閉。有關更多信息,請參見相機如何與家庭/外出助手一起工作。

細節
https://developer-api.nest.com/devices/cameras/ device_id /is_streaming
退貨 boolean
值:true,false
訪問 讀/寫
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

is_audio_input_enabled

攝像頭麥克風狀態,可以是打開,正在收聽或關閉。了解有關Nest Cam音頻設置的更多信息。

細節
https://developer-api.nest.com/devices/cameras/ device_id /is_audio_input_enabled
退貨 boolean
值:true,false
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

last_is_online_change

標識聯機狀態的最後更改的時間戳,採用ISO 8601格式。

細節
https://developer-api.nest.com/devices/cameras/ device_id /last_is_online_change
退貨 string
示例:“ 2016-12-29T18:42:00.000Z”
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

is_video_history_enabled

Nest Aware訂閱狀態(訂閱是否激活)。

細節
https://developer-api.nest.com/devices/cameras/ device_id /is_video_history_enabled
退貨 boolean
值:true,false
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

web_url

Web URL(深鏈接), 指向home.nest.com上的實時視頻流。

細節
https://developer-api.nest.com/devices/cameras/ device_id /web_url
退貨 string
例如:“ https://home.nest.com/cameras/ device_id ?auth= camera_token
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

app_url

指向Nest應用中實時視頻流的應用網址(深層鏈接)。

細節
https://developer-api.nest.com/devices/cameras/ device_id /app_url
退貨 string
示例:“ nestmobile://cameras/ device_id ?auth= camera_token
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

is_public_share_enabled

用戶可以選擇共享他們的視頻並使任何人都可以觀看。啟用公共共享後,您可以閱讀public_share_url

細節
https://developer-api.nest.com/devices/cameras/ device_id /is_public_share_enabled
退貨 boolean
值:true,false
訪問 只讀
可用於 相機讀取+圖像/ v3-v4
相機讀/寫+圖像/ v3-v4

activity_zones

返回所有已定義活動區域的數組。

活動區域用於監視視頻流的用戶定義區域內的運動事件。需要Nest Aware

細節
https://developer-api.nest.com/devices/cameras/ device_id /activity_zones
退貨 array
例如: [ {"name" : " string1 ", "id" : " string2 "},... ]

string1是區域名稱,可以由用戶定義,也可以在創建區域時自動生成。
string2是創建活動區域時由Nest分配的標識符。
訪問 只讀
可用於 相機讀取+圖像/ v3-v4
相機讀/寫+圖像/ v3-v4

public_share_url

當用戶將其視頻流公開時,您可以訪問此URL。

細節
https://developer-api.nest.com/devices/cameras/ device_id /public_share_url
退貨 string
示例:“ https://video.nest.com/live/ string1 ? string2

string1是視頻流名稱,可以是用戶定義的,也可以是在將流設置為public時自動生成的。
訪問 只讀
可用於 相機讀取+圖像/ v3-v4
相機讀/寫+圖像/ v3-v4

快照網址

按需捕獲圖像。返回從實時視頻流捕獲的圖像的URL。要求相機已開啟並且正在動態播放。

使用此字段可從實時視頻流中獲取快照。

  • snapshot_url返回從實時視頻流捕獲的圖像的URL
  • 要求相機已開啟並且正在流式傳輸

如果滿足以下條件,則來自API的快照質量僅為1080p吞吐量:

  • 在應用程序( web_url )中積極查看相機流
  • 積極查看公共流( app_url
  • 訂閱Nest Aware

如果您沒有主動查看流或沒有Nest Aware訂閱,則該API沒有1080p源,無法從該源檢索該分辨率的快照並生成質量較低的圖像。此外,如果存在Nest Aware,低本地網絡帶寬可能會導致API快照分辨率降至1080p以下。

了解有關Nest相機帶寬要求的更多信息。

速率限制適用於此呼叫,具體取決於Nest Aware的訂閱狀態

細節
https://developer-api.nest.com/devices/cameras/ device_id /snapshot_url
退貨 string
示例:“ string1 / device_id / string2 ?auth= camera_token
訪問 只讀
可用於 相機讀取+圖像/ v3-v4
相機讀/寫+圖像/ v3-v4

last_event

該對象捕獲有關觸發通知的最後一個事件的信息。

某些字段和某些權限組合需要Nest Aware訂閱才能訪問上一個事件信息。

以下所有值均位於JSON文檔中的每個devices/cameras/ device_id /last_event

has_sound

聲音事件-檢測到聲音。

細節
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_sound
退貨 boolean
值:true,false
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

has_motion

運動事件-檢測到運動。

細節
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_motion
退貨 boolean
值:true,false
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

has_person

人員事件-檢測到人員。

細節
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_person
退貨 boolean
值:true,false
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

開始時間

事件開始時間,採用ISO 8601格式。

細節
https://developer-api.nest.com/devices/cameras/ device_id /last_event/start_time
退貨 string
示例:“ 2016-12-29T00:00:00.000Z”
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

時間結束

事件結束時間,採用ISO 8601格式。

細節
https://developer-api.nest.com/devices/cameras/ device_id /last_event/end_time
退貨 string
示例:“ 2016-12-29T00:00:00.000Z”
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

urls_expire_time

ISO 8601格式的時間戳,用於標識這些與事件相關的URL的到期時間:

到期時間的計算方式為: last_event/start_time + n天(其中n = 10或30天,具體取決於Nest Aware 訂閱計劃 )。

需要Nest Aware

細節
https://developer-api.nest.com/devices/cameras/ device_id /last_event/urls_expire_time
退貨 string
示例:“ 2016-12-29T00:00:00.000Z”
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

web_url

指向home.nest.com上一次聲音或動作事件的Web URL(深層鏈接)。用於顯示最後記錄的事件,並要求用戶登錄到該帳戶。

需要Nest Aware 。如果事件URL已過期或設備沒有活動的預訂,則此值將不包含在有效負載中。

有關此URL的到期時間的信息,請參見last_event/urls_expire_time

細節
https://developer-api.nest.com/devices/cameras/ device_id /last_event/web_url
退貨 string
示例:“ https://home.nest.com/cameras/ device_id /cuepoints/ string ?auth= camera_token
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

app_url

將應用網址(深層鏈接)嵌套到上一個聲音或動作事件。用於顯示最後記錄的事件,並要求用戶登錄到該帳戶。

需要Nest Aware 。如果事件URL已過期或設備沒有活動的訂閱,則此值將不包含在有效負載中。

有關此URL的過期時間的信息,請參見last_event/urls_expire_time

細節
https://developer-api.nest.com/devices/cameras/ device_id /last_event/app_url
退貨 string
示例:“ nestmobile://cameras/ device_id /cuepoints/ string ?auth= camera_token
訪問 只讀
可用於 相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

image_url

URL(鏈接)到為聲音或運動事件捕獲的圖像文件。

需要Nest Aware 。有關此URL的到期時間的信息,請參見last_event/urls_expire_time

細節
https://developer-api.nest.com/devices/cameras/ device_id /last_event/image_url
退貨 string
例如:“ https://www.dropcam.com/api/wwn.get_image/ string1 / device_id / string2 ?auth= camera_token
訪問 只讀
可用於 相機讀取+圖像/ v1-v4
相機讀/寫+圖像/ v1-v4

animation_image_url

URL(鏈接)到為聲音或運動事件捕獲的gif文件。

需要Nest Aware

細節
https://developer-api.nest.com/devices/cameras/ device_id /last_event/animated_image_url
退貨 string
例如:“ https://www.dropcam.com/api/wwn.get_image/ string1 / device_id / string2 ?auth= camera_token
訪問 只讀
可用於 相機讀取+圖像/ v1-v4
相機讀/寫+圖像/ v1-v4

activity_zone_ids

檢測到運動事件的活動區域的標識符。

需要Nest Aware 。與activity_zones數組一起使用時,您可以從這些ID中獲取區域名稱。

如果last_event/has_motion

  • true =返回檢測到運動事件的活動區域ID
  • false =返回一個空數組
細節
https://developer-api.nest.com/devices/cameras/ device_id /last_event/activity_zone_ids
退貨 array
例如: [ string1 , string2 ,... ]
訪問 只讀
可用於 相機讀取+圖像/ v3-v4
相機讀/寫+圖像/ v3-v4