プレイヤーオプション

プレイヤーオプションはObjectです。不正な値の場合はデフォルト値になります。API「setOptions」でプレイヤーの振る舞いを変更する際、オプションによっては無視されるケース、デフォルト値になるケースがあります。詳細は再生中のプレイヤーオプション変更 (opens new window)を参照してください。

プレイヤーオプションの第1階層のパラメータを以下に示します。

advertising

広告用のパラメータです。

advertising: Object

広告用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

広告の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

vastUrl: 文字列（URL）

VASTの取得URLです。
URLエンコードは不要です。
Googleアドマネージャーの広告のURLを指定する場合は広告再生（Google仕様）します。

vmapUrl: 文字列（URL）

VMAPの取得URLです。
URLエンコードは不要です。
Googleアドマネージャーの広告のURLを指定する場合は広告再生（Google仕様）します。

allowResetMidRollStatus: 真偽値

ミッドロールの繰り返し再生の有効／無効です。
広告再生（Google仕様）では常に無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

authDomain: 文字列の配列

認証情報送受信許可ドメインです。
広告の再生における通信（VASTおよびVMAPの取得、広告トラッキングの送信）において、プレイヤーを使用するWEBページと異なるドメインのサーバーに認証情報(クッキーなど)の送受信を許可するドメイン（後方一致）を指定します。このパラメータに指定していないドメインのサーバーとは認証情報を送受信しません。

midrollMax: 数値＜本＞

早送り時のミッドロール再生本数です。
0以上の整数を指定してください。指定の再生本数に従ってミッドロールを再生します。指定なしの場合は無制限にミッドロールを再生します。
広告再生（Google仕様）では常にひとつです。

smallWindowMode: 文字列

小窓の表示モードです。
広告再生（Google仕様）では常に本編非表示モード(小窓表示無効)です。
'default'： 本編非表示モード(小窓表示無効)
'main_reduce'： 本編縮小表示モード
'ad_reduce'： 広告縮小表示モード
デフォルト値： 'default'

smallWindowPosition: 文字列

小窓の表示位置です。
'topleft'： 左上表示
'topright'： 右上表示
'bottomleft'： 左下表示
'bottomright'： 右下表示
デフォルト値： 'topright'

validateCategoryError: 真偽値

カテゴリーの必須情報に関するエラー判定の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

pipMode

【 deprecated in v1.16.0 】
smallWindowModeを使用してください。

pipPosition

【 deprecated in v1.16.0 】
smallWindowPositionを使用してください。

airplay

AirPlay用のパラメータです。

airplay: Object

AirPlay用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

AirPlayの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

aspectRatio

プレイヤーのアスペクト比のパラメータです。

aspectRatio: 文字列

プレイヤーのアスペクト比です。
幅の比率（数値）:高さの比率（数値）の形式で指定してください。数値は小数も指定できます。プレイヤーの高さを指定する場合は本パラメータを無視します。プレイヤーの高さと幅が未指定の場合は親要素に収まるようにアスペクト比を維持して表示します。
デフォルト値： '16:9'

audioTrack

オーディオ切り替え用のパラメータです。

audioTrack: Object

オーディオ切り替え用パラメータです。
本オブジェクトが無い場合、機能は有効です。

enable: 真偽値

オーディオ切り替えの有効／無効です。
true： 音声ボタンを表示します（表示する環境の場合）。
false： 音声ボタンを非表示にし、自動選択にします。
デフォルト値： true

defaultIndex: 数値

再生を開始する時のオーディオのオーディオトラックインデックスです。
-1以上の整数を指定してください。
-1： デフォルトのオーディオ
デフォルト値： -1

menuButtonVisible: 真偽値

音声ボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

menuLabels: 文字列の配列

音声メニューの各項目を置き換える文言です。
音声メニューの項目を、上から順に指定の文字列に置き換えます。文字数が多いと収まらない場合があります。未指定かつストリームのオーディオトラックにlabel／nameが存在する場合はlabel／nameを使用します。
デフォルト値： '音声＜連番＞'
※ 日本語以外の環境の場合は 'Audio ＜連番＞'

method: 文字列

オーディオの切り替え方法です。
'toggle'： 音声ボタンを押下する度にオーディオを順次切り替えます。
'list'： 音声ボタンを押下することで音声メニューを表示／非表示にします。
デフォルト値： 'list'

saveLocalStorage: 真偽値

選択中のオーディオをローカル記憶領域に保存し、次回の再生に引き継ぐ事の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

autoplay

自動再生のパラメータです。

autoplay: 真偽値

自動再生の有効／無効です。
true： 有効にします。
false： 無効にします。
audio要素／video要素のautoplay属性よりも本設定を優先します。
デフォルト値： false

autoReload

自動リロード用のパラメータです。

autoReload: Object

自動リロード用パラメータです。
本オブジェクトが無い場合、機能は有効です。

enable: 真偽値

自動リロードの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

loadingTimeout: 数値＜ミリ秒＞

再生を継続できない状態になってからリロードするまでの時間です。
0以上の整数を指定してください。
デフォルト値： 10000

beacon

ビーコン用のパラメータです。

beacon: Object

ビーコン用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

プレイヤーのビーコンの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

url: 文字列（URL）

ビーコン送信URLです。
URLエンコードは不要です。

authDomain: 文字列の配列

認証情報送受信許可ドメインです。
ビーコンの送信における通信において、プレイヤーを使用するWEBページと異なるドメインのサーバーに認証情報（クッキーなど）の送受信を許可するドメイン（後方一致）を指定します。このパラメータに指定していないドメインのサーバーとは認証情報を送受信しません。

requestHeaders: Object

追加HTTPヘッダです。
HTTPリクエストに追加するHTTPヘッダを列挙したObjectを指定します。要素は10個まで指定できます。
指定するデータのフォーマットについては、「ユーザーガイド」を参照してください。ヘッダ名が重複する場合は、最後のヘッダ値を使用します。また、HTTP/1.1で規定のHTTPヘッダを指定する場合、ブラウザにより無視される場合があります。

chapter

チャプター用のパラメータです。

chapter: Object

チャプター用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

チャプターの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

parentElementId: 文字列

チャプター領域のdiv要素のidです。
指定がない場合、チャプター領域は非表示です。

nextButtonVisible: 真偽値

次チャプターボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

prevButtonVisible: 真偽値

前チャプターボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

item: Objectの配列

チャプター情報です。
要素は100個まで指定できます。配列が空の場合、機能は無効です。

startTime: 数値＜秒＞

チャプターの再生開始位置です。
0以上コンテンツの尺以下を指定してください。ひとつ目のチャプターは必ず0を指定してください。

title: 文字列

チャプターのタイトルです。

thumbnailUrl: 文字列（URL）

サムネイル画像の取得URLです。

data: Object

チャプターのカスタマイズ用のパラメータです。
デフォルト値： {}

page: 数値＜ページ＞

資料のページ番号です。
0以上資料の総ページ以下を指定してください。資料については、presentationを参照してください。
デフォルト値： -1

controlBarButton

コントロールバーボタン追加用のパラメータです。

controlBarButton: Object

コントロールバーボタン追加用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

コントロールバーボタン追加の有効／無効
true： 有効にします。
false： 無効にします。
デフォルト値： true

item: Objectの配列

コントロールバーボタン情報です。
配列が空の場合はコントロールバーボタンを追加しません。

id: 文字列

コントロールバーボタンの識別子です。
識別子がない場合はコントロールバーボタンを追加しません。

state: Objectの配列

ボタン状態です。
配列が空の場合はコントロールバーボタンを追加しません。

iconfont: 文字列

ボタンアイコンです。
コントロールバーボタンに表示するアイコンフォントのclass属性です。

text: 文字列

ボタンラベル（日本語以外）です。
コントロールバーボタンに表示する文字列です。全角半角問わず10文字以下で指定してください。日本語以外の環境の場合、同階層のtextJaよりも優先します。

textJa: 文字列

ボタンラベル（日本語）です。
コントロールバーボタンに表示する文字列です。全角半角問わず10文字以下で指定してください。日本語環境の場合、同階層のtextよりも優先します。

tooltip: 文字列

ボタン状態ごとのツールチップラベル（日本語以外）です。
コントロールバーボタンのツールチップよりも優先します。日本語以外の環境の場合、同階層のtooltipJaよりも優先します。

tooltipJa: 文字列

ボタン状態ごとのツールチップラベル（日本語）です。
コントロールバーボタンのツールチップよりも優先します。日本語環境の場合、同階層のtooltipよりも優先します。

text_ja:

【 deprecated in v1.17.0 】
textJaを使用してください。

tooltip_ja:

【 deprecated in v1.17.0 】
tooltipJaを使用してください。

defaultStateIndex: 数値

ボタン状態インデックスの初期値です。
デフォルト値： 0

fontFamily: 文字列

フォント名です。
ボタンラベルとボタンアイコンのフォントです。

tooltip: 文字列

コントロールバーボタンのツールチップラベル（日本語以外）です。
日本語以外の環境の場合、同階層のtooltipJaよりも優先します。

tooltipJa: 文字列

コントロールバーボタンのツールチップラベル（日本語）です。
日本語環境の場合、同階層のtooltipよりも優先します。

onClickListener: Function

コントロールバーボタン押下コールバック関数です。
詳細はコントロールバーボタン押下コールバック関数を参照してください。

tooltip_ja:

【 deprecated in v1.17.0 】
tooltipJaを使用してください。

controller

コントローラーカスタマイズ用のパラメータです。

controller: Object

コントローラーカスタマイズ用パラメータです。

beginningButtonVisible: 真偽値

開始位置ボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： false

centerControllerVisible: 真偽値

PCブラウザでのセンターコントローラーの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

centerControllerVisibleForMobile: 真偽値

モバイルブラウザでのセンターコントローラーの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

centerPlayStartVisible: 真偽値

再生開始ボタンの表⽰／⾮表⽰です。
true： 表⽰します。
false： ⾮表⽰にします。
デフォルト値： true

centerPlayToggleVisible: 真偽値

本編及び広告再生中のセンターコントローラー上の再生／一時停止ボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

controlBarVisible: 真偽値

コントロールバーの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

fixedControlBar: 真偽値

コントロールバーの表示位置をプレイヤー領域の下辺に表示するか否かです。
true： プレイヤー領域の下辺に表示します。
false： 動画表示領域／ポスター画像の下辺に表示します。
以下の場合はtrue相当です。

• コンテンツのファーストフレームを取得できていない、かつポスター画像がない場合

デフォルト値： false

preStartVisible: 真偽値

再生開始前のコントロールバーの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

currentTimeVisible: 真偽値

コンテンツの現在の再生位置を示す文字列の表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

durationVisible: 真偽値

コンテンツの尺を示す文字列の表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

enableSeekBarByUser: 真偽値

シークバーの操作の許可／不許可です。
true： 許可します。
false： 許可しません。
デフォルト値： true

seekBarVisible: 真偽値

シークバーの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

fullscreenToggleVisible: 真偽値

フルスクリーンボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

inactivityPauseTimeout: 数値＜ミリ秒＞

一時停止状態でコントローラーおよびタイトルを表示してから自動的に非表示になるまでの時間です。
0は自動的に非表示になりません。
以下の場合は0相当です。

• オーディオの再生

デフォルト値： 2000

inactivityTimeout: 数値＜ミリ秒＞

再生状態でコントローラーおよびタイトルを表示してから自動的に非表示になるまでの時間です。
0は自動的に非表示になりません。
以下の場合は0相当です。

• オーディオの再生

デフォルト値： 2000

liveIndicatorVisible: 真偽値

ライブボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

pictureInPictureButtonVisible: 真偽値

ピクチャーインピクチャーボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： false

playStartButtonEffect: 文字列

再生開始ボタンのアニメーションです。
'none'： アニメーションなし
'reflection'： 反射アニメーション
'ripples'： 波紋アニメーション
デフォルト値： 'none'

playToggleVisible: 真偽値

コントロールバー上の再生／一時停止ボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。

デフォルト値（以下の環境）： true

• PC
• オーディオの再生

デフォルト値（以下の環境）： false

• Android
• iOS / iPadOS

unmuteButtonVisible: 真偽値

ミュート解除ボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

volumeBarVertical: 真偽値

ボリュームバーの表示形式です。
true： 縦表示にします。
false： 横表示にします。
デフォルト値： false

volumeControlVisible: 真偽値

ボリュームボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

accentColor

【 deprecated in v1.22.0 】
--uliza-accent-colorを使用してください。

controlBarColor

【 deprecated in v1.23.0 】
--uliza-audio-controller-colorを使用してください。

nonSeekableRangeColor

【 deprecated in v1.19.0 】
seekableRangeのnonSeekableColorを使用してください。

playStartButtonColor

【 deprecated in v1.23.0 】
--uliza-play-start-button-colorを使用してください。

seekableRangeStart

【 deprecated in v1.19.0 】
seekableRangeのstartを使用してください。

seekableRangeEnd

【 deprecated in v1.19.0 】
seekableRangeのendを使用してください。

customLayer

カスタムレイヤー用のパラメータです。

customLayer: Object

カスタムレイヤー用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

カスタムレイヤーの有効／無効です。
true： 有効にします。かつ、初期状態でカスタムレイヤーを表示します。
false： 無効にします。かつ、カスタムレイヤーを非表示にします。
デフォルト値： false

className: 文字列

カスタムレイヤーに追加するクラス属性です。
複数指定する場合は半角スペースで区切ってください。

disableExternalDisplayType

外部出力抑止用のパラメータです。

disableExternalDisplayType: 文字列の配列

外部出力を抑止する出力方式のリストです。
指定可能な出力方式は以下の通りです。
'airplay'： AirPlay
'googlecast'： 画面のキャスト
'miracast'： Miracast接続
デフォルト値： []

disableInlineFullscreen

ビデオビューア制御用のパラメータです。

disableInlineFullscreen: 真偽値

ビデオビューア制御の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

disableRemoteSeek

リモートシーク制御用のパラメータです。

disableRemoteSeek: 真偽値

リモートシーク制御の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

disableScreenCapture

録画抑止用のパラメータです。

disableScreenCapture: 真偽値

録画抑止の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

dvrThreshold

LIVE／DVRの判定に用いるウィンドウサイズの閾値用のパラメータです。

dvrThreshold: 数値＜秒＞

LIVE／DVRの判定に用いるウィンドウサイズの閾値です。
-1または0以上を指定してください。streamTypeがauto、かつコンテンツタイプが非VODの場合に使用し、ウィンドウサイズが本値以上の場合にDVRと判定します。-1の場合、常にLIVEと判定します。
デフォルト値： 180

enablePlayToggleInPlayerArea

PCブラウザでの再生における、プレイヤー表示領域の押下による再生状態／一時停止状態の切り替え用のパラメータです。

enablePlayToggleInPlayerArea: 真偽値

（PCブラウザ用）プレイヤー表示領域の押下による再生状態／一時停止状態の切り替えの許可／不許可です。 広告再生（Google仕様）では常に許可します。
true： 許可します。
false： 許可しません。
デフォルト値： false

enablePlayToggleInPlayerAreaForMobile

モバイルブラウザでの再生における、プレイヤー表示領域の押下による再生状態／一時停止状態の切り替え用のパラメータです。

enablePlayToggleInPlayerAreaForMobile: 真偽値

（モバイルブラウザ用）プレイヤー表示領域の押下による再生状態／一時停止状態の切り替えの許可／不許可です。 広告再生（Google仕様）では常に許可します。
true： 許可します。
false： 許可しません。
デフォルト値： false

enlargement

拡大表示用のパラメータです。

enlargement: Object

拡大表示用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

拡大表示の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

maxRate: 数値＜%＞

最大拡大率です。
デフォルト値： 500

fullscreenType

プレイヤー画面の拡大方式用のパラメータです。

fullscreenType: 文字列

プレイヤー画面の拡大方式です。
フルスクリーンボタン押下などでフルスクリーン状態に切り替える際のプレイヤー画面の拡大方式を設定します。
'native'： システムのフルスクリーン制御に従ってプレイヤーの画面を拡大します。
'window'： ブラウザのウィンドウいっぱいにプレイヤーの画面を拡大します。

デフォルト値（以下の環境）： 'native'

• PC
• iPadOS Safari
• iPadOS Chrome(※)
• iPadOS Edge(※)

デフォルト値（以下の環境）： 'window'

• Android
• iOS Safari
• iOS / iPadOS WebView

(※) iPadOSのChrome、Edgeは、ブラウザバージョンによってデフォルト値が異なる場合があります。

gestureControl

ジェスチャー用のパラメータです。

gestureControl: Object

ジェスチャー用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

ジェスチャーの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

enablePageScroll: 真偽値

縦方向のページスクロールを行う／行わないです。
true： 行います。
false： 行いません。
デフォルト値： true

flickInterval: 数値＜ミリ秒＞

フリックと判断する期間です。
長いほどフリックと判断しやすく、反面スワイプと確定するのに時間がかかります。
デフォルト値： 100

multiPressInterval: 数値＜ミリ秒＞

ダブルクリック（ダブルタップ）と判断する期間です。
長いほどダブルクリックと判断しやすく、クリック（タップ）が確定するのに時間がかかります。0を指定する場合、ダブルクリックを判定しません。
デフォルト値： 300

eventListener

【 deprecated in v1.22.0 】

multiTouchInterval

【 deprecated in v1.17.0 】
multiPressIntervalを使用してください。

preventDefault

【 deprecated in v1.18.0 】
enablePageScrollを使用してください。

googlecast

Google Cast Sender用のパラメータです。

googlecast: Object

Google Cast Sender用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

Google Cast Senderの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

appId: 文字列

ReceiverアプリケーションIDです。
ULIZA Google Cast ReceiverのIDを指定します。ただし、ULIZA Player (Android)のWebView上で動作する場合は参照しません。

targetReceiverVer: 数値

向き先のReceiverのバージョンです。
ULIZA Video Analytics (Cloud)が有効の場合、強制的に2になります。
デフォルト値：1

castReceiverConfig: Object

Receiver設定情報です。

castMediaInfo: Object

Cast情報です。

height

プレイヤーの高さ用のパラメータです。

height: 数値＜px＞／文字列

プレイヤーの高さです。
video要素のheight属性よりも本設定を優先します。0（ピクセル換算）より大きな値を指定してください。無効な値は無視します。文字列を指定する場合、単位部分を 'px'、'%' としてください。
※ 単位を '%' にする場合、祖先要素のheightが確定しない場合は0になります。
デフォルト値： プレイヤーの幅を基準にアスペクト比から算出する値です。

help

ヘルプ用のパラメータです。

help: Object

ヘルプ用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

ヘルプの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

buttonVisible: 真偽値

ヘルプボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

hotkey

ホットキー用のパラメータです。

hotkey: Object

ホットキー用パラメータです。
本オブジェクトが無い場合、機能は有効です。

enable: 真偽値

ホットキーの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

eventListener: Function／文字列

キー押下コールバック関数または関数名です。
詳細はキー押下コールバック関数を参照してください。

html5

DASH (Widevine)およびDASH (PlayReady)コンテンツのライセンス要求およびHLSコンテンツの認証情報送受信許可ドメイン用のパラメータです。

html5: Object

-

keySystem: Object

-

com.widevine.alpha: 文字列（URL）

DASH (Widevine)のライセンス要求URLです。
URLエンコードは不要です。以下のデータはライセンス要求時にプレイヤーが付与します。

• pssh (ライセンス要求URLのクエリパラメータに付与します）
• ライセンス要求URLで送信するリクエストボディのデータ

プレイヤーはURLに上記以外のクエリパラメータを付与しません。ライセンス要求時に必要なクエリパラメータは、予めこのURLに付与してください。

com.microsoft.playready: 文字列（URL）

DASH (PlayReady)のライセンス要求URLです。
URLエンコードは不要です。以下のデータはライセンス要求時にプレイヤーが付与します。

• pssh（ライセンス要求URLのクエリパラメータに付与します）
• ライセンス要求URLで送信するリクエストボディのデータ

プレイヤーはURLに上記以外のクエリパラメータを付与しません。ライセンス要求時に必要なクエリパラメータは、予めこのURLに付与してください。

hlsjsConfig: Object

-

authDomain: 文字列の配列

認証情報送受信許可ドメインです。
HLSコンテンツの再生における通信において、プレイヤーを使用するWEBページと異なるドメインのサーバーに認証情報(クッキーなど)の送受信を許可するドメイン（後方一致）を指定します。このパラメータに指定していないドメインのサーバーとは認証情報を送受信しません。

live

LIVEカスタマイズ用のパラメータです。

live: Object

LIVEカスタマイズ用パラメータです。

enableKeepLiveHead: 真偽値

HLS（LIVE）で一時停止状態に切り替えた後、再生を再開する際にLIVEの先頭から再生を再開するか否かです。
true： LIVEの先頭から再生を再開する。
false： 一時停止状態に切り替えた位置から再生を再開する。
デフォルト値： true

liveMonitoring

LIVE配信監視用のパラメータです。

liveMonitoring: Object

LIVE配信監視用パラメータです。
本オブジェクトが無い場合、機能は有効です。

enable: 真偽値

LIVE配信監視の有効/無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

autoStart: 真偽値

LIVE配信監視の自動開始の有効/無効です。
true： 自動的に開始します。
false： APIを実行するまで開始しません。
デフォルト値： true

customControl: 真偽値

プレイヤー制御カスタマイズの有効/無効です。
true： LIVE配信の正常／異常を検出し、コールバックイベントを通知します。
false： LIVE配信の正常／異常を検出し、コンテンツのリロードを行います。autoplayがtrueの場合は正常検出時に自動的に再生を開始します。
デフォルト値： false

pollingInterval: 数値＜ミリ秒＞

LIVE配信監視間隔です。
前回の監視処理終了から次の監視処理開始までの間隔
デフォルト値： 10000

muted

ミュート用のパラメータです。

muted: 真偽値

ボリュームのミュート／非ミュートです。
audio要素／video要素のmuted属性よりも本設定を優先します。
true： ミュート
false： 非ミュート
デフォルト値： false

multiAngle

マルチアングル動画再生用のパラメータです。

multiAngle: Object

マルチアングル動画再生用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

マルチアングル動画再生の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

angle: 数値

アングルの数です。
2以上8以下の整数を指定してください。1の場合、機能を無効と扱います。
デフォルト値： 1

angleLabels: 文字列の配列

マルチアングルリストのラベルに表示する文言です。
文字数が多いと収まらない場合があります。
デフォルト値： 'アングル＜連番＞'
※ 日本語以外の環境の場合は 'Angle＜連番＞'

defaultIndex: 数値

再生を開始する時に選択するアングルのインデックスです。
デフォルト値： 0

parentElementId: 文字列

マルチアングルリストのdiv要素のidです。
指定がない場合、マルチアングルリストは非表示です。

saveLocalStorage: 真偽値

選択中のアングルをローカル記憶領域に保存し、次回の再生に引き継ぐ事の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

fps: 数値

動画表示領域の映像を1秒あたりに更新する回数です。
0以上の値を指定してください。デフォルト値からの変更は非推奨です。
デフォルト値： 30

listFps: 数値

マルチアングルリストの映像を1秒あたりに更新する回数です。
0以上の値を指定してください。デフォルト値からの変更は非推奨です。
デフォルト値： 5

nextPrevContent

次／前コンテンツ用のパラメータです。

nextPrevContent: Object

次／前コンテンツ用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

次／前コンテンツの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

nextButtonVisible: 真偽値

次コンテンツボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

prevButtonVisible: 真偽値

前コンテンツボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

tooltipWidth

【 deprecated in v1.22.0 】
--uliza-next-prev-content-tooltip-widthを使用してください。

tooltipHeight

【 deprecated in v1.22.0 】
--uliza-next-prev-content-tooltip-heightを使用してください。

panorama

パノラマ動画再生用のパラメータです。

panorama: Object

パノラマ動画再生用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

パノラマ動画再生の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

videoType: 文字列

パノラマ動画の映像形式です。
'equirectangular'： エクレクタンギュラー（正距円筒）形式
'fisheye'： フィッシュアイ（全天周）形式
'VR1803D'： VR180形式
デフォルト値： 'equirectangular'

inputType: 文字列

パノラマ動画の映像の構成です。
'mono'： モノ形式
'stereo'： ステレオ形式
videoTypeがVR1803Dの場合、inputTypeの指定は不要です。
デフォルト値： 'mono'

cardboardButtonVisible: 真偽値

Cardboardボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。

デフォルト値（以下の環境）： false

• PC
• iPadOS Safari

デフォルト値（以下の環境）： true

• Android
• iOS / iPadOS Chrome
• iOS Safari
• iOS / iPadOS Edge
• iOS / iPadOS WebView

autoMobileOrientation: 真偽値

端末の向きの変更による視点移動の有効／無効です。
true： 有効にします。
false： 無効にします。

デフォルト値（以下の環境）： false

• PC
• iPadOS Safari

デフォルト値（以下の環境）： true

• Android
• iOS / iPadOS Chrome
• iOS Safari
• iOS / iPadOS Edge
• iOS / iPadOS WebView

VREnable

【 deprecated in v1.13.0 】
cardboardButtonVisibleを使用してください。

partsSize

パーツサイズ用のパラメータです。

partsSize: Object

パーツサイズ用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

パーツサイズの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

values: 数値＜倍＞の配列

パーツサイズの倍率のリストです。
倍率の精度は小数第一位までです。上限は2倍で、下限は1倍程度を推奨します。要素は20個まで指定できます。
デフォルト値： [1.0]

defaultIndex: 数値

パーツサイズインデックスの初期値です。
デフォルト値： 1.0（等倍サイズ）のインデックス

menuButtonVisible: 真偽値

パーツサイズボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

menuLabels: 文字列の配列

パーツサイズメニューの各項目に表示する文言です。
パーツサイズメニューの項目を、上から順に指定の文字列に置き換えます。文字数が多いと収まらない場合があります。
デフォルト値： []

method: 文字列

パーツサイズの切り替え方法です。
'toggle'： パーツサイズボタンを押下する度に倍率を順次切り替えます。
'list'： パーツサイズボタンを押下することでパーツサイズメニューを表示／非表示にします。
デフォルト値： 'list'

saveLocalStorage: 真偽値

選択中のパーツサイズをローカル記憶領域に保存し、次回の再生に引き継ぐ事の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

playbackRange

切り出し再生用のパラメータです。

playbackRange: Object

切り出し再生用のパラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

切り出し再生の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

startSeconds: 数値＜秒＞

切り出し開始位置です。
0以上コンテンツの尺未満を指定してください。
デフォルト値： 0

endSeconds: 数値＜秒＞／文字列

切り出し終了位置です。
数値で指定する場合は、切り出し開始位置より大きな値からコンテンツの尺以下を指定してください。指定可能な文字列は以下の通りです。
'end'： コンテンツの終端
デフォルト値： 'end'

playbackRates

倍速再生用のパラメータです。

playbackRates: Object

倍速再生用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

倍速再生の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

values: 数値＜倍＞の配列

再生速度のリストです。
再生速度には0.5以上2.0以下の小数第一位までの値を指定できます。リストは1.0（等倍速）を含め、降順に並べてください。

defaultIndex: 数値

再生速度インデックスの初期値です。
デフォルト値： 1.0（等倍速）のインデックス

menuButtonVisible: 真偽値

再生速度ボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

method: 文字列

再生速度の切り替え方法です。
'toggle'： 再生速度ボタンを押下する度に再生速度を順次切り替えます。
'list'： 再生速度ボタンを押下することで再生速度メニューを表示／非表示にします。
デフォルト値： 'list'

saveLocalStorage: 真偽値

選択中の再生速度をローカル記憶領域に保存し、次回の再生に引き継ぐ事の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

poster

ポスター画像用のパラメータです。

poster: 文字列（URL）

ポスター画像のURLです。
video要素のposter属性よりも本設定を優先します。

posterSlideShow

スライドショー用のパラメータです。

posterSlideShow: Object

スライドショー用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

スライドショーの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

posters: 文字列（URL）の配列

画像のURLのリストです。
要素は20個まで指定できます。

interval: 数値＜ミリ秒＞

画像を切り替える間隔です。
デフォルト値： 1000

presentation

プレゼンテーション用のパラメータです。

presentation: Object

プレゼンテーション用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

プレゼンテーションの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

documentUrl: 文字列（URL）

資料の取得URLです。
プレゼンテーション領域に表示する資料の取得URLを指定します。指定がない場合、機能は無効です。

parentElementId: 文字列

インライン再生時のプレゼンテーションのdiv要素のidです。
指定がない場合、機能は無効です。

displayInPlayer: 真偽値

フルスクリーン再生時に、プレイヤー領域に資料を表示するか否かです。
true： プレイヤー領域に資料を表示します。
false： プレイヤー領域に資料を表示しません。
デフォルト値： false

positionChangeButtonVisible: 真偽値

資料表示位置ボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

fullscreenViewChangeButtonVisible: 真偽値

資料表示状態ボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

defaultFullscreenView: 文字列

プレイヤー領域に資料を表示する時の、資料の初期表示状態です。
'side-by-side'： 並列表示
'inset-view'： 小窓表示
デフォルト値： 'side-by-side'

saveFullscreenViewToLocalStorage: 真偽値

現在のプレイヤー領域に資料を表示している時の、資料の表示状態をローカル記憶領域に保存し、次回の再生に引き継ぐ事の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

repeat

リピート用のパラメータです。

repeat: Object

リピート用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

リピートの有効／無効です。
無効にするとリピートボタンを非表示にし、リピートが機能しません。
true： 有効にします。
false： 無効にします。
デフォルト値： false

buttonVisible: 真偽値

リピートボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

defaultStatus: 真偽値

リピート状態の初期値です。
ブラウザのローカル記憶領域に保存されたリピート状態がある場合、本パラメータより優先します。
true： 有効にします。
false： 無効にします。
デフォルト値： false

saveLocalStorage: 真偽値

現在のリピート状態をローカル記憶領域に保存し、次回の再生に引き継ぐ事の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

resumePlayback

レジューム再生用のパラメータです。

resumePlayback: Object

レジューム再生用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

レジューム再生の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

startPosition: 数値＜秒＞

再生開始位置です。
本値を指定する場合、ブラウザのローカル記憶領域に保存された再生位置より優先します。

resumeConfirmFunc: Function

レジューム確認コールバック関数です。
詳細はレジューム確認コールバック関数を参照してください。

saveVolumeInfo

ボリューム情報の保存用のパラメータです。

saveVolumeInfo: 真偽値

現在のボリューム情報をローカル記憶領域に保存し、次回の再生に引き継ぐ事の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

screenLock

画面ロック用のパラメータです。

screenLock: Object

画面ロック用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

画面ロックの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

unlockType: 文字列

画面ロックの解除方法です。
'longPress'： 長押し解除です。
'press'： 2段階解除です。
デフォルト値： 'longPress'

unlockTime: 数値＜ミリ秒＞

画面ロックの解除方法が 'longPress' の場合の長押しの秒数です。
0以上を指定してください。
デフォルト値： 2000

buttonVisible: 真偽値

画面ロックボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

seekableRange

シーク範囲制御用のパラメータです。

seekableRange: Object

シーク範囲制御用のパラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

シーク範囲制御の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

start: 数値＜秒＞

シーク有効範囲の開始位置です。
0以上コンテンツの尺以下を指定してください。シーク有効範囲の終了位置以下を指定してください。
デフォルト値： 0

end: 数値＜秒＞／文字列

シーク有効範囲の終了位置です。
数値で指定する場合は、0以上コンテンツの尺以下を指定してください。シーク有効範囲の開始位置以下を指定してください。指定可能な文字列は以下の通りです。
'watched'： 視聴済みの最新位置
'end'： コンテンツの終端
デフォルト値： 'end'

nonSeekableColor: 文字列

【 deprecated in v1.23.0 】
--uliza-non-seekable-range-colorを使用してください。

seekpreview

シークプレビュー用のパラメータです。

seekpreview: Object

シークプレビュー用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

シークプレビューの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

url: 文字列（URL）

シークプレビュー画像の取得URLです。
シークプレビューで使用する画像のURLを指定します。

settingMenu

設定メニュー用のパラメータです。

settingMenu: Object

設定メニュー用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

設定メニューの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

menuButtonVisible: 真偽値

設定メニューボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

skin

スキン用のパラメータです。

skin: 文字列

スキン名です。
指定可能なスキン名は以下の通りです。
'default'
'skin1'
'skin2'
デフォルト値： 'default'

skipForwardAndBackward

進む／戻る用のパラメータです。

skipForwardAndBackward: Object

進む／戻る用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

進む／戻るの有効/無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

centerForwardAndBackwardVisible: 真偽値

センターコントローラー上の進む／戻るボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

forwardAndBackwardVisible: 真偽値

コントロールバー上の進む／戻るボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： false

multiTapAreaWidth: 文字列(サイズ： px, %)

ダブルタップに反応する領域の幅です。
0より大きい値を指定すると、モバイルブラウザでプレイヤー領域の左右部をダブルタップする操作による進む／戻るが有効になります。この場合、centerForwardAndBackwardVisibleの値をfalseと扱います。
上限は45%です。
デフォルト値： ’0%’

skipForwardSeconds: 数値＜秒＞

前方シークする秒数です。
0以上999以下を指定してください。0は進むボタンを非表示にします。
デフォルト値： 45

skipBackwardSeconds: 数値＜秒＞

後方シークする秒数です。
0以上999以下を指定してください。0は戻るボタンを非表示にします。
デフォルト値： 15

showCenterForwardAndBackward

【 deprecated in v1.12.0 】
centerForwardAndBackwardVisibleを使用してください。

showForwardAndBackward

【 deprecated in v1.12.0 】
forwardAndBackwardVisibleを使用してください。

sources

プレイヤーが再生するコンテンツ用のパラメータです。

sources: Objectの配列

プレイヤーが再生するコンテンツのメディアソースです。
ひとつだけ指定してください。

src: 文字列（URL）

コンテンツのURLです。

type: 文字列

コンテンツのMIME-typeです。

streamType

コンテンツタイプ用のパラメータです。

streamType: 文字列

再生するコンテンツに応じたコンテンツタイプです。
コンテンツタイプを示す以下の文字列を指定します。なお、'auto' の指定は配信方式がHLSの場合のみサポートします。その他の配信方式の場合、'vod' として動作します。
'auto'： コンテンツタイプをプレイヤーに自動検出させる場合に設定します。
'vod'： コンテンツタイプがVOD形式のコンテンツを再生する場合に設定します。
'live'： コンテンツがLIVE形式のコンテンツを再生する場合に設定します。
'dvr'： コンテンツタイプがDVR形式のコンテンツを再生する場合に設定します。
デフォルト値： 'auto'

subtitles

字幕用のパラメータです。

subtitles: Object

字幕用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

字幕の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

src: Objectの配列

字幕情報です。
言語毎の情報（以下のlabel、url）を列挙したもので、少なくともひとつは指定してください。

label: 文字列

字幕の言語ラベルです。
必須項目です。字幕ボタンのラベルに用います。文字数が多いと収まらない場合があります。

url: 文字列（URL）

字幕データのURLです。
必須項目です。

defaultIndex: 数値

字幕インデックスの初期値です。
コンテンツの再生を開始する時に表示する字幕です。字幕の初期状態をオフにする場合は、-1を指定します。
デフォルト値： -1

horizontalAlign: 文字列

整列方向です。
'left'： 左寄せ
'right'： 右寄せ
'middle'： 中央寄せ
デフォルト値： 'middle'
ただし、WebVTTのalignの指定がある場合はそちらを優先します。

method: 文字列

字幕の切り替え方法です。
'toggle'： 字幕ボタンを押下する度に字幕を順次切り替えます。
'list'： 字幕ボタンを押下することで字幕メニューを表示／非表示にします。
デフォルト値： 'list'

menuButtonVisible: 真偽値

字幕ボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

parentElementId: 文字列

字幕リストのdiv要素のidです。
指定がない場合、字幕リストは非表示です。

saveLocalStorage: 真偽値

選択中の字幕をローカル記憶領域に保存し、次回の再生に引き継ぐ事の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

background_color

【 deprecated in v1.16.0 】
backgroundColorを使用してください。

backgroundColor

【 deprecated in v1.22.0 】
--uliza-subtitles-background-colorを使用してください。

color

【 deprecated in v1.22.0 】
--uliza-subtitles-colorを使用してください。

font_family

【 deprecated in v1.16.0 】
fontFamilyを使用してください。

fontFamily

【 deprecated in v1.22.0 】
--uliza-subtitles-font-familyを使用してください。

fontSize

【 deprecated in v1.22.0 】
--uliza-subtitles-font-sizeを使用してください。

title

タイトル用のパラメータです。

title: Object

タイトル用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

タイトル表示の有効／無効です。
true： タイトルを表示します。
false： タイトルを非表示にします。
デフォルト値： false

visibleForMobile: 真偽値

モバイル端末のタイトル表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値:true

textJa: 文字列

日本語タイトルです。

text: 文字列

日本語以外のタイトルです。

fontSize

【 deprecated in v1.22.0 】
--uliza-title-font-sizeを使用してください。

videoAnalytics

ULIZA Video Analytics (Cloud)連携用のパラメータです。

videoAnalytics: Object

ULIZA Video Analytics (Cloud)連携用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

ULIZA Video Analytics (Cloud)連携の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

trackingId: 文字列

ビーコンの送信先の識別⼦です。
必須項目です。
使⽤可能な⽂字列は、半⾓英数および記号-です。弊社からお知らせする⽂字列を指定してください。

userId: 文字列

ユーザーIDです。
使⽤可能な⽂字列は、半⾓英数および記号!#$%&' ()*+,-.:;<=>?@[]^_`{|}~です。100 ⽂字以下で指定してください。
未指定の場合、プレイヤー内部に保存している値を使用します。保存している値がない場合、プレイヤーが生成した値を使用し、内部に保存します。

contentName: 文字列

コンテンツの識別子（ID）です。
必須項目です。
他のcontentNameと重複しない値を指定します。
4096文字以下で指定してください。

contentTitle: 文字列

コンテンツタイトルです。
URLエンコードは不要です。指定なしの場合、タイトルが有効な場合、プレイヤーオプションtitle.textJaまたはtitle.textを使用します。いずれも未指定の場合は、コンテンツのURLのパスとクエリ文字列を使用します。
4096文字以下で指定してください。

contentCategory: 文字列

コンテンツカテゴリです。
4096文字以下で指定してください。

defaultTrackingOptout: 真偽値

トラッキングオプトアウトの初期状態です。
ブラウザのローカル記憶領域に保存されたトラッキングオプトアウトの値がある場合、本パラメータより優先します。
true： 有効にします。
false： 無効にします。
デフォルト値： false

trackingOptoutButtonVisible: 真偽値

トラッキングオプトアウトボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： false

takeOverSession: 真偽値

Cast接続時のセッション引き継ぎの有効／無効です。
true：有効にします。
false：無効にします。
デフォルト値：true

enableReaction: 真偽値

ULIZA Video Analytics (Cloud)リアクションの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

reactionItem: Objectの配列

リアクションの情報です。
要素は2個まで指定できます。配列が空の場合はリアクションボタンおよびリアクショングラフを追加しません。

buttonId: 文字列

リアクションIDです。
必須項目です。256文字以内で指定してください。複数のリアクションボタンを使用する場合、重複しない値を指定してください。

buttonVisible: 真偽値

リアクションボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

iconId: 文字列

ボタンのアイコンです。
指定可能なアイコンは以下の通りです。
'uliza-icon-thumbs-up'： サムズアップマーク
'uliza-icon-thumbs-down'： サムズダウンマーク
'uliza-icon-question'： ハテナマーク
'uliza-icon-exclamation'： ビックリマーク
'uliza-icon-circle'： ◯マーク
'uliza-icon-cross'： ×マーク
上記以外のアイコンを使用するにはアイコンフォントのclass属性を指定します。詳細は「インテグレーションガイド」を参照してください。
デフォルト値： 'uliza-icon-thumbs-up'

label: 文字列

リアクションのラベルです。
256文字以下で指定してください。
デフォルト値： 'reaction＜連番＞'

graphVisible: 真偽値

リアクショングラフの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： false

graphColor

【 deprecated in v1.22.0 】
--uliza-reaction-graph-colorを使用してください。

iconfont

【 deprecated in v1.21.0 】
iconIdを使用してください。

reactionGraphButtonVisible: 真偽値

リアクショングラフボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

reactionMaxCount: 数値

リアクション送信最大数です。
ひとつのボタンのリアクションの最大数です。
1以上1024以下を指定してください。
デフォルト：1024

item: Objectの配列

【 deprecated in v1.21.0 】
reactionItemを使用してください。

graphButtonVisible: 真偽値

【 deprecated in v1.21.0 】
reactionGraphButtonVisibleを使用してください。

maxReactionCount: 数値

【 deprecated in v1.21.0 】
reactionMaxCountを使用してください。

videoTrack

画質切り替え用のパラメータです。

videoTrack: Object

画質切り替え用パラメータです。
本オブジェクトが無い場合、機能は有効です。

enable: 真偽値

画質切り替えの有効／無効です。
true： 画質ボタンを表示します（表示する環境の場合）。
false： 画質ボタンを非表示にし、自動選択にします。
デフォルト値： true

menuLabels: 文字列の配列

画質メニューの各項目を置き換える文言です。
画質メニューの項目を、上から順に指定の文字列に置き換えます。文字数が多いと収まらない場合があります。ひとつ目は自動選択に対応した文字列を指定してください。
デフォルト値： ストリームのビデオトラックの帯域幅を使用します。

defaultIndex: 数値

再生を開始する時の画質のビデオトラックインデックスです。
-1以上の整数を指定してください。
-1： 自動選択にします。
0： 最高の画質です。
n： 値が大きい程低画質です。
デフォルト値： -1

menuButtonVisible: 真偽値

画質ボタンの表示／非表示です。
true： 表示します。
false： 非表示にします。
デフォルト値： true

method: 文字列

画質の切り替え方法です。
'toggle'： 画質ボタンを押下する度に画質を順次切り替えます。
'list'： 画質ボタンを押下することで画質メニューを表示／非表示にします。
デフォルト値： 'list'

saveLocalStorage: 真偽値

選択中の画質をローカル記憶領域に保存し、次回の再生に引き継ぐ事の有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： true

watermark

ウォーターマーク用のパラメータです。

watermark: Object

ウォーターマーク用パラメータです。
本オブジェクトが無い場合、機能は無効です。

enable: 真偽値

ウォーターマークの有効／無効です。
true： 有効にします。
false： 無効にします。
デフォルト値： false

url: 文字列（URL）

ウォーターマーク画像の取得URLです。
ウォーターマークで使用する画像のURLを指定します。

position: 文字列

ウォーターマーク表示位置です。
'topleft'： 左上表示
'topright'： 右上表示
'topcenter'： 中央上表示
デフォルト値： 'topright'

width

【 deprecated in v1.22.0 】
--uliza-watermark-widthを使用してください。

height

【 deprecated in v1.22.0 】
--uliza-watermark-heightを使用してください。

coordinate

【 deprecated in v1.22.0 】

width

プレイヤーの幅用のパラメータです。

width: 数値＜px＞／文字列

プレイヤーの幅です。
video要素のwidth属性よりも本設定を優先します。0（ピクセル換算）より大きな値を指定してください。無効な値は無視します。文字列を指定する場合、単位部分を 'px'、'%' としてください。
デフォルト値： 0
※ ただし、heightも未指定の場合は親要素の幅になります。

deprecatedパラメータ

以下は、非サポートのパラメータです。これらのパラメータは予告なしに削除する場合がありますので、使用しないで下さい。現在使用している場合、代替のパラメータを使用して下さい。

backgroundColor 【 deprecated in v1.22.0 】

--uliza-base-background-colorを使用してください。

centerPlayToggleVisible 【 deprecated in v1.12.0 】

controllerのcenterPlayToggleVisibleを使用してください。

controlBarColor 【 deprecated in v1.12.0 】

controllerのcontrolBarColorを使用してください。

fixedControlBar 【 deprecated in v1.12.0 】

controllerのfixedControlBarを使用してください。

inactivityPauseTimeout 【 deprecated in v1.12.0 】

controllerのinactivityPauseTimeoutを使用してください。

inactivityTimeout 【 deprecated in v1.12.0 】

controllerのinactivityTimeoutを使用してください。

playToggleVisible 【 deprecated in v1.12.0 】

controllerのplayToggleVisibleを使用してください。

reaction 【 deprecated in v1.22.0 】

videoAnalyticsを使用してください。

showCenterPlayToggle 【 deprecated in v1.12.0 】

controllerのcenterPlayToggleVisibleを使用してください。

showPlayToggle 【 deprecated in v1.12.0 】

controllerのplayToggleVisibleを使用してください。

showVolumeControl 【 deprecated in v1.12.0 】

controllerのvolumeControlVisibleを使用してください。

volumeBarVertical 【 deprecated in v1.12.0 】

controllerのvolumeBarVerticalを使用してください。

volumeControlVisible 【 deprecated in v1.12.0 】

controllerのvolumeControlVisibleを使用してください。