Camera API

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

使用者可以將多個 Nest Cam 新增至 devices/cameras 群組,直到每個架構的最大上限相同。呼叫這個資料位置時,您可以存取 Nest Cam 資料 (結構中的裝置資料值)。

下方所有值均位於 JSON 文件的每個 devices/cameras/device_id 底下。

裝置 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

結構 ID

架構專屬 ID。

詳情
https://developer-api.nest.com/devices/cameras/device_id/structure_id
退貨string
例如:「VqFabWH21nw...」
存取唯讀
支援的語言相機讀取 / v1-v3
相機已讀取 + 圖片 / v1-v4
相機讀取/寫入 / v1-v3
相機讀取/寫入 + 圖片 / v1-v4

地點 ID

Nest 產生的專屬 ID,代表裝置的顯示名稱 name

進一步瞭解 Nest ThermostatNest ProtectNest Cam 的名稱。

詳情
https://developer-api.nest.com/devices/cameras/device_id/where_id
退貨string
例如:「d6reb_OZTM...」
存取唯讀
支援的語言相機讀取 / v1-v3
相機已讀取 + 圖片 / v1-v4
相機讀取/寫入 / v1-v3
相機讀取/寫入 + 圖片 / v1-v4

地點名稱

裝置的顯示名稱。已與 Nest Cam where_id 建立關聯。可以使用我們提供的任何會議室名稱,或是自訂名稱。進一步瞭解 Nest ThermostatNest ProtectNest Cam 的名稱。

詳情
https://developer-api.nest.com/devices/cameras/device_id/where_name
退貨string
例如:「Hallway」
存取唯讀
支援的語言相機讀取 / v3
相機讀取 + 圖片 / v4
相機讀取/寫入 / v3
相機讀取/寫入 + 圖片 / v4

名稱

裝置的顯示名稱;可以是我們提供的清單中任何房間名稱,或是自訂名稱。

詳情
https://developer-api.nest.com/devices/cameras/device_id/name
退貨string
例如:「Hallway」
存取唯讀
支援的語言相機讀取 / 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 (uptairs)」。
存取唯讀
支援的語言相機讀取 / 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

串流

攝影機狀態:無論是開啟或主動串流處理影片,或是關閉影片。詳情請參閱攝影機與在家/外出輔助功能的運作方式

詳情
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

上次上線日期

時間戳記,用來識別線上狀態的上次變更,採 ISO 8601 格式。

詳情
https://developer-api.nest.com/devices/cameras/device_id/last_is_online_change
退貨string
示例:「&tt;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 [網頁網址]

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

應用程式網址

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

已啟用公開共用功能

使用者可以選擇分享自己的影片,並開放所有人觀看。啟用公開共用功能時,您可以讀取 public_share_url

詳情
https://developer-api.nest.com/devices/cameras/device_id/is_public_share_enabled
退貨boolean
值:true、false
存取唯讀
支援的語言相機讀取 + 圖片 / v3-v4
相機讀取/寫入 + 圖片 / v3-v4

活動區

傳回所有已定義的活動區陣列。

活動區可用來監控影片串流中使用者定義區域中的動作事件。必須訂閱 Nest Aware

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

string1 是區域名稱,可以是使用者定義,或是在建立區域時自動產生。
string2 是 Nest 建立活動區域時指派的 ID。
存取唯讀
支援的語言相機讀取 + 圖片 / 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?string2string1
string1 是影片串流名稱,無論使用者定義或串流設定為公開時,都是由系統自動產生。
存取唯讀
支援的語言相機讀取 + 圖片 / v3-v4
相機讀取/寫入 + 圖片 / v3-v4

快照網址

隨心所欲拍下影像。傳回從直播影片串流擷取的圖片網址。必須開啟攝影機,才能串流播放。

您可以透過這個欄位,取得直播影片串流的快照。

  • snapshot_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

start_time

活動開始時間,採 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

end_time

活動結束時間,採用 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

網址數目

採用 ISO 8601 格式的時間戳記,可識別下列事件相關網址的到期時間:

到期時間的計算方式為: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。用於顯示上次記錄的事件,且使用者必須登入自己的帳戶。

必須訂閱 Nest Aware。如果事件網址已過期,或裝置沒有使用中的訂閱項目,這個值就不會包含在酬載中。

如要瞭解這個網址的到期時間,請參閱 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

應用程式網址

Nest 應用程式網址 (深層連結),用於播放最後一個聲響或動作事件。用來顯示上次記錄的事件,而且使用者必須登入自己的帳戶。

必須訂閱 Nest Aware。如果事件網址已過期,或裝置沒有使用中的訂閱項目,這個值就不會包含在酬載中。

如要瞭解這個網址的到期時間,請參閱 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 [圖片網址]

為聲音或動作事件擷取的圖片網址 (連結)。

必須訂閱 Nest Aware。如要瞭解這個網址的到期時間,請參閱 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

Animated_image_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

偵測到動作事件的活動區域 ID。

必須訂閱 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