com.wowza.gocoder.sdk.api.devices

Class WOWZCamera

java.lang.Object

com.wowza.gocoder.sdk.api.devices.WOWZCamera

public class WOWZCamera
extends java.lang.Object

The WOWZCamera class provides an interface for accessing and controlling a camera device. Use the WOWZCameraView.getDeviceCameras() method to retrieve a list of all cameras.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DIRECTION_BACK An identifier for a back-facing camera returned by getDirection().
static int	DIRECTION_FRONT An identifier for a front-facing camera returned by getDirection().
static int	DIRECTION_INDETERMINATE An 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 flash.

Method Summary

Modifier and Type	Method and Description
void	continuePreview()
static java.lang.String	directionString(int direction)
static WOWZCamera[]	getAvailableDeviceCameras() Gets an array of WOWZCamera object instances for each camera detected and accessible on the current device.
int	getCameraId() Gets an ID for the camera, unique to each camera on the device.
static java.lang.String	getCameraInfo() Gets a human-readable list of the cameras detected and the capabilities of each.
static WOWZCamera[]	getDeviceCameras() Gets an array of WOWZCamera object instances for each camera detected on the current device.
static WOWZCamera[]	getDeviceCameras(boolean availableOnly) Gets an array of WOWZCamera object instances for each camera detected, and optionally accessible, on the current device.
static WOWZCamera[]	getDeviceCameras(boolean availableOnly, boolean withCapabilities) Gets an array of WOWZCamera object instances for each camera detected, and optionally accessible, on the current device.
int	getDirection() Gets the direction the camera is facing.
int	getFocusMode() Gets the camera's active focus mode.
int	getFramerate() Gets the current frame rate for the camera.
WOWZSize	getFrameSize() Gets the active or most recent preview frame size used by the preview display.
WOWZError	getLastError()
static int	getNumberOfDeviceCameras() Gets the number of cameras detected on the current device.
WOWZSize	getOptimalPreviewSize(WOWZSize requestedSize) Gets the best frame size supported by the device for previewing video with the specified frame size.
WOWZSize	getOptimalPreviewSize(WOWZSize requestedSize, WOWZSize minimumSize) Gets 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() Gets the interface to the native platform's camera interface.
WOWZSize	getPreferredVideoFrameSize() Gets the device's preferred video frame size.
WOWZStatus	getStatus()
WOWZMediaConfig[]	getSupportedConfigs() Generates an array of configuration instances representing the preview frame sizes supported by this camera device.
WOWZSize[]	getSupportedFrameSizes() Gets a list of preview frame sizes supported by the camera.
SurfaceTexture	getSurfaceTexture() Gets the surface texture used as the output for the camera's preview.
boolean	hasCapability(int capabilityId) Shows whether a device has a flash, auto focus mode, or continue focus mode.
boolean	isAvailable() Checks whether the camera can be opened by the current application.
boolean	isBack() Checks whether the camera is back facing.
boolean	isDirectional() Checks whether the camera is front or back facing.
boolean	isFront() Checks whether the camera is front facing.
boolean	isPreviewing() Checks whether this camera's output is being actively being displayed.
boolean	isTorchOn() Checks whether the camera's flash is 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)
WOWZSize	setFrameSize(WOWZSize requestedFrameSize)
boolean	setSurfaceTexture(SurfaceTexture surfaceTexture) Sets the surface texture used as the output for the camera's preview.
void	setTorchOn(boolean torchOn) Turns on the camera's flash (torch).
static WOWZSize	sizeToWzSize(Camera.Size cameraSize) Converts an instance of Android's Camera.Size to an instance of GoCoder SDK's WOWZSize.
boolean	startPreview(Context context, WOWZSize previewFrameSize, int framerate)
boolean	startPreview(Context context, WOWZSize previewFrameSize, WOWZSize minimumFrameSize, int framerate)
void	stopPreview() AVAILABLE ONLY FOR CAMERAS WHOSE PREVIEW IS ACTIVE
WOWZDataMap	toDataMap()
java.lang.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

An identifier for a front-facing camera returned by getDirection().

DIRECTION_BACK

public static final int DIRECTION_BACK

An identifier for a back-facing camera returned by getDirection().

DIRECTION_INDETERMINATE

public static final int DIRECTION_INDETERMINATE

An 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 flash.

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 java.lang.String directionString(int direction)

getNumberOfDeviceCameras

public static int getNumberOfDeviceCameras()

Gets the number of cameras detected on the current device.

Returns:

The number of cameras on the current device.

getDeviceCameras

public static WOWZCamera[] getDeviceCameras(boolean availableOnly,
                                            boolean withCapabilities)

Gets an array of WOWZCamera object instances for each camera detected, and optionally accessible, on the current device.

Parameters:

availableOnly - If true, the returned array contains instances for only those cameras that could be successfully accessed.

withCapabilities - If true, queries the camera for its 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 WOWZCamera object instances.

getDeviceCameras

public static WOWZCamera[] getDeviceCameras(boolean availableOnly)

Gets an array of WOWZCamera object instances for each camera detected, and optionally accessible, on the current device.

Parameters:

availableOnly - If true, the returned array contains instances for only those camera that could be successfully accessed.

Returns:

An array of WOWZCamera object instances.

getDeviceCameras

public static WOWZCamera[] getDeviceCameras()

Gets an array of WOWZCamera object instances for each camera detected on the current device.

Returns:

An array of WOWZCamera object instances.

See Also:

for details on the the camera interface.

getAvailableDeviceCameras

public static WOWZCamera[] getAvailableDeviceCameras()

Gets an array of WOWZCamera object instances for each camera detected and accessible on the current device.

Returns:

An array of WOWZCamera object instances.

See Also:

for details on the the camera interface.

getCameraInfo

public static java.lang.String getCameraInfo()

Gets a human-readable list of the cameras detected and the capabilities of each.

Returns:

A multiline string containing detailed camera information.

sizeToWzSize

public static WOWZSize sizeToWzSize(Camera.Size cameraSize)

Converts an instance of Android's Camera.Size to an instance of GoCoder SDK's WOWZSize.

Parameters:

cameraSize - An instance of Android's Camera.Size.

Returns:

An instance of GoCoder SDK's WOWZSize.

getCameraId

public int getCameraId()

Gets 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 WOWZStatus getStatus()

getLastError

public WOWZError getLastError()

getPlatformDevice

public Camera getPlatformDevice()

Gets the interface to the native platform's camera interface.

Returns:

The underlying Android Camera object.

See Also:

Android Camera class

isAvailable

public boolean isAvailable()

Checks whether the camera can be opened by the current application.

Returns:

True if the camera can be opened; false if an error occurred attempting access.

isDirectional

public boolean isDirectional()

Checks whether the camera is front or back facing.

Returns:

True if this is a front- or back-facing camera; false otherwise.

getDirection

public int getDirection()

Gets the direction the camera is facing.

Returns:

DIRECTION_FRONT, WOWZCamera##DIRECTION_FRONT, or WOWZCamera##DIRECTION_INDETERMINATE.

isFront

public boolean isFront()

Checks whether the camera is front facing.

Returns:

True if the camera is front facing; false otherwise.

isBack

public boolean isBack()

Checks whether the camera is back facing.

Returns:

True if the camera is a back facing; false otherwise.

isPreviewing

public boolean isPreviewing()

Checks whether 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()

Gets 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 use as the output for the camera's preview.

getSupportedFrameSizes

public WOWZSize[] getSupportedFrameSizes()

Gets a list of preview frame sizes supported by the camera.

Returns:

An array of supported preview sizes, in pixels.

getSupportedConfigs

public WOWZMediaConfig[] 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 WOWZSize getPreferredVideoFrameSize()

Gets the device's preferred video frame size.

Returns:

The device's preferred video frame size.

getOptimalPreviewSize

public WOWZSize getOptimalPreviewSize(WOWZSize requestedSize)

Gets 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 WOWZSize getOptimalPreviewSize(WOWZSize requestedSize,
                                      WOWZSize minimumSize)

Gets 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)

Shows whether a device has a flash, auto focus mode, or continue focus mode.

Parameters:

capabilityId - A specifier indicating the capability, either 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,
                            WOWZSize previewFrameSize,
                            int framerate)

startPreview

public boolean startPreview(Context context,
                            WOWZSize previewFrameSize,
                            WOWZSize minimumFrameSize,
                            int framerate)

release

public void release()

AVAILABLE ONLY FOR OPEN CAMERAS

getFrameSize

public WOWZSize getFrameSize()

Gets the active or most recent preview frame size used by the preview display.

Returns:

The active preview frame size or the most recently used frame size.

setFrameSize

public WOWZSize setFrameSize(WOWZSize 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()

Gets the current frame rate for the camera.

Returns:

The frame rate, in fps.

setFramerate

public int setFramerate(int framerate)

isTorchOn

public boolean isTorchOn()

Checks whether the camera's flash is on.

Returns:

True if the flash is on; false otherwise.

setTorchOn

public void setTorchOn(boolean torchOn)

Turns on the camera's flash (torch).

Parameters:

torchOn - True to turn on the flash; false to turn it off.

getFocusMode

public int getFocusMode()

Gets 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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

toDataMap

public WOWZDataMap toDataMap()