ApsaraVideo Player SDK for Webを使用する場合、一般的に使用される機能の設定は、プレーヤー、再生方法、またはブラウザ環境によって異なる場合があります。 このトピックでは、ApsaraVideo Player SDK for Webの基本機能を設定する方法について説明します。
共通設定
HTML5プレーヤーとFlashプレーヤーを使用してFlash Video (FLV) ビデオとHTTP Live Streaming (HLS) ビデオを再生する場合は、クロスオリジンリソース共有 (CORS) を設定する必要があります。 詳細については、「CORS の設定」をご参照ください。
HTML5プレーヤーを使用するときにCORSを設定しないと、再生中に次のエラーメッセージが返されます。
要求されたリソースに「Access-Control-Allow-Origin」ヘッダーは存在しません。
Flashプレーヤーの使用時にCORSを設定しないと、再生中に次のエラーメッセージが返されます。
フルスクリーン再生が開始されたら、入力を設定して絶対位置を設定し、ソフトキーボードを有効にできます。
メソッド呼び出し
ApsaraVideo Player SDK for Webの基本機能は、属性またはメソッドを使用することで有効になります。
詳細は、「API操作」をご参照ください。
次のサンプルコードは、メソッドを呼び出す方法の例を示しています。
HTML5プレーヤー
プレーヤーの作成に使用される関数のコールバックで、次のメソッドを呼び出します。 サンプルコード:
// HTML5 player var player = new Aliplayer({},function(player) { player.play(); });
Flash player
readyイベントが発生した後、またはプレーヤーを作成するためのreadyコールバックで、次のメソッドを呼び出します。 サンプルコード:
// Flash player player.on('ready',function(e) { player.play(); });
メディア再生の管理
ApsaraVideo Player SDK for Webを使用すると、指定した時点からビデオを再生し、再生を一時停止できます。 HTML5プレーヤーとFlashプレーヤーで同じメソッドを呼び出すことができます。
特定の時点からビデオを再生する
seek
メソッドを呼び出して、指定した時点からビデオを再生できます。 サンプルコード:
// time specifies the specified point in time. Unit: seconds.
player.seek(time)
一時停止再生
pause
メソッドを呼び出して、再生を一時停止できます。 サンプルコード:
player.pause()
大きな再生ボタンを表示するには、このパラメーターをtrue
に設定する必要があります。 例: player.pause(true)
表示モードの指定
ApsaraVideo Player SDK for Webを使用すると、回転やミラーリングなどの表示設定を構成できます。 HTML5プレーヤーのみがこの機能をサポートしています。
PCおよびiOSブラウザは表示設定をサポートしています。
ChromeとFirefox for Androidは表示設定をサポートしています。
WeChatと他のほとんどのブラウザは、再生に内蔵プレーヤーを使用します。 したがって、表示設定はサポートされていません。
回転角度の指定
setRotate
操作を呼び出して、指定した角度に基づいて画像を回転します。 回転角度を照会することもできます。 サンプルコード:
// Specify the rotation angle. A positive value of Angle specifies a clockwise rotation. A negative value of Angle specifies an anticlockwise rotation. For example, player.setRotate(180) specifies a clockwise rotation of 180 degrees.
player.setRotate(<Angle>)
// Obtain the rotation angle.
player.getRotate()
ミラーリングモードの指定
setImage
を呼び出して、ミラーリングモードを設定します。 サポートされているモード: 水平ミラーリングと垂直ミラーリング。 サンプルコード:
// Horizontal mirroring.
player.setImage('horizon')
// Vertical mirroring.
player.setImage('vertical')
ApsaraVideo Player SDK for Webには、ビデオの高さと幅を指定するためのvideoHeight
およびvideoWidth
属性が用意されています。 ほとんどの場合、ビデオの高さと幅はコンテナの高さと幅よりも小さくなります。 これにより、回転およびミラーリング中にビデオが親コンテナからオーバーフローするのを防ぎます。 サンプルコード:
width: '100', // The width of the container.
height: '100%', // The height of the container.
videoHeight:"200px", // The height of the video.
再生情報の取得
ApsaraVideo Player SDK for Webを使用すると、現在の再生の進行状況と再生時間を取得できます。
再生の進行状況の取得
getCurrentTime
を呼び出して、現在の再生の進行状況を取得します。 サンプルコード:
// The returned time is measured in seconds.
player.getCurrentTime()
再生時間の取得
getDuration
を呼び出して、ビデオの合計時間を取得します。 継続時間は、ビデオがロードされた後、または再生イベントが発生した後にのみ取得できます。 サンプルコード:
player.getDuration()
再生ステータスの取得
getStatus
を呼び出して、再生ステータスを取得します。 戻り値:
init: プレイヤーは初期化中です。
準備完了
loading: プレーヤーはデータをロードしています。
プレイ
一時停止
遊ぶ
待っている
エラー
終了
サンプルコード:
player.getStatus()
ボリュームの指定
音量を調整したり、ビデオをミュートしたりできます。
video.volume
プロパティは、iOSおよび特定のAndroidシステムでは読み取り専用です。 したがって、ApsaraVideo Player SDK for Webが提供するgetVolume
およびsetVolume
メソッドは、iOSおよび特定のAndroidシステムでは無効です。
音量を調整する
setVolume
操作を呼び出して、音量を調整します。 現在のボリュームを取得することもできます。 サンプルコード:
// Set the volume to a real number from 0 to 1.
player.setVolume(0)
// Obtain the current volume.
player.getVolume()
ミュートモードの設定
mute
メソッドを呼び出して、再生中にビデオをミュートします。 サンプルコード:
// Mute the video.
player.mute();
// Unmute the video.
player.unMute();
再生速度の指定
再生速度はHTML5プレーヤーに対してのみ指定できます。 ApsaraVideo Player SDK for Webのデフォルトのユーザーインターフェイス (UI) を使用する場合は、組み込みの再生速度機能を使用して、ビデオの視聴時に再生速度を調整できます。 カスタムUIを使用する場合は、setSpeed
操作を呼び出して再生速度を調整できます。
再生速度の設定を無効にする方法の詳細については、API操作のトピックのsetSpeed
セクションをご参照ください。
サンプルコード:
// Specify the playback speed. The following sample code provides an example on how to set the playback speed to twice the current speed.
player.setSpeed(2)
マルチ定義再生
マルチ定義再生用に複数の定義でストリームのURLを設定できます。
再生にVIDとPlayAuthを使用する場合、追加の設定は必要ありません。 ApsaraVideo Player SDK for Webは、ApsaraVideo VODから定義のリストを取得します。 再生ページの [設定] をクリックすると、定義リストが表示されます。
説明VIDとPlayAuthを使用して再生する場合は、format属性を指定して、HTML5プレーヤーのMP4またはMP3形式のメディアファイルを再生するかどうかを決定できます。 デフォルトでは、MP4形式のメディアファイルが再生されます。
URLベースの再生を使用する場合は、ソース属性のキーと値のペアを構成して、複数の定義でストリームのURLを指定する必要があります。 キーと値のペアはJSON形式です。 設定が有効になったら、再生ページの [設定] をクリックして定義リストを表示できます。
定義リストの表示方法を変更する場合は、定義コンポーネントを使用できます。 サンプルコードの詳細については、 「関数」をご参照ください。
URLベースの再生モードでは、ソース属性の次のキーと値のペアがサポートされます。
"OD": "<Original quality URL>"
"FD": "<Low definition URL>"
"LD":"<Standard definition URL>"
"SD": "<High definition URL>"
"HD": "<Ultra-high definition URL>"
"2K": "<2K URL>"
"4K": "<4K URL>"
次のサンプルコードは、URLベースの再生モードで定義を設定する方法の例を示しています。
// The following example shows how to configure the high definition and ultra-high definition URLs.
source:'{"HD":"http://******/player/hdexample.mp4","SD":"http://******/player/sdexample.mp4"}'
ApsaraVideo Player SDK for Webでは、qualitySort属性を指定して、定義を昇順または降順で一覧表示することもできます。
descの値は、最高の定義から最低の定義への降順を指定します。
ascの値は、最低の定義から最高の定義への昇順を指定します。
プレーヤーは、指定した定義を保持します。 次回ビデオを再生するときは、前回指定した定義が使用されます。 最後にビデオを再生したときに定義を指定しなかった場合、再生には低解像度が使用されます。
ビデオが指定された定義で再生されない場合、プレーヤーは自動的に次のより低い定義に切り替わり、メッセージを表示します。 HTML5プレーヤーのみが定義切り替えをサポートしています。
ループ再生の有効化
ApsaraVideo Player SDK for Webでは、rePlay
属性を指定したり、ループ再生用の終了
イベントをリッスンしたりできます。
rePlay属性の指定に使用されるサンプルコード
rePlay:true
終了したイベントをリッスンするために使用されるサンプルコード
player.on('ended',function(){
player.replay()
})