AudioCapabilitiesReceiver
@UnstableApi
class AudioCapabilitiesReceiver
Receives broadcast events indicating changes to the device's audio capabilities, notifying a Listener when audio capability changes occur.
Summary
Nested types |
|---|
interface AudioCapabilitiesReceiver.ListenerListener notified when audio capabilities change. |
Public constructors |
|---|
This function is deprecated. Use |
AudioCapabilitiesReceiver( |
Public functions |
|
|---|---|
AudioCapabilities! |
register()Registers the receiver, meaning it will notify the listener when audio capability changes occur. |
Unit |
setAudioAttributes(audioAttributes: AudioAttributes!)Updates the |
Unit |
@RequiresApi(value = 23)Updates the |
Unit |
Unregisters the receiver, meaning it will no longer notify the listener when audio capability changes occur. |
Public constructors
AudioCapabilitiesReceiver
AudioCapabilitiesReceiver(
context: Context!,
listener: AudioCapabilitiesReceiver.Listener!
)
AudioCapabilitiesReceiver
AudioCapabilitiesReceiver(
context: Context!,
listener: AudioCapabilitiesReceiver.Listener!,
audioAttributes: AudioAttributes!,
routedDevice: AudioDeviceInfo?
)
| Parameters | |
|---|---|
context: Context! |
A context for registering the receiver. |
listener: AudioCapabilitiesReceiver.Listener! |
The listener to notify when audio capabilities change. |
audioAttributes: AudioAttributes! |
The |
routedDevice: AudioDeviceInfo? |
The |
Public functions
register
fun register(): AudioCapabilities!
Registers the receiver, meaning it will notify the listener when audio capability changes occur. The current audio capabilities will be returned. It is important to call unregister when the receiver is no longer required.
| Returns | |
|---|---|
AudioCapabilities! |
The current audio capabilities for the device. |
setAudioAttributes
fun setAudioAttributes(audioAttributes: AudioAttributes!): Unit
Updates the AudioAttributes used by this instance.
| Parameters | |
|---|---|
audioAttributes: AudioAttributes! |
The |
setRoutedDevice
@RequiresApi(value = 23)
fun setRoutedDevice(routedDevice: AudioDeviceInfo?): Unit
Updates the AudioDeviceInfo audio will be routed to.
| Parameters | |
|---|---|
routedDevice: AudioDeviceInfo? |
The |
unregister
fun unregister(): Unit
Unregisters the receiver, meaning it will no longer notify the listener when audio capability changes occur.