AudioRouting

Kotlin |Java

interface AudioRouting

android.media.AudioRouting

Known Direct Subclasses

AudioRecord, AudioTrack, MediaPlayer, MediaRecorder

AudioRecord	The AudioRecord class manages the audio resources for Java applications to record audio from the audio input hardware of the platform.
AudioTrack	The AudioTrack class manages and plays a single audio resource for Java applications.
MediaPlayer	MediaPlayer class can be used to control playback of audio/video files and streams.
MediaRecorder	Used to record audio and video.

AudioRouting defines an interface for controlling routing and routing notifications in AudioTrack and AudioRecord objects.

Summary

Nested classes
abstract	`OnRoutingChangedListener` Defines the interface by which applications can receive notifications of routing changes for the associated `AudioRouting`.

Public methods
abstract Unit	`addOnRoutingChangedListener(listener: AudioRouting.OnRoutingChangedListener!, handler: Handler!)` Adds an `AudioRouting.OnRoutingChangedListener` to receive notifications of routing changes on this AudioTrack/AudioRecord.
abstract AudioDeviceInfo!	`getPreferredDevice()` Returns the selected output/input specified by `setPreferredDevice`.
abstract AudioDeviceInfo!	`getRoutedDevice()` Returns an `AudioDeviceInfo` identifying the current routing of this AudioTrack/AudioRecord.
open MutableList<AudioDeviceInfo!>	`getRoutedDevices()` Returns a List of `AudioDeviceInfo` identifying the current routing of this AudioTrack/AudioRecord.
abstract Unit	`removeOnRoutingChangedListener(listener: AudioRouting.OnRoutingChangedListener!)` Removes an `AudioRouting.OnRoutingChangedListener` which has been previously added to receive rerouting notifications.
abstract Boolean	`setPreferredDevice(deviceInfo: AudioDeviceInfo!)` Specifies an audio device (via an `AudioDeviceInfo` object) to route the output/input to/from.

Public methods

addOnRoutingChangedListener

Added in API level 24

abstract fun addOnRoutingChangedListener(
    listener: AudioRouting.OnRoutingChangedListener!, 
    handler: Handler!
): Unit

Adds an AudioRouting.OnRoutingChangedListener to receive notifications of routing changes on this AudioTrack/AudioRecord.

Parameters
`listener`	AudioRouting.OnRoutingChangedListener!: The `AudioRouting.OnRoutingChangedListener` interface to receive notifications of rerouting events.
`handler`	Handler!: Specifies the `Handler` object for the thread on which to execute the callback. If `null`, the `Handler` associated with the main `Looper` will be used.

getPreferredDevice

Added in API level 24

abstract fun getPreferredDevice(): AudioDeviceInfo!

Returns the selected output/input specified by setPreferredDevice. Note that this is not guaranteed to correspond to the actual device being used for playback/recording.

getRoutedDevice

Added in API level 24

abstract fun getRoutedDevice(): AudioDeviceInfo!

Returns an AudioDeviceInfo identifying the current routing of this AudioTrack/AudioRecord. Note: The query is only valid if the AudioTrack/AudioRecord is currently playing. If it is not, getRoutedDevice() will return null.

getRoutedDevices

Added in API level 36

open fun getRoutedDevices(): MutableList<AudioDeviceInfo!>

Returns a List of AudioDeviceInfo identifying the current routing of this AudioTrack/AudioRecord. Note: The query is only valid if the AudioTrack/AudioRecord is currently playing. If it is not, getRoutedDevices() will return an empty List.

Return
`MutableList<AudioDeviceInfo!>`	This value cannot be `null`.

removeOnRoutingChangedListener

Added in API level 24

abstract fun removeOnRoutingChangedListener(listener: AudioRouting.OnRoutingChangedListener!): Unit

Removes an AudioRouting.OnRoutingChangedListener which has been previously added to receive rerouting notifications.

Parameters
`listener`	AudioRouting.OnRoutingChangedListener!: The previously added `AudioRouting.OnRoutingChangedListener` interface to remove.

setPreferredDevice

Added in API level 24

abstract fun setPreferredDevice(deviceInfo: AudioDeviceInfo!): Boolean

Specifies an audio device (via an AudioDeviceInfo object) to route the output/input to/from.

Parameters
`deviceInfo`	AudioDeviceInfo!: The `AudioDeviceInfo` specifying the audio sink or source. If deviceInfo is null, default routing is restored.

Return
`Boolean`	true if succesful, false if the specified `AudioDeviceInfo` is non-null and does not correspond to a valid audio device.