Skema Fitur Volume Smart Home

action.devices.traits.Volume - Sifat ini termasuk perangkat yang dapat mengubah volume (misalnya, menyetel volume ke tingkat tertentu, membisukan, atau membunyikan audio).

ATRIBUT Perangkat

Perangkat dengan karakteristik ini dapat melaporkan atribut berikut sebagai bagian dari operasi SYNC. Untuk mempelajari penanganan intent SYNC lebih lanjut, lihat fulfillment intent.

Atribut	Jenis	Deskripsi
volumeMaxLevel	Integer	Wajib. Tingkat volume maksimum, dengan asumsi garis dasar 0 (bisukan). Asisten akan menyesuaikan perintah adverbial (misalnya, 'Jadikan TV sedikit lebih keras') sesuai.
volumeCanMuteAndUnmute	Boolean	Wajib. Menunjukkan apakah perangkat dapat membisukan dan membunyikan audio. Bisukan adalah opsi terpisah karena perilaku 'mute' mengubah volume ke 0 sekaligus mengingat volume sebelumnya, sehingga membunyikan audio akan memulihkannya. Hal ini tercermin dalam status volume—jika volume adalah 5, dan pengguna membisukan audio, volume akan tetap 5 dan isMuted bernilai benar.
volumeDefaultPercentage	Integer	(Default: 40) Volume (dalam persentase) untuk volume default yang ditentukan oleh pengguna atau produsen. Skala harus 0-100.
levelStepSize	Integer	(Default: 1) Ukuran langkah default untuk kueri volume relatif seperti 'naikkan volume di <nama_perangkat>.
commandOnlyVolume	Boolean	(Default: false) Menunjukkan apakah perangkat beroperasi menggunakan komunikasi satu arah (benar) atau dua arah (salah). Misalnya, jika pengontrol dapat mengonfirmasi status perangkat baru setelah mengirim permintaan, kolom ini akan salah. Jika tidak memungkinkan untuk mengonfirmasi apakah permintaan berhasil dieksekusi atau untuk mendapatkan status perangkat (misalnya, jika perangkat adalah remote inframerah tradisional), tetapkan kolom ini ke true (benar).

Contoh

Perangkat speaker yang dapat dibisukan dan melaporkan status saat ini

{
  "volumeMaxLevel": 11,
  "volumeCanMuteAndUnmute": true,
  "levelStepSize": 2,
  "commandOnlyVolume": false,
  "volumeDefaultPercentage": 6
}

STATUS Perangkat

Entitas dengan karakteristik ini dapat melaporkan status berikut sebagai bagian dari operasi QUERY. Untuk mempelajari penanganan intent QUERY lebih lanjut, lihat fulfillment intent.

Negara bagian	Jenis	Deskripsi
currentVolume	Integer	Wajib. Persentase volume saat ini. Harus antara >0 dan volumeMaxLevel.
isMuted	Boolean	Wajib jika atribut volumeCanMuteAndUnmute ditetapkan ke true. True jika perangkat dibisukan; false jika tidak. Jika isMuted disetel ke benar (true), perangkat akan tetap menampilkan currentVolume untuk titik yang diingat.

Contoh

Perangkat speaker yang dapat dibisukan dan melaporkan status saat ini

{
  "currentVolume": 5,
  "isMuted": false
}

COMMAND Perangkat

Perangkat dengan karakteristik ini dapat merespons perintah berikut sebagai bagian dari operasi EXECUTE. Untuk mempelajari penanganan intent EXECUTE lebih lanjut, lihat fulfillment intent.

action.devices.commands.mute

Membisukan atau membunyikan audio perangkat.

Parameter

Parameter	Jenis	Deskripsi
mute	Boolean	Wajib. Apakah membisukan perangkat atau membunyikan audio perangkat.

Contoh

Bisukan audio perangkat speaker

{
  "command": "action.devices.commands.mute",
  "params": {
    "mute": true
  }
}

action.devices.commands.setVolume

Setel volume ke tingkat yang diminta, berdasarkan volumeMaxLevel.

Parameter

Parameter	Jenis	Deskripsi
volumeLevel	Integer	Wajib. Volume baru, dari 0 ke volumeMaxLevel.

Contoh

Menyetel volume absolut perangkat speaker

{
  "command": "action.devices.commands.setVolume",
  "params": {
    "volumeLevel": 6
  }
}

action.devices.commands.volumeRelative

Setel volume naik atau turun n langkah, berdasarkan volumeMaxLevel. Untuk perintah yang menggunakan skala relatif, Asisten akan memilih n dengan tepat untuk menskalakan ke langkah-langkah yang tersedia. Misalnya, Buat TV jauh lebih keras akan menetapkan jumlah langkah yang lebih tinggi daripada Buat TV sedikit lebih keras.

Parameter

Parameter	Jenis	Deskripsi
relativeSteps	Integer	Wajib. negatif untuk 'penurunan'.

Contoh

Menetapkan volume relatif perangkat speaker dalam mode khusus perintah

{
  "command": "action.devices.commands.volumeRelative",
  "params": {
    "relativeSteps": -1
  }
}

Perangkat ERRORS

Lihat daftar lengkap error dan pengecualian.

• volumeAlreadyMax: Perangkat menerima perintah VolumeUp saat volumenya sudah paling tinggi.
• volumeAlreadyMin: Perangkat menerima perintah VolumeDown saat volumenya sudah terendah.