com.wowza.wms.transcoder.model

Interface ITranscoderOverlayProvider

public interface ITranscoderOverlayProvider

ITranscoderOverlayProvider: interface to add and remove video overlays.

Method Summary

Methods

Modifier and Type	Method and Description
void	addOverlay(int index, TranscoderVideoOverlayFrame overlay) Add an overlay to a video stream.
void	clearOverlay(int index) Clear video overlay
java.util.Map<Integer,TranscoderVideoOverlayFrame>	getAndClearPendingOverlays() Get a list of pending overlay requests and clear the pending overlay queue.
boolean	isOverlayAvailable() Returns true if there is a pending overlay request.

Method Detail

addOverlay

void addOverlay(int index,
              TranscoderVideoOverlayFrame overlay)

Add an overlay to a video stream.

Parameters:

index - over lay index (zero is bottom in z-order)

overlay - overlay object

clearOverlay

void clearOverlay(int index)

Clear video overlay

Parameters:

index - over lay index (zero is bottom in z-order)

getAndClearPendingOverlays

java.util.Map<Integer,TranscoderVideoOverlayFrame> getAndClearPendingOverlays()

Get a list of pending overlay requests and clear the pending overlay queue.

Returns:

list of pending overlay requests

isOverlayAvailable

boolean isOverlayAvailable()

Returns true if there is a pending overlay request.

Returns:

true if there is a pending overlay request