WZBitmap (GoCoder SDK Android API)

java.lang.Object
- com.wowza.gocoder.sdk.api.android.graphics.WZBitmap

All Implemented Interfaces:

WZRenderAPI.VideoFrameRenderer
```
public class WZBitmap
extends Object
implements WZRenderAPI.VideoFrameRenderer
```
The WZBitmap class can be used to display a bitmap as an overlay on a WZCameraView by registering an instance as a frame listener using WZCameraView.registerFrameListener(WZRenderAPI.VideoFrameListener)

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOTTOM` A position specifier for use as the second argument to `setPosition(int, int)` to align the bitmap along the bottom of the display.
`static int`	`CENTER` A position specifier for use with `setPosition(int, int)` to center the bitmap within the device display.
`static int`	`CURRENT_SIZE` A scale specifier for use as the second argument to `setScale(float, int)` to scale the bitmap as a factor of the current display size
`static int`	`FRAME_HEIGHT` A scale specifier for use as the second argument to `setScale(float, int)` to scale the bitmap as a factor of the video frame height.
`static int`	`FRAME_WIDTH` A scale specifier for use as the second argument to `setScale(float, int)` to scale the bitmap as a factor of the video frame width.
`static int`	`LEFT` A position specifier for use as the first argument to `setPosition(int, int)` to align the bitmap along the left hand side of the display.
`static int`	`ORIGINAL_SIZE` A scale specifier for use as the second argument to `setScale(float, int)` to scale the bitmap as a factor of the source bitmap size
`static int`	`RIGHT` A position specifier for use as the first argument to `setPosition(int, int)` to align the bitmap along the right hand side of the display.
`static int`	`SURFACE_HEIGHT` Deprecated. use `FRAME_HEIGHT` instead
`static int`	`SURFACE_WIDTH` Deprecated. use `FRAME_WIDTH` instead
`static int`	`TOP` A position specifier for use as the second argument to `setPosition(int, int)` to align the bitmap along the top of the display.

Constructor Summary

Constructors
Constructor and Description

WZBitmap()
Default constructor

WZBitmap(Bitmap bitmap)
Create a bitmap renderer instance using the specified Bitmap

Constructors
Constructor and Description
`WZBitmap()` Default constructor
`WZBitmap(Bitmap bitmap)` Create a bitmap renderer instance using the specified Bitmap

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WZSize`	`getDisplaySize()` Returns the current display size of the bitmap being rendered (i.e.
`WZPoint`	`getPosition()` Returns the current position, in display pixels
`int`	`getRotationAngle()` Returns the current rotation angle, in degrees
`float`	`getScale()` Returns the current scale factor
`int`	`getScaleBasis()` Returns the current method used for applying the scale factor
`WZSize`	`getSourceSize()` Returns the original size of the bitmap being rendered
`boolean`	`isVisible()` Indicates if the bitmap is being rendered (i.e.
`boolean`	`isWZVideoFrameRendererActive()` Indicates if the frame renderer is active or not `WZRenderAPI.VideoFrameRenderer.onWZVideoFrameRendererDraw(WZGLES.EglEnv, WZSize, int)` will only be called on an active renderer
`void`	`onWZVideoFrameRendererDraw(WZGLES.EglEnv eglEnv, WZSize frameSize, int frameRotation)` Called to render a frame of video to the viewport for the current OpenGL ES context Note that eglEnv may differ at each call.
`void`	`onWZVideoFrameRendererInit(WZGLES.EglEnv eglEnv)` Called at the beginning of a rendering cycle
`void`	`onWZVideoFrameRendererRelease(WZGLES.EglEnv eglEnv)` Called at the end of a rendering cycle
`void`	`setBitmap(Bitmap bitmap)`
`void`	`setHeight(int height)` Set the display height of the bitmap, The width will be adjusted to preserve the aspect ratio and the scale factor will be reset to 1.0.
`void`	`setPosition(int xpos, int ypos)` Set the bitmap's display position
`void`	`setPosition(WZPoint position)` Set the bitmap's display position
`void`	`setRotation(int angle)` Set the display rotation angle of the bitmap
`void`	`setScale(float scale)` Set the display scale factor for the bitmap based on it's original size
`void`	`setScale(float scale, int scaleBasis)` Set the display scale factor and scaling basis for the bitmap
`void`	`setVisible(boolean isVisible)` Set a flag indicating whether the bitmap should be rendered (i.e.
`void`	`setWidth(int width)` Set the display width of the bitmap.

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

- Field Detail
  - CENTER
```
public static final int CENTER
```
    A position specifier for use with setPosition(int, int) to center the bitmap within the device display.
    
    See Also:
    
    Constant Field Values
  - LEFT
```
public static final int LEFT
```
    A position specifier for use as the first argument to setPosition(int, int) to align the bitmap along the left hand side of the display.
    
    See Also:
    
    Constant Field Values
  - RIGHT
```
public static final int RIGHT
```
    A position specifier for use as the first argument to setPosition(int, int) to align the bitmap along the right hand side of the display.
    
    See Also:
    
    Constant Field Values
  - TOP
```
public static final int TOP
```
    A position specifier for use as the second argument to setPosition(int, int) to align the bitmap along the top of the display.
    
    See Also:
    
    Constant Field Values
  - BOTTOM
```
public static final int BOTTOM
```
    A position specifier for use as the second argument to setPosition(int, int) to align the bitmap along the bottom of the display.
    
    See Also:
    
    Constant Field Values
  - FRAME_WIDTH
```
public static final int FRAME_WIDTH
```
    A scale specifier for use as the second argument to setScale(float, int) to scale the bitmap as a factor of the video frame width.
    
    See Also:
    
    Constant Field Values
  - FRAME_HEIGHT
```
public static final int FRAME_HEIGHT
```
    A scale specifier for use as the second argument to setScale(float, int) to scale the bitmap as a factor of the video frame height.
    
    See Also:
    
    Constant Field Values
  - SURFACE_WIDTH
```
public static final int SURFACE_WIDTH
```
    Deprecated. use FRAME_WIDTH instead
    
    See Also:
    
    Constant Field Values
  - SURFACE_HEIGHT
```
public static final int SURFACE_HEIGHT
```
    Deprecated. use FRAME_HEIGHT instead
    
    See Also:
    
    Constant Field Values
  - ORIGINAL_SIZE
```
public static final int ORIGINAL_SIZE
```
    A scale specifier for use as the second argument to setScale(float, int) to scale the bitmap as a factor of the source bitmap size
    
    See Also:
    
    Constant Field Values
  - CURRENT_SIZE
```
public static final int CURRENT_SIZE
```
    A scale specifier for use as the second argument to setScale(float, int) to scale the bitmap as a factor of the current display size
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WZBitmap
```
public WZBitmap()
```
    Default constructor
  - WZBitmap
```
public WZBitmap(Bitmap bitmap)
```
    Create a bitmap renderer instance using the specified Bitmap
    
    Parameters:
    
    bitmap - the bitmap to render
- Method Detail
  - setBitmap
```
public void setBitmap(Bitmap bitmap)
```
  - getSourceSize
```
public WZSize getSourceSize()
```
    Returns the original size of the bitmap being rendered
    
    Returns:
    
    The original size of the bitmap
  - getDisplaySize
```
public WZSize getDisplaySize()
```
    Returns the current display size of the bitmap being rendered (i.e. with the current scale factor applied)
    
    Returns:
    
    The current size of the bitmap being displayed
  - getScaleBasis
```
public int getScaleBasis()
```
    Returns the current method used for applying the scale factor
    
    Returns:
    
    FRAME_WIDTH, FRAME_HEIGHT, ORIGINAL_SIZE (default), or CURRENT_SIZE
  - getScale
```
public float getScale()
```
    Returns the current scale factor
    
    Returns:
    
    The current scale factor
  - getPosition
```
public WZPoint getPosition()
```
    Returns the current position, in display pixels
    
    Returns:
    
    The current position, in display pixels
  - getRotationAngle
```
public int getRotationAngle()
```
    Returns the current rotation angle, in degrees
    
    Returns:
    
    The current rotation angle (0-360)
  - setWidth
```
public void setWidth(int width)
```
    Set the display width of the bitmap. The height will be adjusted to preserve the aspect ratio and the scale factor will be reset to 1.0.
    
    Parameters:
    
    width - The display width, in device pixels
  - setHeight
```
public void setHeight(int height)
```
    Set the display height of the bitmap, The width will be adjusted to preserve the aspect ratio and the scale factor will be reset to 1.0.
    
    Parameters:
    
    height - The display height, in device pixels
  - setScale
```
public void setScale(float scale)
```
    Set the display scale factor for the bitmap based on it's original size
    
    Parameters:
    
    scale - The scale factor
  - setScale
```
public void setScale(float scale,
                     int scaleBasis)
```
    Set the display scale factor and scaling basis for the bitmap
    
    Parameters:
    
    scale - The scale factor
    
    scaleBasis - One of FRAME_WIDTH, FRAME_HEIGHT, ORIGINAL_SIZE, or CURRENT_SIZE
  - setPosition
```
public void setPosition(WZPoint position)
```
    Set the bitmap's display position
    
    Parameters:
    
    position - The display position, in display pixels
  - setPosition
```
public void setPosition(int xpos,
                        int ypos)
```
    Set the bitmap's display position
    
    Parameters:
    
    xpos - The x position, in display pixels
    
    ypos - The y position, in display pixels
  - setRotation
```
public void setRotation(int angle)
```
    Set the display rotation angle of the bitmap
    
    Parameters:
    
    angle - The display rotation angle, in degrees (0-360)
  - setVisible
```
public void setVisible(boolean isVisible)
```
    Set a flag indicating whether the bitmap should be rendered (i.e. displayed) or not
    
    Parameters:
    
    isVisible - true if the bitmap should be rendered, false otherwise
  - isVisible
```
public boolean isVisible()
```
    Indicates if the bitmap is being rendered (i.e. displayed) or not
    
    Returns:
    
    true if the bitmap is being rendered, false otherwise
  - isWZVideoFrameRendererActive
```
public boolean isWZVideoFrameRendererActive()
```
    Description copied from interface: WZRenderAPI.VideoFrameRenderer
    
    Indicates if the frame renderer is active or not WZRenderAPI.VideoFrameRenderer.onWZVideoFrameRendererDraw(WZGLES.EglEnv, WZSize, int) will only be called on an active renderer
    
    Specified by:
    
    isWZVideoFrameRendererActive in interface WZRenderAPI.VideoFrameRenderer
    
    Returns:
    
    true is this renderer is active, false otherwise.
  - onWZVideoFrameRendererInit
```
public void onWZVideoFrameRendererInit(WZGLES.EglEnv eglEnv)
```
    Description copied from interface: WZRenderAPI.VideoFrameRenderer
    
    Called at the beginning of a rendering cycle
    
    Specified by:
    
    onWZVideoFrameRendererInit in interface WZRenderAPI.VideoFrameRenderer
    
    Parameters:
    
    eglEnv - The current OpenGL ES environment. Note that this may be a different EglEnv than the one supplied with each call to WZRenderAPI.VideoFrameRenderer.onWZVideoFrameRendererDraw(WZGLES.EglEnv, WZSize, int). See for WZRenderAPI.VideoFrameRenderer.onWZVideoFrameRendererDraw(WZGLES.EglEnv, WZSize, int) for details.
  - onWZVideoFrameRendererDraw
```
public void onWZVideoFrameRendererDraw(WZGLES.EglEnv eglEnv,
                                       WZSize frameSize,
                                       int frameRotation)
```
    Description copied from interface: WZRenderAPI.VideoFrameRenderer
    
    Called to render a frame of video to the viewport for the current OpenGL ES context Note that eglEnv may differ at each call. You can assume, however, that the EGL context in each instance in between calls to WZRenderAPI.VideoFrameRenderer.onWZVideoFrameRendererInit(WZGLES.EglEnv) and WZRenderAPI.VideoFrameRenderer.onWZVideoFrameRendererRelease(WZGLES.EglEnv eglEnv) are shared contexts and can access the same EGL resources.
    
    Specified by:
    
    onWZVideoFrameRendererDraw in interface WZRenderAPI.VideoFrameRenderer
    
    Parameters:
    
    eglEnv - The current OpenGL ES environment. Note that this may be a different EglEnv than the one supplied with
    
    frameSize - size of the video frame (pixels)
    
    frameRotation - frameRotation angle to apply when rendering (degrees, usually 0)
  - onWZVideoFrameRendererRelease
```
public void onWZVideoFrameRendererRelease(WZGLES.EglEnv eglEnv)
```
    Description copied from interface: WZRenderAPI.VideoFrameRenderer
    
    Called at the end of a rendering cycle
    
    Specified by:
    
    onWZVideoFrameRendererRelease in interface WZRenderAPI.VideoFrameRenderer
    
    Parameters:
    
    eglEnv - The current OpenGL ES environment.

Class WZBitmap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CENTER

LEFT

RIGHT

TOP

BOTTOM

FRAME_WIDTH

FRAME_HEIGHT

SURFACE_WIDTH

SURFACE_HEIGHT

ORIGINAL_SIZE

CURRENT_SIZE

Constructor Detail

WZBitmap

WZBitmap

Method Detail

setBitmap

getSourceSize

getDisplaySize

getScaleBasis

getScale

getPosition

getRotationAngle

setWidth

setHeight

setScale

setScale

setPosition

setPosition

setRotation

setVisible

isVisible

isWZVideoFrameRendererActive

onWZVideoFrameRendererInit

onWZVideoFrameRendererDraw

onWZVideoFrameRendererRelease