1 BlueZ D-Bus Media API description 2 ********************************* 3 4 Media hierarchy 5 =============== 6 7 Service org.bluez 8 Interface org.bluez.Media 9 Object path [variable prefix]/{hci0,hci1,...} 10 11 Methods void RegisterEndpoint(object endpoint, dict properties) 12 13 Register a local end point to sender, the sender can 14 register as many end points as it likes. 15 16 Note: If the sender disconnects the end points are 17 automatically unregistered. 18 19 possible properties: 20 21 string UUID: 22 23 UUID of the profile which the endpoint 24 is for. 25 26 byte Codec: 27 28 Assigned mumber of codec that the 29 endpoint implements. The values should 30 match the profile specification which 31 is indicated by the UUID. 32 33 array{byte} Capabilities: 34 35 Capabilities blob, it is used as it is 36 so the size and byte order must match. 37 38 Possible Errors: org.bluez.Error.InvalidArguments 39 org.bluez.Error.NotSupported - emitted 40 when interface for the end-point is 41 disabled. 42 43 void UnregisterEndpoint(object endpoint) 44 45 Unregister sender end point. 46 47 MediaEndpoint hierarchy 48 ======================= 49 50 Service unique name 51 Interface org.bluez.MediaEndpoint 52 Object path freely definable 53 54 Methods void SetConfiguration(object transport, dict properties) 55 56 Set configuration for the transport. 57 58 array{byte} SelectConfiguration(array{byte} capabilities) 59 60 Select preferable configuration from the supported 61 capabilities. 62 63 Returns a configuration which can be used to setup 64 a transport. 65 66 Note: There is no need to cache the selected 67 configuration since on success the configuration is 68 send back as parameter of SetConfiguration. 69 70 void ClearConfiguration(object transport) 71 72 Clear transport configuration. 73 74 void Release() 75 76 This method gets called when the service daemon 77 unregisters the endpoint. An endpoint can use it to do 78 cleanup tasks. There is no need to unregister the 79 endpoint, because when this method gets called it has 80 already been unregistered. 81 82 MediaTransport hierarchy 83 ======================== 84 85 Service org.bluez 86 Interface org.bluez.MediaTransport 87 Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/fdX 88 89 Methods dict GetProperties() 90 91 Returns all properties for the interface. See the 92 properties section for available properties. 93 94 fd, uint16, uint16 Acquire(string accesstype) 95 96 Acquire transport file descriptor and the MTU for read 97 and write respectively. 98 99 possible accesstype: 100 101 "r" : Read only access 102 103 "w" : Write only access 104 105 "rw": Read and write access 106 107 void Release(string accesstype) 108 109 Releases file descriptor. 110 111 void SetProperty(string name, variant value) 112 113 Changes the value of the specified property. Only 114 properties that are listed a read-write can be changed. 115 116 On success this will emit a PropertyChanged signal. 117 118 Signals void PropertyChanged(string name, variant value) 119 120 This signal indicates a changed value of the given 121 property. 122 123 Properties object Device [readonly] 124 125 Device object which the transport is connected to. 126 127 string UUID [readonly] 128 129 UUID of the profile which the transport is for. 130 131 byte Codec [readonly] 132 133 Assigned mumber of codec that the transport support. 134 The values should match the profile specification which 135 is indicated by the UUID. 136 137 array{byte} Configuration [readonly] 138 139 Configuration blob, it is used as it is so the size and 140 byte order must match. 141 142 uint16 Delay [readwrite] 143 144 Optional. Transport delay in 1/10 of milisecond, this 145 property is only writeable when the transport was 146 acquired by the sender. 147 148 boolean NREC [readwrite] 149 150 Optional. Indicates if echo cancelling and noise 151 reduction functions are active in the transport, this 152 property is only writeable when the transport was 153 acquired by the sender. 154 155 boolean InbandRingtone [readwrite] 156 157 Optional. Indicates if the transport support sending 158 ringtones, this property is only writeable when the 159 transport was acquired by the sender. 160 161 string Routing [readonly] 162 163 Optional. Indicates where is the transport being routed 164 165 Possible Values: "HCI" or "PCM" 166
