Google is committed to advancing racial equity for Black communities. See how.

相機API

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

用戶可以多巢凸輪添加到devices/cameras基,直至每結構最大。當您調用此數據位置時,您可以訪問 Nest Cam 數據(結構中設備的數據值)。

下面所有的值被每個下找到devices/cameras/ device_id的JSON文檔英寸

設備編號

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

結構標識

結構唯一標識符。

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

where_id

一個唯一的,巢生成的標識符,它表示name ,設備的顯示名稱。

了解更多關於哪裡的名字 鳥巢恆溫器巢保護巢凸輪

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

where_name

設備的顯示名稱。相關的巢凸輪where_id 。可以是我們提供的列表中的任何房間名稱,也可以是自定義名稱。了解更多關於哪裡的名字 鳥巢恆溫器巢保護巢凸輪

細節
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
示例:“Hallway Nest Cam(樓上)”
使用權只讀
可在攝像頭讀取 / v1-v3
相機讀取 + 圖像 / v1-v4
相機讀/寫 / v1-v3
相機讀/寫+圖像/ v1-v4

在線

設備與 Nest 服務的連接狀態。

細節
https://developer-api.nest.com/devices/cameras/ device_id /is_online
退貨boolean
值:真、假
使用權只讀
可在攝像頭讀取 / v1-v3
相機讀取 + 圖像 / v1-v4
相機讀/寫 / v1-v3
相機讀/寫+圖像/ v1-v4

is_streaming

攝像頭狀態,可以是開啟和正在流式傳輸視頻,也可以是關閉。請參閱您的相機如何與民政工作/無人協助的詳細信息。

細節
https://developer-api.nest.com/devices/cameras/ device_id /is_streaming
退貨boolean
值:真、假
使用權讀/寫
可在攝像頭讀取 / v1-v3
相機讀取 + 圖像 / v1-v4
相機讀/寫 / v1-v3
相機讀/寫+圖像/ v1-v4

is_audio_input_enabled

攝像頭麥克風狀態,打開和收聽,或關閉。了解更多關於鳥巢凸輪音頻設置

細節
https://developer-api.nest.com/devices/cameras/ device_id /is_audio_input_enabled
退貨boolean
值:真、假
使用權只讀
可在攝像頭讀取 / 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

巢意識到訂閱狀態(訂閱有效與否)。

細節
https://developer-api.nest.com/devices/cameras/ device_id /is_video_history_enabled
退貨boolean
值:真、假
使用權只讀
可在攝像頭讀取 / v1-v3
相機讀取 + 圖像 / v1-v4
相機讀/寫 / v1-v3
相機讀/寫+圖像/ v1-v4

網址

網頁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 應用中直播視頻流的應用 URL(深層鏈接)。

細節
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
值:真、假
使用權只讀
可在相機讀取 + 圖像 / v3-v4
相機讀/寫+圖像/ v3-v4

活動區域

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

活動區被用於監控內的視頻流的用戶定義的區域中的運動的事件。需要巢感知

細節
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

當用戶使得他們可以訪問此網址的視頻流公眾

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

string1是視頻流的名稱,或者用戶定義當流被設置為公共或自動生成的。
使用權只讀
可在相機讀取 + 圖像 / v3-v4
相機讀/寫+圖像/ v3-v4

快照網址

按需捕獲圖像。返回從實時視頻流中捕獲的圖像的 URL。要求相機處於開啟狀態並進行流式傳輸。

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

  • snapshot_url -返回實況視頻流捕獲的圖像的URL
  • 要求相機已打開並正在流式傳輸

如果您符合以下條件,則 API 的快照質量僅為 1080p 吞吐量:

  • 在應用程序中積極地觀察攝像機流( web_url
  • 積極觀看公共流( app_url
  • 訂閱了 Nest Aware

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

詳細了解了鳥巢相機的帶寬需求

速率限制適用於這一呼籲,取決於巢意識到訂閱狀態

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

最後一個事件

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

一些領域和一些權限組合需要一個巢意識到訂閱訪問最後一個事件的信息。

下面所有的值下的每個找到devices/cameras/ device_id /last_event的JSON文檔英寸

has_sound

聲音事件 - 檢測到聲音。

細節
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_sound
退貨boolean
值:真、假
使用權只讀
可在攝像頭讀取 / v1-v3
相機讀取 + 圖像 / v1-v4
相機讀/寫 / v1-v3
相機讀/寫+圖像/ v1-v4

has_motion

運動事件 - 檢測到運動。

細節
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_motion
退貨boolean
值:真、假
使用權只讀
可在攝像頭讀取 / v1-v3
相機讀取 + 圖像 / v1-v4
相機讀/寫 / v1-v3
相機讀/寫+圖像/ v1-v4

has_person

人員事件 - 檢測到人員。

細節
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_person
退貨boolean
值:真、假
使用權只讀
可在攝像頭讀取 / 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天,這取決於巢感知訂閱計劃)。

需要巢感知

細節
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

網址

網頁URL(深層鏈接)到最後的聲音或運動事件的home.nest.com 。用於顯示上次記錄的事件,需要用戶登錄帳戶。

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

last_event/urls_expire_time查找有關此URL的過期時間信息。

細節
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

最後一個聲音或動作事件的嵌套應用 URL(深層鏈接)。用於顯示上次記錄的事件,需要用戶登錄帳戶。

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

last_event/urls_expire_time查找有關此URL的過期時間信息。

細節
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

圖片網址

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

需要巢感知。見last_event/urls_expire_time查找有關此URL的過期時間信息。

細節
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

動畫圖像網址

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

需要巢感知

細節
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

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

需要巢感知。當與使用activity_zones數組,你可以從這些ID獲得的區域名稱。

如果last_event/has_motion IS

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