# UlizaPlayer

# メソッド

# addButton

プレイヤー表示領域にボタンを追加します。

【引数】

obj: Object
ボタン追加時のパラメータです。
JSON形式で指定します。指定可能な値は以下の通りです。
hideUserInactive
プレイヤーが再生中でかつプレイヤー表示領域で一定時間ユーザーの操作がない場合にボタンを非表示にするかどうかを設定します。
true: ボタンを非表示にします。
false: ボタンを表示し続けます。
デフォルト値: false

【戻り値】

return: Object
UlizaPlayerに追加したボタンの div 要素です。

# addControlBarButton

コントロールバーボタンを追加します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

itemOption: Object
コントロールバーボタン情報です。
詳細はcontrolBarButtonを参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: コントロールバーボタンの追加に成功した。
false: コントロールバーボタンの追加に失敗した。

# appendCenterControllerLine

センターコントローラーに行を追加します。

【引数】

なし

【戻り値】

return: 数値
追加した行のインデックスです。

# createCenterPlayPauseButton

センターコントローラーの再生/一時停止ボタンを生成します。

【引数】

なし

【戻り値】

return: Object
再生/一時停止ボタンの要素です。

# createCenterSkipBackwardButton

センターコントローラーの戻るボタンを生成します。進む/戻る機能が無効の場合は表示しません。

【引数】

sec: 数値<秒>
オプショナルです。
ボタン押下時に後方シークする秒数です。未指定の場合は進む/戻る機能の値を適用します。

【戻り値】

return: Object
戻るボタンの要素です。

# createCenterSkipForwardButton

センターコントローラーの進むボタンを生成します。進む/戻る機能が無効の場合は表示しません。

【引数】

sec: 数値<秒>
オプショナルです。
ボタン押下時に前方シークする秒数です。未指定の場合は進む/戻る機能の値を適用します。

【戻り値】

return: Object
進むボタンの要素です。

# createCenterStartPlayButton

再生開始ボタンを生成します。

【引数】

なし

【戻り値】

return: Object
再生開始ボタンの要素です。

# dispose

UlizaPlayerのインスタンスを破棄します。

【引数】

なし

【戻り値】

なし

# getAdvertising

広告用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
広告用パラメータです。
詳細は advertising を参照してください。未指定のパラメータは省略して返します。

# getAlternativeImage

表示中の代替画像のURLを取得します。

【引数】

なし

【戻り値】

return: 文字列
代替画像のURLです。

# getAspectRatio

現在のプレイヤーのアスペクト比を取得します。

【引数】

なし

【戻り値】

return: 文字列
現在のプレイヤーのアスペクト比です。
詳細は aspectRatio を参照してください。

# getAudioTrack

オーディオ切り替え用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
オーディオ切り替え用パラメータです。
詳細は audioTrack を参照してください。未指定のパラメータは省略して返します。

# getAudioTrackArray

再生中のコンテンツのオーディオトラック情報のリストを取得します。

【引数】

なし

【戻り値】

return: Objectの配列
オーディオトラック情報のリストです。
再生中のコンテンツのオーディオトラック情報を取得できます。

# getBeacon

ビーコン用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
ビーコン用パラメータです。
詳細は beacon を参照してください。未設定のパラメータは省略して返します。

# getCenterControllerLine

センターコントローラーの行を取得します。

【引数】

index: 数値
行のインデックスです。

【戻り値】

return: Object
行の要素です。

# getCenterControllerLines

センターコントローラーの行の配列を取得します。

【引数】

なし

【戻り値】

return: Objectの配列
行の要素の配列です。

# getChapter

チャプター用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
チャプター用パラメータです。
詳細は chapter を参照してください。

# getChapterArray

チャプター情報のリストを取得します。

【引数】

なし

【戻り値】

return: Objectの配列
チャプター情報のリストです。
詳細は chapter を参照してください。

# getControlBarButton

コントロールバーボタン追加用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
コントロールバーボタン追加用パラメータです。
詳細は controlBarButton を参照してください。未設定のパラメータは省略して返します。

# getControlBarButtonVisible

コントロールバーボタンの表示/非表示を取得します。

【引数】

id: 文字列
コントロールバーボタンの識別子です。
詳細は controlBarButton を参照してください。

【戻り値】

return: 真偽値
コントロールバーボタンの表示状態です。
true: 表示している。
false: 表示していない。

# getController

コントローラーカスタマイズ用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
コントローラーカスタマイズ用パラメータです。
詳細は controller を参照してください。未設定のパラメータは省略して返します。

# getControls

コントローラーの操作可否を取得します。

【引数】

なし

【戻り値】

return: 真偽値
コントローラーの操作可否です。
true: コントローラーの操作が可能。
false: コントローラーの操作が不可能。

# getCurrentAudioTrack

選択されているオーディオトラックの情報を取得します。本APIを利用できない環境については、「ユーザーガイド (opens new window)」を参照してください。

【引数】

なし

【戻り値】

return: Object
選択されているオーディオトラックの情報です。

# getCurrentChapter

選択されているチャプターの情報を取得します。

【引数】

なし

【戻り値】

return: Object
選択されているチャプターの情報です。

# getCurrentMultiAngleIndex

選択されているアングルのインデックスを取得します。

【引数】

なし

【戻り値】

return: 数値
選択されているアングルのインデックスです。

# getCurrentPartsSizeIndex

選択されているパーツサイズインデックスの値を取得します。

【引数】

なし

【戻り値】

return: 数値
選択されているパーツサイズインデックスです。

# getCurrentScale

本編の拡大率を取得します。

【引数】

なし

【戻り値】

return: 数値<%>
現在の本編の拡大率です。

# getCurrentSubtitle

選択されている字幕インデックスの値を取得します。

【引数】

なし

【戻り値】

return: 数値
選択されている字幕インデックスです。
字幕が非表示の場合は、-1が戻り値です。

# getCurrentTime

コンテンツの現在の再生位置を取得します。切り出し再生が有効の場合、切り出し後の再生位置を取得します。

【引数】

なし

【戻り値】

return: 数値<秒>
コンテンツの現在の再生位置です。

# getCurrentVideoTrack

選択されているビデオトラックの情報を取得します。本APIを利用できない環境については、「ユーザーガイド (opens new window)」を参照してください。

【引数】

なし

【戻り値】

return: Object
選択されているビデオトラックの情報です。 選択されているビデオトラックの情報には以下の情報が含まれます。
auto ビデオトラック自動選択です。
true: 自動選択の場合
false: 自動選択ではない場合
真偽値
current ビデオトラックインデックスです。 数値

# getCustomLayer

カスタムレイヤー用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
カスタムレイヤー用パラメータです。
詳細は customLayer を参照してください。

# getCustomLayerElement

カスタムレイヤーの要素を取得します。

【引数】

なし

【戻り値】

return: Object
カスタムレイヤーの要素です。

# getCustomLayerVisible

カスタムレイヤーの表示/非表示を取得します。

【引数】

なし

【戻り値】

return: 真偽値
カスタムレイヤーの表示状態です。
true: 表示している。
false: 表示していない。

# getDisableRemoteSeek

リモートシーク制御の有効/無効を取得します。

【引数】

なし

【戻り値】

return: 真偽値
リモートシーク制御の有効/無効です。
詳細は disableRemoteSeek を参照してください。

# getDuration

コンテンツの尺を取得します。切り出し再生が有効の場合、切り出し後のコンテンツの尺を取得します。

【引数】

なし

【戻り値】

return: 数値<秒>
コンテンツの尺です。

# getEnableKeepLiveHead

HLS(LIVE)で一時停止の後、再生を再開する際にLIVEの先頭から再生を再開するか否かを取得します。

【引数】

なし

【戻り値】

return: 真偽値
HLS(LIVE)で一時停止の後、再生を再開する際にLIVEの先頭から再生を再開するか否かです。
詳細は live を参照してください。

# getEnablePlayToggleInPlayerArea

PCブラウザでの再生における、プレイヤー表示領域の押下による再生状態/一時停止状態の切り替えの許可、不許可を取得します。

【引数】

なし

【戻り値】

return: 真偽値
(PCブラウザ用)プレイヤー表示領域の押下による再生状態/一時停止状態の切り替えの許可/不許可です。
詳細は enablePlayToggleInPlayerArea を参照してください。

# getEnablePlayToggleInPlayerAreaForMobile

モバイルブラウザでの再生における、プレイヤー表示領域の押下による再生状態/一時停止状態の切り替えの許可、不許可を取得します。

【引数】

なし

【戻り値】

return: 真偽値
(モバイルブラウザ用)プレイヤー表示領域の押下による再生状態/一時停止状態の切り替えの許可/不許可です。
詳細は enablePlayToggleInPlayerAreaForMobile を参照してください。

# getEnableSeekBarByUser

シークバーの操作許可/不許可を取得します。

【引数】

なし

【戻り値】

return: 真偽値
シークバーの操作許可/不許可です。
詳細は controller を参照してください。

# getEnlargement

拡大表示用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
拡大表示用パラメータです。
詳細は enlargement を参照してください。未設定のパラメータは省略して返します。

# getError

プレイヤーで発生したエラーを取得します。

【引数】

なし

【戻り値】

return: Object
エラーの内容です。

# getFixedControlBar

コントロールバーの表示位置を取得します。

【引数】

なし

【戻り値】

return: 真偽値
コントロールバーの表示位置です。
詳細は controller を参照してください。

# getFullscreenType

現在のプレイヤー画面の拡大方式を取得します。

【引数】

なし

【戻り値】

return: 文字列
現在のプレイヤー画面の拡大方式です。
詳細は fullscreenType を参照してください。

# getGestureControl

ジェスチャー用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
ジェスチャー用パラメータです。
詳細は gestureControl を参照してください。未設定のパラメータは省略して返します。

# getGooglecast

Google Cast Sender用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
Google Cast Sender用パラメータです。
詳細は googlecast を参照してください。未設定のパラメータは省略して返します。

# getHeight

現在のプレイヤーの高さを取得します。

【引数】

なし

【戻り値】

return: 数値<px>
現在のプレイヤーの高さです。
詳細は height を参照してください。

# getHelp

ヘルプ用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
ヘルプ用パラメータです。
詳細は help を参照してください。

# getHelpButtonVisible

ヘルプボタンの表示/非表示を取得します。

【引数】

なし

【戻り値】

return: 真偽値
ヘルプボタンの表示/非表示です。
詳細は help を参照してください。

# getHelpVisible

ヘルプの表示/非表示を取得します。

【引数】

なし

【戻り値】

return: 真偽値
ヘルプの表示状態です。
true: 表示している。
false: 表示していない。

# getHotkey

ホットキー用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
ホットキー用パラメータです。
詳細は hotkey を参照してください。未設定のパラメータは省略して返します。

# getInactivityPauseTimeout

一時停止状態でコントローラーおよびタイトルを表示してから自動的に非表示になるまでの時間を取得します。

【引数】

なし

【戻り値】

return: 数値<ミリ秒>
一時停止状態でコントローラーを表示してから自動的に非表示になるまでの時間です。
詳細は controller を参照してください。

# getInactivityTimeout

再生状態でコントローラーおよびタイトルを表示してから自動的に非表示になるまでの時間を取得します。

【引数】

なし

【戻り値】

return: 数値<ミリ秒>
再生状態でコントローラーを表示してから自動的に非表示になるまでの時間です。
詳細は controller を参照してください。

# getLiveMonitoring

LIVE配信監視用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
LIVE配信監視用パラメータです。
詳細は liveMonitoring を参照してください。

# getMultiAngle

マルチアングル動画再生用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
マルチアングル動画再生用パラメータです。
詳細は multiAngle を参照してください。

# getMuted

ミュート状態を取得します。

【引数】

なし

【戻り値】

return: 真偽値
現在のプレイヤーのミュート状態です。
詳細は muted を参照してください。

# getNextPrevContent

次/前コンテンツ用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
次/前コンテンツ用パラメータです。
詳細は nextPrevContent を参照してください。

# getOriginalCurrentTime

コンテンツの現在の再生位置を取得します。切り出し再生が有効の場合、切り出し前の再生位置を取得します。

【引数】

なし

【戻り値】

return: 数値<秒>
コンテンツの現在の再生位置です。

# getOriginalDuration

コンテンツの尺を取得します。切り出し再生が有効の場合、切り出し前のコンテンツの尺を取得します。

【引数】

なし

【戻り値】

return: 数値<秒>
コンテンツの尺です。
環境や状態によってはInfinityを返します。

# getPartsSize

パーツサイズ用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
パーツサイズ用パラメータです。
詳細は partsSize を参照してください。

# getPlaybackRange

切り出し再生用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
切り出し再生用パラメータです。
詳細は playbackRange を参照してください。

# getPlaybackRate

再生中のコンテンツの再生速度を取得します。

【引数】

なし

【戻り値】

return: 数値<倍>
現在の再生中のコンテンツの再生速度です。

# getPlaybackRates

倍速再生用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
倍速再生用パラメータです。
詳細は playbackRates を参照してください。未設定のパラメータは省略して返します。

# getPlayerStatus

プレイヤーの状態を取得します。

【引数】

なし

【戻り値】

return: Object
プレイヤーの状態です。 プレイヤーの状態には以下の情報が含まれます。
status 現在の再生の状態です。以下のいずれかです。
'preStart': 再生開始前/レジューム確認待ち状態中
'main': 本編の再生中
'ad': リニア広告の再生中
'complete': 完全視聴完了
'error': エラー発生
文字列
externalOutput 現在のCast接続状態または、AirPlay接続状態です。 真偽値
main 本編の再生の状態です。 Object
    status 現在の本編の再生の状態です。以下のいずれかです。
'prepare': 再生準備中
'play': 再生状態
'pause': 一時停止状態/プリロール、ミッドロールの再生中
'seek': シーク中
'stop': 再生開始前/ポストロールの再生中/完全視聴完了/エラー発生
文字列
    started 現在の本編の視聴状態です。mainのstatusが 'play'、'pause' または 'seek' の場合はtrueです。 真偽値
    paused プレイヤーの再生/一時停止状態です。シーク操作中はtrue、シーク中はfalseです。 真偽値
    panorama パノラマ動画再生用パラメータの有無です。 真偽値
ad リニア広告の再生の状態です。 Object
    status 現在のリニア広告の再生の状態です。
以下のいずれかです。
'prepare': 再生準備中
'play': 再生状態
'pause': 一時停止状態
'stop': 本編の再生開始前/本編の再生中/完全視聴完了/エラー発生
文字列
    started 現在のリニア広告の視聴状態です。adのstatusが 'play' および 'pause' の場合はtrueです。 真偽値
    paused プレイヤーの再生状態/一時停止状態です。シーク操作中はtrue、シーク中はfalseです。 真偽値
    offset 現在のリニア広告の種類です。
以下のいずれかです。
'preroll': プリロール
'midroll': ミッドロール
'postroll': ポストロール
'none': 本編の再生開始前/本編の再生中/完全視聴完了
文字列
    smallWindowMode 現在の小窓の表示モードです。以下のいずれかです。
'default': 本編非表示モード(小窓表示無効)
'mainReduce': 本編縮小表示モード
'adReduce': 広告縮小表示モード
'none': 本編表示
文字列

# getPlayStartButtonEffect

再生開始ボタンのアニメーションを取得します。

【引数】

なし

【戻り値】

return: 文字列
再生開始ボタンのアニメーションです。
詳細は controller を参照してください。

# getPoster

ポスター画像のURLを取得します。

【引数】

なし

【戻り値】

return: 文字列(URL)
ポスター画像のURLです。
詳細は poster を参照してください。

# getPosterSlideShow

スライドショー用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
スライドショー用パラメータです。
詳細は posterSlideShow を参照してください。未設定のパラメータは省略して返します。

# getPresentation

プレゼンテーション用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
プレゼンテーション用パラメータです。
詳細は presentation を参照してください。未設定のパラメータは省略して返します。

# getReactionButtonVisible

リアクションボタンの表示/非表示を取得します。

【引数】

index: 数値
オプショナルです。
リアクションインデックスです。未指定の場合は0を適用します。

【戻り値】

return: 真偽値
リアクションボタンの表示/非表示です。
詳細は videoAnalytics を参照してください。

# getReactionGraphData

リアクショングラフ作成用のデータを取得します。

【引数】

index: 数値
オプショナルです。
リアクションインデックスです。未指定の場合は0を適用します。

【戻り値】

return: Objectの配列
リアクショングラフ作成用のデータです。 リアクショングラフ作成用のデータには以下の情報が含まれます。
reaction_point セグメント先頭の位置です。セグメントはコンテンツの尺を100等分した各範囲です。 数値<%>
count セグメント毎のリアクションされた回数です。 数値<回>

# getReactionGraphVisible

リアクショングラフの表示/非表示を取得します。

【引数】

index: 数値
オプショナルです。
リアクションインデックスです。未指定の場合は0を適用します。

【戻り値】

return: 真偽値
リアクショングラフの表示/非表示です。
詳細は videoAnalytics を参照してください。

# getReactionTotalCount

リアクションボタンの総押下数を取得します。

【引数】

index: 数値
オプショナルです。
リアクションインデックスです。未指定の場合は0を適用します。

【戻り値】

return: 数値<回>
リアクションボタンの総押下数です。

# getRepeat

リピート用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
リピート用パラメータです。
詳細は repeat を参照してください。未指定のパラメータは省略して返します。

# getResumePlayback

レジューム再生用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
レジューム再生用パラメータです。
詳細は resumePlayback を参照してください。未設定のパラメータは省略して返します。

# getSaveVolumeInfo

ボリューム情報の保存の許可/不許可を取得します。

【引数】

なし

【戻り値】

return: 真偽値
ボリューム情報の保存の許可/不許可です。
詳細は saveVolumeInfo を参照してください。

# getScreenLock

画面ロック用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
画面ロック用パラメータです。
詳細は screenLock を参照してください。

# getScreenLockStatus

画面ロックの状態を取得します。

【引数】

なし

【戻り値】

return: 真偽値
画面ロック状態です。
true: 画面ロックしている。
false: 画面ロックしていない。

# getSeekableRangeEnd

シーク有効範囲の終了位置を取得します。

【引数】

なし

【戻り値】

return: 数値<秒>/文字列
シーク有効範囲の終了位置です。
詳細は seekableRange を参照してください。

# getSeekableRangeOptions

シーク範囲制御用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
シーク範囲制御用パラメータです。
詳細は seekableRange を参照してください。

# getSeekableRangeStart

シーク有効範囲の開始位置を取得します。

【引数】

なし

【戻り値】

return: 数値<秒>
シーク有効範囲の開始位置です。
詳細は seekableRange を参照してください。

# getSeekpreview

シークプレビュー用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
シークプレビュー用パラメータです。
詳細は seekpreview を参照してください。未設定のパラメータは省略して返します。

# getSettingMenu

設定メニュー用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
設定メニュー用パラメータです。
詳細は settingMenu を参照してください。未設定のパラメータは省略して返します。

# getSettingMenuVisible

設定メニューの表示/非表示を取得します。

【引数】

なし

【戻り値】

return: 真偽値
設定メニューの表示状態です。
true: 表示している。
false: 表示していない。

# getSkin

現在のスキン名を取得します。

【引数】

なし

【戻り値】

return: 文字列
現在のスキン名です。
詳細は skin を参照してください。

# getSkipBackwardSeconds

現在の戻るボタン押下時に後方シークする秒数を取得します。

【引数】

なし

【戻り値】

return: 数値<秒>
現在の戻るボタン押下時に後方シークする秒数です。
詳細は skipForwardAndBackward を参照してください。

# getSkipForwardAndBackward

進む/戻る用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
進む/戻る用パラメータです。
詳細は skipForwardAndBackward を参照してください。未指定のパラメータは省略して返します。

# getSkipForwardSeconds

現在の進むボタン押下時に前方シークする秒数を取得します。

【引数】

なし

【戻り値】

return: 数値<秒>
現在の進むボタン押下時に前方シークする秒数です。
詳細は skipForwardAndBackward を参照してください。

# getSources

コンテンツのメディアソースを取得します。

【引数】

なし

【戻り値】

return: Object
コンテンツのメディアソースです。
詳細は sources を参照してください。

# getStreamType

コンテンツタイプを取得します。

【引数】

なし

【戻り値】

return: 文字列
コンテンツタイプです。
詳細は streamType を参照してください。プレイヤーオプションstreamTypeが 'auto' の場合、コンテンツタイプを検出中は 'auto' です。
コンテンツタイプの検出完了後は検出したコンテンツタイプです。

# getSubtitleArray

再生中のコンテンツの字幕情報のリストを取得します。

【引数】

なし

【戻り値】

return: Objectの配列
字幕情報のリストです。
詳細は subtitles を参照してください。字幕情報を取得できない場合、またはプレイヤーオプションで字幕を無効にする場合、空の配列です。

# getSubtitles

字幕用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
字幕用パラメータです。
詳細は subtitles を参照してください。未設定のパラメータは省略して返します。

# getTitleOptions

タイトル用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
タイトル用パラメータです。
詳細は title を参照してください。

# getTrackingOptout

トラッキングオプトアウトの有効/無効を取得します。

【引数】

なし

【戻り値】

return: 真偽値
現在のトラッキングオプトアウトの有効/無効です。

# getVersion

プレイヤーのバージョンを取得します。

【引数】

なし

【戻り値】

return: 文字列
プレイヤーのバージョンです。

# getVideoAnalyticsOptions

ULIZA Video Analytics (Cloud)連携用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
ULIZA Video Analytics (Cloud)連携用パラメータです。
詳細は videoAnalytics を参照してください。未設定のパラメータは省略して返します。

# getVideoTrack

画質切り替え用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
画質切り替え用パラメータです。
詳細は videoTrack を参照してください。未設定のパラメータは省略して返します。

# getVideoTrackArray

再生中のコンテンツのビデオトラック情報のリストを取得します。本APIを利用できない環境については、「ユーザーガイド (opens new window)」を参照してください。

【引数】

なし

【戻り値】

return: Objectの配列
ビデオトラック情報のリストです。
再生中のコンテンツのビデオトラック情報を取得できます。ビデオトラック情報の並び順は、bandwidthの降順です。コンテンツに同じbandwidthのビデオトラックが含まれる場合、同じbandwidthのビデオトラックのうち、プレイヤーが最初に検出するビデオトラック情報のみをリストに含めます。
ビデオトラック情報には以下の情報が含まれます。
bandwidth ビデオトラックの帯域幅です。 数値<bps>
height ビデオトラックの動画の高さです。
※ ビデオトラックの動画の高さを取得できなかった場合、このパラメータはビデオトラック情報に含まれません。
数値<px>
label 画質メニューに表示中のラベルです。 文字列
width ビデオトラックの動画の幅です。
※ ビデオトラックの動画の幅を取得できなかった場合、このパラメータはビデオトラック情報に含まれません。
数値<px>

# getVisibleVideoAreaRect

動画表示領域の座標およびサイズを取得します。

注意

次に示す再生では、本APIにより正しい値を取得できない場合があります。

  • ulizahtml5()の実行直後
  • fullscreenchangeイベントの通知直後

【引数】

なし

【戻り値】

return: Object
現在の動画表示領域の座標およびサイズです。
座標はプレイヤー領域の左上を原点とした座標を指定します。
現在の動画表示領域の座標およびサイズには以下の情報が含まれます。
top 動画表示領域の垂直方向の座標です。 数値
left 動画表示領域の水平方向の座標です。 数値
height 動画表示領域の幅です。 数値
width 動画表示領域の高さです。 数値

# getVolume

プレイヤーの音量を取得します。

【引数】

なし

【戻り値】

return: 数値
現在のプレイヤーの音量です。
音量は0 ~ 1の範囲です。iOSでは常に1です。

# getVolumeBarVertical

ボリュームバーの表示形式が縦表示かどうかを取得します。

【引数】

なし

【戻り値】

return: 真偽値
現在のボリュームバーの表示形式です。
詳細は controller を参照してください。

# getVolumeControlVisible

ボリュームボタンの表示/非表示を取得します。

【引数】

なし

【戻り値】

return: 真偽値
ボリュームボタンの表示/非表示です。
詳細は controller を参照してください。

# getWatermark

ウォーターマーク用パラメータを取得します。

【引数】

なし

【戻り値】

return: Object
ウォーターマーク用パラメータです。
詳細は watermark を参照してください。未設定のパラメータは省略して返します。

# getWatermarkPosition

現在のウォーターマーク表示位置を取得します。

【引数】

なし

【戻り値】

return: 文字列
現在のウォーターマーク表示位置です。
詳細は watermark を参照してください。

# getWatermarkUrl

現在のウォーターマーク画像のURLを取得します。

【引数】

なし

【戻り値】

return: 文字列(URL)
現在のウォーターマーク画像のURLです。

# getWatermarkVisible

現在のウォーターマークの表示状態を取得します。

【引数】

なし

【戻り値】

return: 真偽値
現在のウォーターマークの表示状態です。
true: 表示している。
false: 表示していない。

# getWidth

現在のプレイヤーの幅を取得します。

【引数】

なし

【戻り値】

return: 数値<px>
現在のプレイヤーの幅です。
詳細は width を参照してください。

# init

プレイヤーの初期化を行います。プレイヤーオプションを変更(コンテンツ切り替え)するには、API「setOptions」実行後に本APIを実行します。

【引数】

なし

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# isConnectingAirPlay

AirPlay接続状態を取得します。

【引数】

なし

【戻り値】

return: 真偽値
現在のAirPlay接続状態です。
true: AirPlay接続状態です。
false: AirPlay未接続状態です。

# isConnectingCast

Cast接続状態を取得します。

【引数】

なし

【戻り値】

return: 真偽値
現在のCast接続状態です。
true: Cast中です。
false: Cast中ではありません。

# isFullscreen

プレイヤー画面がフルスクリーン状態か否かを取得します。

【引数】

なし

【戻り値】

return: 真偽値
現在のプレイヤー画面がフルスクリーン状態か否かです。
true: フルスクリーン状態です。
false: インライン状態です。

# isLiveMonitoring

LIVE配信監視状態を取得します。

【引数】

なし

【戻り値】

return: 真偽値
LIVE配信監視状態です。
true: LIVE配信監視が有効です。
false: LIVE配信監視が無効です。

# isLiveMonitoringSuccess

LIVE配信状態を取得します。

【引数】

なし

【戻り値】

return: 真偽値
LIVE配信状態です。
true: LIVEは配信中です。
false: LIVEは配信中ではありません。

# off

設定したコールバックを削除します。

【引数】

event: 文字列
コールバックの設定を削除するイベントです。
callback: Function
コールバックの設定を削除する関数です。

【戻り値】

return: Object
UlizaPlayerのインスタンスです。

# on

コールバックを設定します。

【引数】

event: 文字列
コールバックのイベントです。
callback: Function
イベントが発生した時に実行する関数です。

【戻り値】

return: Object
UlizaPlayerのインスタンスです。

# one

1度だけ実行するコールバックを設定します。

【引数】

event: 文字列
コールバックのイベントです。
callback: Function
イベントが発生した時に実行する関数です。

【戻り値】

return: Object
UlizaPlayerのインスタンスです。

VASTのClickThrough要素で指定のWEBページを新規タブで表示します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • 本編の再生
  • オーディオの再生
  • 広告再生(Google仕様)

【引数】

なし

【戻り値】

なし

# pause

プレイヤーが再生状態の場合、一時停止状態に切り替えます。

【引数】

なし

【戻り値】

なし

# play

プレイヤーが一時停止中状態の場合、再生状態に切り替えます。ユーザー操作を契機としないタイミングで実行する場合、プラットフォームにより無視される場合があります。

【引数】

なし

【戻り値】

なし

# playNext

プレイリストと連携して、再生中のコンテンツの次のコンテンツを再生します。次のコンテンツについては「ユーザーガイド (opens new window)」を参照してください。

【引数】

なし

【戻り値】

なし

# playPrevious

プレイリストと連携して、再生中のコンテンツの前のコンテンツを再生します。前のコンテンツについては「ユーザーガイド (opens new window)」を参照してください。

【引数】

なし

【戻り値】

なし

# pressAppCastButton

ULIZA Player (Android)と連携し、Castデバイスリスト画面を表示します。

【引数】

なし

【戻り値】

なし

# reactionCountUp

リアクション情報をカウントアップします。

注意

次に示す再生では、本APIによる設定は適用されません。

  • ULIZA Video Analytics (Cloud)が無効のプレイヤーでの再生
  • リアクションが無効のプレイヤーでの再生
  • LIVE/DVRでの再生
  • リニア広告の再生
  • 本編再生開始前および本編再生終了後

【引数】

index: 数値
オプショナルです。
リアクションインデックスです。未指定の場合は0を適用します。

【戻り値】

return: 真偽値
実行結果です。
true: カウントアップに成功した。
false: カウントアップに失敗した。

# reload

コンテンツをリロードします。

DASHコンテンツは非サポートです。

【引数】

なし

【戻り値】

なし

# removeAudioTrackLocalStorage

ブラウザのローカル記憶領域に保存されたオーディオを削除します。

【引数】

なし

【戻り値】

なし

# removeCenterControllerLine

センターコントローラーの行を削除します。

【引数】

index: 数値
行のインデックスです。

【戻り値】

return: 真偽値
実行結果です。
true: 削除に成功した。
false: 削除に失敗した。

# removeMultiAngleLocalStorage

ブラウザのローカル記憶領域に保存されたアングルを削除します。

【引数】

なし

【戻り値】

なし

# removePartsSizeLocalStorage

ブラウザのローカル記憶領域に保存されたパーツサイズを削除します。

【引数】

なし

【戻り値】

なし

# removePlaybackRateLocalStorage

ブラウザのローカル記憶領域に保存された再生速度を削除します。

【引数】

なし

【戻り値】

なし

# removePresentationFullscreenViewLocalStorage

ブラウザのローカル記憶領域に保存された資料の表示状態を削除します。

【引数】

なし

【戻り値】

なし

# removeResumePlaybackLocalStorage

ブラウザのローカル記憶領域に保存された再生位置を削除します。

【引数】

なし

【戻り値】

なし

# removeSubtitleLocalStorage

ブラウザのローカル記憶領域に保存された字幕を削除します。

【引数】

なし

【戻り値】

なし

# removeVideoTrackLocalStorage

ブラウザのローカル記憶領域に保存された画質を削除します。

【引数】

なし

【戻り値】

なし

# removeVolumeLocalStorage

ブラウザのローカル記憶領域に保存されたボリューム/ミュートの情報を削除します。

【引数】

なし

【戻り値】

なし

# seekBackward

後方シークします。シークする秒数は、進む/戻る機能で指定の値です。

注意

次に示す再生では、本APIは適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • 進む/戻るが無効のプレイヤーでの再生
  • リニア広告の再生
  • LIVEの再生
  • 再生開始前

【引数】

なし

【戻り値】

return: 真偽値
シーク結果です。
true: シークに成功した。
false: シークに失敗した。

# seekBackwardBySeconds

指定秒数後方シークします。

注意

次に示す再生では、本APIは適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • リニア広告の再生
  • LIVEの再生
  • 再生開始前

【引数】

seconds: 数値<秒>
後方シークする秒数です。

【戻り値】

return: 真偽値
シーク結果です。
true: シークに成功した。
false: シークに失敗した。

# seekForward

前方シークします。シークする秒数は、進む/戻る機能で指定の値です。

注意

次に示す再生では、本APIは適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • 進む/戻るが無効のプレイヤーでの再生
  • リニア広告の再生
  • LIVEの再生
  • 再生開始前
  • 再生完了後

【引数】

なし

【戻り値】

return: 真偽値
シーク結果です。
true: シークに成功した。
false: シークに失敗した。

# seekForwardBySeconds

指定秒数前方シークします。

注意

次に示す再生では、本APIは適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • リニア広告の再生
  • LIVEの再生
  • 再生開始前
  • 再生完了後

【引数】

seconds: 数値<秒>
前方シークする秒数です。

【戻り値】

return: 真偽値
シーク結果です。
true: シークに成功した。
false: シークに失敗した。

# seekTo

シークします。広告再生中はシークに失敗します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • リニア広告の再生
  • LIVEの再生
  • 再生開始前
  • 再生完了後

【引数】

seconds: 数値<秒>
シークする秒数です。

【戻り値】

return: 真偽値
シーク結果です。
true: シークに成功した。
false: シークに失敗した。

# setAlternativeImage

代替画像を表示します。

【引数】

url: String
代替画像のURLです。
undefinedを指定すると、表示中の代替画像を非表示にします。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setAspectRatio

プレイヤーのアスペクト比を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生
  • プレイヤーの高さが指定されている環境での再生

【引数】

value: 文字列
プレイヤーのアスペクト比です。
詳細は aspectRatio を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setAudioTrack

オーディオ切り替え用パラメータを設定します。不正な値の場合はデフォルト値になります。

【引数】

params: Object
オーディオ切り替え用パラメータです。
詳細は audioTrack を参照してください。未指定のパラメータは、デフォルト値になります。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setAudioTrackMenuButtonVisible

音声ボタンの表示/非表示を設定します。

注意

オーディオ切り替えが非サポートの環境、オーディオ切り替えが無効の場合、本APIによる設定は適用されません。音声ボタンを表示しない環境や配信方式については、「ユーザーガイド (opens new window)」を参照してください。

【引数】

bool: 真偽値
音声ボタンの表示/非表示です。
詳細は audioTrack を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setBeginningButtonVisible

開始位置ボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • リニア広告の再生
  • LIVE/DVRでの再生
  • 再生開始前
  • 再生完了後

【引数】

bool: 真偽値
開始位置ボタンの表示/非表示です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setCenterControllerVisible

PCブラウザでのセンターコントローラーの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生

【引数】

bool: 真偽値
PCブラウザでのセンターコントローラーの表示/非表示です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setCenterControllerVisibleForMobile

モバイルブラウザでのセンターコントローラーの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生

【引数】

bool: 真偽値
モバイルブラウザでのセンターコントローラーの表示/非表示です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setCenterForwardAndBackwardVisible

センターコントローラー上の進む/戻るボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生
  • リニア広告の再生
  • LIVEの再生

【引数】

bool: 真偽値
センターコントローラー上の進む/戻るボタンの表示/非表示です。
詳細は skipForwardAndBackward を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setCenterPlayStartVisible

再生開始ボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • 本編の再生
  • オーディオの再生

【引数】

bool: 真偽値
再生開始ボタンの表⽰/⾮表⽰です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setCenterPlayToggleVisible

本編及び広告再生中のセンターコントローラー上の再生/一時停止ボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生
  • 再生開始前

【引数】

bool: 真偽値
本編及び広告再生中のセンターコントローラー上の再生/一時停止ボタンの表示/非表示です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setChapter

チャプター用パラメータを設定します。不正な値の場合はデフォルト値になります。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • LIVE/DVRの再生

【引数】

params: Object
チャプター用パラメータです。
詳細は chapter を参照してください。未指定のパラメータは、デフォルト値になります。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setControlBarButton

コントロールバーボタンを上書きで設定します。すでに設定されているコントロールバーボタンは削除します。不正な値の場合はデフォルト値になります。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

itemOptions: Object
コントロールバーボタン追加用パラメータです。
詳細は controlBarButton を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: コントロールバーボタンの設定に成功した。
false: コントロールバーボタンの設定に失敗した。

# setControlBarButtonVisible

コントロールバーボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • コントロールバーボタン追加が無効のプレイヤーでの再生

【引数】

id: 文字列
コントロールバーボタンの識別子です。
詳細は controlBarButton を参照してください。
visible: 真偽値
コントロールバーボタンの表示/非表示です。
true: コントロールバーボタンを表示します。
false: コントロールバーボタンを非表示にします。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setControlBarVisible

コントロールバーの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

bool: 真偽値
コントロールバーの表示/非表示です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setController

コントローラーカスタマイズ用パラメータを設定します。不正な値の場合はデフォルト値になります。

【引数】

params: Object
コントローラーカスタマイズ用パラメータです。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setControls

コントローラーの操作可否を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

bool: 真偽値
コントローラーの操作可否です。
true: コントローラーを操作可能な状態にし、その時点で表示可能なコントローラーを即座に表示します。
false: コントローラーを操作不可能な状態にし、コントローラーを即座に非表示にします。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setCurrentAudioTrack

プレイヤーが再生するオーディオトラックを指定します。

注意

オーディオ切り替えが非サポートの環境の場合、オーディオ切り替えが無効の場合、本APIによる設定は適用されません。本APIを利用できない環境については、「ユーザーガイド (opens new window)」を参照してください。

【引数】

index: 数値
オーディオトラックインデックスです。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setCurrentChapter

指定のチャプターの再生開始位置にジャンプします。

注意

次に示す再生では、本APIによる設定は適用されません。

  • 再生開始前
  • リニア広告の再生
  • LIVE/DVRの再生

【引数】

index: 数値
チャプターインデックスです。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setCurrentMultiAngleIndex

選択するアングルのインデックスを指定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • 再生開始前
  • Default Video ControllerのUIが適用される環境での再生

【引数】

index: 数値
アングルのインデックスです。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setCurrentPartsSizeIndex

パーツサイズインデックスを指定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

index: 数値
パーツサイズインデックスです。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setCurrentSubtitle

プレイヤーが表示する字幕を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

index: 数値
字幕インデックスです。
字幕を非表示にする場合は、-1を設定します。

【戻り値】

return: 真偽値
実行結果です。
true: 字幕インデックスの設定に成功した。
false: 字幕インデックスの設定に失敗した。

# setCurrentTime

指定の位置にジャンプします。再生開始前に実行する場合、環境によってはジャンプしない場合があります。シーク範囲制御で指定の範囲を無視してジャンプします。

【引数】

time: 数値<秒>
ジャンプ先の位置です。

【戻り値】

return: 真偽値
ジャンプ結果です。
true: 指定の位置へのジャンプに成功した。
false: 指定の位置へのジャンプに失敗した。

# setCurrentTimeForSeekRange

シーク範囲制御の振る舞いに応じた位置にジャンプします。ジャンプ元と同じ位置へのジャンプは失敗します。再生開始前に実行する場合、環境によってはジャンプしない場合があります。

【引数】

time: 数値<秒>
ジャンプ先の位置です。

【戻り値】

return: 真偽値
ジャンプ結果です。
true: 指定の位置へのジャンプに成功した。
false: 指定の位置へのジャンプに失敗した。

# setCurrentTimeVisible

コンテンツの現在の再生位置を示す文字列の表示/非表示を設定します。

注意

次に示す再生では本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • コンテンツの現在の再生位置が表示されないコンテンツタイプの再生

【引数】

bool: 真偽値
コンテンツの現在の再生位置を示す文字列の表示/非表示です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setCurrentVideoTrack

プレイヤーが再生するビデオトラックを指定します。

注意

画質切り替えが非サポートの環境の場合、画質切り替えが無効の場合、本APIによる設定は適用されません。本APIを利用できない環境については、「ユーザーガイド (opens new window)」を参照してください。

【引数】

index: 数値
ビデオトラックインデックスです。
再生するビデオトラックを自動選択(Auto)にする場合、-1を指定します。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setCustomLayer

カスタムレイヤー用パラメータを設定します。不正な値の場合はデフォルト値になります。

【引数】

params: Object
カスタムレイヤー用パラメータです。
詳細は customLayer を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setCustomLayerVisible

カスタムレイヤーの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • カスタムレイヤーが無効のプレイヤーでの再生
  • Default Video ControllerのUIが適用される環境での再生

【引数】

bool: 真偽値
カスタムレイヤーの文字列の表示/非表示です。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setDisableRemoteSeek

リモートシーク制御の有効/無効を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • リニア広告の再生
  • LIVE/DVRでの再生

【引数】

bool: 真偽値
リモートシーク制御の有効/無効です。
詳細は disableRemoteSeek を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setDurationVisible

コンテンツの尺を示す文字列の表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • コンテンツの尺を示す文字列が表示されないコンテンツタイプの再生
  • リニア広告の再生

【引数】

bool: 真偽値
コンテンツの尺を示す文字列の表示/非表示です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setEnableKeepLiveHead

HLS(LIVE)で一時停止の後、再生を再開する際にLIVEの先頭から再生を再開するか否かを設定します。

【引数】

bool: 真偽値
HLS(LIVE)で一時停止の後、再生を再開する際にLIVEの先頭から再生を再開するか否かです。
詳細は live を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setEnablePlayToggleInPlayerArea

PCブラウザでの再生における、プレイヤー表示領域の押下による再生状態/一時停止状態の切り替えの許可/不許可を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • 広告再生(Google仕様)

【引数】

bool: 真偽値
(PCブラウザ用)プレイヤー表示領域の押下による再生状態/一時停止状態の切り替えの許可/不許可です。
詳細は enablePlayToggleInPlayerArea を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setEnablePlayToggleInPlayerAreaForMobile

モバイルブラウザでの再生における、プレイヤー表示領域の押下による再生状態/一時停止状態の切り替えの許可/不許可を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • 広告再生(Google仕様)

【引数】

bool: 真偽値
(モバイルブラウザ用)プレイヤー表示領域の押下による再生状態/一時停止状態の切り替えの許可/不許可です。
詳細は enablePlayToggleInPlayerAreaForMobile を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setEnableSeekBarByUser

シークバーの操作許可/不許可を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • シークバーの操作ができないコンテンツタイプの再生
  • リニア広告の再生

【引数】

bool: 真偽値
シークバーの操作許可/不許可です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setEnlargement

拡大表示用パラメータを設定します。不正な値の場合はデフォルト値になります。現在の拡大率より拡大表示用パラメータで指定するmaxRateが小さい場合、maxRateのサイズに縮小します。また、enableにfalseを指定する場合、拡大率を100%に戻します。

【引数】

params: Object
拡大表示用パラメータです。
詳細は enlargement を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setFixedControlBar

コントロールバーの表示位置を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • プレイヤー領域に資料を表示する設定での再生

【引数】

bool: 真偽値
コントロールバーの表示位置です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setForwardAndBackwardVisible

コントロールバー上の進む/戻るボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • リニア広告の再生
  • LIVEの再生

【引数】

bool: 真偽値
コントロールバー上の進む/戻るボタンの表示/非表示です。
詳細は skipForwardAndBackward を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setFullscreen

フルスクリーン状態、インライン状態を切り替えます。

注意

ブラウザの仕様に依存する為、APIを実行しても状態が切り替わらない場合があります。
一例として、ユーザー操作を契機としない際に、フルスクリーン状態に切り替わらない場合があります。
ご利用の範囲で十分な検証を実施してください。

【引数】

bool: 真偽値
プレイヤーを表示する状態です。
true: フルスクリーン状態にする。
false: インライン状態にする。

【戻り値】

return: 真偽値
実行結果です。
true: 状態の切り替えに成功した。
false: 状態の切り替えに失敗した。

# setFullscreenToggleVisible

フルスクリーンボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

bool: 真偽値
フルスクリーンボタンの表示/非表示です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setFullscreenType

フルスクリーンボタン押下時などでフルスクリーン状態に切り替える際のプレイヤー画面の拡大方式を変更します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • フルスクリーン状態での再生

【引数】

type: 文字列
プレイヤー画面の拡大方式です。
詳細は fullscreenType を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setGestureControl

ジェスチャー用パラメータを設定します。不正な値の場合はデフォルト値になります。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

params: Object
ジェスチャー用パラメータです。
詳細は gestureControl を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setHeight

プレイヤーの高さを設定します。

【引数】

value: 数値<px>/文字列
プレイヤーの高さです。
詳細は height を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setHelp

ヘルプ用パラメータを設定します。不正な値の場合はデフォルト値になります。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生
  • リニア広告の再生
  • 再生開始前

【引数】

params: Object
ヘルプ用パラメータです。
詳細は help を参照してください。未指定のパラメータは、デフォルト値になります。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setHelpButtonVisible

ヘルプボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生
  • リニア広告の再生
  • 再生開始前
  • ヘルプが無効のプレイヤーでの再生

【引数】

bool: 真偽値
ヘルプボタンの表示/非表示です。
詳細は help を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setHelpVisible

ヘルプの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生
  • リニア広告の再生
  • 再生開始前
  • ヘルプが無効のプレイヤーでの再生

【引数】

bool: 真偽値
ヘルプの表示/非表示です。
true: ヘルプを表示します。
false: ヘルプを非表示にします。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setHotkey

ホットキー用パラメータを設定します。不正な値の場合はデフォルト値になります。

【引数】

params: Object
ホットキー用パラメータです。
詳細は hotkey を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setInactivityPauseTimeout

一時停止状態でコントローラーおよびタイトルを表示してから自動的に非表示になるまでの時間を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生

設定する値は次に示すイベント後に適用します。

  • プレイヤー上でマウスオーバーや押下などのユーザー操作が行われた
  • API「setControls」でtrueを設定した
  • API「setSkin」でスキン名を設定した

【引数】

timeout: 数値<ミリ秒>
一時停止状態でコントローラーを表示してから自動的に非表示になるまでの時間です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setInactivityTimeout

再生状態でコントローラーおよびタイトルを表示してから自動的に非表示になるまでの時間を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生

設定する値は次に示すイベント後に適用します。

  • プレイヤー上でマウスオーバーや押下などのユーザー操作が行われた
  • API「setControls」でtrueを設定した
  • API「setSkin」でスキン名を設定した

【引数】

timeout: 数値<ミリ秒>
再生状態でコントローラーを表示してから自動的に非表示になるまでの時間です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setLiveIndicatorVisible

ライブボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • ライブボタンが表示されないコンテンツタイプの再生

【引数】

bool: 真偽値
ライブボタンの表示/非表示です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setLiveMonitoring

LIVE配信監視用パラメータを設定します。不正な値の場合はデフォルト値になります。本APIを実行するとLIVE配信の監視を停止します。LIVE配信監視の自動開始が無効の場合、LIVE配信監視するには、LIVE配信監視開始のAPIを実行します。

【引数】

params: Object
LIVE配信監視用パラメータです。
詳細は liveMonitoring を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setMuted

プレイヤーのミュート状態を設定します。

【引数】

muteValue: 真偽値
プレイヤーのミュート状態です。
詳細は muted を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setNextChapterButtonVisible

次チャプターボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • LIVE/DVRの再生
  • チャプターが無効のプレイヤーでの再生

【引数】

bool: 真偽値
次チャプターボタンの表示/非表示です。
詳細は chapter を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setNextContentButtonVisible

次コンテンツボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • 次/前コンテンツが無効のプレイヤーでの再生

【引数】

bool: 真偽値
次コンテンツボタンの表示/非表示です。
詳細は nextPrevContent を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setNextPrevContent

次/前コンテンツ用パラメータを設定します。不正な値の場合はデフォルト値になります。

【引数】

params: Object
次/前コンテンツ用パラメータです。
詳細は nextPrevContent を参照してください。未指定のパラメータは、デフォルト値になります。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setOptions

プレイヤーオプションの更新を行います。不正な値の場合はデフォルト値になります。

【引数】

options: Object
変更するプレイヤーオプションです。
元のプレイヤーオプションから変更するパラメータを指定します。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setPanoramaCardboardButtonVisible

Cardboardボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • パノラマ動画再生用パラメータが指定されていないコンテンツの再生
  • パノラマ動画再生が無効のプレイヤーでの再生

【引数】

bool: 真偽値
Cardboardボタンの表示/非表示です。
詳細は panorama を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setPartsSize

パーツサイズ用パラメータを設定します。不正な値の場合はデフォルト値になります。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

params: Object
パーツサイズ用パラメータです。
詳細は partsSize を参照してください。未指定のパラメータは、デフォルト値になります。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setPartsSizeMenuButtonVisible

パーツサイズボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • パーツサイズが無効のプレイヤーでの再生

【引数】

bool: 真偽値
パーツサイズボタンの表示/非表示です。
詳細は partsSize を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setPictureInPictureButtonVisible

ピクチャーインピクチャーボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • オーディオの再生
  • AirPlay接続中
  • Default Video ControllerのUIが適用される環境での再生
  • ピクチャーインピクチャーが非サポートの環境での再生

【引数】

bool: 真偽値
ピクチャーインピクチャーボタンの表示/非表示です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setPlaybackRate

プレイヤーが再生するコンテンツの再生速度を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • 倍速再生が無効のプレイヤーでの再生

【引数】

rateValue: 数値<倍>
再生速度です。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setPlaybackRateMenuButtonVisible

再生速度ボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • LIVEの再生
  • 倍速再生用パラメータが指定されていないコンテンツの再生
  • 倍速再生が利用できない環境での再生
  • 倍速再生が無効のプレイヤーでの再生

【引数】

bool: 真偽値
再生速度ボタンの表示/非表示です。
詳細は playbackRates を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setPlaybackRates

倍速再生用パラメータを設定します。不正な値の場合はデフォルト値になります。

【引数】

rateValue: Object
倍速再生用パラメータです。
詳細は playbackRates を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setPlayStartButtonEffect

再生開始ボタンのアニメーションを設定します。

【引数】

effect: 文字列
再生開始ボタンのアニメーションです。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setPlayToggleVisible

コントロールバー上の再生/一時停止ボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

bool: 真偽値
コントロールバー上の再生/一時停止ボタンの表示/非表示です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setPresentation

プレゼンテーション用パラメータを設定します。不正な値の場合はデフォルト値になります。

注意

次に示す再生では、displayInPlayerが強制的にfalseになります。

  • オーディオの再生
  • パノラマの再生
  • マルチアングルの再生
  • LIVE/DVRでの再生
  • モバイルブラウザでの再生

【引数】

params: Object
プレゼンテーション用パラメータです。
詳細は presentation を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setPrevChapterButtonVisible

前チャプターボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • LIVE/DVRの再生
  • チャプターが無効のプレイヤーでの再生

【引数】

bool: 真偽値
前チャプターボタンの表示/非表示です。
詳細は chapter を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setPrevContentButtonVisible

前コンテンツボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • 次/前コンテンツが無効のプレイヤーでの再生

【引数】

bool: 真偽値
前コンテンツボタンの表示/非表示です。
詳細は nextPrevContent を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setReactionButtonVisible

リアクションボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • ULIZA Video Analytics (Cloud)が無効のプレイヤーでの再生。ただし、トラッキングオプトアウトによる無効時は設定を適用します。
  • リアクションが無効のプレイヤーでの再生
  • LIVE/DVRでの再生

【引数】

bool: 真偽値
リアクションボタンの表示/非表示です。
詳細は videoAnalytics を参照してください。
index: 数値
オプショナルです。
リアクションインデックスです。未指定の場合は0を適用します。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setReactionGraphVisible

リアクショングラフの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • ULIZA Video Analytics (Cloud)が無効のプレイヤーでの再生。ただし、トラッキングオプトアウトによる無効時は設定を適用します。
  • リアクションが無効のプレイヤーでの再生
  • LIVE/DVRでの再生

【引数】

bool: 真偽値
リアクショングラフの表示/非表示です。
詳細は videoAnalytics を参照してください。
index: 数値
リアクションインデックスです。
すべてのアクショングラフを非表示にする場合は、-1を設定します。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setRepeat

リピート用パラメータを設定します。不正な値の場合はデフォルト値になります。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • LIVE/DVRでの再生

【引数】

params: Object
リピート用パラメータです。
詳細は repeat を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setRepeatButtonVisible

リピートボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • リピートが無効のプレイヤーでの再生
  • LIVE/DVRでの再生

【引数】

bool: 真偽値
リピートボタンの表示/非表示です。
詳細は repeat を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setSaveVolumeInfo

ボリューム情報の保存の許可/不許可を設定します。

【引数】

bool: 真偽値
ボリューム情報の保存の許可/不許可です。
詳細は saveVolumeInfo を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setScale

指定する座標を中心点として拡大します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • 拡大表示が無効のプレイヤーでの再生
  • オーディオの再生
  • パノラマ動画の再生
  • リニア広告の再生
  • Cast中
  • AirPlay接続中
  • 再生開始前

【引数】

scale: 数値<%>
拡大率です。
top: 数値<px>
オプショナルです。
中心点の垂直方向の座標です。
left: 数値<px>
オプショナルです。
中心点の水平方向の座標です。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setScreenLock

画面ロック用パラメータを設定します。不正な値の場合はデフォルト値になります。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生

【引数】

params: Object
画面ロック用パラメータです。
詳細は screenLock を参照してください。未指定のパラメータは、デフォルト値になります。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setScreenLockButtonVisible

画面ロックボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生
  • 画面ロックが無効のプレイヤーでの再生

【引数】

bool: 真偽値
画面ロックボタンの表示/非表示です。
詳細は screenLock を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setScreenLockStatus

画面ロックの状態を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生

【引数】

bool: 真偽値
画面ロックの状態です。
true: 画面ロックする。
false: 画面ロックを解除する。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setSeekableRangeEnd

シーク有効範囲の終了位置を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • LIVE/DVRでの再生

【引数】

end: 数値<秒>/文字列
シーク有効範囲の終了位置です。
詳細は seekableRange を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setSeekableRangeOptions

シーク範囲制御用パラメータを設定します。不正な値の場合はデフォルト値になります。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • LIVE/DVRでの再生

【引数】

params: Object
シーク範囲制御用パラメータです。
詳細は seekableRange を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setSeekableRangeStart

シーク有効範囲の開始位置を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • LIVE/DVRでの再生

【引数】

start: 数値<秒>
シーク有効範囲の開始位置です。
詳細は seekableRange を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setSeekBarVisible

シークバーの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • シークバーが表示されないコンテンツタイプの再生

【引数】

bool: 真偽値
シークバーの表示/非表示です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setSeekpreview

シークプレビューパラメータを設定します。不正な値の場合はデフォルト値になります。

【引数】

params: Object
シークプレビューパラメータです。
詳細は seekpreview を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setSettingMenu

設定メニュー用パラメータを設定します。不正な値の場合はデフォルト値になります。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生

【引数】

params: Object
設定メニュー用パラメータです。
詳細は settingMenu を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setSettingMenuButtonVisible

設定メニューボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生
  • 設定メニューが無効のプレイヤーでの再生

【引数】

bool: 真偽値
設定メニューボタンの表示/非表示です。
詳細は settingMenu を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setSettingMenuVisible

設定メニューの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • オーディオの再生
  • 設定メニューが無効のプレイヤーでの再生

【引数】

bool: 真偽値
設定メニューの表示/非表示です。
true: 設定メニューを表示します。
false: 設定メニューを非表示にします。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setSkin

スキンを切り替えます。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

name: 文字列
スキン名です。
詳細は skin を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setSkipBackwardSeconds

戻るボタン押下時に後方シークする秒数を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • リニア広告の再生
  • LIVEの再生

【引数】

seekTime: 数値<秒>
戻るボタン押下時に後方シークする秒数です。
詳細は skipForwardAndBackward を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setSkipForwardAndBackward

進む/戻る用パラメータを設定します。不正な値の場合はデフォルト値になります。

【引数】

params: Object
進む/戻る用パラメータです。
詳細は skipForwardAndBackward を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setSkipForwardSeconds

進むボタン押下時に前方シークする秒数を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • リニア広告の再生
  • LIVEの再生

【引数】

seekTime: 数値<秒>
進むボタン押下時に前方シークする秒数です。
詳細は skipForwardAndBackward を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setSubtitles

字幕用パラメータを設定します。不正な値の場合はデフォルト値になります。

【引数】

params: Object
字幕用パラメータです。
詳細は subtitles を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setSubtitleMenuButtonVisible

字幕ボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • 字幕非サポートの環境での再生
  • 字幕が無効のプレイヤーでの再生 字幕ボタンを表示しない環境や配信方式については、「ユーザーガイド (opens new window)」を参照してください。

【引数】

bool: 真偽値
字幕ボタンの表示/非表示です。
詳細は subtitles を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setTimeDividerVisible

再生位置と尺の間の「/」の表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • スキンdefaultの再生
  • LIVEの再生

【引数】

bool: 真偽値
再生位置と尺の間の「/」の表示/非表示です。
true: 再生位置と尺の間の「/」を表示します。
false: 再生位置と尺の間の「/」を非表示にします。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setTitleOptions

タイトル用パラメータを設定します。不正な値の場合はデフォルト値になります。。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

params: Object
タイトル用パラメータです。
詳細は title を参照してください。未指定のパラメータは、デフォルト値になります。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setTrackingOptout

トラッキングオプトアウトの有効/無効を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • ULIZA Video Analytics (Cloud)連携が無効のプレイヤーでの再生

【引数】

bool: 真偽値
トラッキングオプトアウトの有効/無効です。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setTrackingOptoutButtonVisible

トラッキングオプトアウトボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • ULIZA Video Analytics (Cloud)連携用パラメータが指定されていないコンテンツの再生
  • ULIZA Video Analytics (Cloud)連携が無効のプレイヤーでの再生

【引数】

bool: 真偽値
トラッキングオプトアウトボタンの表示/非表示です。
詳細は videoAnalytics を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setVideoTrack

画質切り替え用パラメータを設定します。不正な値の場合はデフォルト値になります。

【引数】

params: Object
画質切り替え用パラメータです。
詳細は videoTrack を参照してください。未指定のパラメータは、デフォルト値になります。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setVideoTrackMenuButtonVisible

画質ボタンの表示/非表示を設定します。

注意

画質切り替えが非サポートの環境、画質切り替えが無効の場合、本APIによる設定は適用されません。画質ボタンを表示しない環境や配信方式については、「ユーザーガイド (opens new window)」を参照してください。

【引数】

bool: 真偽値
画質ボタンの表示/非表示です。
詳細は videoTrack を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setVolume

プレイヤーの音量を変更します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • iOSでの再生

【引数】

volumeValue: 数値
プレイヤーの音量です。
0以上1以下を指定してください。0は音量0%(無音)、1.0は音量100%(最大)、0.5だと音量50%です。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setVolumeBarVertical

PCでの視聴時、ボリュームボタンにカーソルを合わせることで表示するボリュームバーの表示形式(縦表示/横表示)を変更します。

【引数】

isVertical: 真偽値
ボリュームバーの表示形式です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setVolumeControlVisible

ボリュームボタンの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • ミュート状態の有効、無効を切り替えられない環境での再生

【引数】

bool: 真偽値
ボリュームボタンの表示/非表示です。
詳細は controller を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setWatermark

ウォーターマーク用パラメータを設定します。不正な値の場合はデフォルト値になります。

【引数】

params: Object
ウォーターマーク用パラメータです。
詳細は watermark を参照してください。未指定のパラメータは、デフォルト値になります。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setWatermarkPosition

ウォーターマーク表示位置を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

position: 文字列
ウォーターマーク表示位置です。
詳細は watermark を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setWatermarkUrl

ウォーターマーク画像のURLを設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

url: 文字列(URL)
ウォーターマーク画像のURLです。
詳細は watermark を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setWatermarkVisible

ウォーターマークの表示/非表示を設定します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

bool: 真偽値
ウォーターマークの表示/非表示です。
true: ウォーターマークを表示します。
false: ウォーターマークを非表示にします。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# setWidth

プレイヤーの幅を設定します。

【引数】

value: 数値<px>/文字列
プレイヤーの幅です。
詳細は width を参照してください。

【戻り値】

return: 真偽値
実行結果です。
true: 設定に成功した。
false: 設定に失敗した。

# showToast

トーストを表示します。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生

【引数】

text: 文字列
トーストに表示する文言です。
durationMS: 数値<ミリ秒>
オプショナルです。
表示する時間です。デフォルト値: 2000

【戻り値】

なし

# skipLinearAd

リニア広告をスキップします。ただし、現在の広告の再生位置がVASTのskipoffset属性で指定されている秒数を越えていない場合は、リニア広告をスキップしません。

注意

次に示す再生では、本APIによる設定は適用されません。

  • VASTのskipoffset属性の指定がないリニア広告の再生
  • Default Video ControllerのUIが適用される環境での再生
  • 本編の再生
  • オーディオの再生
  • 広告再生(Google仕様)

【引数】

なし

【戻り値】

return: 真偽値
実行結果です。
true: リニア広告をスキップ成功
false: リニア広告をスキップ失敗

# skipLiveHead

LIVEおよびDVRの先頭付近にシークします。

注意

次に示す再生では、本APIによる設定は適用されません。

  • Default Video ControllerのUIが適用される環境での再生
  • VODの再生
  • リニア広告の再生
  • DVRの先頭付近の再生

【引数】

なし

【戻り値】

return: 真偽値
シーク結果です。
true: シーク成功
false: シーク失敗

# startLiveMonitoring

LIVE配信監視を開始します。

【引数】

なし

【戻り値】

return: 真偽値
実行結果です。
true: 開始成功
false: 開始失敗

# startResume

レジューム確認コールバック関数が指定されている場合、レジューム確認待ち状態を解除し、再生処理を再開します。本APIは、ボタン押下イベント等のユーザー操作イベントから同期で実行しない場合、ブラウザの仕様により、再生が正しく開始されない場合があります。

【引数】

resumePos: 数値<秒>
再生開始位置です。

【戻り値】

return: 真偽値
実行結果です。
true: 再生処理の再開成功
false: 再生処理の再開失敗

# stopLiveMonitoring

LIVE配信監視を停止します。

【引数】

なし

【戻り値】

return: 真偽値
実行結果です。
true: 停止成功
false: 停止失敗

# deprecated API

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

# currentSubtitle 【 deprecated in v1.12.0 】

《 getter 》 getCurrentSubtitle を使用してください。

《 setter 》 setCurrentSubtitle を使用してください。

# currentTime 【 deprecated in v1.12.0 】

《 getter 》 getCurrentTime を使用してください。

《 setter 》 setCurrentTime を使用してください。

# currentVideoTrack 【 deprecated in v1.12.0 】

《 getter 》 getCurrentVideoTrack を使用してください。

《 setter 》 setCurrentVideoTrack を使用してください。

# enablePlayToggleInPlayerArea 【 deprecated in v1.12.0 】

《 getter 》 getEnablePlayToggleInPlayerArea を使用してください。

《 setter 》 setEnablePlayToggleInPlayerArea を使用してください。

# enableSeekBarByUser 【 deprecated in v1.12.0 】

《 getter 》 getEnableSeekBarByUser を使用してください。

《 setter 》 setEnableSeekBarByUser を使用してください。

# error 【 deprecated in v1.12.0 】

getError を使用してください。

# fullscreenType 【 deprecated in v1.12.0 】

《 getter 》 getFullscreenType を使用してください。

《 setter 》 setFullscreenType を使用してください。

# getAccentColor 【 deprecated in v1.22.0 】

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

# getAudioTrackMenuButtonVisible 【 deprecated in v1.23.0 】

--uliza-audio-track-button-display を使用してください。

# getBackgroundColor 【 deprecated in v1.22.0 】

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

# getBeginningButtonVisible 【 deprecated in v1.23.0 】

--uliza-beginning-button-display を使用してください。

# getBitrateMenuButtonVisible 【 deprecated in v1.12.1 】

getVideoTrackMenuButtonVisible を使用してください。

# getCenterControllerVisible 【 deprecated in v1.23.0 】

--uliza-center-controller-display を使用してください。

# getCenterControllerVisibleForMobile 【 deprecated in v1.23.0 】

--uliza-center-controller-display-for-mobile を使用してください。

# getCenterForwardAndBackwardVisible 【 deprecated in v1.23.0 】

--uliza-center-skip-backward-button-display を使用してください。

--uliza-center-skip-forward-button-display を使用してください。

# getCenterPlayToggleVisible 【 deprecated in v1.23.0 】

--uliza-center-play-toggle-button-display を使用してください。

# getCenterPlayStartVisible 【 deprecated in v1.23.0 】

--uliza-play-start-button-display を使用してください。

# getControlBarColor 【 deprecated in v1.23.0 】

--uliza-audio-controller-color を使用してください。

# getControlBarVisible 【 deprecated in v1.23.0 】

--uliza-control-bar-display を使用してください。

# getCurrentTimeVisible 【 deprecated in v1.23.0 】

--uliza-current-time-display を使用してください。

# getDurationVisible 【 deprecated in v1.23.0 】

--uliza-duration-display を使用してください。

# getFullscreenToggleVisible 【 deprecated in v1.23.0 】

--uliza-fullscreen-button-display を使用してください。

# getForwardAndBackwardVisible 【 deprecated in v1.23.0 】

--uliza-skip-backward-button-display を使用してください。

--uliza-skip-forward-button-display を使用してください。

# getHelpButtonVisible 【 deprecated in v1.23.0 】

--uliza-help-button-display を使用してください。

# getLiveIndicatorVisible 【 deprecated in v1.23.0 】

--uliza-live-button-display を使用してください。

# getNextChapterButtonVisible 【 deprecated in v1.23.0 】

--uliza-chapter-next-button-display を使用してください。

# getNextContentButtonVisible【 deprecated in v1.23.0 】

--uliza-next-prev-content-next-button-display を使用してください。

# getNonSeekableRangeColor【 deprecated in v1.23.0 】

--uliza-non-seekable-range-color を使用してください。

# getPanoramaCardboardButtonVisible 【 deprecated in v1.23.0 】

--uliza-panorama-cardboard-button-display を使用してください。

# getPartsSizeMenuButtonVisible 【 deprecated in v1.23.0 】

--uliza-parts-size-button-display を使用してください。

# getPictureInPictureButtonVisible 【 deprecated in v1.23.0 】

--uliza-picture-in-picture-button-display を使用してください。

# getPlaybackRateMenuButtonVisible 【 deprecated in v1.23.0 】

--uliza-playback-rates-button-display を使用してください。

# getPlayStartButtonColor【 deprecated in v1.23.0 】

--uliza-play-start-button-color を使用してください。

# getPlayerStyle 【 deprecated in v1.13.0 】

getAccentColor を使用してください。

# getPlayToggleVisible 【 deprecated in v1.23.0 】

--uliza-play-toggle-button-display を使用してください。

# getPrevChapterButtonVisible 【 deprecated in v1.23.0 】

--uliza-chapter-prev-button-display を使用してください。

# getPrevContentButtonVisible【 deprecated in v1.23.0 】

--uliza-next-prev-content-prev-button-display を使用してください。

# getRepeatButtonVisible 【 deprecated in v1.23.0 】

--uliza-repeat-button-display を使用してください。

# getScreenLockButtonVisible 【 deprecated in v1.23.0 】

--uliza-screen-lock-button-display を使用してください。

# getSeekBarVisible 【 deprecated in v1.23.0 】

--uliza-seek-bar-display を使用してください。

# getSettingMenuButtonVisible 【 deprecated in v1.23.0 】

--uliza-setting-menu-button-display を使用してください。

# getSubtitleMenuButtonVisible 【 deprecated in v1.23.0 】

--uliza-subtitles-button-display を使用してください。

# getUnmuteButtonVisible 【 deprecated in v1.23.0 】

--uliza-unmute-button-display を使用してください。

# getVideoTrackMenuButtonVisible 【 deprecated in v1.23.0 】

--uliza-video-track-button-display を使用してください。

# getVolumeControlVisible 【 deprecated in v1.23.0 】

--uliza-volume-button-display を使用してください。

# getWatermarkCoordinate 【 deprecated in v1.22.0 】

# getWatermarkHeight 【 deprecated in v1.22.0 】

--uliza-watermark-height を使用してください。

# getWatermarkWidth 【 deprecated in v1.22.0 】

--uliza-watermark-width を使用してください。

# height 【 deprecated in v1.12.0 】

《 getter 》 getHeight を使用してください。

《 setter 》 setHeight を使用してください。

# inactivityPauseTimeout 【 deprecated in v1.12.0 】

《 getter 》 getInactivityPauseTimeout を使用してください。

《 setter 》 setInactivityPauseTimeout を使用してください。

# inactivityTimeout 【 deprecated in v1.12.0 】

《 getter 》 getInactivityTimeout を使用してください。

《 setter 》 setInactivityTimeout を使用してください。

# muted 【 deprecated in v1.12.0 】

《 getter 》 getMuted を使用してください。

《 setter 》 setMuted を使用してください。

# playbackRate 【 deprecated in v1.12.0 】

《 getter 》 getPlaybackRate を使用してください。

《 setter 》 setPlaybackRate を使用してください。

# setAccentColor 【 deprecated in v1.22.0 】

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

# setBackgroundColor 【 deprecated in v1.22.0 】

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

# setBitrateMenuButtonVisible 【 deprecated in v1.12.1 】

setVideoTrackMenuButtonVisible を使用してください。

# setControlBarColor 【 deprecated in v1.23.0 】

--uliza-audio-controller-color を使用してください。

# setNonSeekableRangeColor 【 deprecated in v1.23.0 】

--uliza-non-seekable-range-color を使用してください。

# setPlayStartButtonColor 【 deprecated in v1.23.0 】

--uliza-play-start-button-color を使用してください。

# setPlayerStyle 【 deprecated in v1.13.0 】

setAccentColor を使用してください。

# setWatermarkCoordinate 【 deprecated in v1.22.0 】

# setWatermarkHeight 【 deprecated in v1.22.0 】

--uliza-watermark-height を使用してください。

# setWatermarkWidth 【 deprecated in v1.22.0 】

--uliza-watermark-width を使用してください。

# showBitrateMenuButton 【 deprecated in v1.12.0 】

《 getter 》 getVideoTrackMenuButtonVisible を使用してください。

《 setter 》 setVideoTrackMenuButtonVisible を使用してください。

# showCenterForwardAndBackward 【 deprecated in v1.12.0 】

《 getter 》 getCenterForwardAndBackwardVisible を使用してください。

《 setter 》 setCenterForwardAndBackwardVisible を使用してください。

# showCenterPlayToggle 【 deprecated in v1.12.0 】

《 getter 》 getCenterPlayToggleVisible を使用してください。

《 setter 》 setCenterPlayToggleVisible を使用してください。

# showControlBarButton 【 deprecated in v1.12.0 】

《 getter 》 getControlBarButtonVisible を使用してください。

《 setter 》 setControlBarButtonVisible を使用してください。

# showCurrentTimeDisplay 【 deprecated in v1.12.0 】

《 getter 》 getCurrentTimeVisible を使用してください。

《 setter 》 setCurrentTimeVisible を使用してください。

# showDurationDisplay 【 deprecated in v1.12.0 】

《 getter 》 getDurationVisible を使用してください。

《 setter 》 setDurationVisible を使用してください。

# showForwardAndBackward 【 deprecated in v1.12.0 】

《 getter 》 getForwardAndBackwardVisible を使用してください。

《 setter 》 setForwardAndBackwardVisible を使用してください。

# showFullscreenToggle 【 deprecated in v1.12.0 】

《 getter 》 getFullscreenToggleVisible を使用してください。

《 setter 》 setFullscreenToggleVisible を使用してください。

# showLevelChangeMenuButton 【 deprecated in v1.12.0 】

《 getter 》 getVideoTrackMenuButtonVisible を使用してください。

《 setter 》 setVideoTrackMenuButtonVisible を使用してください。

# showLiveDisplay 【 deprecated in v1.12.0 】

《 getter 》 getLiveIndicatorVisible を使用してください。

《 setter 》 setLiveIndicatorVisible を使用してください。

# showPlaybackRateMenuButton 【 deprecated in v1.12.0 】

《 getter 》 getPlaybackRateMenuButtonVisible を使用してください。

《 setter 》 setPlaybackRateMenuButtonVisible を使用してください。

# showPlayToggle 【 deprecated in v1.12.0 】

《 getter 》 getPlayToggleVisible を使用してください。

《 setter 》 setPlayToggleVisible を使用してください。

# showSeekBar 【 deprecated in v1.12.0 】

《 getter 》 getSeekBarVisible を使用してください。

《 setter 》 setSeekBarVisible を使用してください。

# showVolumeMenuButton 【 deprecated in v1.12.0 】

《 getter 》 getVolumeControlVisible を使用してください。

《 setter 》 setVolumeControlVisible を使用してください。

# showWatermark 【 deprecated in v1.12.0 】

《 getter 》 getWatermarkVisible を使用してください。

《 setter 》 setWatermarkVisible を使用してください。

# skin 【 deprecated in v1.12.0 】

《 getter 》 getSkin を使用してください。

《 setter 》 setSkin を使用してください。

# skipBackwardSeconds 【 deprecated in v1.12.0 】

《 getter 》 getSkipBackwardSeconds を使用してください。

《 setter 》 setSkipBackwardSeconds を使用してください。

# skipForwardSeconds 【 deprecated in v1.12.0 】

《 getter 》 getSkipForwardSeconds を使用してください。

《 setter 》 setSkipForwardSeconds を使用してください。

# streamType 【 deprecated in v1.12.0 】

getStreamType を使用してください。

# subtitleArray 【 deprecated in v1.12.0 】

getSubtitleArray を使用してください。

# updatePlayerStyle 【 deprecated in v1.12.0 】

setAccentColor を使用してください。

# videoTrackArray 【 deprecated in v1.12.0 】

getVideoTrackArray を使用してください。

# volume 【 deprecated in v1.12.0 】

《 getter 》 getVolume を使用してください。

《 setter 》 setVolume を使用してください。

# volumeBarVertical 【 deprecated in v1.12.0 】

《 getter 》 getVolumeBarVertical を使用してください。

《 setter 》 setVolumeBarVertical を使用してください。

# watermarkCoordinate 【 deprecated in v1.12.0 】

《 getter 》 getWatermarkCoordinate を使用してください。

《 setter 》 setWatermarkCoordinate を使用してください。

# watermarkHeight 【 deprecated in v1.12.0 】

《 getter 》 getWatermarkHeight を使用してください。

《 setter 》 setWatermarkHeight を使用してください。

# watermarkPosition 【 deprecated in v1.12.0 】

《 getter 》 getWatermarkPosition を使用してください。

《 setter 》 setWatermarkPosition を使用してください。

# watermarkUrl 【 deprecated in v1.12.0 】

《 getter 》 getWatermarkUrl を使用してください。

《 setter 》 setWatermarkUrl を使用してください。

# watermarkWidth 【 deprecated in v1.12.0 】

《 getter 》 getWatermarkWidth を使用してください。

《 setter 》 setWatermarkWidth を使用してください。

# width 【 deprecated in v1.12.0 】

《 getter 》 getWidth を使用してください。

《 setter 》 setWidth を使用してください。

# コールバックイベント

プレイヤーが通知するイベントです。プレイヤーからのイベントを受け取る場合の実装例は以下の通りです。

<script type="text/javascript">
  var player = ulizahtml5('playerId');
  player.on('play', function(){
    console.log('play called');
  });
</script>

# adabort

広告の開始処理の中断です。

# adclickcompanion

コンパニオン広告の押下です。

# adclicklinear

リニア広告の押下です。

# adend

広告の終了です。

# adpause

リニア広告の一時停止です。

# adresume

リニア広告の再開です。

# adskip

リニア広告のスキップです。

# adstart

広告の開始です。

# adstop

リニア広告の再生終了です。

# castConnected

Castデバイスへの接続完了です。

# castDisconnected

Castデバイスとの切断完了です。

# changechapter

チャプターの切り替え完了です。

# complete

完全視聴完了です。広告を含めた一連のコンテンツの再生が完了(ポストロールが設定されている場合はポストロールの再生終了)した時に発行します。

# cuetone

キュートーンの受信です。

# ended

本編再生終了です。本編の再生が終了(ポストロールが設定されている場合はポストロールの再生開始前)した時に発行します。

# error

エラー発生です。

# fullscreenchange

フルスクリーン状態の切り替え開始です。

# liveMonitoringFailed

LIVE配信異常です。

# liveMonitoringSuccess

LIVE配信正常です。

# lockscreen

画面ロックの開始です。

# manualangletrackchange

アングルの切り替え完了です。

# manualvideotrackchange

画質メニューの手動選択です。

# pause

一時停止です。

# play

再生です。

# possibleadblock

広告がブロックされた可能性があります。このイベントは以下のタイミングでコールバックする場合があります。

  • プレイヤー初期化完了
  • Live再生中のミッドロールの挿入完了
ただし、以下の場合もコールバックします。
  • ブラウザのセキュリティ制限等によるVAST、VMAPの通信の失敗

# reactionDataReceived

リアクショングラフ作成用のデータの取得完了です。リアクショングラフ作成用のデータを取得した場合に発行します。

# reload

コンテンツのリロードです。

# seeked

シーク完了です。

# switchedcontents

コンテンツ切り替え完了です。コンテンツ切り替えモードによるコンテンツの切り替えが完了した時に発行します。

# timeupdate

現在再生位置の更新です。

# ulizaAirplayButtonFirstVisible

AirPlayボタンの表示(AirPlayボタンを表示するのが初めての場合)です。

# ulizaAirplayButtonVisible

AirPlayボタンの表示(AirPlayボタンを表示するのが2回目以降の場合)です。

# ulizaCastButtonFirstVisible

Castボタンの表示(Castボタンを表示するのが初めての場合)です。

# ulizaCastButtonVisible

Castボタンの表示(Castボタンを表示するのが2回目以降の場合)です。

# unlockscreen

画面ロックの解除です。

# updatechapter

チャプターの有効/無効、チャプター数の変更です。

# updatepartssize

パーツサイズの切り替え完了です。

# updatestreamtype

コンテンツタイプ検出完了です。コンテンツタイプにautoが指定されても、コンテンツタイプの自動検出の条件を満たさない等で自動検出できなかった場合、イベントは発行しません。

# コールバック関数

# コントロールバーボタン押下コールバック関数

プレイヤーオプションcontrolBarButton.onClickListenerで指定するコールバック関数です。

【引数】

currentStateIndex: 数値
押下前のボタン状態のボタン状態インデックスです。
nextStateIndex: 数値
押下後のボタン状態のボタン状態インデックスです。
player: Object
UlizaPlayerのインスタンスです。
element: Object
ボタンオブジェクトです。

【戻り値】

return: 数値
ボタン状態インデックスです。
戻り値のボタン状態インデックスのボタン状態にボタンを更新します。戻り値がボタン状態インデックスの範囲外、または戻り値がない場合はnextStateIndexのボタン状態にボタンを更新します。

補足

ボタン状態の配列に含まれる要素に0以上の整数を昇順で割り当てた値をボタン状態インデックスと呼びます。以下は、3つのボタン状態を持つコントロールバーボタンとボタン状態インデックスの例です。

controlBarButton: {
  enable: true,
  item: [
    {
      id: 'ContorolBarButtonId',
      state: [
        {
          textJa: 'No0' // ボタン状態インデックス=0
        },
        {
          textJa: 'No1' // ボタン状態インデックス=1
        },
        {
          textJa: 'No2' // ボタン状態インデックス=2
        }
      ]
    }
  ]
}

# キー押下コールバック関数

プレイヤーオプションhotkey.eventListenerで指定するコールバック関数です。ホットキーが無効の場合は実行しません。実行対象のキーはECMAScriptで定義されているkeydownイベントで実行されるキーに準拠します。

【引数】

player: Object
UlizaPlayerのインスタンスです。
event: Object
KeyboardEventオブジェクトです。

【戻り値】

return: 真偽値
true: デフォルトのホットキー挙動を行う。
false: デフォルトのホットキー挙動を行わない。

# レジューム確認コールバック関数

プレイヤーオプションresumePlayback.resumeConfirmFuncで指定するコールバック関数です。

【引数】

resumePos: 数値<秒>
再生開始位置です。

【戻り値】

なし