WOWZText (GoCoder SDK Android API)

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

public class WOWZText
extends java.lang.Object

Display text as an overlay on a WOWZCameraView.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOTTOM` A position specifier to 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 to use with either argument of `setPosition(int, int)` to center the text in the device display.
`static int`	`LEFT` A position specifier to use as the first argument of `setPosition(int, int)` to align the text along the left hand side of the display.
`static int`	`RIGHT` A position specifier to 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 to 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()` Gets the current position, in display pixels.
`float`	`getAscent()` Gets the scaled font ascent.
`WOWZSize`	`getBaseSize()` Gets the original (unscaled) size, in pixels, of the text being rendered.
`float`	`getCharHeight()` Gets the scaled character height, in pixels.
`float`	`getCharWidth(char chr)` Gets the scaled width, in pixels, of the specified character.
`float`	`getCharWidthMax()` Gets the scaled maximum character width, in pixels.
`WOWZColor`	`getColor()`
`float`	`getDescent()` Gets the scaled font descent.
`WOWZTextManager.Font`	`getFont()`
`java.util.UUID`	`getFontId()`
`int`	`getHeight()` Gets the scaled height of the text object.
`WOWZPoint`	`getPosition()`
`int`	`getRotationAngle()` Gets the current rotation angle, from 0 degrees to 360 degrees.
`float`	`getScale()` Gets the scale factor that's currently applied.
`int`	`getScaleBasis()` Gets the current method used to apply the scale factor.
`WOWZSize`	`getScaledSize()` Gets the scaled size of the rendered text object.
`float`	`getSpacing()` Gets the spacing between characters.
`java.lang.String`	`getText()`
`int`	`getWidth()` Gets the scaled width, in pixels, of the text object.
`boolean`	`isVisible()` Checks whether the bitmap is rendered (displayed).
`void`	`setAlignment(int alignment)`
`void`	`setColor(float r, float g, float b)`
`void`	`setColor(float r, float g, float b, float a)`
`void`	`setColor(WOWZColor color)`
`void`	`setFontId(java.util.UUID fontId)`
`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`	`setRotationAngle(int angle)` Sets the bitmap's display rotation angle, from 0 degrees to 360 degrees.
`void`	`setScale(float scale)` Sets the display scale factor for the bitmap based on its original size.
`void`	`setScale(float scale, int scaleBasis)` Sets the bitmap's display scale factor and scaling basis.
`void`	`setSpacing(float spacing)` Sets the spacing between characters.
`void`	`setText(java.lang.String text)`
`void`	`setVisible(boolean isVisible)` Sets a flag indicating whether the bitmap should be rendered (displayed).

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 with either argument of setPosition(int, int) to center the text 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 text along the left hand side of the display.
    
    See Also:
    
    Constant Field Values
  - RIGHT
```
public static final int RIGHT
```
    A position specifier to 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 to 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 to 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 java.lang.String getText()
```
  - setText
```
public void setText(java.lang.String text)
```
  - getFontId
```
public java.util.UUID getFontId()
```
  - setFontId
```
public void setFontId(java.util.UUID fontId)
```
  - getFont
```
public WOWZTextManager.Font getFont()
```
  - getColor
```
public WOWZColor getColor()
```
  - setColor
```
public void setColor(WOWZColor 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 WOWZSize getBaseSize()
```
    Gets the original (unscaled) size, in pixels, of the text being rendered.
    
    Returns:
    
    The original size of the text.
  - getScaledSize
```
public WOWZSize getScaledSize()
```
    Gets the scaled size of the rendered text object.
    
    Returns:
    
    The scaled size of the displayed text object.
  - getWidth
```
public int getWidth()
```
    Gets the scaled width, in pixels, of the text object.
    
    Returns:
    
    The scaled width of the text object.
  - getHeight
```
public int getHeight()
```
    Gets the scaled height of the text object.
    
    Returns:
    
    The scaled height of the font.
  - getScaleBasis
```
public int getScaleBasis()
```
    Gets the current method used to apply the scale factor.
    
    Returns:
    
    The WOWZTextManager.SCALE_BASIS_FRAME_WIDTH, WOWZTextManager.SCALE_BASIS_FRAME_HEIGHT, or WOWZTextManager.SCALE_BASIS_BASE_SIZE method.
  - getScale
```
public float getScale()
```
    Gets the scale factor that's currently applied.
    
    Returns:
    
    The current scale factor.
  - setScale
```
public void setScale(float scale)
```
    Sets the display scale factor for the bitmap based on its 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 WOWZTextManager.SCALE_BASIS_FRAME_WIDTH, WOWZTextManager.SCALE_BASIS_FRAME_HEIGHT, WOWZTextManager.SCALE_BASIS_BASE_SIZE, or WOWZTextManager.SCALE_BASIS_CURRENT_SIZE method.
  - getSpacing
```
public float getSpacing()
```
    Gets the spacing between characters.
    
    Returns:
    
    The size of the space between characters.
  - setSpacing
```
public void setSpacing(float spacing)
```
    Sets the spacing between characters.
    
    Parameters:
    
    spacing - The size of the space between characters.
  - 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.
  - getAlignment
```
public int getAlignment()
```
    Gets the current position, in display pixels.
    
    Returns:
    
    The current position.
  - setAlignment
```
public void setAlignment(int alignment)
```
  - getRotationAngle
```
public int getRotationAngle()
```
    Gets the current rotation angle, from 0 degrees to 360 degrees.
    
    Returns:
    
    The current angle of rotation.
  - setRotationAngle
```
public void setRotationAngle(int angle)
```
    Sets the bitmap's display rotation angle, from 0 degrees to 360 degrees.
    
    Parameters:
    
    angle - The angle of the display rotation.
  - 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 rendered (displayed).
    
    Returns:
    
    True if the bitmap is rendered; false otherwise.
  - getCharWidth
```
public float getCharWidth(char chr)
```
    Gets the scaled width, in pixels, of the specified character.
    
    Parameters:
    
    chr - The character whose width is to be returned.
    
    Returns:
    
    The character's width.
  - getCharWidthMax
```
public float getCharWidthMax()
```
    Gets the scaled maximum character width, in pixels.
    
    Returns:
    
    The maximum character width.
  - getCharHeight
```
public float getCharHeight()
```
    Gets the scaled character height, in pixels.
    
    Returns:
    
    The character height.
  - getAscent
```
public float getAscent()
```
    Gets the scaled font ascent.
    
    Returns:
    
    The font ascent.
  - getDescent
```
public float getDescent()
```
    Gets the scaled font descent.
    
    Returns:
    
    The font descent.
  - getPosition
```
public WOWZPoint getPosition()
```

Class WOWZText

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