1 BlueZ D-Bus Control API description 2 *********************************** 3 4 Copyright (C) 2004-2010 Marcel Holtmann <marcel (a] holtmann.org> 5 Copyright (C) 2007-2008 David Stockwell <dstockwell (a] frequency-one.com> 6 7 8 Control hierarchy 9 ================= 10 11 Service org.bluez 12 Interface org.bluez.Control 13 Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX 14 15 Methods void Connect() 16 17 Connect to remote device (CT or TG). 18 19 void Disconnect() 20 21 Disconnect remote device. 22 23 dict GetProperties() 24 25 Returns all properties for the interface. See the 26 properties section for available properties. 27 28 void VolumeUp() 29 30 Adjust remote volume one step up 31 32 void VolumeDown() 33 34 Adjust remote volume one step down 35 36 boolean SendPassthrough(avc_operation_id key, boolean state, 37 string op_data) 38 39 Called to send Passthrough commands. ONLY valid if 40 BlueZ device is in CT role. 41 42 boolean SendVendorDependent(string op_data) 43 44 Called to send VendorDependent commands, other than 45 Metadata or Events defined in the AVRCP+Metadata 46 specification. 47 48 void ChangePlayback(string status, uint32 elapsed) 49 50 The status can be "playing", "stopped", "paused", 51 "forward-seek", "reverse-seek" or "error". Elapsed is 52 the position within the track in milliseconds. 53 54 void ChangeTrack(dict metadata) 55 56 Called to send the mandated TrackChange event and 57 potential metadata information. 58 59 Current defined metadata information are represented 60 with the following keys: 61 62 Title string (mandatory) 63 Artist string 64 Album string 65 Genre string 66 NumberOfTracks uint32 67 TrackNumber uint32 68 TrackDuration uint32 (in milliseconds) 69 70 void ChangeSetting(string setting, variant value) 71 72 Called to transmit Application Settings, CT Status 73 and the like. 74 75 Currenet defined settings are represented with the 76 following keys: 77 78 Equalizer off, on 79 Repeat off, singletrack, alltracks, group 80 Shuffle off, alltracks, group 81 Scan off, alltracks, group 82 Battery normal, warning, critical, external, fullcharge 83 System powered, unpowered, unplugged 84 Volume uint8 85 86 Signals Connected() 87 88 Sent when a successful AVRCP connection has been made 89 to the remote device. 90 91 Disconnected() 92 93 Sent when the AVRCP connection to the remote device 94 has been disconnected. 95 96 Passthrough(uint8 key, boolean state, int32 company_id, 97 string op_data) 98 99 Called when Passthrough command is received from 100 connected device. 101 102 NOTE: according to the AV/C Subpanel Spec, company_id 103 and op_data are passed ONLY when the key is 104 "Vendor_Unique", or 0x7E. 105 106 When the key is NOT 0x7E, the signal returns 107 company_id=-1, and zero-length op_data. 108 109 VendorDependentReceived(string op_data) 110 111 Called when VendorDependent message is received from 112 connected device (except for Metadata defined in 113 Bluetooth SIG AVRCP+Metadata spec). 114 115 TrackChanged(dict metadata) 116 117 Called when Metadata is received from connected device. 118 May be multiple meta attribute/element pairs. 119 120 PlaybackChanged(string status, uint32 elapsed) 121 122 SettingChanged(string setting, variant value) 123 124 Properties uint8 SubUnitID [readonly] 125 126 The three-bit Subunit ID from the connected device. 127 128 uint8 SubUnitType [readonly] 129 130 The five-bit Subunit Type from the connected device. 131 132 boolean Connected [readonly] 133 134 array{uint32} CompanyIDs [readonly] 135 136 List of three-byte Company IDs (OUI) supported by the 137 connected device. Note that Bluetooth SIG Company 138 ID (0x001958) is always included. 139 140 array{string} Capabilities [readonly] 141 142 List of Capabilities provided by the connected device. 143
