סוג המכשיר 'פעמון לדלת' מיושם באמצעות שתי תכונות:
PushAvStreamTransport,
שמטפלת בהעברת זרם אודיו ווידאו באמצעות פרוטוקולים מבוססי-push, ו-
WebRtcLiveView,
שמספקת את היכולת לשלוט בשידורים חיים ובדיבור חוזר.
לפני שמשתמשים בתכונות או מנסים לעדכן מאפיינים, תמיד צריך לבדוק אם המכשיר תומך במאפיינים ובפקודות. מידע נוסף זמין במאמר שליטה במכשירים ב-Android.
| Home APIs Device Type | תכונות | אפליקציה לדוגמה ב-Kotlin | תרחיש לדוגמה |
|---|---|---|---|
פעמון דלת
מכשיר שמפעילים באמצעות לחצן מחוץ לדלת, שמפיק אות קולי או חזותי, ומשמש לבקשת תשומת הלב של אדם שנמצא בצד השני של הדלת. יכול להיות שפעמוני הדלת יכללו שידורים חיים נגישים, תקשורת דו-כיוונית או אירועי זיהוי. |
Required Traits google PushAvStreamTransport google WebRtcLiveView |
Doorbell |
התחלת שידור חי
כדי להתחיל שידור חי, שולחים את המחרוזת Session Description Protocol (SDP) ל-method startLiveView() של המאפיין WebRtcLiveView, שמחזיר את WebRtcLiveViewTrait.StartLiveViewCommand.Response עם שלושה ערכים:
- נתוני ה-SDP של הסשן.
- משך הסשן בשניות.
- מזהה הסשן, שאפשר להשתמש בו כדי להאריך או לסיים את הסשן.
suspend fun getWebRtcLiveViewTrait(cameraDevice: HomeDevice) { return cameraDevice.type(GoogleDoorbellDevice).trait(WebRtcLiveView).first { it?.metadata?.sourceConnectivity?.connectivityState == ConnectivityState.ONLINE } } // Start the live view suspend fun startCameraStream(trait: WebRtcLiveView, offerSdp: String) { val response = trait.startLiveView(offerSdp) // Response contains three fields (see below) return response } ... // This is used to manage the WebRTC connection val peerConnection: RTCPeerConnection = ... ... val startResponse = startCameraStream(sdp) val answerSdp = startResponse?.answerSdp val sessionDuration = startResponse?.liveSessionDurationSeconds val mediaSessionId = startResponse?.mediaSessionId peerConnection.setRemoteDescription(SessionDescription.Type.ANSWER, answerSdp)
הארכת שידור חי
לשידורים חיים יש משך זמן מוגדר מראש, ולאחר מכן הם מסתיימים. כדי להאריך את משך הזמן של סטרימינג פעיל, צריך לשלוח בקשת הארכה באמצעות השיטה WebRtcLiveView.extendLiveView():
// Assuming camera stream has just been started suspend fun scheduleExtension(trait: WebRtcLiveView, mediaSessionId: String, liveSessionDurationSeconds: UShort ) { delay(liveSessionDurationSeconds - BUFFER_SECONDS * 1000) val response = trait.extendLiveView(mediaSessionId) // returns how long the session will be live for return response.liveSessionDurationSeconds }
הפעלה והפסקה של TalkBack
כדי להפעיל את TalkBack, מתקשרים אל השיטה startTalkback() של מאפיין WebRtcLiveView. כדי להפסיק את הפעולה, משתמשים בפקודה stopTalkback().
// Make sure camera stream is on suspend fun setTalkback(isOn: Boolean, trait: WebRtcLiveView, mediaSessionId: String) { if(isOn) { trait.startTalkback(mediaSessionId) } else { trait.stopTalkback(mediaSessionId) } }
הפעלה והשבתה של יכולת ההקלטה
כדי להפעיל את יכולת ההקלטה של המצלמה, צריך להעביר את הערך
TransportStatusEnum.Active
לשיטה
setTransportStatus()
של מאפיין
PushAvStreamTransport. כדי להשבית את האפשרות להקלטה, מעבירים את הערך TransportStatusEnum.Inactive.
בדוגמה הבאה, אנחנו משתמשים בפקודה Boolean כדי להפעיל או להשבית את האפשרות להקלטה, ומכניסים את כל הפקודות האלה לפקודה אחת:
// Start or stop recording for all connections. suspend fun setCameraRecording(isOn: Boolean) { val pushAvStreamTransport = getPushAvStreamTransport if(isOn) { pushAvStreamTransport.setTransportStatus(TransportStatusEnum.Active) } else { pushAvStreamTransport.setTransportStatus(TransportStatusEnum.Inactive) } }
הפעלה או השבתה של יכולת ההקלטה של המצלמה זהות להפעלה או להשבתה של הווידאו מהמצלמה. כשהווידאו מהמצלמה מופעל, המצלמה מקליטה (למטרות של אירועים וקליפים קשורים).
כשהיכולת להקליט מושבתת (הווידאו מהמצלמה מושבת):
- יכול להיות שהמצלמה עדיין תופיע כמחוברת לאינטרנט בהתאם ל
connectivityStateשלסוג המכשיר. - אין גישה לשידור החי, והמצלמה לא מזהה אירועים בענן.
איך בודקים אם אפשרות ההקלטה מופעלת
כדי לבדוק אם יכולת ההקלטה של המצלמה מופעלת, צריך לבדוק אם יש חיבורים פעילים. בדוגמה הבאה מוגדרות שתי פונקציות שמבצעות את הפעולה הזו:
// Get the on/off state suspend fun onOffState(cameraDevice: HomeDevice, cameraDeviceType) { // Query the device for pushAvStreamTransport val pushAvTrait = getPushAvStreamTransport() return pushAvTrait.recordModeActive() } // Check if the camera's recording capability is enabled fun PushAvStreamTransport.recordModeActive(): Boolean { return currentConnections?.any { it.transportStatus == TransportStatusEnum.Active } ?: false }
דרך נוספת לבדוק היא באמצעות הפונקציה findTransport() עם פרדיקט:
// Fetch the current connections suspend fun queryRecordModeState(cameraDevice: HomeDevice, cameraDeviceType) { val pushAvStreamTransport = getPushAvStreamTransport() return pushAvStreamTransport.findTransport().let { it.transportConfigurations.any { it.transportStatus == TransportStatusEnum.Active } }
הגדרות אודיו
אפשר לשלוט בהגדרות שונות של אודיו במצלמה באמצעות ממשקי ה-API של Home.
הפעלה או השבתה של המיקרופון
כדי להפעיל או להשבית את המיקרופון במכשיר, מעדכנים את מאפיין microphoneMuted של מאפיין התכונה CameraAvStreamManagement באמצעות הפונקציה המובנית setMicrophoneMuted Kotlin:
// Turn the device's microphone on or off suspend fun turnOffMicrophone(disableMicrophone: Boolean, trait: CameraAvStreamManagement) { trait.update { setMicrophoneMuted(disableMicrophone) } }
איך מפעילים או משביתים את הקלטת האודיו
כדי להפעיל או להשבית את הקלטת האודיו במכשיר, מעדכנים את המאפיין
recordingMicrophoneMuted
של מאפיין התכונה CameraAvStreamManagement באמצעות הפונקציה המובנית
setRecordingMicrophoneMuted Kotlin:
// Turn audio recording on or off for the device suspend fun turnOffAudioRecording(disableAudioRecording: Boolean, trait: CameraAvStreamManagement) { trait.update { setRecordingMicrophoneMuted(disableAudioRecording) } }
שינוי עוצמת הקול של הרמקול
כדי לשנות את עוצמת הקול של הרמקול במכשיר, מעדכנים את המאפיין
speakerVolumeLevel
של מאפיין CameraAvStreamManagement באמצעות הפונקציה המובנית
setSpeakerVolumeLevel Kotlin:
// Adjust the camera speaker volume suspend fun adjustSpeakerVolume(volume: Int, trait: CameraAvStreamManagement) { trait.update { setSpeakerVolumeLevel(volume.toUbyte()) } }
הגדרות אחרות
אפשר לשלוט בהגדרות שונות אחרות של המצלמה באמצעות ממשקי ה-API של Home.
הפעלה או השבתה של ראיית לילה
כדי להפעיל או להשבית את ראיית הלילה במצלמה, משתמשים ב-TriStateAutoEnum כדי לעדכן את מאפיין nightVision של מאפיין CameraAvStreamManagement באמצעות פונקציית Kotlin המובנית setNightVision:
// Turn night vision on cameraAvStreamManagement.update { setNightVision(CameraAvStreamManagementTrait.TriStateAutoEnum.On) } // Turn night vision off CameraAvStreamManagement.update { setNightVision(CameraAvStreamManagementTrait.TriStateAutoEnum.Off) }
שינוי הבהירות של נורית הסטטוס
כדי לשנות את הבהירות של נורית הסטטוס, משתמשים ב-ThreeLevelAutoEnum כדי לעדכן את המאפיין statusLightBrightness של מאפיין CameraAvStreamManagement באמצעות פונקציית Kotlin המובנית:setStatusLightBrightness
// Set the LED brightness to high cameraAvStreamManagement.update { setStatusLightBrightness(CameraAvStreamManagementTrait.ThreeLevelAutoEnum.High) } // Set the LED brightness to low cameraAvStreamManagement.update { setStatusLightBrightness(CameraAvStreamManagementTrait.ThreeLevelAutoEnum.Low) }
שינוי מרחק התצוגה של המצלמה
אזור התצוגה של המצלמה זהה לתכונה 'התקרבות וחיתוך' שמתוארת במאמר התמיכה בנושא התקרבות והגדלה של סרטונים ממצלמת Nest.
הגדרת אזור התצוגה מופיעה בתג ViewportStruct שמכיל ארבעה ערכים, שמשמשים כקואורדינטות של אזור התצוגה. הקואורדינטות מוגדרות כך:
(x1,y1) -- (x2,y1) | | (x1,y2) -- (x2,y2)
הערכים של ViewportStruct נקבעים לפי ממשק המשתמש של האפליקציה והיישום של המצלמה. ברמה הבסיסית ביותר, כדי להגדיר את אזור התצוגה של סרטון המצלמה, צריך לעדכן את המאפיין viewport של מאפיין המאפיינים CameraAvStreamManagement באמצעות ViewportStruct, באמצעות פונקציית Kotlin המובנית setViewport:
cameraAvStreamManagement .update { setViewport( CameraAvStreamManagementTrait.ViewportStruct( x1 = horizontalRange.rangeStart.roundToInt().toUShort(), x2 = horizontalRange.rangeEnd.roundToInt().toUShort(), y1 = verticalRange.rangeStart.roundToInt().toUShort(), y2 = verticalRange.rangeEnd.roundToInt().toUShort(), ) ) }
שינוי הרגישות של יציאה ממצב שינה
רמת הרגישות של המכשיר להתעוררות משמשת לחיסכון בסוללה. היא עוזרת להקטין את הטווח שבו המכשיר יכול לזהות פעילות, ולהגדיל את הזמן שנדרש להתעוררות אחרי זיהוי הפעילות.
בממשקי ה-API של Home, אפשר להגדיר את זה באמצעות המאפיין motionSensitivity של triggerOptions ב-transportOptions של המכשיר. האפשרויות האלה מוגדרות במאפיין PushAvStreamTransport של כל מכשיר.
אפשר להגדיר את רגישות ההפעלה רק לערכים הבאים:
- 1 = נמוך
- 5 = בינוני
- 10 = גבוה
כדי לעדכן את ההגדרה, צריך למצוא את הגדרות התעבורה של הזרמי ההקלטה הפעילים באמצעות הפקודה findTransport, ואז לשנות את ההגדרה עם ערך הרגישות החדש באמצעות הפקודה modifyPushTransport:
// Create a struct with the new wake-up sensitivity val toUpdate = TransportOptionsStruct( triggerOptions = TransportTriggerOptionsStruct( motionSensitivity = OptionalValue.present(wakeUpSensitivity.toUByte()) ) ) // Get the configurations for active connections val connections = pushAvStreamTransport.findTransport().transportConfigurations // Update all recording streams with the new transport options. for (connection in connections) { if (connection.transportOptions.getOrNull()?.streamUsage == StreamUsageEnum.Recording) { trait.modifyPushTransport( connectionId = connection.connectionId, transportOptions = toUpdate, ) } }
שינוי משך האירוע המקסימלי
משך האירוע המקסימלי הוא משך הזמן שבו המצלמה תקליט קליפ של אירוע. אפשר להגדיר את זה באמצעות ממשקי ה-API של Home, לכל מכשיר בנפרד, באורכים זהים לאורכים שמוגדרים באמצעות Google Home app (GHA), במרווחי זמן של שניות:
- 10 שניות
- 15 שניות
- 30 שניות
- 60 שניות (דקה אחת)
- 120 שניות (2 דקות)
- 180 שניות (3 דקות)
בממשקי ה-API של Home, אפשר להגדיר את זה באמצעות המאפיין motionTimeControl של triggerOptions ב-transportOptions של המכשיר. האפשרויות האלה מוגדרות במאפיין PushAvStreamTransport של כל מכשיר.
כדי לעדכן את ההגדרה, צריך למצוא את הגדרת ההעברה של הזרמי ההקלטה הפעילים באמצעות הפקודה findTransport, ואז לשנות את ההגדרה עם הערך החדש של אורך האירוע באמצעות הפקודה modifyPushTransport:
// Create a struct with the new max event length // where maxDuration is the length in seconds val toUpdate = TransportOptionsStruct( triggerOptions = TransportTriggerOptionsStruct( motionTimeControl = OptionalValue.present( TransportMotionTriggerTimeControlStruct(maxDuration = it.toUInt()) ) ) ) // Get the configurations for active connections val connections = pushAvStreamTransport.findTransport().transportConfigurations // Update all recording streams with the new transport options. for (connection in connections) { if (connection.transportOptions.getOrNull()?.streamUsage == StreamUsageEnum.Recording) { trait.modifyPushTransport( connectionId = connection.connectionId, transportOptions = toUpdate, ) } }
הגדרות של Chime
אפשר לשלוט בהגדרות שונות של צלצול בדלת באמצעות ממשקי ה-API של Home.
שינוי הצליל של מנגנון הצלצול
כדי לשנות את צליל הפעמון בדלת, קודם צריך לקבל את רשימת הצלילים של הפעמון שמותקנים במכשיר באמצעות מאפיין installedChimeSounds של תכונת Chime:
// Get a list of chimes and identify the currently selected one private val doorbellChimeTraitFlow: Flow= device.traitFromType(Chime, GoogleDoorbellDevice) val chimeSounds = doorbellChimeTraitFlow.first().installedChimeSounds ?: emptyList()
לאחר מכן, מעדכנים את מאפיין selectedChime של מאפיין Chime באמצעות הפונקציה המובנית setSelectedChime Kotlin:
// Set the chime using the chimeId from the installed list chimeSounds.firstOrNull { it.name == name }?.let { setSelectedChime(it.chimeId) }
שימוש בצליל חיצוני
אפשר להגדיר את מצלמת הדלת כך שתשתמש בצליל חיצוני, כמו פעמון מכני שמורכב בתוך הבית. צריך להגדיר את זה במהלך ההתקנה של פעמון הדלת כדי למנוע נזק אפשרי לפעמון החיצוני.
כדי לציין איזה סוג של צלצול חיצוני מותקן, צריך להשתמש ב-ExternalChimeType כדי לעדכן את מאפיין externalChime של מאפיין התכונה Chime באמצעות פונקציית Kotlin המובנית:setExternalChime
// Indicate the external chime is mechanical chime.update { setExternalChime(ChimeTrait.ExternalChimeType.Mechanical) }
שינוי משך הצלצול החיצוני
אפשר להגדיר את משך הצלצול של פעמון חיצוני בשניות באמצעות ממשקי ה-API של Home. אם הצליל החיצוני תומך בהגדרת משך הצליל, המשתמש יכול להגדיר אותו.
הערך שמוגדר כאן תלוי במפרט של מנגנון הצלצול החיצוני עצמו, ובמשך הצלצול המומלץ שלו.
כדי לשנות את משך הצלצול החיצוני, מעדכנים את המאפיין externalChimeDurationSeconds של מאפיין Chime באמצעות הפונקציה המובנית setExternalChimeDurationSeconds Kotlin:
// Change the external chime duration chime.update { setExternalChimeDurationSeconds(newDuration.toUShort()) }