com.wowza.gocoder.sdk.api.android.graphics

Class WZTextManager

java.lang.Object

com.wowza.gocoder.sdk.api.android.graphics.WZTextManager

All Implemented Interfaces:

WZRenderAPI.VideoFrameRenderer

public final class WZTextManager
extends Object
implements WZRenderAPI.VideoFrameRenderer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WZTextManager.Font

Field Summary

Fields

Modifier and Type	Field and Description
static int	SCALE_BASIS_BASE_SIZE scale the text as a factor of the original text size
static int	SCALE_BASIS_CURRENT_SIZE scale the text as a factor of the current, scaled text size
static int	SCALE_BASIS_FRAME_HEIGHT scale the text as a factor of the video frame height.
static int	SCALE_BASIS_FRAME_WIDTH scale the text as a factor of the video frame width.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all text objects
WZText	createTextObject(UUID fontId) Create a new, empty text object to be drawn using the font with the specified id
WZText	createTextObject(UUID fontId, String text) Create a new text object using the specified string to be drawn using the font with the specified id
WZText	createTextObject(UUID fontId, String text, float r, float g, float b) Create a new text object using the specified font, text string, and color
WZText	createTextObject(UUID fontId, String text, float r, float g, float b, float a) Create a new text object using the specified font, text string, and color
WZText	createTextObject(UUID fontId, String text, WZColor color) Create a new text object using the specified font, text string, and color
WZTextManager.Font	getFontById(UUID fontId) Returns the font for the specified id
static WZTextManager	getInstance() Use this method to access the GoCoder SDK Text Manager
void	init(Context context) Initialize the text manager by providing the application context.
boolean	isTextVisible() Indicates if text object rendering is enabled or not
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
UUID	loadFont(String file, int size, int padX, int padY) This will load the specified font file, create a texture for the defined character range, and setup all required values used to render with it.
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	release() Release the resources used by the text manager
void	releaseTextObject(WZText textObject) Remove the specified text object
void	setTextVisible(boolean textVisible) Set the visibility of all text objects

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SCALE_BASIS_FRAME_WIDTH

public static final int SCALE_BASIS_FRAME_WIDTH

scale the text as a factor of the video frame width.

See Also:

Constant Field Values

SCALE_BASIS_FRAME_HEIGHT

public static final int SCALE_BASIS_FRAME_HEIGHT

scale the text as a factor of the video frame height.

See Also:

Constant Field Values

SCALE_BASIS_BASE_SIZE

public static final int SCALE_BASIS_BASE_SIZE

scale the text as a factor of the original text size

See Also:

Constant Field Values

SCALE_BASIS_CURRENT_SIZE

public static final int SCALE_BASIS_CURRENT_SIZE

scale the text as a factor of the current, scaled text size

See Also:

Constant Field Values

Method Detail

getInstance

public static WZTextManager getInstance()

Use this method to access the GoCoder SDK Text Manager

Returns:

The GoCoder SDK Text Manager

init

public void init(Context context)

Initialize the text manager by providing the application context. This is called during SDK initialization and it is not necessary for client app code to call

Parameters:

context - The app context

release

public void release()

Release the resources used by the text manager

loadFont

public UUID loadFont(String file,
                     int size,
                     int padX,
                     int padY)

This will load the specified font file, create a texture for the defined character range, and setup all required values used to render with it.

Parameters:

file - Filename of the font (.ttf, .otf) to use. In 'Assets' folder.

size - Requested pixel size of font (height)

padX - Extra padding per character (X Axis); to prevent overlapping characters.

padY - Extra padding per character (Y Axis); to prevent overlapping characters.

getFontById

public WZTextManager.Font getFontById(UUID fontId)

Returns the font for the specified id

Parameters:

fontId - The id for the font to return

Returns:

The font for the specified id, null if a font with that id does not exist

createTextObject

public WZText createTextObject(UUID fontId)

Create a new, empty text object to be drawn using the font with the specified id

Parameters:

fontId - The id for the font to be used for this text object

Returns:

A new text object, null if the font id specified is invalid

createTextObject

public WZText createTextObject(UUID fontId,
                               String text)

Create a new text object using the specified string to be drawn using the font with the specified id

Parameters:

fontId - The id for the font to be used for this text object

text - The text string to draw

Returns:

A new text object, null if the font id specified is invalid

createTextObject

public WZText createTextObject(UUID fontId,
                               String text,
                               WZColor color)

Create a new text object using the specified font, text string, and color

Parameters:

fontId - The id for the font to be used for this text object

text - The text string to draw

color - The text color

Returns:

A new text object, null if the font id specified is invalid

createTextObject

public WZText createTextObject(UUID fontId,
                               String text,
                               float r,
                               float g,
                               float b,
                               float a)

Create a new text object using the specified font, text string, and color

Parameters:

fontId - The id for the font to be used for this text object

text - The text string to draw

r - The red component of the text color (0.0 - 1.0)

g - The green component of the text color (0.0 - 1.0)

b - The blue component of the text color (0.0 - 1.0)

a - The alpha component of the text color (0.0 - 1.0)

Returns:

A new text object, null if the font id specified is invalid

createTextObject

public WZText createTextObject(UUID fontId,
                               String text,
                               float r,
                               float g,
                               float b)

Create a new text object using the specified font, text string, and color

Parameters:

fontId - The id for the font to be used for this text object

text - The text string to draw

r - The red component of the text color (0.0 - 1.0)

g - The green component of the text color (0.0 - 1.0)

b - The blue component of the text color (0.0 - 1.0)

Returns:

A new text object, null if the font id specified is invalid

releaseTextObject

public void releaseTextObject(WZText textObject)

Remove the specified text object

Parameters:

textObject - A text object to remove

clear

public void clear()

Removes all text objects

setTextVisible

public void setTextVisible(boolean textVisible)

Set the visibility of all text objects

Parameters:

textVisible - true if text objects should be rendered, false otherwise

isTextVisible

public boolean isTextVisible()

Indicates if text object rendering is enabled or not

Returns:

true if text rendering is enabled, 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.