Kapı zili cihaz türü iki özellik kullanılarak uygulanır:
PushAvStreamTransportTrait,
which handles audio and video stream transport using push-based protocols, and
WebRtcLiveViewTrait,
which provides the ability to control livestreams and talkback.
Herhangi bir özelliği kullanmadan veya özellikleri güncellemeye çalışmadan önce cihazın özellik ve komut desteğini mutlaka kontrol edin. Daha fazla bilgi için iOScihazlarını kontrol etme başlıklı makaleye bakın.
| Home API'leri Cihaz Türü | Özellikler | Swift Örnek Uygulaması | Kullanım Örneği |
|---|---|---|---|
Kapı zili
Kapının dışındaki bir düğmeyle etkinleştirilen, kapının diğer tarafında bulunan bir kişinin dikkatini çekmek için kullanılan sesli ve/veya görsel sinyal veren cihaz. Kapı zillerinde erişilebilir canlı yayınlar, iki yönlü konuşma veya algılama etkinlikleri bulunabilir. |
Zorunlu Özellikler google PushAvStreamTransportTrait google WebRtcLiveViewTrait |
Kapı zili |
Canlı yayın başlatma
Canlı yayın başlatmak için Oturum Açıklama Protokolü (SDP) dizesini WebRtcLiveViewTrait özelliğinin startLiveView(offerSdp:) yöntemine gönderin. Bu yöntem üç değer döndürür:
- Oturumun SDP'si.
- Saniye cinsinden oturum süresi.
- Oturumu uzatmak veya sonlandırmak için kullanılabilecek oturum kimliği.
public func sendOffer(offerSdp: String) async throws
-> (answerSdp: String, mediaSessionId: String, liveViewDuration: TimeInterval)
{
do {
Logger.info("Sending StartLiveView command...")
let response = try await liveViewTrait.startLiveView(
offerSdp: offerSdp
)
Logger.info("Received StartLiveView response: \(response)")
return (
answerSdp: response.answerSdp,
mediaSessionId: response.mediaSessionId,
liveViewDuration: TimeInterval(response.liveSessionDurationSeconds)
)
} catch {
Logger.error("Failed to send StartLiveView command: \(error)")
throw error
}
}
Canlı yayını uzatma
Canlı yayınların süresi önceden belirlenir ve bu süre sonunda sona erer. Etkin bir akışın süresini uzatmak için extendLiveView(mediaSessionId:optionalArgsProvider:) yöntemini kullanarak uzatma isteğinde bulunun:
public func extendLiveView(mediaSessionId: String) async throws {
do {
Logger.info("Extending live view...")
let extendedDuration = try await liveViewTrait.extendLiveView(mediaSessionId: mediaSessionId)
Logger.info("Extended live view for \(extendedDuration.liveSessionDurationSeconds) seconds.")
} catch {
Logger.error("Failed to extend live view: \(error)")
throw error
}
}
TalkBack'i başlatma ve durdurma
TalkBack'i başlatmak için
WebRtcLiveViewTrait
özelliğinin startTalkback(mediaSessionId:optionalArgsProvider:) yöntemini çağırın.
Durdurmak için stopTalkback(mediaSessionId:) simgesini kullanın.
public func toggleTwoWayTalk(isOn: Bool, mediaSessionId: String) async throws {
do {
Logger.info("Toggling twoWayTalk to \(isOn ? "ON" : "OFF")...")
if isOn {
try await liveViewTrait.startTalkback(mediaSessionId: mediaSessionId)
} else {
try await liveViewTrait.stopTalkback(mediaSessionId: mediaSessionId)
}
} catch {
throw HomeError.commandFailed("Failed to toggle twoWayTalk: \(error)")
}
}
Kayıt özelliğini etkinleştirme ve devre dışı bırakma
Kameranın kayıt özelliğini etkinleştirmek için TransportStatusEnum.Active öğesini PushAvStreamTransportTrait özelliğinin setTransportStatus(transportStatus:optionalArgsProvider:) yöntemine iletin. Kayıt özelliğini devre dışı bırakmak için TransportStatusEnum.Inactive simgesini geçin.
Aşağıdaki örnekte, bu aramaları, kayıt özelliğini etkinleştirmek veya devre dışı bırakmak için Boolean kullanan tek bir aramada sarmalıyoruz:
public func toggleIsRecording(isOn: Bool) {
self.uiState = .loading
guard let pushAvStreamTransportTrait else {
Logger.error("PushAvStreamTransportTrait not found.")
return
}
Task {
do {
try await pushAvStreamTransportTrait.setTransportStatus(
transportStatus: isOn ? .active : .inactive)
if isOn {
do {
self.player = try self.createWebRtcPlayer()
} catch {
Logger.error("Failed to initialize WebRtcPlayer: \(error)")
self.uiState = .disconnected
return
}
await self.player?.initialize()
self.uiState = .live
} else {
self.player = nil
self.uiState = .off
}
} catch {
Logger.error("Failed to toggle onOff: \(error)")
}
}
}
Kameranın kayıt özelliğini etkinleştirmek veya devre dışı bırakmak, kamera videosunu açmak veya kapatmakla aynıdır. Kameranın videosu açıkken kayıt yapılır (etkinlikler ve ilgili klipler için).
Kayıt özelliği devre dışı bırakıldığında (kamera videosu kapalıyken):
- Kamera,
connectivityStatecihaz türüne göre çevrimiçi olarak görünmeye devam edebilir. - Canlı yayına erişilemiyor ve kamera herhangi bir bulut etkinliği algılamıyor.
Kayıt özelliğinin etkin olup olmadığını kontrol etme
Bir kameranın kayıt özelliğinin etkin olup olmadığını belirlemek için herhangi bir bağlantının etkin olup olmadığını kontrol edin. Aşağıdaki örnekte bu işlemi gerçekleştirmek için iki işlev tanımlanmaktadır:
public func isDeviceRecording() -> Bool {
guard let pushAvStreamTransportTrait else {
Logger.error("PushAvStreamTransportTrait not found.")
return false
}
guard
let hasActiveConnection =
pushAvStreamTransportTrait
.attributes
.currentConnections?
.contains(where: { $0.transportStatus == .active })
else {
return false
}
return hasActiveConnection
}
Ses ayarları
Çeşitli kamera ses ayarları, Home API'leri aracılığıyla kontrol edilebilir.
Mikrofonu açma veya kapatma
Cihazın mikrofonunu açmak veya kapatmak için yerleşik setMicrophoneMuted işlevini kullanarak CameraAvStreamManagementTrait özelliğinin microphoneMuted özelliğini güncelleyin:
// Turn the device's microphone on or off
func setMicrophone(on: Bool) async {
do {
_ = try await self.cameraAvStreamManagementTrait?.update {
$0.setMicrophoneMuted(!on)
}
} catch {
// Error
}
}
Ses kaydını etkinleştirme veya devre dışı bırakma
Cihazda ses kaydını etkinleştirmek veya devre dışı bırakmak için yerleşik setRecordingMicrophoneMuted işlevini kullanarak CameraAvStreamManagementTrait özelliğinin recordingMicrophoneMuted özelliğini güncelleyin:
// Turn audio recording on or off for the device
func setAudioRecording(on: Bool) async {
do {
_ = try await self.cameraAvStreamManagementTrait?.update {
$0.setRecordingMicrophoneMuted(!on)
}
} catch {
// Error
}
}
Hoparlörün ses düzeyini ayarlama
Cihazın hoparlör sesini ayarlamak için yerleşik setSpeakerVolumeLevel işlevini kullanarak CameraAvStreamManagementTrait özelliğinin speakerVolumeLevel özelliğini güncelleyin:
// Adjust the camera speaker volume
func setSpeakerVolume(to value: UInt8) async {
do {
_ = try await cameraAvStreamManagementTrait.update {
$0.setSpeakerVolumeLevel(value)
}
} catch {
// Error
}
}
Diğer ayarlar
Diğer çeşitli kamera ayarları Home API'leri aracılığıyla kontrol edilebilir.
Gece görüşünü açma veya kapatma
Kamerada gece görüşünü açmak veya kapatmak için TriStateAutoEnum kullanarak yerleşik setNightVision işlevini kullanarak CameraAvStreamManagementTrait özelliğinin nightVision özelliğini güncelleyin:
// Turn night vision on or off
func setNightVision(
to value: Google.CameraAvStreamManagementTrait.TriStateAutoEnum
) async {
do {
_ = try await cameraAvStreamManagementTrait.update {
$0.setNightVision(value)
}
} catch {
// Error
}
}
Durum LED'inin parlaklığını değiştirme
Durum LED'inin parlaklığını değiştirmek için yerleşik setStatusLightBrightness işlevini kullanarak CameraAvStreamManagementTrait özelliğinin statusLightBrightness özelliğini güncellemek üzere ThreeLevelAutoEnum kullanın:
// Set the LED brightness
func setStatusLightBrightness(
to value: Google.CameraAvStreamManagementTrait.ThreeLevelAutoEnum
) async {
do {
_ = try await cameraAvStreamManagementTrait.update {
$0.setStatusLightBrightness(value)
}
} catch {
// Error
}
}
Kamera görüntü alanını değiştirme
Kamera görüntü alanı, Nest kamera videosunu yakınlaştırma ve iyileştirme başlıklı destek makalesinde açıklanan yakınlaştırma ve kırpma özelliğiyle aynıdır.
Görünüm alanı, dört değer içeren bir ViewportStruct içinde tanımlanır. Bu değerler, görünüm alanının koordinatları olarak kullanılır. Koordinatlar şu şekilde tanımlanır:
(x1,y1) -- (x2,y1) | | (x1,y2) -- (x2,y2)
ViewportStruct değerlerinin belirlenmesi, uygulamanın kullanıcı arayüzüne ve kamera uygulamasına bağlıdır. En temel düzeyde, kamera videosunun görünüm alanını ayarlamak için işlevini kullanarak CameraAvStreamManagementTrait özelliğinin viewport özelliğini ViewportStruct ile güncelleyin.setViewport
func setCrop(x1: UInt16, y1: UInt16, x2: UInt16, y2: UInt16) {
let viewport = Google.CameraAvStreamManagementTrait.ViewportStruct(
x1: x1,
y1: y1,
x2: x2,
y2: y2
)
Task {
do {
try await cameraAvStreamManagementTrait.update {
$0.setViewport(viewport)
}
} catch {
// Error
}
}
}
TransportOptionsStruct oluşturma
Bazı ayarlar, TransportOptionsStruct özelliklerinde değişiklik yapılmasını gerektirir. Bu değişiklikler daha sonra bir akış bağlantısının aktarım seçeneklerine iletilir. Swift'te bu yapının, özellikler güncellenmeden önce oluşturulması gerekir.
Aşağıdaki ayar değişiklikleriyle kullanılacak yapıyı oluşturmak için bu yardımcı işlevi kullanın:
func getTransportOptions(
transportOptions: Google.PushAvStreamTransportTrait.TransportOptionsStruct,
wakeUpSensitivity: UInt8?,
maxEventLength: UInt32?
) async throws
-> Google.PushAvStreamTransportTrait.TransportOptionsStruct
{
var newMotionTimeControl:
Google.PushAvStreamTransportTrait.TransportMotionTriggerTimeControlStruct? = nil
if let maxEventLength {
guard let motionTimeControl = transportOptions.triggerOptions.motionTimeControl else {
throw HomeError.failedPrecondition(
// Error - cannot update max event length without motion time control
}
newMotionTimeControl =
Google.PushAvStreamTransportTrait.TransportMotionTriggerTimeControlStruct(
initialDuration: motionTimeControl.initialDuration,
augmentationDuration: motionTimeControl.augmentationDuration,
maxDuration: maxEventLength,
blindDuration: motionTimeControl.blindDuration
)
}
return Google.PushAvStreamTransportTrait.TransportOptionsStruct(
streamUsage: .recording,
videoStreamID: nil,
audioStreamID: nil,
tlsEndpointID: transportOptions.tlsEndpointID,
url: transportOptions.url,
triggerOptions: Google.PushAvStreamTransportTrait.TransportTriggerOptionsStruct(
triggerType: .motion,
motionZones: nil,
motionSensitivity: wakeUpSensitivity,
motionTimeControl: newMotionTimeControl,
maxPreRollLen: nil
),
ingestMethod: .cmafIngest,
containerOptions: Google.PushAvStreamTransportTrait.ContainerOptionsStruct(
containerType: .cmaf,
cmafContainerOptions: nil
),
expiryTime: nil
)
}
private func getRecordingConnection() async throws
-> Google.PushAvStreamTransportTrait.TransportConfigurationStruct?
{
guard let pushAvStreamTransportTrait else {
// Error - PushAvStreamTransport trait not available
return nil
}
let connections = try await pushAvStreamTransportTrait.findTransport().transportConfigurations
for connection in connections {
guard let transportOptions = connection.transportOptions,
transportOptions.streamUsage == .recording
else {
continue
}
return connection
}
return nil
}
Cihazın uyanma hassasiyetini ayarlama
Cihazın uyanma hassasiyeti, cihazın etkinliği algılayabileceği aralığı azaltarak ve bu etkinliği algıladıktan sonra uyanma süresini artırarak pil tasarrufu yapmak için kullanılır.
Home API'lerinde bu, cihazın transportOptions içindeki triggerOptions öğesinin motionSensitivity özelliği kullanılarak ayarlanabilir. Bu seçenekler her cihaz için PushAvStreamTransportTrait özelliğinde tanımlanır.
Uyandırma hassasiyeti yalnızca aşağıdaki değerlere ayarlanabilir:
- 1 = Düşük
- 5 = Orta
- 10 = Yüksek
Güncelleme işlemi için findTransport komutunu kullanarak etkin kayıt akışlarının aktarım yapılandırmasını bulun, ardından modifyPushTransport komutunu kullanarak yapılandırmayı yeni hassasiyet değeriyle değiştirin.
modifyPushTransport komutu, TransportOptionsStruct değerinin tamamının iletilmesini gerektirir. Bu nedenle, mevcut yapılandırmadaki değerleri önce kopyalamanız gerekir. Bunu yapmak için yardımcı işlev oluşturmak üzere TransportOptionsStruct oluşturma başlıklı makaleyi inceleyin.
func setWakeUpSensitivity(to value: UInt8) async {
do {
let connection = try await getRecordingConnection()
guard let connection,
let transportOptions = connection.transportOptions
else {
// Error - Transport options not available
return
}
guard transportOptions.triggerOptions.motionSensitivity != nil else {
// Error - Motion sensitivity not available to be updated for this device
return
}
try await pushAvStreamTransportTrait.modifyPushTransport(
connectionID: connection.connectionID,
transportOptions: self.getTransportOptions(
transportOptions: transportOptions,
wakeUpSensitivity: value,
maxEventLength: nil
)
)
} catch {
// Error
}
}
Maksimum etkinlik süresini ayarlama
Maksimum etkinlik süresi, kameranın bir etkinlik için klip kaydedeceği süredir. Bu, Home API'leri aracılığıyla cihaz başına Google Home app (GHA) üzerinden olduğu gibi saniyelik aralıklarla yapılandırılabilir:
- 10 saniye
- 15 saniye
- 30 saniye
- 60 saniye (1 dakika)
- 120 saniye (2 dakika)
- 180 saniye (3 dakika)
Home API'lerinde bu, cihazın transportOptions içindeki triggerOptions öğesinin motionTimeControl özelliği kullanılarak ayarlanabilir. Bu seçenekler her cihaz için PushAvStreamTransportTrait özelliğinde tanımlanır.
Güncelleme işlemi için findTransport komutunu kullanarak etkin kayıt akışlarının aktarım yapılandırmasını bulmanız, ardından modifyPushTransport komutunu kullanarak yapılandırmayı yeni etkinlik uzunluğu değeriyle değiştirmeniz gerekir.
modifyPushTransport komutu, TransportOptionsStruct değerinin tamamının iletilmesini gerektirir. Bu nedenle, mevcut yapılandırmadaki değerleri önce kopyalamanız gerekir. Bunu yapmak için yardımcı işlev oluşturmak üzere TransportOptionsStruct oluşturma başlıklı makaleyi inceleyin.
func setMaxEventLength(to value: UInt32) async {
do {
let connection = try await getRecordingConnection()
guard let connection,
let transportOptions = connection.transportOptions
else {
// Error - Transport options not available
return
}
guard transportOptions.triggerOptions.motionTimeControl != nil else {
// Error - Motion time control not available to be updated for this device
return
}
try await pushAvStreamTransportTrait.modifyPushTransport(
connectionID: connection.connectionID,
transportOptions: self.getTransportOptions(
transportOptions: transportOptions,
wakeUpSensitivity: nil,
maxEventLength: value
)
)
} catch {
// Error
}
}
Zil ayarları
Çeşitli kapı zili sesi ayarları, Home API'leri aracılığıyla kontrol edilebilir.
Zil sesini değiştirme
Kapı zili sesini değiştirmek için önce ChimeTrait özelliğinin installedChimeSounds özelliğini kullanarak cihaza yüklenen zili seslerinin listesini alın:
doorbellChimeTrait.attributes.installedChimeSounds?.compactMap { chimeSound in
return chimeSound.chimeID, chimeSound.name
}
Ardından, yerleşik setSelectedChime işlevini kullanarak ChimeTrait özelliğinin selectedChime özelliğini güncelleyin:
func setDoorbellChime(chimeID: UInt8) async {
do {
_ = try await doorbellChimeTrait.update {
$0.setSelectedChime(chimeID)
}
} catch {
// Error
}
}
Harici bir zil kullanma
Kapı zili, evde kurulu mekanik zil gibi harici bir zil kullanacak şekilde yapılandırılabilir. Harici zil cihazında olası hasarları önlemek için bu ayar kapı zili kurulumu sırasında yapılandırılmalıdır.
Hangi tür harici zil sesinin yüklendiğini belirtmek için yerleşik setExternalChime işlevini kullanarak ChimeTrait özelliğinin externalChime özelliğini güncellemek üzere ExternalChimeType özelliğini kullanın:
// Indicate the external chime is mechanical
func setExternalChime(to value: Google.ChimeTrait.ExternalChimeType) async {
do {
_ = try await doorbellChimeTrait.update {
$0.setExternalChime(value)
}
} catch {
// Error
}
}
Harici zil süresini değiştirme
Harici bir zilin çalma süresi (saniye cinsinden) Home API'leri aracılığıyla yapılandırılabilir. Harici zil sesi, zil sesi süresini destekliyorsa kullanıcı bu süreyi yapılandırmak isteyebilir.
Burada ayarlanan değer, harici zilin özelliklerine ve önerilen zil süresine bağlıdır.
Harici zil sesinin süresini değiştirmek için yerleşik setExternalChimeDurationSeconds işlevini kullanarak ChimeTrait özelliğinin externalChimeDurationSeconds özelliğini güncelleyin:
// Change the external chime duration
func setExternalChimeDuration(to value: UInt16) async {
do {
_ = try await doorbellChimeTrait.update {
$0.setExternalChimeDuration(value)
}
} catch {
// Error
}
}