ApsaraVideo VOD:API 操作

パラメーター

タイプ

説明

id

String

プレーヤーの外部コンテナのDOM要素のID。

source

String

ビデオ再生URL。

vid

String

メディアトランスコーディング用のメディアID。

playauth

String

ビデオ再生の資格情報。 詳細については、「GetVideoPlayAuth」をご参照ください。

preventRecord

Boolean

暗号化ビデオストリームのダウンロード保護機能を有効にするかどうかを指定します。

playConfig

JSON

VidAuthまたはVidStsベースの再生に指定できるカスタムパラメーター。 このパラメーターは、ApsaraVideo VOD APIに渡されます。 サポートされるフィールドの詳細については、「PlayConfig: メディア再生のカスタム設定を指定する」をご参照ください。 サンプルコード：

{"PlayDomain":"vod.test_domain","PreviewTime":"20","MtsHlsUriToken":"yqCD7******oVjslp5Q"}

authTimeout

回

ビデオがVidAuthまたはVidStsを使用して再生されるときに取得される再生URLの有効期間。 単位は秒です。 デフォルト値: 7200

有効期間は、ビデオの実際の期間よりも長くなければなりません。 それ以外の場合、再生URLは再生が完了する前に期限切れになります。

height

String

プレイヤーの高さ。 有効な値：

• 100%

• 100px

width

String

プレーヤーの幅。 有効な値：

• 100%

• 100px

autoSize

ブール | 文字列

高さと幅のパラメーターを設定して、自動スケーリング機能を使用するかどうかを指定します。

たとえば、width: '500px' 、autoSize: 'height' を設定した場合、ビデオの幅は500ピクセルで、ビデオの高さはソースビデオのアスペクト比に基づいてスケーリングされます。

height: '500px' 、autoSize: 'width' を設定した場合、ビデオの高さは500ピクセルで、ビデオの幅はソースビデオのアスペクト比に基づいてスケーリングされます。

autoSize: trueを設定すると、ソースビデオのアスペクト比に基づいてビデオの高さがスケーリングされます。

videoWidth

String

ビデオの幅。 このパラメーターは、HTML5プレーヤーでのみサポートされます。 詳細は、「表示モードの指定」をご参照ください。

videoHeight

String

ビデオの高さ。 このパラメーターは、HTML5プレーヤーでのみサポートされます。 詳細は、「表示モードの指定」をご参照ください。

preload

Boolean

プレーヤーの自動読み込みを有効にするかどうかを指定します。 このパラメーターは、HTML5プレーヤーでのみサポートされます。

カバー

String

プレーヤーのデフォルトのサムネイル。 有効な画像URLを入力します。 このパラメーターは、autoplayがfalseに設定されている場合にのみ有効です。 Flash playerの場合、このパラメーターを有効にするには、クロスオリジンリソース共有 (CORS) 機能も有効にする必要があります。

isLive

Boolean

再生がライブストリーミングかどうかを指定します。 再生がライブストリーミングの場合、プログレスバーをドラッグすることはできません。 デフォルト値: "false" ライブストリーミングの場合、このパラメーターをtrueに設定する必要があります。

自動再生

Boolean

自動再生を有効にするかどうかを指定します。 このパラメーターは、モバイルデバイスでは有効になりません。 有効な値：

• true

• false (デフォルト)

autoplayPolicy

オブジェクト

アダプティブミュート自動再生を有効にするかどうかを指定します。 このパラメーターは、autoplayをtrueに設定した場合にのみ有効になります。 サンプルコード：

autoplayPolicy: {
  fallbackToMute: true, // Specifies whether to play the video in the mute mode when audio failed to be played during autoplay. Default value: false.
  showUnmuteBtn: true, // Specifies whether to display the large mute button in the middle of the view when videos are being automatically played in the mute mode. Default value: true.
}

再再生

Boolean

自動ループ再生を有効にするかどうかを指定します。

useH5Prism

Boolean

HTML5プレーヤーが使用されることを指定します。

useFlashPrism

Boolean

Flashプレーヤーを使用することを指定します。

playsinline

Boolean

ビデオをHTML5プレーヤーでインラインで再生するかどうかを指定します。 このパラメータは、Android用の特定のブラウザでは有効になりません。

skinRes

Url

プレーヤーのスキン画像。 必要な場合を除き、このパラメーターの値を変更しないことをお勧めします。 プレーヤースキンイメージを変更する方法の詳細については、「プレーヤースキンの設定」をご参照ください。

skinLayout

配列 | ブール

コンポーネントのレイアウト。 このパラメーターを設定しない場合、デフォルトのレイアウトがコンポーネントに使用されます。 falseは、すべてのフィーチャコンポーネントが非表示であることを示します。 詳細については、「skinLayout属性の設定」をご参照ください。

skinLayoutIgnore

配列

非表示にするUIコンポーネント。 コンポーネントの詳細については、「skinLayout属性の設定」をご参照ください。 サンプルコード：

skinLayoutIgnore: [
  'bigPlayButton', // Hide the big playback button
  'controlBar.fullScreenButton' // Hide the full screen button on the control bar. You can use the dot operator to select the subcomponent.
]

controlBarVisibility

String

コントロールバーの表示方法を指定します。 有効な値：

• click: 再生セクションをクリックすると、コントロールバーが表示されます。

• hover (デフォルト): 再生セクションの上にポインターを移動すると、コントロールバーが表示されます。

• always: コントロールバーは常に表示されます。

• never: コントロールパネルは非表示です。

showBarTime

回

コントロールバーが自動的に非表示になる時間 (ミリ秒単位) 。

extraInfo

String

カスタムパラメーター。 値はJSON文字列です。 このパラメーターは、Flashプレーヤーでのみサポートされます。 有効な値：

• fullTitle: テストページでビデオをフルスクリーンモードで再生すると、ビデオタイトルが表示されます。

• m3u8BufferLength: HTTPライブストリーミング (HLS) ビデオの再生中にバッファされたTSファイルの長さ。 単位は秒です。

enableSystemMenu

Boolean

右クリック時にショートカットメニューを表示するかどうかを指定します。 デフォルト値は false です。

フォーマット

String

ストリーミングURL形式。 有効な値：

• mp4

• hlsまたはm3u8

• flv

• mp3

デフォルトでは、このパラメータは空のままです。 このパラメーターに値を指定すると、HTML5プレーヤーに対してのみ有効になります。

mediaType

String

返されるコンテンツのメディアタイプ。 このパラメーターは、VIDベースの再生でのみサポートされます。 デフォルト値はvideoです。 有効な値：

• video: ビデオファイル。

• audio: オーディオのみを含むビデオファイル。 たとえば、MP4ファイル。 このパラメーターはHTML5プレーヤーでのみサポートされています。

qualitySort

String

ソート方法。 このパラメーターは、VIDとPlayAuthに基づく再生でのみサポートされます。 有効な値：

• desc: 降順。

• asc: 昇順。

デフォルト値はascです。 このパラメーターはHTML5プレーヤーでのみサポートされています。

定義

String

ビデオの解像度。 異なる解像度は、「FD、LD」などのコンマ (,) で区切ります。 値は、VIDによって指定されたビデオに対してサポートされる解像度のサブセットである。 このパラメーターは、HTML5プレーヤーでのみサポートされます。 有効な値：

• FD: 低い定義

• LD: 標準定義

• SD: 高い定義

• HD: 超高い定义

• OD: 元の質

• 2K

• 4K

defaultDefinition

String

デフォルトのビデオ解像度。 値は、VIDで指定されたビデオの解像度です。 このパラメーターは、HTML5プレーヤーでのみサポートされます。 有効な値：

• FD: 低い定義

• LD: 標準定義

• SD: 高い定義

• HD: 超高い定义

• OD: 元の質

• 2K

• 4K

autoPlayDelay

回

再生遅延 (秒単位) 。 詳細については、「再生遅延の設定」をご参照ください。

autoPlayDelayDisplayText

String

再生遅延をユーザーに通知するテキスト。 詳細については、「再生遅延の設定」をご参照ください。

言語

String

プレイヤーが使用する言語。 デフォルト値はzh-cnです。 このパラメータを空のままにすると、ブラウザの言語が使用されます。 有効な値：

• zh-cn: 中国語

• en-us: 英語

languageTexts

JSON

JSON形式のカスタム言語テキスト。 値は {jp:{Play:"Play"}} のようなキー: 値のペアです。 詳細については、「JSON形式」をご参照ください。

スナップショット

Boolean

Flashプレーヤーのスナップショット機能を有効にするかどうかを指定します。 有効な値：

• true

• false (デフォルト)

snapshotWatermark

オブジェクト

HTML5のスナップショット透かし。

useHlsPluginForSafari

Boolean

Safariで再生用にHLSプラグインを有効にするかどうかを指定します。 このパラメーターはSafari 11ではサポートされていません。 有効な値：

• true

• false (デフォルト)

enableStashBufferForFlv

Boolean

HTML5プレーヤーでFLVビデオを再生するときにバッファリングを有効にするかどうかを指定します。 このパラメーターは、ライブストリーミングに対してのみ有効です。 有効な値：

• true (デフォルト)

• false

stashInitialSizeForFlv

回

HTML5でのFLV再生の初期キャッシュサイズ。 このパラメーターは、ライブストリーミングに対してのみ有効です。 デフォルト値: 32。 (単位：KB)

小さいバッファサイズを指定すると、ライブストリームを短時間でロードして再生できます。 しかし、値が小さすぎるとすぐに吃音が発生する可能性があります。

loadDataTimeout

回

低解像度に切り替えるようにユーザーに促すメッセージを表示するために必要なバッファ期間。 単位は秒です。 デフォルト値は 20 です。

waitingTimeout

回

バッファの最大持続時間 (秒) 。 指定された期間が経過すると、エラーメッセージが表示されます。 デフォルト値は 640 です。

diagnostisButtonVisible

Boolean

診断ボタンを表示するかどうかを指定します。 有効な値：

• true (デフォルト)

• false

disableSeek

Boolean

シーク機能を無効にするかどうかを指定します。 有効な値：

• true

• false (デフォルト)

encryptType

回

Alibaba Cloud独自の暗号を使用して暗号化されたビデオを再生するかどうかを指定します。 デフォルト値：0。 有効な値：

• 0: Alibaba Cloud独自の暗号化を使用して暗号化されたビデオを再生しません。

• 1: Alibaba Cloud独自の暗号化を使用して暗号化されたビデオを再生します。

progressMarkers

配列

進行状況バーのマーカーのコンテンツ配列。 詳細については、「プログレスバーのマーク」をご参照ください。

vodRetry

回

VOD再生が失敗したときのリトライ回数。 デフォルト値: 3。

liveRetry

回

ライブストリームの再生に失敗したときのリトライ回数。 既定値：5

hlsFrameChasing

Boolean

HLSベースのライブストリーミングでフレーム同期を有効にするかどうかを指定します。 有効な値：

• true

• false (デフォルト)

chasingFirstParagraph

回

フェーズ1のフレーム同期が有効になるまでのレイテンシ。 単位は秒です。 デフォルト値は 20 です。

chasingSecondParagraph

回

フェーズ2のフレーム同期が有効になるまでのレイテンシ。 単位は秒です。 デフォルト値: 40。

chasingFirstSpeed

回

フェーズ1のフレーム同期が有効なときの再生速度。 デフォルト値: 1.1

chasingSecondSpeed

回

フェーズ2のフレーム同期が有効なときの再生速度。 デフォルト値: 1.2

hlsOption.maxLiveSyncPlaybackRate

回

HLSベースのライブストリーミングでフレーム同期が有効になっているときの再生速度。 デフォルト値は 1 です。 1は、フレーム同期が有効でないことを指定します。

• サンプルコード：

  hlsOption: {
    maxLiveSyncPlaybackRate: 1.5, // Configure the playback speed when frame synchronization is enabled.
    liveSyncDurationCount: 3 // Set the maximum number of delayed segments allowed. For example, you can set liveSyncDurationCount to 3.
  }

• この場合、ライブストリーミングのレイテンシが3つのセグメントの期間を超えると、プレーヤーはストリームを1.5倍で再生して現在の再生位置に追いつきます。 liveSyncDurationCountパラメーターに小さな値を指定しないことを推奨します。 そうでなければ、プレーヤーがストリームを早送りするときに吃音が発生する可能性があります。

flvFrameChasing

Boolean

FLVベースのライブストリーミングでフレーム同期を有効にするかどうかを指定します。 有効な値：

• true

• false (デフォルト)

keyShortCuts

Boolean

ショートカットキーを有効にするかどうかを指定します。 有効な値：

• true

• false (デフォルト)

keyFastForwardStep

回

早送りおよび巻き戻し操作の時間範囲。 単位は秒です。 デフォルト値は 10 です。

rtsFallback

Boolean

RTS再生劣化機能を有効にするかどうかを指定します。 この機能を有効にすると、ブラウザがRTCをサポートしていないか、RTSを介したストリームのプルが失敗すると、HTTPライブストリーミング (HLS) やHTTPフラッシュビデオ (HTTP-FLV) などの劣化したプロトコルを介してストリームが自動的に再生されます。 FLVベースの再生は、HLSベースの再生よりも低い待ち時間を課すので、より高い優先度を有する。 HLSベースの再生は、ブラウザがRTCまたはFLVをサポートしていない場合に使用されます。

この機能はデフォルトで無効になっています。 この機能を無効にするには、このパラメーターにfalseを指定します。

rtsFallbackType

String

HLSまたはFLVフォーマットの再生URLなどの代替RTS URL。 デフォルトでは、このパラメータは空のままです。 この場合、デフォルトポリシーが使用され、システムは最初にFLVでストリームを再生しようとします。 お使いのブラウザがFLVをサポートしていない場合、システムはHLSを介してストリームを再生します。

rtsFallbackSource

String

デフォルトの再生劣化ポリシーを使用することを推奨します。 特定のURLからストリームを取得する場合は、このパラメーターを指定します。

traceId

String

一意のユーザー識別子。 traceIdをパブリックトレースポイントとして使用して、ログを追跡できます。 デフォルトでは、イベント追跡ログがアップロードされ、ユーザー識別用にtraceIdが指定されます。 traceIdを指定しない場合、ApsaraVideo Player SDK for Webは自動的にUUIDを生成し、そのUUIDをブラウザーキャッシュに保存します。

textTracks

配列

WebVTT外部字幕。 サンプルコード：

textTracks: [
  { kind: 'subtitles', label: 'Chinese', src: 'Subtitle URL', srclang: 'zh-CN', default: true },
	{ kind: 'subtitles', label: 'English (en-US)', src: 'Subtitle URL'', srclang: 'en-US' }
],

比率

回

プレーヤーがサイズ変更される固定アスペクト比。 たとえば、ビデオのアスペクト比が16:9で、width: "100%" 、ratio: 16/9を指定した場合、プレーヤーのアスペクト比はビデオと同じになり、アスペクト比に基づいて比例してサイズを変更できます。

extLanguageTexts

オブジェクト

ApsaraVideo Player SDKには、一連のUIが組み込まれています。 このパラメーターを指定すると、UIコンテンツを変更できます。 たとえば、デフォルトではHigh Definitionに対してHDが表示されます。 解像度名をHDから1080pに変更できます。 サンプルコード：

extLanguageTexts: {
    'zh-cn': {
      'HD': "1080p"
    }
}

speedLevels

配列

カスタム再生速度。 キーは速度を指定し、テキストはUIコンテンツを指定します。 このパラメータを空のままにすると、デフォルト設定が使用されます。 サンプルコード：

speedLevels: [
  {"key": 0.25, "text": "0.25"},
  {"key": 0.5, "text": "0.5"},
  {"key": 1, "text": "Original"},
  {"key": 1.25, "text": "1.25"},
  {"key": 1.5, "text": "1.5"},
  {"key": 2,"text": "2"}
]

ロゴ

配列

カスタムロゴ画像。 サンプルコード：

    logo: [{
      width: 30,
      position: 'bottom-right',
      origin: 'content',
      src: 'a.png'
    },
    {
      width: 20,
      position: 'bottom-right',
      offsetY: -20,
      origin: 'content',
      src: 'b.png'
    }]

次の項目はフィールドを説明します。

• src: ロゴ画像のURL。

• origin: オブジェクト参照。 有効な値：

  • ボックス: プレーヤー

  • content: ビデオコンテンツ

• width/height: ロゴ画像の幅と高さをパーセンテージで表示します。 幅または高さのいずれかを指定した場合、他のパラメーターはソースイメージのアスペクト比に基づいて指定されます。

• position: オブジェクト参照に対するロゴ画像の位置。 有効な値：

  • 左上

  • 右上

  • 左下

  • 右下

• offsetX/offsetY: オブジェクト参照に対するロゴ画像のオフセット (パーセンテージ) 。

ライセンス

オブジェクト

再生品質モニタリング、シングルポイントトレース、H.265およびH.266ビデオ再生などの付加価値機能を使用するには、Yidaでリクエストを送信してライセンスを申請する必要があります。 詳細については、「再生品質モニタリング」、「シングルポイントトレース」、および「H.265およびH.266ビデオの再生」をご参照ください。 ライセンスの発行後、次のサンプルコードを使用してライセンスを統合します。

// Set domain to the domain name that you specified when you apply for the license.
// Set key to the key file of the license.
license: {
    domain: "example.com",
    key: "example-key"
  }

ミュート

Boolean

ミュートモードでビデオを再生するかどうかを指定します。 ブラウザで自動再生が無効になっている場合は、このパラメーターを設定して自動再生をミュートします。 詳細については、「自動再生」をご参照ください。

clickPause

Boolean

ビデオ画像をクリックしたときにビデオを一時停止するか再生するかを指定します。

disablePip

Boolean

ブラウザで組み込みのピクチャインピクチャ (PiP) ボタンを非表示にするかどうかを指定します。

env

String

プレーヤーのイベント追跡データを中国本土のデータセンターにアップロードするかどうかを指定します。 デフォルト設定です。 中国本土以外のデータにコンプライアンス要件がある場合は、env: 'SEA' を設定して、シンガポールリージョンにデータをアップロードします。

イベント

説明

準備完了

プレーヤーのビデオ初期化ボタンがレンダリングされたときにトリガーされるイベント。 readyイベントの完了後にプレーヤーのUI設定を初期化して、初期化中にUIが上書きされないようにします。

プレイ

一時停止されたビデオが再び再生されるときに呼び出されるイベント。

pause

ビデオが一時停止されたときに呼び出されるイベント。

canplay

オーディオまたはビデオファイルの再生準備ができたときにトリガーされるイベント。 このイベントは複数回トリガーでき、HTML5プレーヤーでのみサポートされます。

演奏

再生中に呼び出されるイベント。 このイベントは複数回呼び出すことができます。

終了

ビデオの再生が完了した後に呼び出されるイベント。

liveStreamStop

ライブストリームが中断されたときに呼び出されるイベント。 このイベントは、プレイヤーが5回連続してHLSストリームを再生できなかった後にトリガーされます。 このイベントは、ライブストリームが中断されるか、ビデオを再度ロードする必要があることを示します。

onM3u8Retry

HLSストリームが中断されたときに呼び出される再試行イベント。 このイベントは、ライブストリームの中断ごとに1回だけ呼び出されます。

hideBar

コントロールバーを自動的に非表示にするために呼び出されるイベント。

showBar

コントロールバーを自動的に表示するために呼び出されるイベント。

待っている

データキャッシュイベント。

timeupdate

再生位置が変化したときに呼び出されるイベント。 このイベントはHTML5プレーヤーでのみサポートされています。 getCurrentTimeメソッドを使用して、現在の再生時間を取得できます。

snapshoted

スナップショットがキャプチャされたときに呼び出されるイベント。

requestFullScreen

全画面モードを有効にするために呼び出されるイベント。 このイベントはHTML5プレーヤーでのみサポートされています。

cancelFullScreen

全画面モードを終了するために呼び出されるイベント。 このイベントはHTML5プレーヤーでのみサポートされ、iOSデバイスでは呼び出されません。

error

再生エラーが発生したときに呼び出されるイベント。

startSeek

シークの開始時にトリガーされるイベント。 戻り値は、シークが開始されるビデオ内の位置です。

completeSeek

シークが終了したときにトリガーされるイベント。 戻り値は、シークが終了するビデオ内の位置です。

resolutionChange

ライブストリーミング中にビデオの解像度が変更されたときに呼び出されるイベント。

seiFrame

HLSまたはFLVベースの再生のためにSEI (Supplemental Enhancement Information) が受信されたときに呼び出されるイベント。

rtsFallback

このイベントは、劣化したプロトコルが再生に使用されるときにトリガーされます。 reasonは劣化の原因を示し、fallbackUrlは代替URLを示します。

settingSelected

速度、定義、字幕などの再生設定が変更されたときにトリガーされるイベント。

/**
 * For example, the event is triggered when you change the playback speed to 1.25x. Sample code:
 * {name: 'Playback speed', type: 'speed', text: '1.25x', key: 1.25}
 */

rtsTraceId

RTSストリームがプルされたときにトリガーされるイベント。 イベントをリッスンしてTraceIdを取得します。 表示されたログのdata.paramDataパラメーターで、traceIdはストリームのプルに使用されるTraceIdを示し、sourceはRTSストリームの再生URLを示します。

player.on('rtsTraceId', function(data) {
  console.log('[EVENT]rtsTraceId', data.paramData);
})

自動再生

このイベントは、自動再生が成功または失敗したときにトリガーされます。 コールバックのevent.paramDataパラメーターに対してtrueが返された場合、自動再生は成功です。 コールバックのevent.paramDataパラメーターに対してfalseが返された場合、自動再生は失敗しました。 この場合、手動で再生をトリガーする必要があります。

mutedAutoplay

ビデオがミュートモードで自動的に再生されたときにトリガーされるイベント。 ミュートモードでビデオを自動的に再生するには、autoplayPolicy.fallbackToMuteをtrueに設定します。

videoUnavailable

ビデオのエンコード形式がサポートされていないため、再生中に黒画面が発生したときにトリガーされるイベント。 たとえば、このイベントは、H.265ビデオをサポートしていないブラウザでビデオを再生したときにトリガーされます。 この場合、オーディオのみが再生され、黒画面が発生します。