Interface ITranscoderOverlayProvider


public interface ITranscoderOverlayProvider

ITranscoderOverlayProvider: interface to add and remove video overlays.

  • Method Details

    • 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)
    • isOverlayAvailable

      boolean isOverlayAvailable()
      Returns true if there is a pending overlay request.
      Returns:
      true if there is a pending overlay request
    • getAndClearPendingOverlays

      Map<Integer,TranscoderVideoOverlayFrame> getAndClearPendingOverlays()
      Get a list of pending overlay requests and clear the pending overlay queue.
      Returns:
      list of pending overlay requests