Skema Atribut 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 Type Deskripsi
volumeMaxLevel Integer

Wajib.

Tingkat volume maksimum, dengan asumsi garis dasar 0 (bisukan). Asisten akan menyesuaikan perintah iklan (misalnya 'buat tv sedikit lebih keras') sesuai dengan itu.

volumeCanMuteAndUnmute Boolean

Wajib.

Menunjukkan apakah perangkat dapat membisukan dan membunyikan audio. Bisukan adalah opsi terpisah karena perilaku 'bisu' mengambil 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 bernilai benar.

volumeDefaultPercentage Integer

(Default: 40)

Volume (dalam persentase) untuk volume default yang ditentukan oleh pengguna atau produsen. Skalanya 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 bernilai false. 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 true (benar).

Contoh

Perangkat speaker yang dapat dibisukan dan melaporkan status saat ini

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

STATE 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 Type Deskripsi
currentVolume Integer

Wajib.

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

isMuted Boolean

Diperlukan jika atribut volumeCanMuteAndUnmute disetel ke benar (true). True jika perangkat dibisukan; false jika tidak. Jika isMuted bernilai 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
}

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

Wajib.

Apakah membisukan perangkat atau membunyikan audio perangkat.

Contoh

Bisukan perangkat speaker

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

action.devices.commands.setVolume

Setel volume ke tingkat yang diminta, berdasarkan volumeMaxLevel.

Parameter

Parameter Type Deskripsi
volumeLevel Integer

Wajib.

Volume baru, dari 0 sampai volumeMaxLevel.

Contoh

Menyetel volume mutlak perangkat speaker

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

action.devices.commands.volumeRelative

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

Parameter

Parameter Type Deskripsi
relativeSteps Integer

Wajib.

negatif untuk 'penurunan'.

Contoh

Menyetel volume relatif perangkat speaker dalam mode khusus perintah

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

ERRORS perangkat

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