CameraSource.Options.Builder

java.lang.Object

com.amazonaws.ivs.broadcast.CameraSource.Options.Builder

Enclosing class:: CameraSource.Options

public static final class CameraSource.Options.Builder extends Object

Use this class to build CameraSource.Options objects

Constructor Summary

Constructors

Constructor

Description

Builder()

Instantiate a new builder with no options
Method Summary

Modifier and Type

Method

Description

CameraSource.Options

build()

Builds the options object

CameraSource.Options.Builder

setEnableTorch(boolean enableTorch)

Enable camera torch mode.

CameraSource.Options.Builder

setZoomFactor(float zoomFactor)

Set camera zoom factor

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- Builder
  
  public Builder()
  
  Instantiate a new builder with no options
Method Details
- setZoomFactor
  
  public CameraSource.Options.Builder setZoomFactor(float zoomFactor)
  
  Set camera zoom factor
  
  Parameters:
  
  zoomFactor - New zoom factor between 1.0f and max zoom factor supported by the device
  
  Returns:
  
  The builder for chaining calls
- setEnableTorch
  
  public CameraSource.Options.Builder setEnableTorch(boolean enableTorch)
  
  Enable camera torch mode. The torch will turn on once the camera is in use by the SDK, e.g. creating a preview or using it in a Session. Note that enabling torch will increase battery consumption and device thermals, especially on older, low-end devices.
  
  Parameters:
  
  enableTorch - Whether to enable torch mode
  
  Returns:
  
  The builder for chaining calls
- build
  
  public CameraSource.Options build()
  
  Builds the options object
  
  Returns:
  
  A new options object with the specific options set in the builder