このトピックでは、Aliplayer がサポートするプロパティ、メソッド、およびイベントについて説明します。
Aliplayer の使用中に問題が発生した場合は、「Web プレーヤー よくある質問」または「再生エラーの自己トラブルシューティング」をご参照ください。
プロパティ
Aliplayer を初期化する際には、複数のプロパティを設定できます。これらのプロパティには、ライセンス権限付与、メディアソース情報、プレーヤー UI 設定、および再生動作が含まれます。
名前 | 型 | 説明 |
id | String | プレーヤーの外側コンテナの DOM 要素 ID。 |
source | String | URL による再生を使用する場合、このプロパティで動画 URL を指定します。 説明
|
vid | String | ApsaraVideo Media Processing サービスのメディア ID。 |
playauth | String | 再生認証情報。再生認証情報の取得手順については、「再生認証情報の取得」をご参照ください。 |
customVodServer | String | VOD プロキシ用のカスタムドメイン(VidAuth 再生モードバージョン 2.32.0 以降でサポート)。専用のリクエストプロキシサービスを「デプロイ」する必要があります。デフォルトの VOD ドメイン(*.aliyuncs.com)に到達できない場合、プレーヤーは自動的にお客様のプロキシサービスにフォールバックします。これにより、ISP によるハイジャックを回避し、再生の安定性と成功率を向上させます。 |
playConfig | JSON | Vid(VidAuth または VidSts)による再生時に使用されるカスタム設定。これらは VOD API に直接渡されます。「メディア再生のカスタム PlayConfig 設定」でサポートされるフィールドおよびパラメーターの説明をご参照ください。例: |
authTimeout | Number | Vid(VidAuth または VidSts)で取得した動画再生 URL の有効期間。単位:秒。デフォルト値:7200。 再生が完了する前に再生 URL が失効しないよう、この値を実際の動画再生時間より長く設定してください。 |
height | String | プレーヤーの高さ。有効な値:
|
width | String | プレーヤーの幅。有効な値:
|
autoSize | Boolean | String | 動画コンテンツに合わせてプレーヤーサイズを自動調整します。有効な値:'height' または 'width'。 たとえば、width: '500px' および autoSize: 'height' を設定すると、プレーヤーの幅は固定の 500px となり、高さは動画のアスペクト比に基づいて調整されます。 また、height: '500px' および autoSize: 'width' を設定すると、プレーヤーの高さは固定の 500px となり、幅は動画のアスペクト比に基づいて調整されます。 注:autoSize: true は autoSize: 'height' と等価です。高さの自動調整がデフォルトです。 |
videoWidth | String | 動画の幅。詳細については、「表示モードの設定」をご参照ください。 |
videoHeight | String | 動画の高さ。詳細については、「表示モードの設定」をご参照ください。 |
preload | Boolean | プレーヤーが自動的に読み込みを行います。 |
cover | String | プレーヤーのデフォルトカバーアイコン。有効な画像 URL を入力してください。この設定は、autoplay を false に設定した場合にのみ有効です。 |
isLive | Boolean | コンテンツがライブ配信であるかどうかを示します。有効にすると、ユーザーはプログレスバーをドラッグできなくなります。デフォルト値:false。ライブ配信の場合は true を設定します。 |
autoplay | Boolean | プレーヤーの自動再生を有効にします。モバイル端末では自動再生が失敗することがあります。有効な値:
説明 ブラウザの制限により、Web プレーヤー SDK での自動再生が失敗することがあります。詳細については、「高度な機能」をご参照ください。 |
autoplayPolicy | Object | ミュート再生を伴う自動再生に対する適応的ポリシーをサポートします。このプロパティは、 説明
|
rePlay | Boolean | 自動ループ再生を有効にします。 |
useH5Prism | Boolean | HTML5 プレーヤーを使用します。 |
playsinline | Boolean | HTML5 のインライン再生を有効にします。一部の Android ブラウザではサポートされていません。 |
skinRes | Url | スキン画像の URL。このフィールドの変更は推奨されません。スキンのカスタマイズについては、「プレーヤースキンのカスタマイズ」をご参照ください。 |
skinLayout | Array | Boolean | UI コンポーネントのレイアウトを構成します。このプロパティを省略すると、デフォルトのレイアウトが使用されます。false を設定すると、すべての UI コンポーネントが非表示になります。「skinLayout プロパティの構成」をご参照ください。 |
skinLayoutIgnore | Array | 非表示にする UI コンポーネントのリスト。「VOD コンポーネントパラメーターのリファレンス」でコンポーネント名をご確認ください。設定例: 説明 skinLayoutIgnore は skinLayout よりも優先されます。 |
controlBarVisibility | String | コントロールパネルの実装方法。有効な値は以下の通りです:
|
showBarTime | Number | コントロールバーが自動的に非表示になるまでの時間(ミリ秒単位)。 |
enableSystemMenu | Boolean | システムの右クリックメニューを有効にします。デフォルト値:false。 |
format | String | 再生 URL のフォーマットを指定します。有効な値:
デフォルト値:空。 |
mediaType | String | 音声または動画を返すかを指定します。vid を使用した再生の場合のみサポートされます。デフォルト値:video。有効な値:
|
qualitySort | String | 並べ替え順序を指定します。Vid + PlayAuth 再生の場合のみサポートされます。有効な値:
デフォルト値:asc。 |
definition | String | 表示する動画ディフィニションを定義します。複数のディフィニションはカンマ(,)で区切ります。例:'FD,LD'。これは、指定された vid で利用可能なディフィニションのサブセットです。有効な値:
|
defaultDefinition | String | デフォルトの動画ディフィニションを設定します。これは、指定された vid で利用可能なディフィニションのいずれかである必要があります。有効な値:
|
autoPlayDelay | Number | 再生開始までの遅延時間。単位:秒。 |
language | String | 国際化の言語を設定します。デフォルト値:zh-cn。省略した場合、ブラウザの言語が使用されます。有効な値:
|
languageTexts | JSON | JSON 形式のカスタム国際化テキスト。キーは language プロパティの値と一致させる必要があります。例:{jp:{Play:"Play"}}。キーの一覧については、「JSON 構造」をご参照ください。 |
snapshotWatermark | Object | HTML5 プレーヤーのスクリーンショットウォーターマークを構成します。 |
useHlsPluginForSafari | Boolean | Safari ブラウザ(Safari 11 を除く)向けに HLS プラグインを有効にします。有効な値:
|
enableStashBufferForFlv | Boolean | HTML5 プレーヤーにおける FLV の再生キャッシュを有効にします。ライブ配信にのみ適用されます。有効な値:
|
stashInitialSizeForFlv | Number | HTML5 プレーヤーにおける FLV の初期キャッシュサイズ。ライブ配信にのみ適用されます。デフォルト値:32 KB。 値を小さくすると起動速度が向上しますが、小さすぎると短時間後にコマ落ちが発生する可能性があります。 |
loadDataTimeout | Number | バッファリング中に、ユーザーに低ディフィニションへの切り替えを促すまでの時間(秒単位)。デフォルト値:20。 |
waitingTimeout | Number | 最大バッファリングタイムアウト。この時間を超えるとエラーメッセージが表示されます。単位:秒。デフォルト値:60。 |
diagnosisButtonVisible | Boolean | 診断ボタンを表示します。有効な値:
|
disableSeek | Boolean | プログレスバーによるシーク操作を無効にします。有効な値:
|
encryptType | Number | Alibaba Cloud 動画暗号化(プライベート暗号化)を有効にします。デフォルト値:0。有効な値:
|
progressMarkers | Array | プログレスマーカーオブジェクトの配列。「プログレスバーのマーカー」をご参照ください。 |
vodRetry | Number | VOD 再生失敗時のリトライ回数。デフォルト値:3。 |
liveRetry | Number | ライブ配信再生失敗時のリトライ回数。デフォルト値:5。 |
hlsFrameChasing | Boolean | HLS ライブ配信におけるフレーム同期を有効にします。有効な値:
説明 このパラメーターは Web プレーヤー SDK バージョン 2.21.0 より前のバージョンでのみ設定可能です。バージョン 2.21.0 以降では、HLS ライブ配信モードにおけるフレーム同期を有効にするには、「 |
chasingFirstParagraph | Number | 最初のフレーム同期セグメントの持続時間。単位:秒。デフォルト値:20。 説明 このパラメーターは Web プレーヤー SDK バージョン 2.21.0 より前のバージョンでのみ設定可能です。バージョン 2.21.0 以降では、HLS ライブ配信モードにおけるフレーム同期を設定するには、「 |
chasingSecondParagraph | Number | 2 番目のフレーム同期セグメントの持続時間。単位:秒。デフォルト値:40。 説明 このパラメーターは Web プレーヤー SDK バージョン 2.21.0 より前のバージョンでのみ設定可能です。バージョン 2.21.0 以降では、HLS ライブ配信モードにおけるフレーム同期を設定するには、「 |
chasingFirstSpeed | Number | 最初のフレーム同期セグメントの再生速度。デフォルト値:1.1×。 説明 このパラメーターは Web プレーヤー SDK バージョン 2.21.0 より前のバージョンでのみ設定可能です。バージョン 2.21.0 以降では、HLS ライブ配信モードにおけるフレーム同期を設定するには、「 |
chasingSecondSpeed | Number | 2 番目のフレーム同期セグメントの再生速度。デフォルト値:1.2×。 説明 このパラメーターは Web プレーヤー SDK バージョン 2.21.0 より前のバージョンでのみ設定可能です。バージョン 2.21.0 以降では、HLS ライブ配信モードにおけるフレーム同期を設定するには、「 |
hlsOption.maxLiveSyncPlaybackRate | Number | HLS ライブ配信におけるフレーム同期の再生速度を設定します。デフォルト値:1(フレーム同期なし)。
説明 このパラメーターは Web プレーヤー SDK バージョン 2.21.0 以降でのみサポートされます。 |
flvFrameChasing | Boolean | FLV ライブ配信におけるフレーム同期を有効にします。有効な値:
デフォルト値:false。 |
keyShortCuts | Boolean | キーボードショートカットを有効にします。有効な値:
デフォルト値:false。 説明 矢印キー(左右)で早送りおよび巻き戻しを制御します。矢印キー(上下)で音量を制御します。スペースキーで再生/一時停止を切り替えます。 |
keyFastForwardStep | Number | 早送りおよび巻き戻しの時間間隔。単位:秒。デフォルト値:10。 |
rtsFallback | Boolean | ブラウザが RTS をサポートしていない場合、または RTS ストリームフェッチングが失敗した場合、プレーヤーは自動的に FLV または HLS にフォールバックします。低遅延を実現するために、FLV を優先します。ブラウザが FLV をサポートしていない場合は、HLS にフォールバックします。 この機能はデフォルトで有効です。無効にするには、このパラメーターを false に設定します。 |
rtsFallbackType | String | RTS からフォールバックするプロトコルを指定します。有効な値:HLS または FLV。デフォルトでは、プレーヤーが自動的に選択し、低遅延を実現するために FLV を優先します。ブラウザが FLV をサポートしていない場合は、HLS にフォールバックします。 |
rtsFallbackSource | String | プレーヤーのデフォルトフォールバック戦略の使用を推奨します。ただし、固定のストリーム URL をフォールバック先として指定したい場合は、このパラメーターを使用します。 |
traceId | String | お客様固有のユーザー識別子。この値をパブリックな計測ポイントに渡すことで、ログ報告を追跡できます。Web プレーヤー SDK ではデフォルトでログ報告が有効になっています。traceId を渡すことで、ユーザーを特定できます。省略した場合、Web プレーヤー SDK が UUID を生成し、ブラウザのキャッシュに保存します。 説明 Web プレーヤー SDK バージョン 2.10.0 以降でサポートされます。 |
textTracks | Array | 外部 WebVTT 字幕を構成します。例: フィールドの説明:
|
ratio | Number | プレーヤーを固定アスペクト比でスケーリングするように設定します。たとえば、動画のアスペクト比が 16:9 の場合、プレーヤーのパラメーターを |
extLanguageTexts | Object | Web プレーヤー SDK には、組み込みの中国語および英語 UI テキストが含まれています。このプロパティを使用して、特定の UI 要素のテキストをカスタマイズできます。たとえば、HD の表示を high definition から 1080p に変更する場合: |
speedLevels | Array | 再生速度リストをカスタマイズします。各オブジェクトにはキー(速度値)とテキスト(UI ラベル)が含まれます。省略した場合、デフォルトのリストが使用されます。例: |
logo | Array | カスタムロゴ画像を構成します。例: フィールドの説明:
|
license | Object | 再生品質モニタリング(旧)、単一ポイントトラブルシューティング、またはH.265/H.266 動画再生などの付加価値機能を利用するには、まず「Web プレーヤー SDK 付加価値サービス申請フォーム」を提出してライセンスを取得する必要があります。その後、以下のようにライセンスを統合します: |
mute | Boolean | ミュート再生を有効にします。ブラウザが自動再生をブロックした場合にミュート再生を伴う自動再生を有効にするために、このパラメーターを構成します。詳細については、「高度な機能」をご参照ください。 |
clickPause | Boolean | 動画エリアをクリックして再生/一時停止を切り替えます。
デフォルト値:デスクトップ環境では true、モバイル環境では false です。インタラクションの競合を避けるため、dbClickSkip との併用は避けてください。 |
disablePip | Boolean | ブラウザのネイティブのピクチャーインピクチャー(PiP)ボタンを非表示にします。 説明
|
env | String | デフォルトでは、プレーヤーのテレメトリデータは中国のデータセンターにアップロードされます。中国以外の地域でのコンプライアンス要件がある場合は、env: 'SEA' を設定して、データをシンガポールのデータセンターにアップロードします。 |
watchStartTime | Number | 再生の開始時刻を個別に設定します。 watchEndTime と併用して、時間範囲再生を有効にします。ユーザーは指定された時間範囲内でのみ再生およびシーク操作が可能です。 単位:秒 |
watchEndTime | Number | watchStartTime と併用して、時間範囲再生を有効にします。ユーザーは指定された時間範囲内でのみ再生およびシーク操作が可能です。 この値が watchStartTime より小さい場合、watchStartTime は無視されます。 単位:秒 |
start | Number | start および end を使用して、動画からセグメントを抽出します。たとえば、元の動画が 60 秒の場合、start: 10 および end: 30 を設定すると、プレーヤーは元の動画の 10 秒目から始まる 20 秒間の動画を表示します。 |
end | Number | start および end を使用して、動画からセグメントを抽出します。たとえば、元の動画が 60 秒の場合、start: 10 および end: 30 を設定すると、プレーヤーは元の動画の 10 秒目から始まる 20 秒間の動画を表示します。 |
dbClickFullscreen | Boolean | ダブルクリックで全画面表示を有効にします。デスクトップ環境ではデフォルトで有効です。 |
longPressFastForward | Boolean | 長押しによる早送りを有効にします(モバイル端末のみ)。有効な値:
|
dbClickSkip | Boolean | 左側をダブルクリックすると巻き戻し、右側をダブルクリックすると早送り(モバイル端末のみ)。有効な値:
インタラクションの競合を避けるため、clickPause との併用は避けてください。 |
enableMockFullscreen | Boolean | CSS ベースの疑似全画面表示を有効にします。デフォルトでは、プレーヤーはブラウザの全画面 API を呼び出します。iOS および一部の Android ブラウザでは、システムプレーヤーが全画面表示を制御し、UI の問題が発生する場合があります。このパラメーターを有効にすることで、システムプレーヤーによる制御を回避できます。デフォルト値:false。 |
watermark | Object | ダイナミックウォーターマークを構成します。例: フィールドの説明:
|
memoryPlay | Object | 再生の再開を有効にするには、プレーヤー構成に フィールドの説明:
|
menuMode | String | 再生速度、ディフィニション、字幕、音声トラックのコントロールを表示する場所を設定します。有効な値:
|
メソッド
これらのメソッドは、ready イベントが発生した後、またはプレーヤーを作成する際の ready コールバック内で呼び出すことができます。例:
// 方法 1:
var player = new Aliplayer({}, function (player) {
player.play();
});
// 方法 2:
var player = new Aliplayer({});
function handleReady(player) {
player.play();
};
player.on('ready', handleReady);Aliplayer インスタンスで使用可能なメソッド:
play()
再生を開始します。
関数定義
() => Playerpause()
再生を一時停止します。
(showPlayButton?: boolean) => Playerパラメーター
名前 | 型 | 必須 | 説明 |
showPlayButton | Boolean | いいえ | 再生ボタンを表示します。 |
replay()
再生を再開します。
関数定義
() => Playerseek()
特定の時間にジャンプします。
関数定義
(time: number) => Player パラメーター
名前 | 型 | 必須 | 説明 |
time | number | はい | ジャンプ先の時間。単位:秒。 |
dispose()
プレーヤーを破棄します。
関数定義
() => voidgetCurrentTime()
現在の再生時間を取得します。単位は秒です。
関数定義
() => numbergetDuration()
動画の総再生時間を取得します。単位は秒です。動画が読み込まれた後、または play イベントが発生した後にこのメソッドを呼び出すことができます。
関数定義
() => numbergetVolume()
現在の音量を取得します。0 から 1 の間の実数を返します。iOS および一部の Android デバイスではサポートされていません。
関数定義
() => number | undefinedsetVolume()
音量を設定します。
関数定義
(volume: number) => voidパラメーター
名前 | 型 | 必須 | 説明 |
volume | number | はい | 0 から 1 の間の実数で表される音量。iOS および一部の Android デバイスではサポートされていません。 |
mute()
再生をミュートします。
関数定義
(quiet?: boolean) => Playerパラメーター
名前 | 型 | 必須 | 説明 |
quiet | boolean | いいえ | 左下隅に表示されるミュート/ミュート解除ステータステキストを非表示にします。 |
unMute()
再生のミュートを解除します。
関数定義
(quiet?: boolean) => Playerパラメーター
名前 | 型 | 必須 | 説明 |
quiet | boolean | いいえ | ミュート解除時に左下隅に表示されるテキストプロンプトを非表示にするかどうか。 |
getPlayTime()
実際の再生時間(一時停止時間を除く)を取得します。可変速度再生の場合、これは実際の経過時間を返します。単位は秒です。
関数定義
() => numberloadByUrl()
別の動画に切り替えます。MP4、HLS、FLV など、同じフォーマットの動画間でのみ切り替えをサポートします。異なるフォーマット間で切り替えるには、プレーヤーを破棄して新しいインスタンスを作成する必要があります。
関数定義
(url: string, seconds?: number, autoPlay?: boolean) => voidパラメーター
名前 | 型 | 必須 | 説明 |
url | string | はい | 切り替える動画の URL。 |
seconds | number | いいえ | 切り替え後の再生開始時間。 |
autoPlay | boolean | いいえ | 切り替え後に自動的に再生を開始します。 |
replayByVidAndPlayAuth()
別の VOD 動画に切り替えます。同じフォーマットの動画間でのみ切り替えをサポートします。
関数定義
(vid: string, playauth: string) => voidパラメーター
名前 | 型 | 必須 | 説明 |
vid | string | はい | 動画 ID。 |
playauth | string | はい | 再生認証情報。 |
replayByVidAndAuthInfo()
別の MPS 動画に切り替えます。同じフォーマットの動画間でのみ切り替えをサポートします。
関数定義
(vid: string, accId: string, accSecret: string, stsToken: string, authInfo: string, domainRegion: string) => voidパラメーターの詳細については、「MPS 再生」をご参照ください。
replayByMediaAuth()
別の Universal Media Service 動画に切り替えます。同じフォーマットの動画間でのみ切り替えをサポートします。
関数定義
(mediaAuth: string) => voidパラメーター
名前 | 型 | 必須 | 説明 |
mediaAuth | string | はい | 再生認証情報。 |
getBuildInComponent()
組み込み UI コンポーネント(全画面表示ボタンやプログレスバーなど)を取得します。
関数定義
(name: string) => BuildInComponent;パラメーター
名前 | 型 | 必須 | 説明 |
name | string | はい | 組み込みコンポーネントの名前(例:fullScreenButton)。コンポーネント名の一覧については、「skinLayout プロパティの構成」をご参照ください。各コンポーネントは hide および show メソッドをサポートします。 |
setPlayerSize()
プレーヤーサイズを設定します。
関数定義
(width: string, height: string) => voidパラメーター
名前 | 型 | 必須 | 説明 |
width | string | はい | プレーヤーサイズを設定します。有効な値:
|
height | string | はい |
setSpeed()
手動で再生速度を設定します。モバイル端末(Android 向け WeChat など)では動作しない場合があります。速度制御はデフォルトで有効です。
関数定義
(speed: number) => voidパラメーター
名前 | パラメータータイプ | 必須 | 説明 |
speed | number | はい | 0.5× から 2× の再生速度をサポートします。 |
速度制御を無効にするには:
個別に速度制御を無効化またはカスタマイズすることはできません。グローバルに無効化する必要があります。
CSS オーバーライドによる速度制御の無効化:
.prism-setting-speed { display: none !important; }
setTraceId()
ログ追跡のための共通計測情報を渡します。
関数定義
(traceId: string) => voidパラメーター
名前 | 型 | 必須 | 説明 |
traceId | string | はい | 一意の識別子。 |
Web プレーヤー SDK バージョン 2.10.0 以降でサポートされます。
setSanpshotProperties()
スクリーンショット設定を構成します。
関数定義
(width: number, height: number, rate: number) => voidパラメーター
名前 | 型 | 必須 | 説明 |
width | number | はい | 幅および高さの単位:ピクセル。スクリーンショット品質範囲:0~1(デフォルト:1)。詳細については、「動画スクリーンショット」をご参照ください。 |
height | number | はい | |
rate | number | はい |
fullscreenService.requestFullScreen()
全画面表示を開始します。
関数定義
() => PlayerfullscreenService.cancelFullScreen()
全画面表示を終了します。iOS ではサポートされていません。
関数定義
() => PlayerfullscreenService.getIsFullScreen()
全画面表示状態を取得します。
関数定義
() => booleangetStatus()
プレーヤーの状態を取得します。文字列を返します。例:
init:初期化中。
ready:準備完了。
loading:読み込み中。
play:再生中。
pause:一時停止中。
playing:再生中。
waiting:バッファリング中。
error:エラー発生。
終了:終了。
関数定義
() => stringliveShiftSerivce.setLiveTimeRange()
ライブ配信の開始および終了時刻を設定します。これにより、タイムシフトが有効になります。
関数定義
(start: string, end: string) => voidパラメーター
名前 | 型 | 必須 | 説明 |
start | string | はい | ライブ配信の開始時刻。 |
end | string | はい | ライブ配信の終了時刻。 |
例
player.liveShiftSerivce.setLiveTimeRange('2025/03/21 12:43:00', '2025/03/21 23:31:00')setRotate()
プレーヤーの回転角度を設定します。
関数定義
(rotate: number) => voidパラメーター
名前 | 型 | 必須 | 説明 |
rotate | number | はい | 正の値は時計回り、負の値は反時計回りに回転します。例:setRotate(90)。「表示モードの設定」をご参照ください。 |
getRotate()
プレーヤーの回転角度を取得します。
関数定義
() => number詳細については、「表示モードの設定」をご参照ください。
setImage()
ミラー表示を適用します。
関数定義
(type: string) => voidパラメーター
名前 | 型 | 必須 | 説明 |
type | string | はい | 有効な値:
例:setImage('horizon')。「表示モードの設定」をご参照ください。 |
setCover()
カバー画像を設定します。
関数定義
(coverUrl: string) => voidパラメーター
名前 | 型 | 必須 | 説明 |
coverUrl | string | はい | サムネイル URL。 |
setProgressMarkers()
プログレスマーカーを設定します。
関数定義
(markers: Array<{ time: number, text: string }>) => voidパラメーター
名前 | 型 | 必須 | 説明 |
markers | Array<markers> | はい | markers:マーカーオブジェクトの配列(必須)。 marker.time:マーカーの時間(必須)。 marker.text:マーカーのテキストラベル(必須)。 progressMarkers パラメーターの詳細については、上記を参照してください。 |
setPreviewTime()
プレビュー持続時間を設定します。
関数定義
(time: number) => voidパラメーター
名前 | 型 | 必須 | 説明 |
time | number | はい | 単位:秒。「プレビュー」をご参照ください。 |
getPreviewTime()
プレビュー持続時間を取得します。
関数定義
() => numberisPreview()
プレビューモードが有効かどうかを確認します。
関数定義
() => booleangetCurrentPDT()
HLS 動画ストリームの現在の ProgramDateTime を取得します。
関数定義
() => number | undefinedsetTextTracks()
WebVTT 字幕の配列を設定します。
関数定義
(textTracks: Array<{ kind: string, label: string, src: string, srclang: string }>) => voidパラメーター
名前 | 型 | 必須 | 説明 |
textTracks | Array<object> | はい | 例: 説明 Web プレーヤー SDK バージョン 2.12.0 以降でサポートされます。 |
setLogo()
カスタムロゴ画像を設定します。
関数定義
(logoList: Array<{ width: number, position: string, origin: string, src: string }>) => voidパラメーター
名前 | 型 | 必須 | 説明 |
logoList | Array<object> | はい | 例: フィールドの説明については、プロパティ:logo をご参照ください。 |
setWatchTime()
現在の動画の watchStartTime/watchEndTime を動的に更新します。
関数定義
(start: number, end: number) => voidパラメーター
名前 | 型 | 必須 | 説明 |
start | string | はい | 開始時刻。 |
end | string | はい | 終了時刻。 |
setNextWatchTime()
次の動画の watchStartTime/watchEndTime を設定します。loadByUrl または replayByVidAndPlayAuth を使用して動画を切り替える場合、次の動画の時間範囲が現在の動画と異なる場合は、まず setNextWatchTime を呼び出す必要があります。
関数定義
(start: number, end: number) => voidパラメーター
名前 | 型 | 必須 | 説明 |
start | string | はい | 開始時刻。 |
end | string | はい | 終了時刻。 |
setStartEnd()
現在の動画の start/end を動的に更新します。
関数定義
(start: number, end: number) => voidパラメーター
名前 | 型 | 必須 | 説明 |
start | string | はい | 開始時刻。 |
end | string | はい | 終了時刻。 |
setNextStartEnd()
次の動画の start/end を設定します。loadByUrl または replayByVidAndPlayAuth を使用して動画を切り替える場合、次の動画のセグメント範囲が現在の動画と異なる場合は、まず setNextStartEnd を呼び出す必要があります。
関数定義
(start: number, end: number) => voidパラメーター
名前 | 型 | 必須 | 説明 |
start | string | はい | 開始時刻。 |
end | string | はい | 終了時刻。 |
takeSnapshot()
スクリーンショットを撮影します。返された base64 文字列は、直接 img.src として使用できます。setSnapshotProperties を使用してスクリーンショット品質を構成し、snapshotWatermark を使用してウォーターマークを追加できます。
注:一部のモバイルブラウザ(UC ブラウザや QQ ブラウザなど)では、video タグがハイジャックされているため、スクリーンショット機能が動作しない場合があります。
関数定義
() => { time: number, base64: string, binary: string, error: Error | null }戻り値
名前 | 型 | 説明 |
time | string | スクリーンショットの時間。 |
base64 | string | Base64 エンコードされたスクリーンショットコンテンツ。 |
binary | string | スクリーンショットコンテンツのバイナリ文字列表現。 |
error | Error | スクリーンショットエラーの詳細。 |
showControlBar()
コントロールバーを表示します。
関数定義
() => voidhideControlBar()
コントロールバーを非表示にします。
関数定義
() => voidイベント
プレーヤーイベント
名前 | 説明 |
ready | プレーヤー UI のレンダリングが完了したとき。このイベント後に UI 初期化ロジックを実行することで、デフォルトの初期化によって上書きされるのを防ぎます。 説明 このイベントが発生した後のみ、プレーヤーメソッドを呼び出すことができます。 |
play | 一時停止から再生が再開されたときに発生します。 |
pause | 再生が一時停止されたときに発生します。 |
canplay | オーディオまたはビデオの再生を開始できるようになったときに発生します。このイベントは複数回発生する可能性があります。HTML5 プレーヤーのみ対応。 |
playing | 再生中に繰り返し発生します。 |
ended | 現在の動画の再生が終了したときに発生します。 |
liveStreamStop | ライブストリームが停止したときに発生します。HLS ライブストリームの場合、5 回の失敗したリトライ後に発生します。アプリケーション層に、ストリームが停止したか、再読み込みが必要であることを通知します。 説明 HLS ライブストリームが失敗または切断された場合、プレーヤーは自動的に 5 回リトライします。アプリケーション層で追加のリトライロジックを実装しないでください。 |
onM3u8Retry | HLS ライブストリームの中断後にプレーヤーがリトライするたびに 1 回発生します。 |
hideBar | コントロールバーが自動的に非表示になったときに発生します。 |
showBar | コントロールバーは自動的にイベントを表示します。 |
waiting | データのバッファリング中に発生します。 |
timeupdate | 再生位置が変更されたときに発生します。現在の再生時間を取得するには、getCurrentTime() を呼び出します。 |
snapshoted | スクリーンショットの撮影が完了したときに発生します。 |
requestFullScreen | 全画面表示に入ったときに発生します。 |
cancelFullScreen | 全画面表示を終了したときに発生します。iOS では発生しません。 |
error | エラーが発生したときに発生します。 |
startSeek | ドラッグ操作の開始時に、ドラッグポイントの作成時刻をパラメーターとして返します。 |
completeSeek | ドラッグ操作を完了したときに、ドラッグポイントのタイムスタンプをパラメーターとして返します。 |
resolutionChange | ライブストリームのソースが解像度を変更したときに発生します。 |
seiFrame | HLS または FLV 経由で SEI メッセージを受信したときに発生します。 |
rtsFallback | RTS がフォールバックしたときに発生します。 |
settingSelected | 設定(再生速度、ディフィニション、字幕など)が選択されたときに発生します。 説明 オープンソースの速度プラグインはプレーヤーと同期しないため、これを使用するにはカスタムコードと再コンパイルが必要です。独自のイベントリスナーを定義してください。プレーヤーの |
rtsTraceId | RTS ストリームフェッチングが成功したときにこのイベントがトリガーされ、RTS TraceId を取得するためにサブスクライブできます。ログ出力では、 |
autoplay | 自動再生が成功または失敗したときに発生します。コールバックパラメーター |
mutedAutoplay | ミュート再生を伴う自動再生が成功し、 |
videoUnavailable | エンコーディングがサポートされていないために動画再生が失敗し、ブラックスクリーンが表示されたときに発生します。たとえば、H.265 をサポートしていないブラウザで H.265 動画を再生すると、音声のみ再生され、ブラックスクリーンが表示されます。 |
イベントサブスクリプション
プレーヤーインスタンスの on メソッドを使用して、イベントをサブスクライブできます。例:
function handleReady() {}; player.on('ready', handleReady); // 一部のイベントは頻繁に発生します。1 回だけリッスンするには、player.one を使用します。 player.one('canplay', () => {});プレーヤーインスタンスの off メソッドを使用して、イベントのサブスクリプションを解除できます。例:
player.off('ready',handleReady);