public abstract class

ImageDevice

extends Device
java.lang.Object
   ↳ com.amazonaws.ivs.broadcast.Device
     ↳ com.amazonaws.ivs.broadcast.ImageDevice
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Image and video input sources must conform to this interface

Summary

Nested Classes
enum ImageDevice.Rotation Utility enum that defines common rotations by degree in radians. 
Public Constructors
ImageDevice()
Public Methods
abstract ImagePreviewView getPreviewView()
Gets a ImagePreviewView that will display a preview of this device's contents.
abstract ImagePreviewView getPreviewView(BroadcastConfiguration.AspectMode aspectMode)
abstract void rotateOnConfigurationChanges(boolean enable)
Enables/disables rotations of this ImageDevice when the physical device is rotated.
abstract void setRotation(float rotation)
Sets the rotation of the ImageDevice.
void setRotation(ImageDevice.Rotation rotation)
Sets the rotation of the ImageDevice.
abstract boolean willRotateOnConfigurationChanges()
[Expand]
Inherited Methods
From class com.amazonaws.ivs.broadcast.Device
From class java.lang.Object

Public Constructors

public ImageDevice ()

Public Methods

public abstract ImagePreviewView getPreviewView ()

Gets a ImagePreviewView that will display a preview of this device's contents. Warning: Using many ImagePreviewViews at once may result in performance degradation.

Throws
BroadcastException If unable to get preview view.

public abstract ImagePreviewView getPreviewView (BroadcastConfiguration.AspectMode aspectMode)

public abstract void rotateOnConfigurationChanges (boolean enable)

Enables/disables rotations of this ImageDevice when the physical device is rotated. When this is enabled, the image source will be rotated to match configuration changes. This is often useful with camera devices, for example. When this is disabled, the image source will not be rotated to match configuration changes. This is often useful for custom image sources or if the camera ought to be locked to a particular orientation to match the application.

Parameters
enable Whether this device should rotate on configuration changes (e.g. when the physical device is rotated).

public abstract void setRotation (float rotation)

Sets the rotation of the ImageDevice.

Parameters
rotation Rotation in radians

public void setRotation (ImageDevice.Rotation rotation)

Sets the rotation of the ImageDevice.

Parameters
rotation Rotation enum

public abstract boolean willRotateOnConfigurationChanges ()

Returns
  • Whether this ImageDevice will rotate on configuration changes.