控制隱藏式字幕樣式 control-closed-caption-styling

等候媒體播放器至少在 PREPARED 狀態。

建立 TextFormatBuilder 執行個體。

您可以現在提供所有隱藏式字幕樣式引數，或稍後再設定。

TVSDK會將隱藏式字幕樣式資訊封裝在 TextFormat 介面。 此 TextFormatBuilder 類別會建立實作此介面的物件。

public TextFormatBuilder(
   TextFormat.Font font,
   TextFormat.Size size,
   TextFormat.FontEdge fontEdge,
   java.lang.String fontColor,
   java.lang.String backgroundColor,
   java.lang.String fillColor,
   java.lang.String edgeColor,
   int fontOpacity,
   int backgroundOpacity,
   int fillOpacity
   java.lang.String bottomInset,
   java.lang.String safeArea)

若要取得實作物件的參照 TextFormat 介面，呼叫 TextFormatBuilder.toTextFormat 公用方法。

這會傳回 TextFormat 可套用至媒體播放器的物件。

public TextFormat toTextFormat()

您可以執行下列任一項動作，取得目前的隱藏式字幕樣式設定：

• 透過取得所有樣式設定 MediaPlayer.getCCStyle 傳回值是 TextFormat 介面。

  code language-java
  /** * @return the current closed captioning style. * If no style was previously set, it returns a TextFormat object * with default values for each attribute. * @throws MediaPlayerException if media player was already released. */ public TextFormat getCCStyle() throws MediaPlayerException;

• 透過，一次取得一個設定 TextFormat 介面getter方法。

  code language-java

  public java.lang.String getFontColor(); public java.lang.String getBackgroundColor(); public java.lang.String getFillColor(); // retrieve the font fill color public java.lang.String getEdgeColor(); // retrieve the font edge color public TextFormat.Size getSize(); // retrieve the font size public TextFormat.FontEdge getFontEdge(); // retrieve the font edge type public TextFormat.Font getFont(); // retrieve the font type public int getFontOpacity(); public int getBackgroundOpacity(); public java.lang.String getBottomInset(java.lang.String bi); public java.lang.String getSafeArea(java.lang.String sa);

若要變更樣式設定，請執行下列任一項動作：

• 使用setter方法 MediaPlayer.setCCStyle，傳遞的例項 TextFormat 介面：

  code language-java
  /** * Sets the closed captioning style. Used to control the closed captioning font, * size, color, edge and opacity. * * This method is safe to use even if the current media stream doesn't have closed * captions. * * @param textFormat * @throws MediaPlayerException */ public void setCCStyle(TextFormat textFormat) throws MediaPlayerException;

• 使用 TextFormatBuilder 類別，定義個別的setter方法。

  此 TextFormat 介面會定義不可變物件，因此只有getter方法而沒有setter。 您只能使用設定隱藏式字幕樣式引數 TextFormatBuilder 類別：

  code language-java

  // set font type public void setFont(Font font) public void setBackgroundColor(String backgroundColor) public void setFillColor(String fillColor) // set the font-edge color public void setEdgeColor(String edgeColor) // set the font size public void setSize(Size size) // set the font edge type public void setFontEdge(FontEdge fontEdge) public void setFontOpacity(int fontOpacity) public void setBackgroundOpacity(int backgroundOpacity) // set the font-fill opacity level public void setFillOpacity(int fillOpacity) public void setFontColor(String fontColor) public void setBottomInset(String bi) public void setSafeArea(String sa) public void setTreatSpaceAsAlphaNum(bool)

  note important
  IMPORTANT
  色彩設定： 在Android TVSDK 2.X中，已改良隱藏式字幕的色彩樣式。 增強功能允許使用代表RGB顏色值的十六進位字串來設定隱藏式字幕顏色。 RGB十六進位色彩表示是您在Photoshop等應用程式中所使用的6位元組字串：
  FFFFFF =黑色 000000 =白色 FF0000 =紅色 00FF00 =綠色 0000FF =藍色 等等。
  在您的應用程式中，每當您傳遞顏色樣式資訊至 TextFormatBuilder，您仍可使用 Color 分項清單和以前一樣，但現在您必須新增 getValue() 變更為顏色，以取得字串形式的值。 例如：
  tfb = tfb.setBackgroundColor(TextFormat.Color.RED <b>.getValue()</b>);