AudioDeviceDescriptor

java.lang.Object
- ohos.media.audio.AudioDeviceDescriptor

```
public class AudioDeviceDescriptor
extends Object
```
Provides audio device details.
The device details include the ID, name, address, type (defined by DeviceType), and role (defined by DeviceRole).

从以下版本开始:

1

SystemCapability

SystemCapability.Multimedia#AUDIO

嵌套类概要

嵌套类
限定符和类型	类	说明
`static class`	`AudioDeviceDescriptor.DeviceFlag`	Describes audio device flags.
`static class`	`AudioDeviceDescriptor.DeviceRole`	Describes audio device roles.
`static class`	`AudioDeviceDescriptor.DeviceType`	Describes audio device types.

构造器概要

构造器
构造器	说明
`AudioDeviceDescriptor(int id, String name, String address, AudioDeviceDescriptor.DeviceType type, AudioDeviceDescriptor.DeviceRole role, int[] samplingRates, int[] channelMasks, int[] channelIndexMasks, List<AudioStreamInfo.EncodingFormat> encodings)`	A constructor used to create an `AudioDeviceDescriptor` instance.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`boolean`	`equals(Object object)`	Checks whether the audio device details, including the ID, name, address, type, and role, specified by the input parameters of the `AudioDeviceDescriptor` method are the same as those of an existing audio device.
`String`	`getAddress()`	Obtains a device address.
`int[]`	`getChannelCounts()`	Obtains an array whose elements indicate the channel types supported by the device.
`int[]`	`getChannelIndexMasks()`	Obtains the channel index masks.
`int[]`	`getChannelMasks()`	Obtains the channel masks.
`List<AudioStreamInfo.EncodingFormat>`	`getEncodings()`	Obtains the encoding formats.
`int`	`getId()`	Obtains a device ID.
`String`	`getName()`	Obtains a device name.
`AudioDeviceDescriptor.DeviceRole`	`getRole()`	Obtains a device role.
`int[]`	`getSamplingRates()`	Obtains the sampling rates.
`AudioDeviceDescriptor.DeviceType`	`getType()`	Obtains a device type.
`int`	`hashCode()`	Generates a hash code value based on the ID, name, address, type, role, sampling rates, channel masks, and channel index masks of the device.
`boolean`	`isInputDevice()`	Checks whether the device is an input device.
`boolean`	`isOutputDevice()`	Checks whether the device is an output device.
`void`	`setAddress(String address)`	Sets a device address.
`void`	`setChannelIndexMasks(int[] channelIndexMasks)`	Sets the channel index masks.
`void`	`setChannelMasks(int[] channelMasks)`	Sets the channel masks.
`void`	`setEncodings(List<AudioStreamInfo.EncodingFormat> encodings)`	Sets the encoding formats.
`void`	`setId(int id)`	Sets a device ID.
`void`	`setName(String name)`	Sets a device name.
`void`	`setRole(AudioDeviceDescriptor.DeviceRole role)`	Sets a device role.
`void`	`setSamplingRates(int[] samplingRates)`	Sets the sampling rates.
`void`	`setType(AudioDeviceDescriptor.DeviceType type)`	Sets a device type.

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - AudioDeviceDescriptor
```
public AudioDeviceDescriptor(int id,
                             String name,
                             String address,
                             AudioDeviceDescriptor.DeviceType type,
                             AudioDeviceDescriptor.DeviceRole role,
                             int[] samplingRates,
                             int[] channelMasks,
                             int[] channelIndexMasks,
                             List<AudioStreamInfo.EncodingFormat> encodings)
```
    A constructor used to create an AudioDeviceDescriptor instance.
    
    参数:
    
    id - Indicates the device ID.
    
    name - Indicates the device name.
    
    address - Indicates the device address.
    
    type - Indicates the device type defined by DeviceType.
    
    role - Indicates the device role defined by DeviceRole.
    
    从以下版本开始:
    
    1
- 方法详细资料
  - equals
```
public boolean equals(Object object)
```
    Checks whether the audio device details, including the ID, name, address, type, and role, specified by the input parameters of the AudioDeviceDescriptor method are the same as those of an existing audio device.
    This method overrides the equals method.
    
    覆盖:
    
    equals 在类中 Object
    
    参数:
    
    object - Indicates an AudioDeviceDescriptor object.
    
    返回:
    
    Returns true if the device details are the same; returns false otherwise.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    Object.hashCode(), HashMap
  - hashCode
```
public int hashCode()
```
    Generates a hash code value based on the ID, name, address, type, role, sampling rates, channel masks, and channel index masks of the device.
    
    覆盖:
    
    hashCode 在类中 Object
    
    返回:
    
    Returns the hash code value.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - isOutputDevice
```
public boolean isOutputDevice()
```
    Checks whether the device is an output device.
    
    返回:
    
    Returns true if the device is an output device; returns false otherwise.
    
    从以下版本开始:
    
    1
  - isInputDevice
```
public boolean isInputDevice()
```
    Checks whether the device is an input device.
    
    返回:
    
    Returns true if the device is an input device; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getId
```
public int getId()
```
    Obtains a device ID.
    
    返回:
    
    Returns the device ID.
    
    从以下版本开始:
    
    1
  - setId
```
public void setId(int id)
```
    Sets a device ID.
    
    参数:
    
    id - Indicates the device ID.
    
    从以下版本开始:
    
    1
  - getName
```
public String getName()
```
    Obtains a device name.
    
    返回:
    
    Returns the device name.
    
    从以下版本开始:
    
    1
  - setName
```
public void setName(String name)
```
    Sets a device name.
    
    参数:
    
    name - Indicates the device name.
    
    从以下版本开始:
    
    1
  - getAddress
```
public String getAddress()
```
    Obtains a device address.
    
    返回:
    
    Returns the device address.
    
    从以下版本开始:
    
    1
  - setAddress
```
public void setAddress(String address)
```
    Sets a device address.
    
    参数:
    
    address - Indicates the device address.
    
    从以下版本开始:
    
    1
  - getType
```
public AudioDeviceDescriptor.DeviceType getType()
```
    Obtains a device type.
    
    返回:
    
    Returns the device type defined by DeviceType.
    
    从以下版本开始:
    
    1
  - setType
```
public void setType(AudioDeviceDescriptor.DeviceType type)
```
    Sets a device type.
    
    参数:
    
    type - Indicates the device type defined by DeviceType.
    
    从以下版本开始:
    
    1
  - getRole
```
public AudioDeviceDescriptor.DeviceRole getRole()
```
    Obtains a device role.
    
    返回:
    
    Returns the device role defined by DeviceRole.
    
    从以下版本开始:
    
    1
  - setRole
```
public void setRole(AudioDeviceDescriptor.DeviceRole role)
```
    Sets a device role.
    
    参数:
    
    role - Indicates the device role defined by DeviceRole.
    
    从以下版本开始:
    
    1
  - getSamplingRates
```
public int[] getSamplingRates()
```
    Obtains the sampling rates.
    
    返回:
    
    Returns the sampling rates.
    
    从以下版本开始:
    
    1
  - setSamplingRates
```
public void setSamplingRates(int[] samplingRates)
```
    Sets the sampling rates.
    
    参数:
    
    samplingRates - Indicates the sampling rates to set.
    
    从以下版本开始:
    
    1
  - getChannelMasks
```
public int[] getChannelMasks()
```
    Obtains the channel masks.
    
    返回:
    
    Returns the channel masks.
    
    从以下版本开始:
    
    1
  - setChannelMasks
```
public void setChannelMasks(int[] channelMasks)
```
    Sets the channel masks.
    
    参数:
    
    channelMasks - Indicates the channel masks to set.
    
    从以下版本开始:
    
    1
  - getChannelIndexMasks
```
public int[] getChannelIndexMasks()
```
    Obtains the channel index masks.
    
    返回:
    
    Returns the channel index masks.
    
    从以下版本开始:
    
    1
  - setChannelIndexMasks
```
public void setChannelIndexMasks(int[] channelIndexMasks)
```
    Sets the channel index masks.
    
    参数:
    
    channelIndexMasks - Indicates the channel index masks to set.
    
    从以下版本开始:
    
    1
  - getEncodings
```
public List<AudioStreamInfo.EncodingFormat> getEncodings()
```
    Obtains the encoding formats.
    
    返回:
    
    Returns the encoding formats.
    
    从以下版本开始:
    
    3
  - setEncodings
```
public void setEncodings(List<AudioStreamInfo.EncodingFormat> encodings)
```
    Sets the encoding formats.
    
    参数:
    
    encodings - Indicates the encoding formats to set.
    
    从以下版本开始:
    
    3
  - getChannelCounts
```
public int[] getChannelCounts()
```
    Obtains an array whose elements indicate the channel types supported by the device.
    For example, {1, 2, 4} indicates that the device supports single channel, dual channel, and quad channel. If the obtained array is empty, the device supports any channel types, including single channel, dual channel, quad channel, six channel, and eight channel.
    
    返回:
    
    Returns the array.
    
    从以下版本开始:
    
    1

类 AudioDeviceDescriptor

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

AudioDeviceDescriptor

方法详细资料

equals

hashCode

isOutputDevice

isInputDevice

getId

setId

getName

setName

getAddress

setAddress

getType

setType

getRole

setRole

getSamplingRates

setSamplingRates

getChannelMasks

setChannelMasks

getChannelIndexMasks

setChannelIndexMasks

getEncodings

setEncodings

getChannelCounts