WZText (GoCoder SDK Android API)

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

```
public class WZText
extends Object
```
The WZText class can be used to display text as an overlay on a WZCameraView

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 text along the bottom of the display.
`static int`	`CENTER` A position specifier for use with `setPosition(int, int)` to center the text within the device display.
`static int`	`LEFT` A position specifier for use as the first argument to `setPosition(int, int)` to align the text along the left hand side of the display.
`static int`	`RIGHT` A position specifier for use as the first argument to `setPosition(int, int)` to align the text along the right hand side of the display.
`static int`	`TOP` A position specifier for use as the second argument to `setPosition(int, int)` to align the text along the top of the display.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAlignment()` Returns the current position, in display pixels
`float`	`getAscent()` Return the scaled font ascent
`WZSize`	`getBaseSize()` Returns the original, unscaled size of the text being rendered
`float`	`getCharHeight()` Get the scaled character height
`float`	`getCharWidth(char chr)` Get the scaled width of the specified character
`float`	`getCharWidthMax()` Get the scaled maximum character width
`WZColor`	`getColor()`
`float`	`getDescent()` Return the scaled font descent
`WZTextManager.Font`	`getFont()`
`UUID`	`getFontId()`
`int`	`getHeight()` Get the scaled height of this text object
`WZPoint`	`getPosition()`
`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`	`getScaledSize()` Returns the scaled size of the text object being rendered (i.e.
`float`	`getSpacing()` Get the spacing between characters
`String`	`getText()`
`int`	`getWidth()` Get the scaled width of this text object
`boolean`	`isVisible()` Indicates if the bitmap is being rendered (i.e.
`void`	`setAlignment(int alignment)`
`void`	`setColor(float r, float g, float b)`
`void`	`setColor(float r, float g, float b, float a)`
`void`	`setColor(WZColor color)`
`void`	`setFontId(UUID fontId)`
`void`	`setPosition(int xpos, int ypos)` Set the bitmap's display position
`void`	`setPosition(WZPoint position)` Set the bitmap's display position
`void`	`setRotationAngle(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`	`setSpacing(float spacing)` Set the spacing between characters
`void`	`setText(String text)`
`void`	`setVisible(boolean isVisible)` Set a flag indicating whether the bitmap should be rendered (i.e.

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 text 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 text 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 text 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 text 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 text along the bottom of the display.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getText
```
public String getText()
```
  - setText
```
public void setText(String text)
```
  - getFontId
```
public UUID getFontId()
```
  - setFontId
```
public void setFontId(UUID fontId)
```
  - getFont
```
public WZTextManager.Font getFont()
```
  - getColor
```
public WZColor getColor()
```
  - setColor
```
public void setColor(WZColor color)
```
  - setColor
```
public void setColor(float r,
                     float g,
                     float b,
                     float a)
```
  - setColor
```
public void setColor(float r,
                     float g,
                     float b)
```
  - getBaseSize
```
public WZSize getBaseSize()
```
    Returns the original, unscaled size of the text being rendered
    
    Returns:
    
    The original, unscaled size of the text
  - getScaledSize
```
public WZSize getScaledSize()
```
    Returns the scaled size of the text object being rendered (i.e. with the current scale factor applied)
    
    Returns:
    
    The scaled size of the text object being displayed
  - getWidth
```
public int getWidth()
```
    Get the scaled width of this text object
    
    Returns:
    
    width, in pixels
  - getHeight
```
public int getHeight()
```
    Get the scaled height of this text object
    
    Returns:
    
    the actual font height
  - getScaleBasis
```
public int getScaleBasis()
```
    Returns the current method used for applying the scale factor
    
    Returns:
    
    One of WZTextManager.SCALE_BASIS_FRAME_WIDTH, WZTextManager.SCALE_BASIS_FRAME_HEIGHT, WZTextManager.SCALE_BASIS_BASE_SIZE
  - getScale
```
public float getScale()
```
    Returns the current scale factor
    
    Returns:
    
    The current scale factor
  - 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 WZTextManager.SCALE_BASIS_FRAME_WIDTH, WZTextManager.SCALE_BASIS_FRAME_HEIGHT, WZTextManager.SCALE_BASIS_BASE_SIZE, or WZTextManager.SCALE_BASIS_CURRENT_SIZE
  - getSpacing
```
public float getSpacing()
```
    Get the spacing between characters
    
    Returns:
    
    the spacing between characters
  - setSpacing
```
public void setSpacing(float spacing)
```
    Set the spacing between characters
    
    Parameters:
    
    spacing - the spacing between characters
  - 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
  - getAlignment
```
public int getAlignment()
```
    Returns the current position, in display pixels
    
    Returns:
    
    The current position, in display pixels
  - setAlignment
```
public void setAlignment(int alignment)
```
  - getRotationAngle
```
public int getRotationAngle()
```
    Returns the current rotation angle, in degrees
    
    Returns:
    
    The current rotation angle (0-360)
  - setRotationAngle
```
public void setRotationAngle(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 bitma 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
  - getCharWidth
```
public float getCharWidth(char chr)
```
    Get the scaled width of the specified character
    
    Parameters:
    
    chr - the character whose width to return
    
    Returns:
    
    the character width, in pixels
  - getCharWidthMax
```
public float getCharWidthMax()
```
    Get the scaled maximum character width
    
    Returns:
    
    max character width, in pixels
  - getCharHeight
```
public float getCharHeight()
```
    Get the scaled character height
    
    Returns:
    
    the character height, in pixels
  - getAscent
```
public float getAscent()
```
    Return the scaled font ascent
    
    Returns:
    
    the font ascent
  - getDescent
```
public float getDescent()
```
    Return the scaled font descent
    
    Returns:
    
    the font descent
  - getPosition
```
public WZPoint getPosition()
```

Class WZText

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CENTER

LEFT

RIGHT

TOP

BOTTOM

Method Detail

getText

setText

getFontId

setFontId

getFont

getColor

setColor

setColor

setColor

getBaseSize

getScaledSize

getWidth

getHeight

getScaleBasis

getScale

setScale

setScale

getSpacing

setSpacing

setPosition

setPosition

getAlignment

setAlignment

getRotationAngle

setRotationAngle

setVisible

isVisible

getCharWidth

getCharWidthMax

getCharHeight

getAscent

getDescent

getPosition