public
static
class
Device.Descriptor
extends Object| java.lang.Object | |
| ↳ | com.amazonaws.ivs.broadcast.Device.Descriptor |
Class Overview
Represents an input device's description. This can be used to identify the device without opening or attaching it.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| enum | Device.Descriptor.DeviceType | ||||||||||
| enum | Device.Descriptor.Position | Physical device position | |||||||||
| enum | Device.Descriptor.StreamType | Media types present in a stream | |||||||||
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | DEFAULT_ID | ||||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public AudioDevice.Format | audioFormat | Microphone audio format | |||||||||
| public CameraCharacteristics | cameraCharacteristics | Android-specific characteristics for cameras | |||||||||
| public int | channelCount | Microphone channel count | |||||||||
| public String | deviceId | System deviceId. | |||||||||
| public String | friendlyName | A human-readable name | |||||||||
| public boolean | isDefault | Default device indicator | |||||||||
| public int | pixelHeight | ||||||||||
| public int | pixelWidth | Camera pixel dimensions | |||||||||
| public Device.Descriptor.Position | position | The physical location of the device, if it can be determined | |||||||||
| public float | rotation | Camera rotation | |||||||||
| public int | sampleRate | Microphone sample rate | |||||||||
| public StreamType[] | streams | The types of streams supported by the device | |||||||||
| public Device.Descriptor.DeviceType | type | The device type or family | |||||||||
| public String | urn | Unique device locator. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Descriptor() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean | hasStream(Device.Descriptor.StreamType wants) | ||||||||||
| boolean | isValid() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Constants
public static final String DEFAULT_ID
Constant Value:
"-1"
Fields
public CameraCharacteristics cameraCharacteristics
Android-specific characteristics for cameras
public int channelCount
Microphone channel count
public String deviceId
System deviceId. These may not be unique as the system may reuse device ids for different types
public String friendlyName
A human-readable name
public boolean isDefault
Default device indicator
public int pixelHeight
public int pixelWidth
Camera pixel dimensions
public Device.Descriptor.Position position
The physical location of the device, if it can be determined
public float rotation
Camera rotation
public int sampleRate
Microphone sample rate
public String urn
Unique device locator. this will be unique but it may be generated internally and may not match system addresses.