WZCamera (GoCoder SDK Android API)

java.lang.Object
- com.wowza.gocoder.sdk.api.devices.WZCamera

```
public class WZCamera
extends Object
```
The WZCamera class provides an interface for accessing and controlling a camera device. The method WZCameraView.getDeviceCameras() can be used to retrieve a list of all cameras.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DIRECTION_BACK` Identifier for a back facing camera returned by `getDirection()`
`static int`	`DIRECTION_FRONT` Identifier for a front facing camera returned by `getDirection()`
`static int`	`DIRECTION_INDETERMINATE` Identifier for a camera with an indeterminate direction or where direction is not applicable
`static int`	`FOCUS_MODE_AUTO` An identifier used with the `hasCapability(int)` method to detect support for auto focus
`static int`	`FOCUS_MODE_CONTINUOUS` An identifier used with the `hasCapability(int)` method to detect support for continuous video focus
`static int`	`FOCUS_MODE_OFF` An identifier used with the `setFramerate(int)` method to turn off all focus modes
`static int`	`TORCH` An identifier used with the `hasCapability(int)` method to detect the presence of a torch (i.e.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`continuePreview()`
`static String`	`directionString(int direction)`
`static WZCamera[]`	`getAvailableDeviceCameras()` Returns an array of `WZCamera` object instances for each camera detected and accessible on the current device.
`int`	`getCameraId()` Returns an id for the camera, unique to each camera on the device.
`static String`	`getCameraInfo()` Returns a human readable list of the cameras detected and the capabilities of each.
`static WZCamera[]`	`getDeviceCameras()` Returns an array of `WZCamera` object instances for each camera detected on the current device.
`static WZCamera[]`	`getDeviceCameras(boolean availableOnly)` Returns an array of `WZCamera` object instances for each camera detected, and optionally accessible, on the current device.
`static WZCamera[]`	`getDeviceCameras(boolean availableOnly, boolean withCapabilities)` Returns an array of `WZCamera` object instances for each camera detected, and optionally accessible, on the current device.
`int`	`getDirection()` Returns the direction the camera is facing
`int`	`getFocusMode()` Returns the camera's active focus mode
`int`	`getFramerate()` Returns the current framerate setting for the camera.
`WZSize`	`getFrameSize()` Returns the active preview frame size or the last frame size used when the preview display was active
`WZError`	`getLastError()`
`static int`	`getNumberOfDeviceCameras()` Returns the number of cameras detected on the current device.
`WZSize`	`getOptimalPreviewSize(WZSize requestedSize)` Returns the best frame size supported by the device for previewing video with the specified frame size
`WZSize`	`getOptimalPreviewSize(WZSize requestedSize, WZSize minimumSize)` Returns the best frame size supported by the device for previewing video with the specified frame size that is equal to or larger than the specified minimum size
`Camera`	`getPlatformDevice()` Get the interface to the native platform's camera interface
`WZSize`	`getPreferredVideoFrameSize()` Returns the frame size the device reported as the preferred video frame size
`WZStatus`	`getStatus()`
`WZMediaConfig[]`	`getSupportedConfigs()` Generates an array of configuration instances representing the preview frame sizes supported by this camera device
`WZSize[]`	`getSupportedFrameSizes()` Returns a list of preview frame sizes supported by the camera
`SurfaceTexture`	`getSurfaceTexture()` Returns the surface texture used as the output for the camera's preview
`boolean`	`hasCapability(int capabilityId)` Provides an interface to interrogate device support of various capabilities
`boolean`	`isAvailable()` Indicates if the camera can be opened by the current application
`boolean`	`isBack()` Indicates if the camera is a back facing camera
`boolean`	`isDirectional()` Indicates if the camera is a front or back facing camera
`boolean`	`isFront()` Indicates if the camera is a front facing camera
`boolean`	`isPreviewing()` Indicates if this camera's output is being actively being displayed
`boolean`	`isTorchOn()` Indicates if the camera's "torch" is currently turned on
`boolean`	`open()`
`void`	`pausePreview()`
`void`	`release()` AVAILABLE ONLY FOR OPEN CAMERAS
`void`	`setFocusMode(int focusMode)` Sets the camera's active focus mode
`void`	`setFocusPoint(float x, float y, int focusAreaSize)` Turns on auto focus mode and sets the focus point to the screen coordinate x, y
`int`	`setFramerate(int framerate)`
`WZSize`	`setFrameSize(WZSize requestedFrameSize)`
`boolean`	`setSurfaceTexture(SurfaceTexture surfaceTexture)` Sets the surface texture used as the output for the camera's preview
`void`	`setTorchOn(boolean torchOn)` Turns the camera's torch (aka flashlight) on or off
`static WZSize`	`sizeToWzSize(Camera.Size cameraSize)` Converts an instance of Android's Camera.Size to an instance of GoCoder SDK's WZSize
`boolean`	`startPreview(Context context, WZSize previewFrameSize, int framerate)`
`boolean`	`startPreview(Context context, WZSize previewFrameSize, WZSize minimumFrameSize, int framerate)`
`void`	`stopPreview()` AVAILABLE ONLY FOR CAMERAS WHOSE PREVIEW IS ACTIVE
`WZDataMap`	`toDataMap()`
`String`	`toString()`
`RectF`	`toViewCoords(View view, Rect cameraRect)` Converts camera coordinates to coordinates for the specified view

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

- Field Detail
  - DIRECTION_FRONT
```
public static final int DIRECTION_FRONT
```
    Identifier for a front facing camera returned by getDirection()
  - DIRECTION_BACK
```
public static final int DIRECTION_BACK
```
    Identifier for a back facing camera returned by getDirection()
  - DIRECTION_INDETERMINATE
```
public static final int DIRECTION_INDETERMINATE
```
    Identifier for a camera with an indeterminate direction or where direction is not applicable
    
    See Also:
    
    Constant Field Values
  - TORCH
```
public static final int TORCH
```
    An identifier used with the hasCapability(int) method to detect the presence of a torch (i.e. flashlight)
    
    See Also:
    
    Constant Field Values
  - FOCUS_MODE_AUTO
```
public static final int FOCUS_MODE_AUTO
```
    An identifier used with the hasCapability(int) method to detect support for auto focus
    
    See Also:
    
    Constant Field Values
  - FOCUS_MODE_CONTINUOUS
```
public static final int FOCUS_MODE_CONTINUOUS
```
    An identifier used with the hasCapability(int) method to detect support for continuous video focus
    
    See Also:
    
    Constant Field Values
  - FOCUS_MODE_OFF
```
public static final int FOCUS_MODE_OFF
```
    An identifier used with the setFramerate(int) method to turn off all focus modes
    
    See Also:
    
    Constant Field Values
- Method Detail
  - directionString
```
public static String directionString(int direction)
```
  - getNumberOfDeviceCameras
```
public static int getNumberOfDeviceCameras()
```
    Returns the number of cameras detected on the current device.
    
    Returns:
    
    The number of cameras detected on the current device.
  - getDeviceCameras
```
public static WZCamera[] getDeviceCameras(boolean availableOnly,
                                          boolean withCapabilities)
```
    Returns an array of WZCamera object instances for each camera detected, and optionally accessible, on the current device.
    
    Parameters:
    
    availableOnly - If set to true, the returned array will contain instances for only those camera that could be successfully opened for access.
    
    withCapabilities - If set to true, the camera's will be interrogated at this time for it's full set of features. This is ordinarily only done the first time the camera is opened for preview. Doing so here can cause performance issues when starting the camera preview
    
    Returns:
    
    An array of WZCamera object instances
  - getDeviceCameras
```
public static WZCamera[] getDeviceCameras(boolean availableOnly)
```
    Returns an array of WZCamera object instances for each camera detected, and optionally accessible, on the current device.
    
    Parameters:
    
    availableOnly - If set to true, the returned array will contain instances for only those camera that could be successfully opened for access.
    
    Returns:
    
    An array of WZCamera object instances
  - getDeviceCameras
```
public static WZCamera[] getDeviceCameras()
```
    Returns an array of WZCamera object instances for each camera detected on the current device.
    
    Returns:
    
    An array of WZCamera object instances
    
    See Also:
    
    for detal on the the camera interface
  - getAvailableDeviceCameras
```
public static WZCamera[] getAvailableDeviceCameras()
```
    Returns an array of WZCamera object instances for each camera detected and accessible on the current device.
    
    Returns:
    
    An array of WZCamera object instances
    
    See Also:
    
    for detal on the the camera interface
  - getCameraInfo
```
public static String getCameraInfo()
```
    Returns a human readable list of the cameras detected and the capabilities of each.
    
    Returns:
    
    A multi-line string containing detailed camera information.
  - sizeToWzSize
```
public static WZSize sizeToWzSize(Camera.Size cameraSize)
```
    Converts an instance of Android's Camera.Size to an instance of GoCoder SDK's WZSize
    
    Parameters:
    
    cameraSize - an instance of Android's Camera.Size
    
    Returns:
    
    an instance of GoCoder SDK's WZSize
  - getCameraId
```
public int getCameraId()
```
    Returns an id for the camera, unique to each camera on the device.
    
    Returns:
    
    a specifier unique to each camera detected on the active device
  - getStatus
```
public WZStatus getStatus()
```
  - getLastError
```
public WZError getLastError()
```
  - getPlatformDevice
```
public Camera getPlatformDevice()
```
    Get the interface to the native platform's camera interface
    
    Returns:
    
    the underlying Android Camera object
    
    See Also:
    
    Android Camera class
  - isAvailable
```
public boolean isAvailable()
```
    Indicates if the camera can be opened by the current application
    
    Returns:
    
    true if the camera can be opened, false if an error occurred when access was last attempted
  - isDirectional
```
public boolean isDirectional()
```
    Indicates if the camera is a front or back facing camera
    
    Returns:
    
    returns true if this is a front or back facing camera, false otherwise
  - getDirection
```
public int getDirection()
```
    Returns the direction the camera is facing
    
    Returns:
    
    DIRECTION_FRONT, WZCamera##DIRECTION_FRONT or
  - isFront
```
public boolean isFront()
```
    Indicates if the camera is a front facing camera
    
    Returns:
    
    returns true if this is a front facing camera, false otherwise
  - isBack
```
public boolean isBack()
```
    Indicates if the camera is a back facing camera
    
    Returns:
    
    returns true if this is a back facing camera, false otherwise
  - isPreviewing
```
public boolean isPreviewing()
```
    Indicates if this camera's output is being actively being displayed
    
    Returns:
    
    true if this camera's output is being displayed, false otherwise
  - getSurfaceTexture
```
public SurfaceTexture getSurfaceTexture()
```
    Returns the surface texture used as the output for the camera's preview
    
    Returns:
    
    the surface texture used as the output for the camera's preview
  - setSurfaceTexture
```
public boolean setSurfaceTexture(SurfaceTexture surfaceTexture)
```
    Sets the surface texture used as the output for the camera's preview
    
    Parameters:
    
    surfaceTexture - the surface texture to be used as the output for the camera's preview
  - getSupportedFrameSizes
```
public WZSize[] getSupportedFrameSizes()
```
    Returns a list of preview frame sizes supported by the camera
    
    Returns:
    
    an array of preview sizes supported, in pixels
  - getSupportedConfigs
```
public WZMediaConfig[] getSupportedConfigs()
```
    Generates an array of configuration instances representing the preview frame sizes supported by this camera device
    
    Returns:
    
    an array of preview sizes supported, in pixels
  - getPreferredVideoFrameSize
```
public WZSize getPreferredVideoFrameSize()
```
    Returns the frame size the device reported as the preferred video frame size
    
    Returns:
    
    the frame size the device reported as the preferred video frame size
  - getOptimalPreviewSize
```
public WZSize getOptimalPreviewSize(WZSize requestedSize)
```
    Returns the best frame size supported by the device for previewing video with the specified frame size
    
    Parameters:
    
    requestedSize - the requested frame size for display
    
    Returns:
    
    the best frame size supported by the device for previewing video with the specified frame size
  - getOptimalPreviewSize
```
public WZSize getOptimalPreviewSize(WZSize requestedSize,
                                    WZSize minimumSize)
```
    Returns the best frame size supported by the device for previewing video with the specified frame size that is equal to or larger than the specified minimum size
    
    Parameters:
    
    requestedSize - the requested frame size for display
    
    minimumSize - the minimum frame size to be considered
    
    Returns:
    
    the best frame size supported by the device for previewing video with the specified frame size
  - hasCapability
```
public boolean hasCapability(int capabilityId)
```
    Provides an interface to interrogate device support of various capabilities
    
    Parameters:
    
    capabilityId - a specifier indicating the capability, one of TORCH, FOCUS_MODE_AUTO, or FOCUS_MODE_CONTINUOUS
    
    Returns:
    
    true if the current device supports the specified capability, false otherwise
  - open
```
public boolean open()
```
  - startPreview
```
public boolean startPreview(Context context,
                            WZSize previewFrameSize,
                            int framerate)
```
  - startPreview
```
public boolean startPreview(Context context,
                            WZSize previewFrameSize,
                            WZSize minimumFrameSize,
                            int framerate)
```
  - release
```
public void release()
```
    AVAILABLE ONLY FOR OPEN CAMERAS
  - getFrameSize
```
public WZSize getFrameSize()
```
    Returns the active preview frame size or the last frame size used when the preview display was active
    
    Returns:
    
    the active preview frame size or the last frame size used when the preview display was active
  - setFrameSize
```
public WZSize setFrameSize(WZSize requestedFrameSize)
```
  - stopPreview
```
public void stopPreview()
```
    AVAILABLE ONLY FOR CAMERAS WHOSE PREVIEW IS ACTIVE
  - pausePreview
```
public void pausePreview()
```
  - continuePreview
```
public void continuePreview()
```
  - getFramerate
```
public int getFramerate()
```
    Returns the current framerate setting for the camera.
    
    Returns:
    
    the framerate (fps)
  - setFramerate
```
public int setFramerate(int framerate)
```
  - isTorchOn
```
public boolean isTorchOn()
```
    Indicates if the camera's "torch" is currently turned on
    
    Returns:
    
    true if on, false otherwise
  - setTorchOn
```
public void setTorchOn(boolean torchOn)
```
    Turns the camera's torch (aka flashlight) on or off
    
    Parameters:
    
    torchOn - specify true to turn the torch on, false to turn it off
  - getFocusMode
```
public int getFocusMode()
```
    Returns the camera's active focus mode
    
    Returns:
    
    FOCUS_MODE_OFF, FOCUS_MODE_AUTO, or FOCUS_MODE_CONTINUOUS
  - setFocusMode
```
public void setFocusMode(int focusMode)
```
    Sets the camera's active focus mode
    
    Parameters:
    
    focusMode - FOCUS_MODE_OFF or FOCUS_MODE_CONTINUOUS
  - setFocusPoint
```
public void setFocusPoint(float x,
                          float y,
                          int focusAreaSize)
```
    Turns on auto focus mode and sets the focus point to the screen coordinate x, y
    
    Parameters:
    
    x - the x position of the focus point on the display screen
    
    y - the y position of the focus point on the display screen
  - toViewCoords
```
public RectF toViewCoords(View view,
                          Rect cameraRect)
```
    Converts camera coordinates to coordinates for the specified view
    
    Parameters:
    
    view - The view to map
    
    cameraRect - A rectangle in camera coordinates
    
    Returns:
    
    A rectangle mapped from the camera coordinates to the view coordinates
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toDataMap
```
public WZDataMap toDataMap()
```

Class WZCamera

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DIRECTION_FRONT

DIRECTION_BACK

DIRECTION_INDETERMINATE

TORCH

FOCUS_MODE_AUTO

FOCUS_MODE_CONTINUOUS

FOCUS_MODE_OFF

Method Detail

directionString

getNumberOfDeviceCameras

getDeviceCameras

getDeviceCameras

getDeviceCameras

getAvailableDeviceCameras

getCameraInfo

sizeToWzSize

getCameraId

getStatus

getLastError

getPlatformDevice

isAvailable

isDirectional

getDirection

isFront

isBack

isPreviewing

getSurfaceTexture

setSurfaceTexture

getSupportedFrameSizes

getSupportedConfigs

getPreferredVideoFrameSize

getOptimalPreviewSize

getOptimalPreviewSize

hasCapability

open

startPreview

startPreview

release

getFrameSize

setFrameSize

stopPreview

pausePreview

continuePreview

getFramerate

setFramerate

isTorchOn

setTorchOn

getFocusMode

setFocusMode

setFocusPoint

toViewCoords

toString

toDataMap