Package com.amazonaws.ivs.broadcast

Class Device.Descriptor

java.lang.Object

com.amazonaws.ivs.broadcast.Device.Descriptor

Enclosing class:

Device

public static class Device.Descriptor
extends Object

Represents an input device's description. This can be used to identify the device without opening or attaching it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Device.Descriptor.DeviceType
static enum	Device.Descriptor.Position	Physical device position
static enum	Device.Descriptor.StreamType	Media types present in a stream

Field Summary

Fields

Modifier and Type	Field	Description
AudioDevice.Format	audioFormat	Microphone audio format
android.hardware.camera2.CameraCharacteristics	cameraCharacteristics	Android-specific characteristics for cameras
int	channelCount	Microphone channel count
static final String	DEFAULT_ID
String	deviceId	System deviceId.
String	friendlyName	A human-readable name
boolean	isDefault	Default device indicator
int	pixelHeight
int	pixelWidth	Camera pixel dimensions
Device.Descriptor.Position	position	The physical location of the device, if it can be determined
float	rotation	Camera rotation
int	sampleRate	Microphone sample rate
Device.Descriptor.StreamType[]	streams	The types of streams supported by the device
Device.Descriptor.DeviceType	type	The device type or family
String	urn	Unique device locator.

Constructor Summary

Constructors

Constructor	Description
Descriptor()

Method Summary

Modifier and Type	Method	Description
boolean	hasStream(Device.Descriptor.StreamType wants)
boolean	isValid()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

deviceId

public String deviceId

System deviceId. These may not be unique as the system may reuse device ids for different types

urn

public String urn

Unique device locator. this will be unique but it may be generated internally and may not match system addresses.

friendlyName

public String friendlyName

A human-readable name

type

public Device.Descriptor.DeviceType type

The device type or family

streams

public Device.Descriptor.StreamType[] streams

The types of streams supported by the device

position

public Device.Descriptor.Position position

The physical location of the device, if it can be determined

cameraCharacteristics

public android.hardware.camera2.CameraCharacteristics cameraCharacteristics

Android-specific characteristics for cameras

pixelWidth

public int pixelWidth

Camera pixel dimensions

pixelHeight

public int pixelHeight

rotation

public float rotation

Camera rotation

sampleRate

public int sampleRate

Microphone sample rate

channelCount

public int channelCount

Microphone channel count

audioFormat

public AudioDevice.Format audioFormat

Microphone audio format

isDefault

public boolean isDefault

Default device indicator

DEFAULT_ID

public static final String DEFAULT_ID

See Also:

• Constant Field Values

Constructor Details

Descriptor

public Descriptor()

Method Details

hasStream

public boolean hasStream(Device.Descriptor.StreamType wants)

isValid

public boolean isValid()