This API provides methods and events to support Bluetooth discovery, pairing and connecting. It also provides method to select appropriate audio sink and to chose audio stream to be streamed to device.<\/p>
<\/p>
This is updated version of Bluetooth API. It provides events to support Bluetooth auto-connect notification for the last connected bluetooth device, in which the connection can be Accepted or Rejected<\/p>
based on user interest. This API is extension of existing org.rdk.bluetoothSettings_2<\/strong> api.<\/p> <\/p> Event:<\/span><\/strong><\/p> Name<\/p><\/th> Payload<\/p><\/th> Description<\/p><\/th><\/tr><\/thead> HashMap {<\/p> <\/p> deviceID:uint64<\/strong><\/p> name:String<\/strong><\/p> deviceType:String<\/strong><\/p> lastConnectedState:bool<\/strong><\/p> }<\/p><\/td> One or more of third party devices, that have already been paired to the set top box, will send this event when they come inside the set top box range or gets powered Up within the range.<\/p> Separate notification is sent for each device that comes up, provided the device is already paired with the set top box.<\/p> deviceID<\/strong> – ID derived from Bluetooth MAC address. 6 byte MAC value is packed into 8 byte with leading zeros for first 2 bytes.<\/p> name<\/strong> – device name as specified by manufacturer<\/p> deviceType<\/strong> – device class<\/p> lastConnectedState<\/strong> – true or false. Only the last connected device has the true status.<\/p> <\/p><\/td><\/tr> HashMap {<\/p> <\/p> deviceID:uint64<\/strong><\/p> name:String<\/strong><\/p> deviceType:String<\/strong><\/p> lastConnectedState:bool<\/strong><\/p> }<\/p><\/td> A third party device that is currently connected to the set top was lost(poweredOff) or went out of range.<\/p> Separate notification is sent for the lost device<\/p> deviceID<\/strong> – ID derived from Bluetooth MAC address. 6 byte MAC value is packed into 8 byte with leading zeros for first 2 bytes.<\/p> name<\/strong> – device name as specified by manufacturer<\/p> deviceType<\/strong> – device class<\/p> lastConnectedState<\/strong> – true or false. Only the last connected device has the true status. Status is true in this case.<\/p><\/td><\/tr><\/tbody><\/table> <\/div> This is updated version of Bluetooth API. It provides methods to support Bluetooth-In feature, allowing external source device to play audio through set top box.<\/p> This API is extension of existing org.rdk.bluetoothSettings_1<\/strong> api.<\/p> <\/p> Methods:<\/p> Name<\/p><\/th> Parameters<\/p><\/th> Return Value<\/p><\/th> Description<\/p><\/th><\/tr><\/thead> deviceID:uint64 <\/p><\/td> HashMap {<\/p> album: string<\/strong><\/p> trackNumber: uint32<\/strong><\/p> genre: string<\/strong><\/p> duration: unit32<\/strong><\/p> numberOfTracks:uint32<\/strong><\/p> title: string<\/strong><\/p> artist: string<\/strong><\/p> }<\/p><\/td> This method provides info on currently playing song\/audio from external source. The returned info from Bluetooth-In device provides information that could be displayed on Tv screen.<\/p> deviceID <\/strong>– ID derived from Bluetooth MAC address. 6 byte MAC value is packed into 8 byte with leading zeros for first 2 bytes<\/p> <\/p><\/td><\/tr> deviceID:uint64 audioCtrlCmd:String<\/strong><\/p><\/td> This method provides control over connected source. Request can have one of the following values:<\/p> PLAY, PAUSE, STOP, SKIP_NEXT, RESTART, SKIP_PREVIOUS<\/p> deviceID <\/strong>– ID derived from Bluetooth MAC address. 6 byte MAC value is packed into 8 byte with leading zeros for first 2 bytes<\/p> audioCtrlCmd <\/strong>– Audio control request to be set to the playback.<\/p><\/td><\/tr> deviceID:uint64<\/strong><\/p> eventType: string<\/strong><\/p> respValue: string<\/strong><\/p><\/td> Responds to a bluetooth event. For example, can respond to a pairing or connection event and indicate the proper response, such as is the connection request accepted.<\/p> Details is in object that defines the following keys:<\/p> eventType<\/strong> – CONNECTION, PAIRING, PLAYBACK<\/p> responseValue<\/strong> – ACCEPTED, REJECTED<\/p> deviceID<\/strong> – ID derived from Bluetooth MAC address. 6 byte MAC value is packed into 8 byte with leading zeros for first 2 bytes<\/p><\/td><\/tr><\/tbody><\/table> <\/div> <\/p> Event<\/p> Name<\/p><\/th> Payload<\/p><\/th> Description<\/p><\/th><\/tr><\/thead> Returns the status change for Bluetooth In streaming functionality. <\/p> “PLAYBACK_STARTED” – playback was started<\/p> “PLAYBACK_STOPPED” – remote source stopped playback<\/p> “PLAYBACK_PAUSED” – remote source paused current playback<\/p> “PLAYBACK_ENDED” – remote source stopped playback and requested disconnect.<\/p><\/td><\/tr> HashMap {<\/p> deviceID:uint64<\/strong><\/p> name:String<\/strong><\/p> deviceType:String<\/strong><\/p> supportedProfle:String<\/strong><\/p> manufacturer:<\/strong>String<\/strong><\/p> MAC:<\/strong>String<\/strong><\/p> }<\/p><\/td> A connection is requested by third party device that has already been paired to the set top box.<\/p> deviceID<\/strong> – ID derived from Bluetooth MAC address. 6 byte MAC value is packed into 8 byte with leading zeros for first 2 bytes.<\/p> name<\/strong> – device name as specified by manufacturer<\/p> deviceType<\/strong> – device class<\/p> supportedProfle<\/strong> – list of profiles that are supported by device<\/p> manufacturer<\/strong> – device manufacturer<\/p> MAC<\/strong> – device MAC ID<\/p><\/td><\/tr> HashMap {<\/p> deviceID:uint64<\/strong><\/p> name:String<\/strong><\/p> deviceType:String<\/strong><\/p> supportedProfle:String<\/strong><\/p> manufacturer:<\/strong>String<\/strong><\/p> MAC:<\/strong>String<\/strong><\/p> }<\/p><\/td> A connection is requested by third party device that has already been paired to the set top box.<\/p> deviceID<\/strong> – ID derived from Bluetooth MAC address. 6 byte MAC value is packed into 8 byte with leading zeros for first 2 bytes.<\/p> name<\/strong> – device name as specified by manufacturer<\/p> deviceType<\/strong> – device class<\/p> supportedProfle<\/strong> – list of profiles that are supported by device<\/p> manufacturer<\/strong> – device manufacturer<\/p> MAC<\/strong> – device MAC ID<\/p><\/td><\/tr><\/tbody><\/table> <\/div> This is initial version of Bluetooth API. It provides methods to discover Bluetooth devices, retrieve list of paired and currently connected devices.<\/p> It also provides functions to initiate pairing and connecting.<\/p> Service Manager will send event in case external Bluetooth adapter is inserted or removed, when device connects or is disconnects, or if it requests to pair for input.<\/p> Existence of this API indicates that software support for Bluetooth in RDK stack exists.<\/p> <\/p> Methods:<\/p> Name<\/p><\/th> Parameters<\/p><\/th> Return Value<\/p><\/th> Description<\/p><\/th><\/tr><\/thead> Returns the current status of Bluetooth subsystem. Valid responses are:<\/p> “NO_BLUETOOTH_HARDWARE” – Bluetooth is supported in RDK software, but no Bluetooth hardware found<\/p> “SOFTWARE_DISABLED” – Bluetooth is currently disabled in software. Bluetooth needs to be enabled by calling setBluetoothEnabled<\/strong>.<\/p> “AVAILABLE” – Bluetooth stack is initialized, not software disabled and hardware is running.<\/p><\/td><\/tr> Initiates device discovery. Passes timeout in seconds. If call is made with timeout of 0 seconds, settop will immediately stop discovery.<\/p> Call returns status:<\/p> “NO_BLUETOOTH_HARDWARE” – Bluetooth is supported in RDK software, but no Bluetooth hardware found<\/p> AVAILABLE” – Bluetooth stack is initialized, not software disabled and hardware is running.<\/p><\/td><\/tr> getDiscoveredDevices<\/strong><\/p><\/td> HashMap {<\/p> deviceID:uint64<\/strong><\/p> name:String<\/strong><\/p> deviceType:String<\/strong><\/p> connectedState:bool<\/strong><\/p> paired:bool }<\/p><\/td> Returns the list of discovered devices:<\/p> deviceID<\/strong> – ID derived from Bluetooth MAC address. 6 byte MAC value is packed into 8 byte with leading zeros for first 2 bytes.<\/p> Example: MAC 6C:A0:17:B6:00:24 will be represented with 64 bit ID whose hex representation will look like 0 x 00 00 6C A0 17 B6 00 24<\/p> Example multiple Bluetooth speakers\/headphones in the same room.<\/p> name<\/strong> – device name as specified by manufacturer<\/p> deviceType<\/strong> – device class (examples “headset”, “speakers”, etc)<\/p> connectedState<\/strong> – true or false<\/p> paired<\/strong> – true or false<\/p><\/td><\/tr> getPairedDevices<\/strong><\/p><\/td> HashMap {<\/p> deviceID:uint64<\/strong><\/p> name:String<\/strong><\/p> deviceType:String<\/strong><\/p> connectedState:bool }<\/p><\/td> Returns list of all paired device:<\/p> deviceID<\/strong> – ID derived from Bluetooth MAC address. 6 byte MAC value is packed into 8 byte with leading zeros for first 2 bytes.<\/p> name<\/strong> – device name as specified by manufacturer<\/p> deviceFound<\/strong><\/td> deviceLost<\/strong><\/td> Name: org.rdk.bluetoothSettings_2<\/strong><\/h4>
getAudioInfo<\/strong><\/td>
<\/strong><\/p>setPlayback<\/strong><\/td>
<\/strong><\/p>none<\/td> respondToEvent<\/strong><\/td> none<\/td> streamingStatusChanged<\/strong><\/td> newStatus:String<\/strong><\/td> connectionRequest<\/strong><\/td> playbackRequest<\/strong><\/td> Name: org.rdk.bluetoothSettings_1<\/strong><\/h4>
getStatusSupport<\/strong><\/td> none<\/td> status:String<\/strong><\/td> startDeviceDiscovery<\/strong><\/td> timeout:int<\/strong><\/td> status:String<\/strong><\/td> stopDeviceDiscovery<\/strong><\/td> none<\/td> none<\/td> Stops Bluetooth device discovery immediately.<\/td><\/tr> none<\/td>
<\/strong><\/p>
<\/strong><\/p>
<\/span><\/strong><\/p>none<\/td>
<\/strong><\/p>