Skema Trait 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).

ATTRIBUTES Perangkat

Perangkat dengan karakteristik ini mungkin melaporkan hal berikut sebagai bagian dari operasi SYNC. Untuk mempelajari selengkapnya tentang menangani intent SYNC, lihat Pemenuhan intent.

Atribut	Jenis	Deskripsi
volumeMaxLevel	Bilangan Bulat	Wajib. Level volume maksimum, dengan asumsi dasar pengukuran 0 (bisukan). Asisten akan menyesuaikan perintah adverbial (misalnya 'buat tv sedikit lebih keras') sesuai dengan perintah tersebut.
volumeCanMuteAndUnmute	Boolean	Wajib. Menunjukkan apakah perangkat dapat membisukan dan membunyikan volume. Bisukan adalah opsi yang terpisah dari 'bisukan' mengubah volume ke 0 sambil 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 adalah benar.
volumeDefaultPercentage	Bilangan Bulat	(Default: 40) Volume (dalam persentase) untuk volume default yang ditentukan oleh pengguna atau produsen. Skalanya harus 0-100.
levelStepSize	Bilangan Bulat	(Default: 1) Ukuran langkah default untuk kueri volume relatif seperti 'naikkan volume di <device_name>.
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 bernilai false. Jika tidak dapat mengonfirmasi apakah permintaan berhasil dieksekusi 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
}

NEGARA Perangkat

Entitas dengan karakteristik ini dapat melaporkan hal berikut status sebagai bagian dari operasi QUERY. Untuk mempelajari selengkapnya tentang menangani intent QUERY, lihat Pemenuhan intent.

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

Contoh

Perangkat speaker yang dapat dibisukan dan melaporkan status saat ini

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

Perangkat COMMANDS

Perangkat dengan karakteristik ini dapat merespons hal berikut sebagai bagian dari operasi EXECUTE. Untuk mempelajari selengkapnya tentang menangani intent EXECUTE, lihat Pemenuhan intent.

action.devices.commands.mute

Membisukan atau membunyikan perangkat.

Parameter

Parameter	Jenis	Deskripsi
mute	Boolean	Wajib. Menentukan apakah akan membisukan perangkat atau membunyikan perangkat.

Contoh

Membisukan 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	Bilangan Bulat	Wajib. Volume baru, dari 0 sampai volumeMaxLevel.

Contoh

Menyetel volume absolut perangkat speaker

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

action.devices.commands.volumeRelative

Setel naikkan atau turunkan volume 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
  }
}

Perangkat ERRORS

Lihat daftar lengkap error dan pengecualian.

• volumeAlreadyMax: Perangkat menerima perintah VolumeUp saat sudah mencapai volume tertinggi.
• volumeAlreadyMin: Perangkat menerima perintah VolumeDown saat sudah pada volume terendah.