WOWZBitmap (GoCoder SDK Android API)

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

All Implemented Interfaces:

WOWZRenderAPI.VideoFrameRenderer
```
public class WOWZBitmap
extends java.lang.Object
implements WOWZRenderAPI.VideoFrameRenderer
```
Display a WOWZBitmap as an overlay on a WOWZCameraView by using WOWZCameraView.registerFrameListener(WOWZRenderAPI.VideoFrameListener) to register an instance as a frame listener.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOTTOM` A position specifier to use as the second argument of `setPosition(int, int)` to align the bitmap along the bottom of the display.
`static int`	`CENTER` A position specifier to use as either argument of `setPosition(int, int)` to center the bitmap in the device display.
`static int`	`CURRENT_SIZE` A scale specifier to use as the second argument of `setScale(float, int)` to scale the bitmap as a factor of the current display size.
`static int`	`FRAME_HEIGHT` A scale specifier to use as the second argument of `setScale(float, int)` to scale the bitmap as a factor of the video frame height.
`static int`	`FRAME_WIDTH` A scale specifier to use as the second argument of `setScale(float, int)` to scale the bitmap as a factor of the video frame width.
`static int`	`LEFT` A position specifier to use as the first argument of `setPosition(int, int)` to align the bitmap along the left side of the display.
`static int`	`ORIGINAL_SIZE` A scale specifier to use as the second argument of `setScale(float, int)` to scale the bitmap as a factor of the source bitmap size.
`static int`	`RIGHT` A position specifier to use as the first argument of `setPosition(int, int)` to align the bitmap along the right 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 to use as the second argument of `setPosition(int, int)` to align the bitmap along the top of the display.

Constructor Summary

Constructors
Constructor and Description

WOWZBitmap()
The default constructor.

WOWZBitmap(Bitmap bitmap)
Creates a bitmap renderer instance using the specified bitmap.

Constructors
Constructor and Description
`WOWZBitmap()` The default constructor.
`WOWZBitmap(Bitmap bitmap)` Creates a bitmap renderer instance using the specified bitmap.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WOWZSize`	`getDisplaySize()` Gets the display size of the bitmap being rendered, accounting for any scale factors that have been applied.
`WOWZPoint`	`getPosition()` Gets the current position, in display pixels.
`int`	`getRotationAngle()` Gets the current rotation angle, from 0 degrees to 360 degrees.
`float`	`getScale()` Gets the scale factor applied by `ORIGINAL_SIZE` (default), `FRAME_WIDTH`, `FRAME_HEIGHT`, or `CURRENT_SIZE`.
`int`	`getScaleBasis()` Gets the method used to apply the scale factor.
`WOWZSize`	`getSourceSize()` Gets the original size of the bitmap being rendered.
`boolean`	`isVisible()` Checks whether the bitmap is being rendered (displayed).
`boolean`	`isWZVideoFrameRendererActive()` Checks whether the frame renderer is active.
`void`	`onWZVideoFrameRendererDraw(WOWZGLES.EglEnv eglEnv, WOWZSize frameSize, int frameRotation)` Called to render a frame of video to the viewport for the current OpenGL ES context.
`void`	`onWZVideoFrameRendererInit(WOWZGLES.EglEnv eglEnv)` Called at the beginning of a rendering cycle.
`void`	`onWZVideoFrameRendererRelease(WOWZGLES.EglEnv eglEnv)` Called at the end of a rendering cycle.
`void`	`setBitmap(Bitmap bitmap)`
`void`	`setHeight(int height)` Sets the bitmap's display height, in device pixels.
`void`	`setPosition(int xpos, int ypos)` Sets the bitmap's display position, in display pixels.
`void`	`setPosition(WOWZPoint position)` Sets the bitmap's display position, in display pixels.
`void`	`setRotation(int angle)` Sets the bitmap's display rotation angle, from 0 degrees to 360 degrees.
`void`	`setScale(float scale)` Sets the bitmap's display scale factor based on the bitmap's original size.
`void`	`setScale(float scale, int scaleBasis)` Sets the bitmap's display scale factor and scaling basis.
`void`	`setVisible(boolean isVisible)` Sets a flag indicating whether the bitmap should be rendered (displayed).
`void`	`setWidth(int width)` Sets the bitmap's display width, in device pixels.

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 to use as either argument of setPosition(int, int) to center the bitmap in the device display.
    
    See Also:
    
    Constant Field Values
  - LEFT
```
public static final int LEFT
```
    A position specifier to use as the first argument of setPosition(int, int) to align the bitmap along the left side of the display.
    
    See Also:
    
    Constant Field Values
  - RIGHT
```
public static final int RIGHT
```
    A position specifier to use as the first argument of setPosition(int, int) to align the bitmap along the right side of the display.
    
    See Also:
    
    Constant Field Values
  - TOP
```
public static final int TOP
```
    A position specifier to use as the second argument of 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 to use as the second argument of 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 to use as the second argument of 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 to use as the second argument of 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 to use as the second argument of 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 to use as the second argument of setScale(float, int) to scale the bitmap as a factor of the current display size.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WOWZBitmap
```
public WOWZBitmap()
```
    The default constructor.
  - WOWZBitmap
```
public WOWZBitmap(Bitmap bitmap)
```
    Creates a bitmap renderer instance using the specified bitmap.
    
    Parameters:
    
    bitmap - The bitmap you want to render.
- Method Detail
  - setBitmap
```
public void setBitmap(Bitmap bitmap)
```
  - getSourceSize
```
public WOWZSize getSourceSize()
```
    Gets the original size of the bitmap being rendered.
    
    Returns:
    
    The original size of the bitmap.
  - getDisplaySize
```
public WOWZSize getDisplaySize()
```
    Gets the display size of the bitmap being rendered, accounting for any scale factors that have been applied.
    
    Returns:
    
    The current size of the displayed bitmap.
  - getScaleBasis
```
public int getScaleBasis()
```
    Gets the method used to apply the scale factor.
    
    Returns:
    
    The ORIGINAL_SIZE (default), FRAME_WIDTH, FRAME_HEIGHT, or CURRENT_SIZE method.
  - getScale
```
public float getScale()
```
    Gets the scale factor applied by ORIGINAL_SIZE (default), FRAME_WIDTH, FRAME_HEIGHT, or CURRENT_SIZE.
    
    Returns:
    
    The scale factor.
  - getPosition
```
public WOWZPoint getPosition()
```
    Gets the current position, in display pixels.
    
    Returns:
    
    The current position.
  - getRotationAngle
```
public int getRotationAngle()
```
    Gets the current rotation angle, from 0 degrees to 360 degrees.
    
    Returns:
    
    The rotation angle.
  - setWidth
```
public void setWidth(int width)
```
    Sets the bitmap's display width, in device pixels. Adjusts the height to preserve the aspect ratio and resets the scale factor to 1.0.
    
    Parameters:
    
    width - The display width.
  - setHeight
```
public void setHeight(int height)
```
    Sets the bitmap's display height, in device pixels. Adjusts the width to preserve the aspect ratio and resets the scale factor to 1.0.
    
    Parameters:
    
    height - The display height.
  - setScale
```
public void setScale(float scale)
```
    Sets the bitmap's display scale factor based on the bitmap's original size.
    
    Parameters:
    
    scale - The scale factor.
  - setScale
```
public void setScale(float scale,
                     int scaleBasis)
```
    Sets the bitmap's display scale factor and scaling basis.
    
    Parameters:
    
    scale - The scale factor.
    
    scaleBasis - The FRAME_WIDTH, FRAME_HEIGHT, ORIGINAL_SIZE, or CURRENT_SIZE method.
  - setPosition
```
public void setPosition(WOWZPoint position)
```
    Sets the bitmap's display position, in display pixels.
    
    Parameters:
    
    position - The display position.
  - setPosition
```
public void setPosition(int xpos,
                        int ypos)
```
    Sets the bitmap's display position, in display pixels.
    
    Parameters:
    
    xpos - The x position.
    
    ypos - The y position.
  - setRotation
```
public void setRotation(int angle)
```
    Sets the bitmap's display rotation angle, from 0 degrees to 360 degrees.
    
    Parameters:
    
    angle - The display rotation angle.
  - setVisible
```
public void setVisible(boolean isVisible)
```
    Sets a flag indicating whether the bitmap should be rendered (displayed).
    
    Parameters:
    
    isVisible - True if the bitmap should be rendered; false otherwise.
  - isVisible
```
public boolean isVisible()
```
    Checks whether the bitmap is being rendered (displayed).
    
    Returns:
    
    True if the bitmap is rendered; false otherwise.
  - isWZVideoFrameRendererActive
```
public boolean isWZVideoFrameRendererActive()
```
    Description copied from interface: WOWZRenderAPI.VideoFrameRenderer
    
    Checks whether the frame renderer is active. WOWZRenderAPI.VideoFrameRenderer.onWZVideoFrameRendererDraw(WOWZGLES.EglEnv, WOWZSize, int) will only be called on an active renderer.
    
    Specified by:
    
    isWZVideoFrameRendererActive in interface WOWZRenderAPI.VideoFrameRenderer
    
    Returns:
    
    True if this renderer is active; false otherwise.
  - onWZVideoFrameRendererInit
```
public void onWZVideoFrameRendererInit(WOWZGLES.EglEnv eglEnv)
```
    Description copied from interface: WOWZRenderAPI.VideoFrameRenderer
    
    Called at the beginning of a rendering cycle.
    
    Specified by:
    
    onWZVideoFrameRendererInit in interface WOWZRenderAPI.VideoFrameRenderer
    
    Parameters:
    
    eglEnv - The current OpenGL ES environment, which may be a different EglEnv than the one supplied with each call to WOWZRenderAPI.VideoFrameRenderer.onWZVideoFrameRendererDraw(WOWZGLES.EglEnv, WOWZSize, int). See for WOWZRenderAPI.VideoFrameRenderer.onWZVideoFrameRendererDraw(WOWZGLES.EglEnv, WOWZSize, int) for details.
  - onWZVideoFrameRendererDraw
```
public void onWZVideoFrameRendererDraw(WOWZGLES.EglEnv eglEnv,
                                       WOWZSize frameSize,
                                       int frameRotation)
```
    Description copied from interface: WOWZRenderAPI.VideoFrameRenderer
    
    Called to render a frame of video to the viewport for the current OpenGL ES context. The eglEnv may differ at each call but you can assume that the EGL context in each instance in between calls to WOWZRenderAPI.VideoFrameRenderer.onWZVideoFrameRendererInit(WOWZGLES.EglEnv) and WOWZRenderAPI.VideoFrameRenderer.onWZVideoFrameRendererRelease(WOWZGLES.EglEnv eglEnv) are shared contexts and can access the same EGL resources.
    
    Specified by:
    
    onWZVideoFrameRendererDraw in interface WOWZRenderAPI.VideoFrameRenderer
    
    Parameters:
    
    eglEnv - The current OpenGL ES environment.
    
    frameSize - The size of the video frame, in pixels.
    
    frameRotation - The angle to apply when rendering, in degrees (usually 0).
  - onWZVideoFrameRendererRelease
```
public void onWZVideoFrameRendererRelease(WOWZGLES.EglEnv eglEnv)
```
    Description copied from interface: WOWZRenderAPI.VideoFrameRenderer
    
    Called at the end of a rendering cycle.
    
    Specified by:
    
    onWZVideoFrameRendererRelease in interface WOWZRenderAPI.VideoFrameRenderer
    
    Parameters:
    
    eglEnv - The current OpenGL ES environment.

Class WOWZBitmap

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

WOWZBitmap

WOWZBitmap

Method Detail

setBitmap

getSourceSize

getDisplaySize

getScaleBasis

getScale

getPosition

getRotationAngle

setWidth

setHeight

setScale

setScale

setPosition

setPosition

setRotation

setVisible

isVisible

isWZVideoFrameRendererActive

onWZVideoFrameRendererInit

onWZVideoFrameRendererDraw

onWZVideoFrameRendererRelease