ApsaraVideo VOD:Aliplayer API reference

名前

タイプ

説明

id

String

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

source

String

URL ベースの再生を使用する場合、source プロパティを使用して動画の再生 URL を指定します。

vid

String

ApsaraVideo Media Processing のメディア ID です。

playauth

String

再生認証情報です。再生認証情報を取得するには、「オーディオとビデオの再生認証情報の取得」をご参照ください。

customVodServer

String

カスタム VOD プロキシドメイン名です。このプロパティは、バージョン 2.32.0 以降の VidAuth 再生方法に適用されます。専用のリクエストプロキシサービスをデプロイする必要があります。デフォルトの VOD ドメイン名 (*.aliyuncs.com) にアクセスできない場合、プレーヤーは自動的にプロキシサービスにフォールバックします。これにより、キャリアハイジャックのリスクを効果的に軽減し、再生の安定性と成功率を大幅に向上させることができます。

playConfig

JSON

Vid ベースの再生 (VidAuth および VidSts) のカスタム設定フィールドです。設定は VOD API に渡されます。サポートされているカスタムフィールドとその説明については、「カスタムメディア再生設定 (PlayConfig)」をご参照ください。次のコードは値の例です：

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

authTimeout

Number

Vid ベースの再生 (VidAuth および VidSts) を介して取得した動画再生 URL の有効期間です。単位：秒。デフォルト値：7200。

再生が完了する前に再生 URL が期限切れになるのを防ぐために、この期間が実際の動画の長さよりも長いことを確認してください。

height

String

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

• 100%

• 100px

width

String

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

• 100%

• 100px

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

プレーヤーが動画を自動再生するかどうかを指定します。autoplay プロパティはモバイルデバイスでは有効ではありません。有効な値：

• true：自動再生を有効にします。

• false (デフォルト)：自動再生を無効にします。

autoplayPolicy

Object

プレーヤーの適応型ミュート自動再生ポリシーです。このプロパティは、autoplay が true に設定されている場合にのみ有効です。次のコードは設定例です：

autoplayPolicy: {
  fallbackToMute: true, // 音声付き自動再生が失敗した場合にミュート自動再生にフォールバックするかどうかを指定します。デフォルト：false。
  showUnmuteBtn: true, // ミュート自動再生中に中央に大きなミュート解除ボタンを表示するかどうかを指定します。デフォルト：true。
}

rePlay

Boolean

プレーヤーは再生を自動的にループします。

useH5Prism

Boolean

H5 プレーヤーを使用するかどうかを指定します。

playsinline

Boolean

H5 で動画をインライン再生するかどうかを指定します。一部の Android ブラウザでは動作しない場合があります。

skinRes

Url

スキン画像です。このフィールドは変更しないことを推奨します。変更する場合は、「プレーヤースキンの設定」をご参照ください。

skinLayout

Array | Boolean

機能コンポーネントのレイアウト構成です。このフィールドを指定しない場合、デフォルトのレイアウトが使用されます。値 `false` はすべての機能コンポーネントを非表示にします。詳細については、「skinLayout プロパティの設定」をご参照ください。

skinLayoutIgnore

Array

非表示にする UI コンポーネントです。コンポーネント名については、「VOD コンポーネントのパラメーター」をご参照ください。次のコードは設定例です：

skinLayoutIgnore: [
  'bigPlayButton', // 大きな再生ボタンを非表示にします。
  'controlBar.fullScreenButton' // コントロールバーの全画面ボタンを非表示にします (ドット表記でサブコンポーネントを選択)。
]

controlBarVisibility

String

コントロールパネルの実装です。有効な値は次のとおりです：

• click：プレーヤーエリアをクリックします。

• hover (デフォルト)：プレーヤーエリアに移動します。

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

• never：コントロールバー全体を非表示にします。

showBarTime

Number

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

enableSystemMenu

Boolean

システムの右クリックメニューを表示するかどうかを指定します。デフォルト値は false です。

format

String

再生 URL のフォーマットを指定します。有効な値：

• mp4

• hls または m3u8

• flv

• mp3

デフォルト値は空です。

mediaType

String

オーディオまたはビデオを返すかどうかを指定します。これは `vid` 再生方法を使用する場合にのみサポートされます。デフォルト値は video です。有効な値：

• video：ビデオ。

• audio：MP4 オーディオファイルなど、オーディオのみを含むビデオフォーマットの場合。

qualitySort

String

ソート順を指定します。これは Vid + PlayAuth 再生方法を使用する場合にのみサポートされます。有効な値：

• desc：降順 (大きいものから小さいものへ) でソートします。

• asc：昇順 (小さいものから大きいものへ) でソートします。

デフォルト値：asc。

definition

String

表示する動画の解像度をコンマ (,) で区切って指定します。例：'FD,LD'。この値は、`vid` で利用可能な解像度のサブセットです。有効な値：

• FD (低解像度)

• LD (標準解像度)

• HD (高解像度)

• HD (超高解像度)

• OD (オリジナル画質)

• 2K (2K)

• 4K (4K)

defaultDefinition

String

デフォルトの動画解像度です。この値は、`vid` で利用可能な解像度のいずれかである必要があります。有効な値：

• FD (低解像度)

• LD (標準解像度)

• HD (高解像度)

• HD (超高解像度)

• OD (オリジナル画質)

• 2K (2K)

• 4K (4K)

autoPlayDelay

Number

再生が開始されるまでの遅延時間です。単位：秒。

language

String

国際化のための言語です。デフォルト値は zh-cn です。設定しない場合、ブラウザの言語が使用されます。有効な値：

• zh-cn：中国語。

• en-us：英語。

languageTexts

JSON

カスタム国際化テキスト用の JSON オブジェクトです。キーは `language` プロパティの値に対応する必要があります。例：{jp:{Play:"Play"}}。JSON 構造については、「JSON 構造」をご参照ください。

snapshotWatermark

Object

H5 でのスクリーンショットにウォーターマークを設定します。

useHlsPluginForSafari

Boolean

Safari 11 を除く Safari ブラウザでの再生に HLS プラグインを有効にするかどうかを指定します。有効な値：

• true：プラグインを有効にします。

• false (デフォルト)：プラグインを無効にします。

enableStashBufferForFlv

Boolean

H5 で FLV ストリームを再生する際に、再生キャッシュを有効にするかどうかを指定します。これはライブストリーミングでのみ機能します。有効な値：

• true (デフォルト)：キャッシュを有効にします。

• false：キャッシュを無効にします。

stashInitialSizeForFlv

Number

H5 で FLV ストリームを再生する際の初期キャッシュサイズです。これはライブストリーミングでのみ機能します。デフォルトは 32 KB です。

値を小さくすると初回再生が速くなりますが、値が小さすぎると短時間の再生後にカクつきが発生する可能性があります。

loadDataTimeout

Number

プレーヤーがより低い解像度への切り替えをユーザーに促すまでのバッファリング時間 (秒) です。デフォルトは 20 秒です。

waitingTimeout

Number

最大バッファリングタイムアウト期間です。この期間を超えると、エラーが表示されます。単位：秒。デフォルトは 60 秒です。

diagnosisButtonVisible

Boolean

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

• true (デフォルト)：ボタンを表示します。

• false：ボタンを表示しません。

disableSeek

Boolean

プログレスバーでのシークを無効にします。有効な値：

• true：シークを無効にします。

• false (デフォルト)：無効にしません。

encryptType

Number

Alibaba Cloud プライベート暗号化で暗号化された動画を再生するかどうかを指定します。デフォルト値は 0 です。有効な値：

• 0：暗号化されていない動画を再生します。

• 1：プライベート暗号化された動画を再生します。

progressMarkers

Array

プログレスバーをマーキングするためのコンテンツの配列です。詳細については、「プログレスバーマーカー」をご参照ください。

vodRetry

Number

失敗した VOD 再生のリトライ試行回数です。デフォルトは 3 です。

liveRetry

Number

失敗したライブ再生のリトライ試行回数です。デフォルトは 5 です。

hlsFrameChasing

Boolean

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

• true：フレーム同期を有効にします。

• false (デフォルト)：フレーム同期を無効にします。

chasingFirstParagraph

Number

最初のフレーム同期セグメントの長さです。単位：秒。デフォルトは 20 秒です。

chasingSecondParagraph

Number

2 番目のフレーム同期セグメントの長さです。単位：秒。デフォルトは 40 秒です。

chasingFirstSpeed

Number

最初のフレーム同期セグメントの再生速度です。デフォルトは 1.1x です。

chasingSecondSpeed

Number

2 番目のフレーム同期セグメントの再生速度です。デフォルトは 1.2x です。

hlsOption.maxLiveSyncPlaybackRate

Number

HLS ライブストリーミングモードで、ライブフレーム同期の再生速度を設定します。デフォルトは 1 で、フレーム同期が無効であることを意味します。

• 設定例：

  hlsOption: {
    maxLiveSyncPlaybackRate: 1.5, // フレーム同期の再生速度を設定します。
    liveSyncDurationCount: 3 // フレーム同期をトリガーする遅延セグメントの数を設定します。
  }

• 例の意味：ライブストリーミングの遅延が 3 セグメントの期間より大きい場合、プレーヤーは 1.5 倍速で再生し、3 セグメントの遅延に追いつきます。プレーヤーはネットワークの変動に対応するためにある程度のバッファーが必要なため、liveSyncDurationCount の値は慎重に変更してください。値が小さすぎるとカクつきが発生する可能性があります。

flvFrameChasing

Boolean

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

• true：フレーム同期を有効にします。

• false：フレーム同期を無効にします。

デフォルト値は false です。

keyShortCuts

Boolean

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

• true：キーボードショートカットを有効にします。

• false：キーボードショートカットを無効にします。

デフォルト値は 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

`traceId` は、独自のユニークなユーザー識別子です。`traceId` をパブリックなイベントトラッキングに渡して、報告されたログを追跡します。デフォルトでは、Web プレーヤー SDK はログ報告が有効になっています。`traceId` を渡すことでユーザーを識別できます。渡さない場合、Web プレーヤー SDK は UUID (プレーヤー SDK によって生成されるユニークな識別子) を生成し、ブラウザのキャッシュに保存します。

textTracks

Array

WebVTT 外部字幕を設定します。次のコードは例です：

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

ratio

Number

プレーヤーを固定の縦横比でスケーリングするように設定します。たとえば、動画の縦横比が 16:9 の場合、プレーヤーのパラメーターを width: "100%", ratio: 16/9 に設定できます。これにより、プレーヤーの縦横比が動画コンテンツと一致し、ページのサイズ変更に応じて比例してスケーリングされます。

extLanguageTexts

Object

プレーヤー SDK には、中国語と英語の UI テキストが組み込まれています。このプロパティを使用して、UI の一部の表示テキストをカスタマイズできます。たとえば、HD 解像度の表示テキスト (デフォルトは高清) を1080p に変更するには、次のようにします：

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

speedLevels

Array

カスタム再生速度リスト配列を設定します。`key` は速度値を、`text` は UI テキストを表します。渡されない場合、デフォルトのリストが使用されます。次のコードはパラメーター値の例です：

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

logo

Array

カスタムロゴ画像を設定します。次のコードは例です：

    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：位置決めの基準となるオブジェクトです。有効な値：

  • box：プレーヤー

  • content：動画コンテンツ

• width/height：ロゴの幅/高さをパーセンテージで指定します (`origin` に基づいて計算)。片方のディメンションのみを指定した場合、もう一方は画像の縦横比に基づいて比例してスケーリングされます。

• position：ロゴの相対位置で、`origin` を基準に配置されます。有効な値：

  • top-left：左上

  • top-right：右上

  • bottom-left：左下

  • bottom-right：右下

• offsetX/offsetY：`position` からのオフセットをパーセンテージで指定します (`origin` に基づいて計算)。

license

Object

再生品質モニタリング (旧バージョン)、シングルポイントトレース、H.265/H.266 エンコード動画ストリームの再生などの付加価値サービスを利用するには、まずWeb プレーヤー SDK 付加価値サービス申請フォームに記入してライセンスを申請してください。その後、次のようにライセンスを統合します：

// domain はライセンス申請時に提供したドメイン名です。
// key はライセンスキーです。
license: {
    domain: "example.com",
    key: "example-key"
  }

mute

Boolean

動画をミュートで再生するかどうかを設定します。ブラウザが自動再生を禁止している場合、このパラメーターを設定してミュート自動再生を行うことができます。詳細については、「高度な機能」をご参照ください。

clickPause

Boolean

動画画面をクリックして一時停止または再生します。

• true：有効。

• false：無効。

デフォルト値は PC では `true`、モバイルデバイスでは `false` です。インタラクションの競合を避けるため、`dbClickSkip` プロパティと併用しないでください。

disablePip

Boolean

ブラウザのネイティブのピクチャーインピクチャー (PiP) ボタンを非表示にします。

env

String

プレーヤーのイベントトラッキングデータは、デフォルトで中国のデータセンターにアップロードされます。中国以外のリージョンでデータコンプライアンス要件がある場合は、パラメーター `env: 'SEA'` を渡してください。データはシンガポールのデータセンターにアップロードされます。

watchStartTime

Number

単独で使用する場合、再生の開始時刻を表します。

`watchEndTime` と一緒に使用すると、範囲再生が有効になり、指定された開始時刻と終了時刻の間でのみ再生とシークが可能になります。

単位：秒

watchEndTime

Number

`watchStartTime` と一緒に使用して範囲再生を有効にし、指定された開始時刻と終了時刻の間でのみ再生とシークを許可します。

このパラメーターの値が `watchStartTime` より小さい場合、`watchStartTime` は無効になります。

単位：秒

start

Number

`end` と一緒に使用して、動画の一部を切り取り、別の動画として扱います。たとえば、60 秒の動画で `start:10` と `end:30` を設定すると、表示される長さが 20 秒の動画になり、元の動画の 10 秒の時点から再生が開始されます。

end

Number

`start` と一緒に使用して、動画の一部を切り取り、別の動画として扱います。たとえば、60 秒の動画で `start:10` と `end:30` を設定すると、表示される長さが 20 秒の動画になり、元の動画の 10 秒の時点から再生が開始されます。

dbClickFullscreen

Boolean

ダブルクリックで全画面表示にするかどうかを指定します。PC ではデフォルトで有効になっています。

longPressFastForward

Boolean

長押しによる早送り機能 (モバイルのみ) です。有効な値：

• true (デフォルト)：有効。

• false：無効。

dbClickSkip

Boolean

ダブルクリックによるスキップ機能 (モバイルのみ) で、左側をダブルクリックすると早戻し、右側をダブルクリックすると早送りします。有効な値：

• true (デフォルト)：有効。

• false：無効。

インタラクションの競合を避けるため、`clickPause` プロパティと併用しないでください。

enableMockFullscreen

Boolean

Web ページ全画面機能です。プレーヤーはデフォルトでブラウザの全画面 API を呼び出します。iOS ブラウザや一部の Android ブラウザでは、全画面モードがシステムプレーヤーに乗っ取られ、UI が消えるなどの問題が発生することがあります。これを防ぐために、このパラメーターを有効にして CSS を使用した疑似全画面を実装できます。デフォルト値は false です。

名前

パラメータータイプ

必須

説明

showPlayButton

Boolean

いいえ

再生ボタンを表示するかどうかを指定します。

名前

パラメータータイプ

必須

説明

time

number

はい

シークする時間です。単位：秒。

名前

パラメータータイプ

必須

説明

volume

number

はい

vol は 0 から 1 までの実数です。これは iOS や一部の Android デバイスでは動作しない場合があります。

名前

パラメータータイプ

必須

説明

quiet

boolean

いいえ

ミュート時に左下のテキストプロンプトを非表示にするかどうかを指定します。

名前

パラメータータイプ

必須

説明

quiet

boolean

いいえ

ミュート解除時に左下のテキストプロンプトを非表示にするかどうかを指定します。

名前

パラメータータイプ

必須

説明

url

string

はい

切り替える動画の URL です。

seconds

number

いいえ

切り替え後の開始位置です。

autoPlay

boolean

いいえ

切り替え後に自動再生するかどうかを指定します。

名前

パラメータータイプ

必須

説明

vid

string

はい

動画 ID です。

playauth

string

はい

再生認証情報です。

名前

パラメータータイプ

必須

説明

mediaAuth

string

はい

再生認証情報です。

名前

パラメータータイプ

必須

説明

name

string

はい

組み込みコンポーネントの名前 (例：`fullScreenButton`) については、「skinLayout プロパティの設定」をご参照ください。各コンポーネントは、表示を制御するための `hide()` および `show()` メソッドをサポートしています。

名前

パラメータータイプ

必須

説明

width

string

はい

プレーヤーのサイズを設定します。有効な値：

• 400px

• 60%

height

string

はい

名前

パラメータータイプ

必須

説明

speed

number

はい

0.5x から 2x までの再生速度をサポートします。

名前

パラメータータイプ

必須

説明

traceId

string

はい

ユニークな識別子です。

名前

パラメータータイプ

必須

説明

width

number

はい

高さと幅は px 単位です。スクリーンショットの品質は 0 から 1 の間の数値で、デフォルトは 1 です。動画のスナップショットの詳細については、「動画のスナップショット」をご参照ください。

height

number

はい

rate

number

はい

名前

パラメータータイプ

必須

説明

start

string

はい

start はライブストリーミングの開始時刻です。

end

string

はい

end はライブストリーミングの終了時刻です。

名前

パラメータータイプ

必須

説明

rotate

number

はい

正の数は時計回りの回転を、負の数は反時計回りの回転を示します。例：`setRotate(90)`。詳細については、「表示モードの設定」をご参照ください。

名前

パラメータータイプ

必須

説明

type

string

はい

有効な値：

• horizon：水平。

• vertical：垂直。

例：`setImage('horizon')`。詳細については、「表示モードの設定」をご参照ください。

名前

パラメータータイプ

必須

説明

coverUrl

string

はい

サムネイルの URL です。

名前

パラメータータイプ

必須

説明

markers

Array<markers>

はい

markers：マーカーデータのコレクションです。必須。

marker.time：マーカーの時間です。必須。

marker.text：マーカーのテキストです。必須。

詳細については、`progressMarkers` パラメーターをご参照ください。

名前

パラメータータイプ

必須

説明

time

number

はい

単位：秒。詳細については、「プレビュー」をご参照ください。

名前

パラメータータイプ

必須

説明

textTracks

Array<object>

はい

次のコードは例です：

player.setTextTracks([ { kind: 'subtitles', label: 'Chinese', src: 'caption_url', srclang: 'zh-CN' },{ kind: 'subtitles', label: 'English (US)', src: 'caption_url', srclang: 'en-US' }])

名前

パラメータータイプ

必須

説明

logoList

Array<object>

はい

次のコードは例です：

player.setLogo([{
      width: 30,
      position: 'bottom-right',
      origin: 'content',
      src: 'a.jpg'
    },
    {
      width: 20,
      position: 'bottom-right',
      offsetY: -20,
      origin: 'content',
      src: 'b.jpg'
    }])

各フィールドの詳細な説明については、`logo` プロパティをご参照ください。

名前

パラメータータイプ

必須

説明

start

string

はい

start は開始時刻です。

end

string

はい

end は終了時刻です。

名前

パラメータータイプ

必須

説明

start

string

はい

start は開始時刻です。

end

string

はい

end は終了時刻です。

名前

パラメータータイプ

必須

説明

start

string

はい

start は開始時刻です。

end

string

はい

end は終了時刻です。

名前

パラメータータイプ

必須

説明

start

string

はい

start は開始時刻です。

end

string

はい

end は終了時刻です。

名前

パラメータータイプ

説明

time

string

スナップショットの時間です。

base64

string

スナップショットの base64 コンテンツです。

binary

string

スナップショットのコンテンツをバイナリ文字列として表したものです。

error

Error

スナップショット例外の詳細です。