Skema Sifat Volume Smart Home

action.devices.traits.Volume - Fitur ini milik perangkat yang dapat mengubah volume (misalnya, menyetel volume ke level tertentu, membisukan, atau membunyikan audio).

ATRIBUT Perangkat

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

Atribut Jenis Deskripsi
volumeMaxLevel Bilangan Bulat

Wajib.

Level volume maksimum, dengan asumsi dasar pengukuran 0 (bisukan). Asisten akan menyesuaikan perintah kata keterangan (misalnya, 'buat TV sedikit lebih keras') sebagaimana mestinya.
volumeCanMuteAndUnmute Boolean

Wajib.

Menunjukkan apakah perangkat dapat membisukan dan membunyikan volume. Bisukan adalah opsi terpisah karena perilaku 'bisukan' akan menurunkan volume ke 0 sekaligus mengingat volume sebelumnya, sehingga membunyikan akan memulihkannya. Hal ini tercermin dalam status volume. Jika volume adalah 5 dan pengguna membisukan audio, volume akan tetap 5 dan isMuted adalah benar.
volumeDefaultPercentage Bilangan Bulat

(Default: 40)

Volume (dalam persentase) untuk volume default yang ditentukan oleh pengguna atau produsen. Skala harus antara 0-100.
levelStepSize Bilangan Bulat

(Default: 1)

Ukuran langkah default untuk kueri volume relatif seperti 'volume naik di <device_name>.
commandOnlyVolume Boolean

(Default: false)

Menunjukkan apakah perangkat beroperasi menggunakan komunikasi satu arah (true) atau dua arah (false). Misalnya, jika pengontrol dapat mengonfirmasi status perangkat baru setelah mengirim permintaan, kolom ini akan bernilai false. Jika tidak dapat mengonfirmasi apakah permintaan berhasil dijalankan atau untuk mendapatkan status perangkat (misalnya, jika perangkat adalah remote inframerah tradisional), setel kolom ini ke benar (true).

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 lebih lanjut cara menangani intent QUERY, lihat Fulfillment intent.

Negara bagian Jenis Deskripsi
currentVolume Bilangan Bulat

Wajib.

Persentase volume saat ini. Harus antara >0 dan volumeMaxLevel.
isMuted Boolean

Wajib jika atribut volumeCanMuteAndUnmute ditetapkan ke benar. Benar jika perangkat dibisukan; salah jika tidak. Jika isMuted bernilai benar, perangkat masih menampilkan currentVolume untuk titik yang diingat.

Contoh

Perangkat speaker yang dapat dibisukan dan melaporkan status saat ini

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

Perintah Perangkat

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

action.devices.commands.mute

Membisukan atau membunyikan perangkat.

Parameter

Parameter Jenis Deskripsi
mute Boolean

Wajib.

Apakah akan membisukan perangkat atau membunyikan perangkat.

Contoh

Membisukan 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 Bilangan Bulat

Wajib.

Volume baru, dari 0 hingga volumeMaxLevel.

Contoh

Menetapkan volume absolut perangkat speaker

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

action.devices.commands.volumeRelative

Naikkan atau turunkan volume sebanyak n langkah, berdasarkan volumeMaxLevel. Untuk perintah yang menggunakan skala relatif, Asisten akan memilih n secara tepat untuk menyesuaikan dengan langkah-langkah yang tersedia. Misalnya, opsi Buat TV lebih keras akan menetapkan jumlah langkah yang lebih tinggi daripada Membuat TV sedikit lebih keras.

Parameter

Parameter Jenis Deskripsi
relativeSteps Bilangan Bulat

Wajib.

negatif untuk 'mengurangi'.

Contoh

Menetapkan volume relatif perangkat speaker dalam mode khusus perintah

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

ERROR Perangkat

Lihat daftar lengkap error dan pengecualian.
  • volumeAlreadyMax: Perangkat menerima perintah VolumeUp saat sudah berada di volume tertinggi.
  • volumeAlreadyMin: Perangkat menerima perintah VolumeDown saat volume sudah terendah.