# UlizaPlayer
# メソッド
# addButton
プレイヤー表示領域にボタンを追加します。
【引数】
【戻り値】
# addControlBarButton
コントロールバーボタンを追加します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
【引数】
【戻り値】
# appendCenterControllerLine
センターコントローラーに行を追加します。
【引数】
なし
【戻り値】
# createCenterPlayPauseButton
センターコントローラーの再生／一時停止ボタンを生成します。
【引数】
なし
【戻り値】
# createCenterSkipBackwardButton
センターコントローラーの戻るボタンを生成します。進む／戻る機能が無効の場合は表示しません。
【引数】
【戻り値】
# createCenterSkipForwardButton
センターコントローラーの進むボタンを生成します。進む／戻る機能が無効の場合は表示しません。
【引数】
【戻り値】
# createCenterStartPlayButton
再生開始ボタンを生成します。
【引数】
なし
【戻り値】
- return: Object
- 再生開始ボタンの要素です。
# dispose
UlizaPlayerのインスタンスを破棄します。
【引数】
なし
【戻り値】
なし
# getAdvertising
広告用パラメータを取得します。
【引数】
なし
【戻り値】
# getAlternativeImage
表示中の代替画像のURLを取得します。
【引数】
なし
【戻り値】
# getAspectRatio
現在のプレイヤーのアスペクト比を取得します。
【引数】
なし
【戻り値】
# getAudioTrack
オーディオ切り替え用パラメータを取得します。
【引数】
なし
【戻り値】
# getAudioTrackArray
再生中のコンテンツのオーディオトラック情報のリストを取得します。
【引数】
なし
【戻り値】
# getBeacon
ビーコン用パラメータを取得します。
【引数】
なし
【戻り値】
# getCenterControllerLine
センターコントローラーの行を取得します。
【引数】
【戻り値】
# getCenterControllerLines
センターコントローラーの行の配列を取得します。
【引数】
なし
【戻り値】
# getChapter
チャプター用パラメータを取得します。
【引数】
なし
【戻り値】
# getChapterArray
チャプター情報のリストを取得します。
【引数】
なし
【戻り値】
# getControlBarButton
コントロールバーボタン追加用パラメータを取得します。
【引数】
なし
【戻り値】
# getControlBarButtonVisible
コントロールバーボタンの表示／非表示を取得します。
【引数】
【戻り値】
# getController
コントローラーカスタマイズ用パラメータを取得します。
【引数】
なし
【戻り値】
# getControls
コントローラーの操作可否を取得します。
【引数】
なし
【戻り値】
# getCurrentAudioTrack
選択されているオーディオトラックの情報を取得します。本APIを利用できない環境については、「ユーザーガイド (opens new window)」を参照してください。
【引数】
なし
【戻り値】
# getCurrentChapter
選択されているチャプターの情報を取得します。
【引数】
なし
【戻り値】
# getCurrentMultiAngleIndex
選択されているアングルのインデックスを取得します。
【引数】
なし
【戻り値】
# getCurrentPartsSizeIndex
選択されているパーツサイズインデックスの値を取得します。
【引数】
なし
【戻り値】
# getCurrentScale
本編の拡大率を取得します。
【引数】
なし
【戻り値】
# getCurrentSubtitle
選択されている字幕インデックスの値を取得します。
【引数】
なし
【戻り値】
# getCurrentTime
コンテンツの現在の再生位置を取得します。切り出し再生が有効の場合、切り出し後の再生位置を取得します。
【引数】
なし
【戻り値】
# getCurrentVideoTrack
選択されているビデオトラックの情報を取得します。本APIを利用できない環境については、「ユーザーガイド (opens new window)」を参照してください。
【引数】
なし
【戻り値】
# getCustomLayer
カスタムレイヤー用パラメータを取得します。
【引数】
なし
【戻り値】
# getCustomLayerElement
カスタムレイヤーの要素を取得します。
【引数】
なし
【戻り値】
# getCustomLayerVisible
カスタムレイヤーの表示／非表示を取得します。
【引数】
なし
【戻り値】
# getDisableInlineFullscreen
ビデオビューア制御の有効／無効を取得します。
【引数】
なし
【戻り値】
# getDisableRemoteSeek
リモートシーク制御の有効／無効を取得します。
【引数】
なし
【戻り値】
# getDuration
コンテンツの尺を取得します。切り出し再生が有効の場合、切り出し後のコンテンツの尺を取得します。
【引数】
なし
【戻り値】
# getEnableKeepLiveHead
HLS（LIVE）で一時停止の後、再生を再開する際にLIVEの先頭から再生を再開するか否かを取得します。
【引数】
なし
【戻り値】
# getEnablePlayToggleInPlayerArea
PCブラウザでの再生における、プレイヤー表示領域の押下による再生状態／一時停止状態の切り替えの許可、不許可を取得します。
【引数】
なし
【戻り値】
# getEnablePlayToggleInPlayerAreaForMobile
モバイルブラウザでの再生における、プレイヤー表示領域の押下による再生状態／一時停止状態の切り替えの許可、不許可を取得します。
【引数】
なし
【戻り値】
# getEnableSeekBarByUser
シークバーの操作許可／不許可を取得します。
【引数】
なし
【戻り値】
# getEnlargement
拡大表示用パラメータを取得します。
【引数】
なし
【戻り値】
# getError
プレイヤーで発生したエラーを取得します。
【引数】
なし
【戻り値】
# getFixedControlBar
コントロールバーの表示位置を取得します。
【引数】
なし
【戻り値】
# getFullscreenType
現在のプレイヤー画面の拡大方式を取得します。
【引数】
なし
【戻り値】
# getGestureControl
ジェスチャー用パラメータを取得します。
【引数】
なし
【戻り値】
# getGooglecast
Google Cast Sender用パラメータを取得します。
【引数】
なし
【戻り値】
# getHeight
現在のプレイヤーの高さを取得します。
【引数】
なし
【戻り値】
# getHelp
ヘルプ用パラメータを取得します。
【引数】
なし
【戻り値】
# getHelpButtonVisible
ヘルプボタンの表示／非表示を取得します。
【引数】
なし
【戻り値】
# getHelpVisible
ヘルプの表示／非表示を取得します。
【引数】
なし
【戻り値】
# getHotkey
ホットキー用パラメータを取得します。
【引数】
なし
【戻り値】
# getInactivityPauseTimeout
一時停止状態でコントローラーおよびタイトルを表示してから自動的に非表示になるまでの時間を取得します。
【引数】
なし
【戻り値】
# getInactivityTimeout
再生状態でコントローラーおよびタイトルを表示してから自動的に非表示になるまでの時間を取得します。
【引数】
なし
【戻り値】
# getLiveMonitoring
LIVE配信監視用パラメータを取得します。
【引数】
なし
【戻り値】
# getMultiAngle
マルチアングル動画再生用パラメータを取得します。
【引数】
なし
【戻り値】
# getMuted
ミュート状態を取得します。
【引数】
なし
【戻り値】
# getNextPrevContent
次／前コンテンツ用パラメータを取得します。
【引数】
なし
【戻り値】
# getOriginalCurrentTime
コンテンツの現在の再生位置を取得します。切り出し再生が有効の場合、切り出し前の再生位置を取得します。
【引数】
なし
【戻り値】
# getOriginalDuration
コンテンツの尺を取得します。切り出し再生が有効の場合、切り出し前のコンテンツの尺を取得します。
【引数】
なし
【戻り値】
# getPartsSize
パーツサイズ用パラメータを取得します。
【引数】
なし
【戻り値】
# getPlaybackRange
切り出し再生用パラメータを取得します。
【引数】
なし
【戻り値】
# getPlaybackRate
再生中のコンテンツの再生速度を取得します。
【引数】
なし
【戻り値】
# getPlaybackRates
倍速再生用パラメータを取得します。
【引数】
なし
【戻り値】
# getPlayerStatus
プレイヤーの状態を取得します。
【引数】
なし
【戻り値】
# getPlayStartButtonEffect
再生開始ボタンのアニメーションを取得します。
【引数】
なし
【戻り値】
# getPoster
ポスター画像のURLを取得します。
【引数】
なし
【戻り値】
# getPosterSlideShow
スライドショー用パラメータを取得します。
【引数】
なし
【戻り値】
# getPresentation
プレゼンテーション用パラメータを取得します。
【引数】
なし
【戻り値】
# getReactionButtonVisible
リアクションボタンの表示／非表示を取得します。
【引数】
【戻り値】
# getReactionGraphData
リアクショングラフ作成用のデータを取得します。
【引数】
【戻り値】
# getReactionGraphVisible
リアクショングラフの表示／非表示を取得します。
【引数】
【戻り値】
# getReactionTotalCount
リアクションボタンの総押下数を取得します。
【引数】
【戻り値】
# getRepeat
リピート用パラメータを取得します。
【引数】
なし
【戻り値】
# getResumePlayback
レジューム再生用パラメータを取得します。
【引数】
なし
【戻り値】
# getSaveVolumeInfo
ボリューム情報の保存の許可／不許可を取得します。
【引数】
なし
【戻り値】
# getScreenLock
画面ロック用パラメータを取得します。
【引数】
なし
【戻り値】
# getScreenLockStatus
画面ロックの状態を取得します。
【引数】
なし
【戻り値】
# getSeekableRangeEnd
シーク有効範囲の終了位置を取得します。
【引数】
なし
【戻り値】
# getSeekableRangeOptions
シーク範囲制御用パラメータを取得します。
【引数】
なし
【戻り値】
# getSeekableRangeStart
シーク有効範囲の開始位置を取得します。
【引数】
なし
【戻り値】
# getSeekpreview
シークプレビュー用パラメータを取得します。
【引数】
なし
【戻り値】
# getSettingMenu
設定メニュー用パラメータを取得します。
【引数】
なし
【戻り値】
# getSettingMenuVisible
設定メニューの表示／非表示を取得します。
【引数】
なし
【戻り値】
# getSkin
現在のスキン名を取得します。
【引数】
なし
【戻り値】
# getSkipBackwardSeconds
現在の戻るボタン押下時に後方シークする秒数を取得します。
【引数】
なし
【戻り値】
# getSkipForwardAndBackward
進む／戻る用パラメータを取得します。
【引数】
なし
【戻り値】
# getSkipForwardSeconds
現在の進むボタン押下時に前方シークする秒数を取得します。
【引数】
なし
【戻り値】
# getSources
コンテンツのメディアソースを取得します。
【引数】
なし
【戻り値】
# getStreamType
コンテンツタイプを取得します。
【引数】
なし
【戻り値】
# getSubtitleArray
再生中のコンテンツの字幕情報のリストを取得します。
【引数】
なし
【戻り値】
# getSubtitles
字幕用パラメータを取得します。
【引数】
なし
【戻り値】
# getTitleOptions
タイトル用パラメータを取得します。
【引数】
なし
【戻り値】
# getTrackingOptout
トラッキングオプトアウトの有効／無効を取得します。
【引数】
なし
【戻り値】
- return: 真偽値
- 現在のトラッキングオプトアウトの有効／無効です。
# getVersion
プレイヤーのバージョンを取得します。
【引数】
なし
【戻り値】
# getVideoAnalyticsOptions
ULIZA Video Analytics (Cloud)連携用パラメータを取得します。
【引数】
なし
【戻り値】
- return: Object
- ULIZA Video Analytics (Cloud)連携用パラメータです。
詳細は videoAnalytics を参照してください。未設定のパラメータは省略して返します。
# getVideoTrack
画質切り替え用パラメータを取得します。
【引数】
なし
【戻り値】
# getVideoTrackArray
再生中のコンテンツのビデオトラック情報のリストを取得します。本APIを利用できない環境については、「ユーザーガイド (opens new window)」を参照してください。
【引数】
なし
【戻り値】
# getVisibleVideoAreaRect
動画表示領域の座標およびサイズを取得します。
注意
次に示す再生では、本APIにより正しい値を取得できない場合があります。
- ulizahtml5()の実行直後
- fullscreenchangeイベントの通知直後
【引数】
なし
【戻り値】
# getVolume
プレイヤーの音量を取得します。
【引数】
なし
【戻り値】
# getVolumeBarVertical
ボリュームバーの表示形式が縦表示かどうかを取得します。
【引数】
なし
【戻り値】
# getVolumeControlVisible
ボリュームボタンの表示／非表示を取得します。
【引数】
なし
【戻り値】
# getWatermark
ウォーターマーク用パラメータを取得します。
【引数】
なし
【戻り値】
# getWatermarkPosition
現在のウォーターマーク表示位置を取得します。
【引数】
なし
【戻り値】
# getWatermarkUrl
現在のウォーターマーク画像のURLを取得します。
【引数】
なし
【戻り値】
# getWatermarkVisible
現在のウォーターマークの表示状態を取得します。
【引数】
なし
【戻り値】
# getWidth
現在のプレイヤーの幅を取得します。
【引数】
なし
【戻り値】
# init
プレイヤーの初期化を行います。プレイヤーオプションを変更（コンテンツ切り替え）するには、API「setOptions」実行後に本APIを実行します。
【引数】
なし
【戻り値】
# isConnectingAirPlay
AirPlay接続状態を取得します。
【引数】
なし
【戻り値】
# isConnectingCast
Cast接続状態を取得します。
【引数】
なし
【戻り値】
# isFullscreen
プレイヤー画面がフルスクリーン状態か否かを取得します。
【引数】
なし
【戻り値】
# isLiveMonitoring
LIVE配信監視状態を取得します。
【引数】
なし
【戻り値】
# isLiveMonitoringSuccess
LIVE配信状態を取得します。
【引数】
なし
【戻り値】
# off
設定したコールバックを削除します。
【引数】
【戻り値】
# on
コールバックを設定します。
【引数】
【戻り値】
# one
1度だけ実行するコールバックを設定します。
【引数】
【戻り値】
# openLinearAdLink
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での再生
- リニア広告の再生
- 本編再生開始前および本編再生終了後
【引数】
【戻り値】
# reload
コンテンツをリロードします。
DASHコンテンツは非サポートです。
【引数】
なし
【戻り値】
なし
# removeAudioTrackLocalStorage
ブラウザのローカル記憶領域に保存されたオーディオを削除します。
【引数】
なし
【戻り値】
なし
# removeCenterControllerLine
センターコントローラーの行を削除します。
【引数】
【戻り値】
# removeMultiAngleLocalStorage
ブラウザのローカル記憶領域に保存されたアングルを削除します。
【引数】
なし
【戻り値】
なし
# removePartsSizeLocalStorage
ブラウザのローカル記憶領域に保存されたパーツサイズを削除します。
【引数】
なし
【戻り値】
なし
# removePlaybackRateLocalStorage
ブラウザのローカル記憶領域に保存された再生速度を削除します。
【引数】
なし
【戻り値】
なし
# removePresentationFullscreenViewLocalStorage
ブラウザのローカル記憶領域に保存された資料の表示状態を削除します。
【引数】
なし
【戻り値】
なし
# removeResumePlaybackLocalStorage
ブラウザのローカル記憶領域に保存された再生位置を削除します。
【引数】
なし
【戻り値】
なし
# removeSubtitleLocalStorage
ブラウザのローカル記憶領域に保存された字幕を削除します。
【引数】
なし
【戻り値】
なし
# removeVideoTrackLocalStorage
ブラウザのローカル記憶領域に保存された画質を削除します。
【引数】
なし
【戻り値】
なし
# removeVolumeLocalStorage
ブラウザのローカル記憶領域に保存されたボリューム／ミュートの情報を削除します。
【引数】
なし
【戻り値】
なし
# seekBackward
後方シークします。シークする秒数は、進む／戻る機能で指定の値です。
注意
次に示す再生では、本APIは適用されません。
- Default Video ControllerのUIが適用される環境での再生
- 進む／戻るが無効のプレイヤーでの再生
- リニア広告の再生
- LIVEの再生
- 再生開始前
【引数】
なし
【戻り値】
# seekBackwardBySeconds
指定秒数後方シークします。
注意
次に示す再生では、本APIは適用されません。
- Default Video ControllerのUIが適用される環境での再生
- リニア広告の再生
- LIVEの再生
- 再生開始前
【引数】
【戻り値】
- return: 真偽値
- シーク結果です。
true： シークに成功した。
false： シークに失敗した。
# seekForward
前方シークします。シークする秒数は、進む／戻る機能で指定の値です。
注意
次に示す再生では、本APIは適用されません。
- Default Video ControllerのUIが適用される環境での再生
- 進む／戻るが無効のプレイヤーでの再生
- リニア広告の再生
- LIVEの再生
- 再生開始前
- 再生完了後
【引数】
なし
【戻り値】
# seekForwardBySeconds
指定秒数前方シークします。
注意
次に示す再生では、本APIは適用されません。
- Default Video ControllerのUIが適用される環境での再生
- リニア広告の再生
- LIVEの再生
- 再生開始前
- 再生完了後
【引数】
【戻り値】
# seekTo
シークします。広告再生中はシークに失敗します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- リニア広告の再生
- LIVEの再生
- 再生開始前
- 再生完了後
【引数】
【戻り値】
# setAlternativeImage
代替画像を表示します。
【引数】
【戻り値】
# setAspectRatio
プレイヤーのアスペクト比を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- オーディオの再生
- プレイヤーの高さが指定されている環境での再生
【引数】
【戻り値】
# setAudioTrack
オーディオ切り替え用パラメータを設定します。不正な値の場合はデフォルト値になります。
【引数】
【戻り値】
# setAudioTrackMenuButtonVisible
音声ボタンの表示／非表示を設定します。
注意
オーディオ切り替えが非サポートの環境、オーディオ切り替えが無効の場合、本APIによる設定は適用されません。音声ボタンを表示しない環境や配信方式については、「ユーザーガイド (opens new window)」を参照してください。
【引数】
【戻り値】
# setBeginningButtonVisible
開始位置ボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- リニア広告の再生
- LIVE／DVRでの再生
- 再生開始前
- 再生完了後
【引数】
【戻り値】
# setCenterControllerVisible
PCブラウザでのセンターコントローラーの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- オーディオの再生
【引数】
【戻り値】
# setCenterControllerVisibleForMobile
モバイルブラウザでのセンターコントローラーの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- オーディオの再生
【引数】
【戻り値】
# setCenterForwardAndBackwardVisible
センターコントローラー上の進む／戻るボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- オーディオの再生
- リニア広告の再生
- LIVEの再生
【引数】
【戻り値】
# setCenterPlayStartVisible
再生開始ボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- 本編の再生
- オーディオの再生
【引数】
【戻り値】
# setCenterPlayToggleVisible
本編及び広告再生中のセンターコントローラー上の再生／一時停止ボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- オーディオの再生
- 再生開始前
【引数】
【戻り値】
# setChapter
チャプター用パラメータを設定します。不正な値の場合はデフォルト値になります。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- LIVE／DVRの再生
【引数】
【戻り値】
# setControlBarButton
コントロールバーボタンを上書きで設定します。すでに設定されているコントロールバーボタンは削除します。不正な値の場合はデフォルト値になります。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
【引数】
【戻り値】
# setControlBarButtonVisible
コントロールバーボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- コントロールバーボタン追加が無効のプレイヤーでの再生
【引数】
【戻り値】
# setControlBarVisible
コントロールバーの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
【引数】
【戻り値】
# setController
コントローラーカスタマイズ用パラメータを設定します。不正な値の場合はデフォルト値になります。
【引数】
【戻り値】
# setControls
コントローラーの操作可否を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
【引数】
【戻り値】
# setCurrentAudioTrack
プレイヤーが再生するオーディオトラックを指定します。
注意
オーディオ切り替えが非サポートの環境の場合、オーディオ切り替えが無効の場合、本APIによる設定は適用されません。本APIを利用できない環境については、「ユーザーガイド (opens new window)」を参照してください。
【引数】
【戻り値】
# setCurrentChapter
指定のチャプターの再生開始位置にジャンプします。
注意
次に示す再生では、本APIによる設定は適用されません。
- 再生開始前
- リニア広告の再生
- LIVE／DVRの再生
【引数】
【戻り値】
# setCurrentMultiAngleIndex
選択するアングルのインデックスを指定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- 再生開始前
- Default Video ControllerのUIが適用される環境での再生
【引数】
【戻り値】
# setCurrentPartsSizeIndex
パーツサイズインデックスを指定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
【引数】
【戻り値】
# setCurrentSubtitle
プレイヤーが表示する字幕を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
【引数】
【戻り値】
# setCurrentTime
指定の位置にジャンプします。再生開始前に実行する場合、環境によってはジャンプしない場合があります。シーク範囲制御で指定の範囲を無視してジャンプします。
【引数】
【戻り値】
# setCurrentTimeForSeekRange
シーク範囲制御の振る舞いに応じた位置にジャンプします。ジャンプ元と同じ位置へのジャンプは失敗します。再生開始前に実行する場合、環境によってはジャンプしない場合があります。
【引数】
【戻り値】
# setCurrentTimeVisible
コンテンツの現在の再生位置を示す文字列の表示／非表示を設定します。
注意
次に示す再生では本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- コンテンツの現在の再生位置が表示されないコンテンツタイプの再生
【引数】
【戻り値】
# setCurrentVideoTrack
プレイヤーが再生するビデオトラックを指定します。
注意
画質切り替えが非サポートの環境の場合、画質切り替えが無効の場合、本APIによる設定は適用されません。本APIを利用できない環境については、「ユーザーガイド (opens new window)」を参照してください。
【引数】
【戻り値】
# setCustomLayer
カスタムレイヤー用パラメータを設定します。不正な値の場合はデフォルト値になります。
【引数】
【戻り値】
# setCustomLayerVisible
カスタムレイヤーの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- カスタムレイヤーが無効のプレイヤーでの再生
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
【引数】
【戻り値】
# setDisableInlineFullscreen
ビデオビューア制御の有効／無効を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- リニア広告の再生
【引数】
【戻り値】
# setDisableRemoteSeek
リモートシーク制御の有効／無効を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- リニア広告の再生
- LIVE／DVRでの再生
【引数】
【戻り値】
# setDurationVisible
コンテンツの尺を示す文字列の表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- コンテンツの尺を示す文字列が表示されないコンテンツタイプの再生
- リニア広告の再生
【引数】
【戻り値】
# setEnableKeepLiveHead
HLS（LIVE）で一時停止の後、再生を再開する際にLIVEの先頭から再生を再開するか否かを設定します。
【引数】
【戻り値】
# setEnablePlayToggleInPlayerArea
PCブラウザでの再生における、プレイヤー表示領域の押下による再生状態／一時停止状態の切り替えの許可／不許可を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- 広告再生（Google仕様）
- ビデオビューアを使用した再生
【引数】
【戻り値】
# setEnablePlayToggleInPlayerAreaForMobile
モバイルブラウザでの再生における、プレイヤー表示領域の押下による再生状態／一時停止状態の切り替えの許可／不許可を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- 広告再生（Google仕様）
【引数】
【戻り値】
# setEnableSeekBarByUser
シークバーの操作許可／不許可を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- シークバーの操作ができないコンテンツタイプの再生
- リニア広告の再生
【引数】
【戻り値】
# setEnlargement
拡大表示用パラメータを設定します。不正な値の場合はデフォルト値になります。現在の拡大率より拡大表示用パラメータで指定するmaxRateが小さい場合、maxRateのサイズに縮小します。また、enableにfalseを指定する場合、拡大率を100%に戻します。
【引数】
【戻り値】
# setFixedControlBar
コントロールバーの表示位置を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- プレイヤー領域に資料を表示する設定での再生
【引数】
【戻り値】
# setForwardAndBackwardVisible
コントロールバー上の進む／戻るボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- リニア広告の再生
- LIVEの再生
【引数】
【戻り値】
# setFullscreen
フルスクリーン状態、インライン状態を切り替えます。
注意
ブラウザの仕様に依存する為、APIを実行しても状態が切り替わらない場合があります。
一例として、ユーザー操作を契機としない際に、フルスクリーン状態に切り替わらない場合があります。
ご利用の範囲で十分な検証を実施してください。
【引数】
【戻り値】
# setFullscreenToggleVisible
フルスクリーンボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
【引数】
【戻り値】
# setFullscreenType
フルスクリーンボタン押下時などでフルスクリーン状態に切り替える際のプレイヤー画面の拡大方式を変更します。
注意
次に示す再生では、本APIによる設定は適用されません。
- フルスクリーン状態での再生
【引数】
【戻り値】
# setGestureControl
ジェスチャー用パラメータを設定します。不正な値の場合はデフォルト値になります。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
【引数】
【戻り値】
# setHeight
プレイヤーの高さを設定します。
【引数】
【戻り値】
# setHelp
ヘルプ用パラメータを設定します。不正な値の場合はデフォルト値になります。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- オーディオの再生
- リニア広告の再生
- 再生開始前
【引数】
【戻り値】
# setHelpButtonVisible
ヘルプボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- オーディオの再生
- リニア広告の再生
- 再生開始前
- ヘルプが無効のプレイヤーでの再生
【引数】
【戻り値】
# setHelpVisible
ヘルプの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- オーディオの再生
- リニア広告の再生
- 再生開始前
- ヘルプが無効のプレイヤーでの再生
【引数】
【戻り値】
# setHotkey
ホットキー用パラメータを設定します。不正な値の場合はデフォルト値になります。
【引数】
【戻り値】
# setInactivityPauseTimeout
一時停止状態でコントローラーおよびタイトルを表示してから自動的に非表示になるまでの時間を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- オーディオの再生
設定する値は次に示すイベント後に適用します。
- プレイヤー上でマウスオーバーや押下などのユーザー操作が行われた
- API「setControls」でtrueを設定した
- API「setSkin」でスキン名を設定した
【引数】
【戻り値】
# setInactivityTimeout
再生状態でコントローラーおよびタイトルを表示してから自動的に非表示になるまでの時間を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- オーディオの再生
設定する値は次に示すイベント後に適用します。
- プレイヤー上でマウスオーバーや押下などのユーザー操作が行われた
- API「setControls」でtrueを設定した
- API「setSkin」でスキン名を設定した
【引数】
【戻り値】
# setLiveIndicatorVisible
ライブボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- ライブボタンが表示されないコンテンツタイプの再生
【引数】
【戻り値】
# setLiveMonitoring
LIVE配信監視用パラメータを設定します。不正な値の場合はデフォルト値になります。本APIを実行するとLIVE配信の監視を停止します。LIVE配信監視の自動開始が無効の場合、LIVE配信監視するには、LIVE配信監視開始のAPIを実行します。
【引数】
【戻り値】
# setMuted
プレイヤーのミュート状態を設定します。
【引数】
【戻り値】
# setNextChapterButtonVisible
次チャプターボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- LIVE／DVRの再生
- チャプターが無効のプレイヤーでの再生
【引数】
【戻り値】
# setNextContentButtonVisible
次コンテンツボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- 次／前コンテンツが無効のプレイヤーでの再生
【引数】
【戻り値】
# setNextPrevContent
次／前コンテンツ用パラメータを設定します。不正な値の場合はデフォルト値になります。
【引数】
【戻り値】
# setOptions
プレイヤーオプションの更新を行います。不正な値の場合はデフォルト値になります。
【引数】
【戻り値】
# setPanoramaCardboardButtonVisible
Cardboardボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- パノラマ動画再生用パラメータが指定されていないコンテンツの再生
- パノラマ動画再生が無効のプレイヤーでの再生
【引数】
【戻り値】
# setPartsSize
パーツサイズ用パラメータを設定します。不正な値の場合はデフォルト値になります。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
【引数】
【戻り値】
# setPartsSizeMenuButtonVisible
パーツサイズボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- パーツサイズが無効のプレイヤーでの再生
【引数】
【戻り値】
# setPictureInPictureButtonVisible
ピクチャーインピクチャーボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- オーディオの再生
- AirPlay接続中
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- ピクチャーインピクチャーが非サポートの環境での再生
【引数】
【戻り値】
# setPlaybackRate
プレイヤーが再生するコンテンツの再生速度を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- 倍速再生が無効のプレイヤーでの再生
【引数】
【戻り値】
# setPlaybackRateMenuButtonVisible
再生速度ボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- LIVEの再生
- 倍速再生用パラメータが指定されていないコンテンツの再生
- 倍速再生が利用できない環境での再生
- 倍速再生が無効のプレイヤーでの再生
【引数】
【戻り値】
# setPlaybackRates
倍速再生用パラメータを設定します。不正な値の場合はデフォルト値になります。
【引数】
【戻り値】
# setPlayStartButtonEffect
再生開始ボタンのアニメーションを設定します。
【引数】
【戻り値】
# setPlayToggleVisible
コントロールバー上の再生／一時停止ボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
【引数】
【戻り値】
# setPresentation
プレゼンテーション用パラメータを設定します。不正な値の場合はデフォルト値になります。
注意
次に示す再生では、displayInPlayerが強制的にfalseになります。
- オーディオの再生
- パノラマの再生
- マルチアングルの再生
- LIVE／DVRでの再生
- モバイルブラウザでの再生
【引数】
【戻り値】
# setPrevChapterButtonVisible
前チャプターボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- ビデオビューアを使用した再生
- LIVE／DVRの再生
- チャプターが無効のプレイヤーでの再生
【引数】
【戻り値】
# setPrevContentButtonVisible
前コンテンツボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- 次／前コンテンツが無効のプレイヤーでの再生
【引数】
【戻り値】
# setReactionButtonVisible
リアクションボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- ULIZA Video Analytics (Cloud)が無効のプレイヤーでの再生。ただし、トラッキングオプトアウトによる無効時は設定を適用します。
- リアクションが無効のプレイヤーでの再生
- LIVE／DVRでの再生
【引数】
【戻り値】
# setReactionGraphVisible
リアクショングラフの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- ULIZA Video Analytics (Cloud)が無効のプレイヤーでの再生。ただし、トラッキングオプトアウトによる無効時は設定を適用します。
- リアクションが無効のプレイヤーでの再生
- LIVE／DVRでの再生
【引数】
【戻り値】
# setRepeat
リピート用パラメータを設定します。不正な値の場合はデフォルト値になります。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- LIVE／DVRでの再生
【引数】
【戻り値】
# setRepeatButtonVisible
リピートボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- リピートが無効のプレイヤーでの再生
- LIVE／DVRでの再生
【引数】
【戻り値】
# setSaveVolumeInfo
ボリューム情報の保存の許可／不許可を設定します。
【引数】
【戻り値】
# setScale
指定する座標を中心点として拡大します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- 拡大表示が無効のプレイヤーでの再生
- オーディオの再生
- パノラマ動画の再生
- リニア広告の再生
- Cast中
- AirPlay接続中
- 再生開始前
【引数】
【戻り値】
# setScreenLock
画面ロック用パラメータを設定します。不正な値の場合はデフォルト値になります。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- オーディオの再生
【引数】
【戻り値】
# setScreenLockButtonVisible
画面ロックボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- オーディオの再生
- 画面ロックが無効のプレイヤーでの再生
【引数】
【戻り値】
# setScreenLockStatus
画面ロックの状態を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- オーディオの再生
【引数】
【戻り値】
# setSeekableRangeEnd
シーク有効範囲の終了位置を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- LIVE／DVRでの再生
【引数】
【戻り値】
# setSeekableRangeOptions
シーク範囲制御用パラメータを設定します。不正な値の場合はデフォルト値になります。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- LIVE／DVRでの再生
【引数】
【戻り値】
# setSeekableRangeStart
シーク有効範囲の開始位置を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- LIVE／DVRでの再生
【引数】
【戻り値】
# setSeekBarVisible
シークバーの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- シークバーが表示されないコンテンツタイプの再生
【引数】
【戻り値】
# setSeekpreview
シークプレビューパラメータを設定します。不正な値の場合はデフォルト値になります。
【引数】
【戻り値】
# setSettingMenu
設定メニュー用パラメータを設定します。不正な値の場合はデフォルト値になります。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- オーディオの再生
【引数】
【戻り値】
# setSettingMenuButtonVisible
設定メニューボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- オーディオの再生
- 設定メニューが無効のプレイヤーでの再生
【引数】
【戻り値】
# setSettingMenuVisible
設定メニューの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- オーディオの再生
- 設定メニューが無効のプレイヤーでの再生
【引数】
【戻り値】
# setSkin
スキンを切り替えます。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
【引数】
【戻り値】
# setSkipBackwardSeconds
戻るボタン押下時に後方シークする秒数を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- リニア広告の再生
- LIVEの再生
【引数】
【戻り値】
# setSkipForwardAndBackward
進む／戻る用パラメータを設定します。不正な値の場合はデフォルト値になります。
【引数】
【戻り値】
# setSkipForwardSeconds
進むボタン押下時に前方シークする秒数を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- リニア広告の再生
- LIVEの再生
【引数】
【戻り値】
# setSubtitles
字幕用パラメータを設定します。不正な値の場合はデフォルト値になります。
【引数】
【戻り値】
# setSubtitleMenuButtonVisible
字幕ボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- 字幕非サポートの環境での再生
- 字幕が無効のプレイヤーでの再生 字幕ボタンを表示しない環境や配信方式については、「ユーザーガイド (opens new window)」を参照してください。
【引数】
【戻り値】
# setTimeDividerVisible
再生位置と尺の間の「/」の表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- スキンdefaultの再生
- LIVEの再生
【引数】
【戻り値】
# setTitleOptions
タイトル用パラメータを設定します。不正な値の場合はデフォルト値になります。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
【引数】
【戻り値】
# setTrackingOptout
トラッキングオプトアウトの有効／無効を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- ULIZA Video Analytics (Cloud)連携が無効のプレイヤーでの再生
【引数】
【戻り値】
# setTrackingOptoutButtonVisible
トラッキングオプトアウトボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- ULIZA Video Analytics (Cloud)連携用パラメータが指定されていないコンテンツの再生
- ULIZA Video Analytics (Cloud)連携が無効のプレイヤーでの再生
【引数】
- bool: 真偽値
- トラッキングオプトアウトボタンの表示／非表示です。
詳細は videoAnalytics を参照してください。
【戻り値】
- return: 真偽値
- 実行結果です。
true： 設定に成功した。
false： 設定に失敗した。
# setVideoTrack
画質切り替え用パラメータを設定します。不正な値の場合はデフォルト値になります。
【引数】
【戻り値】
# setVideoTrackMenuButtonVisible
画質ボタンの表示／非表示を設定します。
注意
画質切り替えが非サポートの環境、画質切り替えが無効の場合、本APIによる設定は適用されません。画質ボタンを表示しない環境や配信方式については、「ユーザーガイド (opens new window)」を参照してください。
【引数】
【戻り値】
# setVolume
プレイヤーの音量を変更します。
注意
次に示す再生では、本APIによる設定は適用されません。
- iOSでの再生
【引数】
【戻り値】
# setVolumeBarVertical
PCでの視聴時、ボリュームボタンにカーソルを合わせることで表示するボリュームバーの表示形式（縦表示／横表示）を変更します。
【引数】
【戻り値】
# setVolumeControlVisible
ボリュームボタンの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- ミュート状態の有効、無効を切り替えられない環境での再生
【引数】
【戻り値】
# setWatermark
ウォーターマーク用パラメータを設定します。不正な値の場合はデフォルト値になります。
【引数】
【戻り値】
# setWatermarkPosition
ウォーターマーク表示位置を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
【引数】
【戻り値】
# setWatermarkUrl
ウォーターマーク画像のURLを設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
【引数】
【戻り値】
# setWatermarkVisible
ウォーターマークの表示／非表示を設定します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
【引数】
【戻り値】
# setWidth
プレイヤーの幅を設定します。
【引数】
【戻り値】
# showToast
トーストを表示します。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
【引数】
【戻り値】
なし
# skipLinearAd
リニア広告をスキップします。ただし、現在の広告の再生位置がVASTのskipoffset属性で指定されている秒数を越えていない場合は、リニア広告をスキップしません。
注意
次に示す再生では、本APIによる設定は適用されません。
- VASTのskipoffset属性の指定がないリニア広告の再生
- Default Video ControllerのUIが適用される環境での再生
- 本編の再生
- オーディオの再生
- 広告再生（Google仕様）
【引数】
なし
【戻り値】
# skipLiveHead
LIVEおよびDVRの先頭付近にシークします。
注意
次に示す再生では、本APIによる設定は適用されません。
- Default Video ControllerのUIが適用される環境での再生
- ビデオビューアを使用した再生
- VODの再生
- リニア広告の再生
- DVRの先頭付近の再生
【引数】
なし
【戻り値】
# startLiveMonitoring
LIVE配信監視を開始します。
【引数】
なし
【戻り値】
# startResume
レジューム確認コールバック関数が指定されている場合、レジューム確認待ち状態を解除し、再生処理を再開します。本APIは、ボタン押下イベント等のユーザー操作イベントから同期で実行しない場合、ブラウザの仕様により、再生が正しく開始されない場合があります。
【引数】
【戻り値】
# stopLiveMonitoring
LIVE配信監視を停止します。
【引数】
なし
【戻り値】
# 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で指定するコールバック関数です。
【引数】
【戻り値】
補足
ボタン状態の配列に含まれる要素に0以上の整数を昇順で割り当てた値をボタン状態インデックスと呼びます。以下は、3つのボタン状態を持つコントロールバーボタンとボタン状態インデックスの例です。
controlBarButton: {
enable: true,
item: [
{
id: 'ContorolBarButtonId',
state: [
{
textJa: 'No0' // ボタン状態インデックス=0
},
{
textJa: 'No1' // ボタン状態インデックス=1
},
{
textJa: 'No2' // ボタン状態インデックス=2
}
]
}
]
}
# キー押下コールバック関数
プレイヤーオプションhotkey.eventListenerで指定するコールバック関数です。ホットキーが無効の場合は実行しません。実行対象のキーはECMAScriptで定義されているkeydownイベントで実行されるキーに準拠します。
【引数】
【戻り値】
# レジューム確認コールバック関数
プレイヤーオプションresumePlayback.resumeConfirmFuncで指定するコールバック関数です。
【引数】
【戻り値】
なし
← デザインカスタマイズ 改版履歴 →