Skema Trait Volume Smart Home

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

ATTRIBUTE Perangkat

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

Atribut Type Deskripsi
volumeMaxLevel Bilangan Bulat

Wajib.

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

Wajib.

Menunjukkan apakah perangkat dapat membisukan dan membunyikan volume. Bisukan adalah opsi terpisah karena perilaku 'bisukan' menjadikan volume ke 0 sambil mengingat volume sebelumnya, sehingga bunyi 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 menjadi salah. Jika tidak memungkinkan untuk mengonfirmasi apakah permintaan berhasil dijalankan atau untuk mendapatkan status perangkat (misalnya, jika perangkat adalah remote inframerah tradisional), tetapkan 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 penanganan intent QUERY lebih lanjut, lihat Fulfillment intent.

Status Type 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 tidak. Jika isMuted bernilai benar, perangkat tetap akan menampilkan currentVolume untuk titik yang diingat.

Contoh

Perangkat speaker yang dapat dibisukan dan melaporkan status saat ini

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

Perangkat COMMAND

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 Type Deskripsi
mute Boolean

Wajib.

Apakah membisukan perangkat atau membunyikan perangkat.

Contoh

Bisukan audio perangkat speaker

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

action.devices.commands.setVolume

Menyetel volume ke level yang diminta, berdasarkan volumeMaxLevel.

Parameter

Parameter Type Deskripsi
volumeLevel Bilangan Bulat

Wajib.

Volume baru, dari 0 hingga volumeMaxLevel.

Contoh

Menyetel volume absolut perangkat speaker

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

action.devices.commands.volumeRelative

Menyetel volume naik atau turun n langkah, berdasarkan volumeMaxLevel. Untuk perintah yang menggunakan skala relatif, Asisten akan memilih n yang sesuai untuk menskalakan ke langkah yang tersedia. Misalnya, Buat TV lebih keras akan menyetel jumlah langkah yang lebih tinggi daripada Buat TV sedikit lebih keras.

Parameter

Parameter Type Deskripsi
relativeSteps Bilangan Bulat

Wajib.

negatif untuk 'penurunan'.

Contoh

Menyetel 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 mencapai volume terendah.