ApsaraVideo VOD:ApsaraVideo Player SDK for Android の基本機能

VOD 再生

VidAuth vidAuth = new VidAuth();
vidAuth.setVid("Vid");                 // 必須。 ビデオ ID (VideoId) 。
vidAuth.setPlayAuth("<yourPlayAuth>"); // 必須。 GetVideoPlayAuth から取得した再生認証情報。
vidAuth.setRegion("region-id");        // SDK V5.5.5.0 以降では非推奨です。プレーヤーはリージョンを自動的に解析します。以前のバージョンでは、このパラメーターは必須です。デフォルト： cn-shanghai。
   // vidAuth.setAuthTimeout(3600);    // オプション。 再生 URL の有効期間を秒単位で設定します。この値は、ApsaraVideo VOD コンソールで設定された有効期間を上書きします。デフォルト：3600。再生中に URL の有効期限が切れないように、ビデオの長さを超える値を設定してください。
        
   // ApsaraVideo VOD コンソールで HLS 暗号化パラメーターのパススルーを有効にする場合、デフォルトのパラメーターは MtsHlsUriToken です。config を指定し、VidAuth データソースとあわせて渡します。
   VidPlayerConfigGen vidConfig = new VidPlayerConfigGen();
   vidConfig.setMtsHlsUriToken("<yourMtsHlsUriToken>");
   vidAuth.setPlayerConfig(vidConfig);
   aliPlayer.setDataSource(vidAuth);

VidSts vidSts = new VidSts();
       vidSts.setVid("Vid");                               // 必須。 ビデオ ID (VideoId) 。
       vidSts.setAccessKeyId("<yourAccessKeyId>");         // 必須。 STS (AssumeRole) から取得した一時的な AccessKey ID。
       vidSts.setAccessKeySecret("<yourAccessKeySecret>"); // 必須。 STS (AssumeRole) から取得した一時的な AccessKey Secret。
       vidSts.setSecurityToken("<yourSecurityToken>");     // 必須。 AssumeRole から取得した STS トークン。
       vidSts.setRegion("RegionID");                       // 必須。 ApsaraVideo VOD のリージョン。デフォルト： cn-shanghai。
       // vidSts.setAuthTimeout(3600);                     // オプション。 再生 URL の有効期間を秒単位で設定します。この値は、ApsaraVideo VOD コンソールで設定された有効期間を上書きします。デフォルト：3600。再生中に URL の有効期限が切れないように、ビデオの長さを超える値を設定してください。
        
       // ApsaraVideo VOD コンソールで HLS 暗号化パラメーターのパススルーを有効にする場合、デフォルトのパラメーターは MtsHlsUriToken です。config を指定し、vidSts データソースとあわせて渡します。
       // 有効になっていない場合、以下の設定は不要です。
       VidPlayerConfigGen vidConfig = new VidPlayerConfigGen();
       vidConfig.setMtsHlsUriToken("<yourMtsHlsUriToken>");
       vidSts.setPlayerConfig(vidConfig);
       aliPlayer.setDataSource(vidSts);

 UrlSource urlSource = new UrlSource();
        urlSource.setUri("your-playback-url"); // 必須。 VOD URL、サードパーティ URL、またはローカルファイルパス。
        aliPlayer.setDataSource(urlSource);

ライブストリームの再生

ライブストリームの再生については、「標準ライブストリーミング再生」をご参照ください。

プレーヤーの準備

prepare を呼び出し、メディアデータをロードしてパースします。

aliPlayer.prepare();

再生の開始

start を呼び出して、再生を開始または再開します。

aliPlayer.start();

特定の位置へのシーク

特定の位置にジャンプするには、seekTo を呼び出します。このメソッドは、ユーザーがプログレスバーをドラッグする場合や、保存した位置から再生を再開する場合に便利です。

// ターゲット時間をミリ秒単位で指定します。
aliPlayer.seekTo(long position);

prepare を呼び出す前に再生開始位置を設定するには、setStartTime を使用します。この設定は、prepare の呼び出しごとに 1 回だけ有効になり、その後自動的にクリアされます。

// 開始位置をミリ秒単位で設定します。seekMode は、正確なシークか不正確なシークかを指定します。
aliPlayer.setStartTime(time, seekMode);

再生の一時停止

pause を呼び出して再生を一時停止します。

aliPlayer.pause();

再生の停止

stop を呼び出して再生を停止します。

aliPlayer.stop();

プレーヤービューのバインド解除

再生を停止した後、プレーヤーインスタンスを破棄する前に、プレーヤービューのバインドを解除してレンダリングリソースを解放し、メモリリークを防ぎます。使用しているプレーヤービューのタイプに基づいて、バインド解除メソッドを選択します。

// プレーヤービューのバインドを解除
aliPlayer.setSurface(null);

// プレーヤービューのバインドを解除
aliPlayer.setDisplayView(null);

プレーヤーの破棄

プレーヤーは同期的または非同期的に破棄できます。

// 同期的な破棄。 プレーヤーリソースが解放されるまでブロックします。自動的に stop を呼び出します。
aliPlayer.release();
// 非同期的な破棄。 すぐに戻ります。自動的に stop を呼び出します。
aliPlayer.releaseAsync();

リスナーの設定

プレーヤーに複数のリスナーを設定できます。OnErrorListener、OnCompletionListener、OnLoadingStatusListener、および OnInfoListener を設定することをお勧めします。

aliPlayer.setOnErrorListener(new IPlayer.OnErrorListener() {
    // プレーヤーの使用中にエラーが発生した場合にトリガーされるコールバックです。

    @Override
    public void onError(ErrorInfo errorInfo) {
        ErrorCode errorCode = errorInfo.getCode(); // エラーコード。
        String errorMsg = errorInfo.getMsg(); // エラーメッセージ。
        // errorExtra は、追加のエラー情報を JSON 文字列で提供します。例：
        //{ "Url": "xxx",
   		//	"Module": "NetWork",
    	//	"ModuleCode": "-377",
   		//  "ModuleMessage": "Redirect to a url that is not a media"}
        // ModuleCode の値は、必ずしも errorCode の値と同じではないことにご注意ください。
        String errorExtra= errorInfo.getExtra();         
        // エラーが発生したらプレーヤーを停止します。
        aliPlayer.stop();
    }
});
aliPlayer.setOnPreparedListener(new IPlayer.OnPreparedListener() {
    // aliPlayer.prepare() メソッドを呼び出すと、プレーヤーはデータの読み取りと解析を開始します。このコールバックは、データの解析が完了した後にトリガーされます。

    @Override
    public void onPrepared() {
        // プレーヤーの準備ができました。
    }
});
aliPlayer.setOnCompletionListener(new IPlayer.OnCompletionListener() {
    // 再生が完了した後にトリガーされるコールバックです。
    @Override
    public void onCompletion() {
        // ほとんどの場合、stop メソッドを呼び出して再生を停止できます。
        aliPlayer.stop();
    }
});
aliPlayer.setOnInfoListener(new IPlayer.OnInfoListener() {
    // 現在の再生位置やバッファリング位置など、プレーヤーに関する情報です。
    @Override
    public void onInfo(InfoBean infoBean) {
        InfoCode code = infoBean.getCode(); // 情報コード。
        String msg = infoBean.getExtraMsg();// 情報の内容。
        long value = infoBean.getExtraValue(); // 情報の値。

        // 現在の再生位置： InfoCode.CurrentPosition。
        // バッファリングされた位置： InfoCode.BufferedPosition。
    }
});
aliPlayer.setOnLoadingStatusListener(new IPlayer.OnLoadingStatusListener() {
    // プレーヤーの読み込みステータス。これを使用して、ネットワーク接続が悪いときに読み込み画面を表示できます。

    @Override
    public void onLoadingBegin() {
        // プレーヤーがデータの読み込みを開始します。ビデオとオーディオはまだ再生できる状態ではありません。
        // ほとんどの場合、円形の読み込みインジケーターを表示できます。
    }

    @Override
    public void onLoadingProgress(int percent, float netSpeed) {
        // 読み込みの進捗率 (パーセント) とネットワーク速度。
        // ネットワーク速度は予約フィールドです。値は 0 です。
    }

    @Override
    public void onLoadingEnd() {
        // プレーヤーがデータの読み込みを停止します。ビデオとオーディオは再生できる状態です。
        // ほとんどの場合、円形の読み込みインジケーターを非表示にできます。
    }
});

再生状態の変更の監視

onStateChanged コールバックを使用して、プレーヤーの状態遷移を監視します。

aliPlayer.setOnStateChangedListener(new IPlayer.OnStateChangedListener() {
    @Override
    public void onStateChanged(int newState) {
        /*
          int idle = 0;
          int initalized = 1;
          int prepared = 2;
          int started = 3;
          int paused = 4;
          int stopped = 5;
          int completion = 6;
          int error = 7;
      */
    }
});

スケーリングモード

SDK は 3 つのスケーリングモードをサポートしています：

// アスペクト比を維持したままビューに収まるようにスケーリングします (レターボックス)。
aliPlayer.setScaleMode(ScaleMode.SCALE_ASPECT_FIT);
// アスペクト比を維持したままビューを埋めるようにスケーリングします (クロッピング)。
aliPlayer.setScaleMode(ScaleMode.SCALE_ASPECT_FILL);
// ビューを埋めるように引き伸ばします。アスペクト比は維持されません。画像の歪みが発生する可能性があります。
aliPlayer.setScaleMode(ScaleMode.SCALE_TO_FILL);

回転

setRotateMode を呼び出してビデオを回転させます。getRotateMode で現在の回転角度を取得できます。

// 回転なし。
aliPlayer.setRotateMode(RotateMode.ROTATE_0);
// 時計回りに 90°。
aliPlayer.setRotateMode(RotateMode.ROTATE_90);
// 時計回りに 180°。
aliPlayer.setRotateMode(RotateMode.ROTATE_180);
// 時計回りに 270°。
aliPlayer.setRotateMode(RotateMode.ROTATE_270);
// 現在の回転角度を取得します。
aliPlayer.getRotateMode();

ミラーリング

setMirrorMode を呼び出してビデオをミラーリングします。 SDK は水平および垂直ミラーリングをサポートしています:

// ミラーリングなし。
aliPlayer.setMirrorMode(MirrorMode.MIRROR_MODE_NONE);
// 水平ミラーリング。
aliPlayer.setMirrorMode(MirrorMode.MIRROR_MODE_HORIZONTAL);
// 垂直ミラーリング。
aliPlayer.setMirrorMode(MirrorMode.MIRROR_MODE_VERTICAL);

再生進捗

onInfo コールバックで、getExtraValue を呼び出して現在の再生位置をミリ秒単位で取得します。

aliPlayer.setOnInfoListener(new IPlayer.OnInfoListener() {
    @Override
    public void onInfo(InfoBean infoBean) {
        if(infoBean.getCode() == InfoCode.CurrentPosition){
            // 現在の再生位置 (ミリ秒)。
            long extraValue = infoBean.getExtraValue();
        }
    }
});

総再生時間

動画の再生時間は、メディアがロードされた後にのみ取得できます。getDuration は、onPrepared コールバックがトリガーされた後に呼び出してください。

long duration = aliPlayer.getDuration();

実際の再生時間

実際の再生時間をリアルタイムで取得できます。この値には、再生が一時停止またはバッファリングされている時間は含まれません。

long playedDuration = aliPlayer.getPlayedDuration(); 

バッファリング進捗

onInfo コールバックでは、InfoCode.BufferedPosition を確認して現在のバッファリング進捗を取得します。

aliPlayer.setOnInfoListener(new IPlayer.OnInfoListener() {
    @Override
    public void onInfo(InfoBean infoBean) {
        if(infoBean.getCode() == InfoCode.BufferedPosition){
            // 現在のバッファリング進捗 (ミリ秒)。
            long extraValue = infoBean.getExtraValue();
        }
    }
});

リアルタイムのレンダリングとビットレートのメトリクス

レンダリングフレームレート、オーディオとビデオのビットレート、ネットワークの下りビットレートをリアルタイムで取得します。

// ビデオレンダリングのフレームレート。float 値を返します。
aliPlayer.getOption(IPlayer.Option.RenderFPS);
// ビデオビットレート。bit/s 単位の float 値を返します。
aliPlayer.getOption(IPlayer.Option.VideoBitrate);
// オーディオビットレート。bit/s 単位の float 値を返します。
aliPlayer.getOption(IPlayer.Option.AudioBitrate);
// ネットワークの下りビットレート。bit/s 単位の float 値を返します。
aliPlayer.getOption(IPlayer.Option.DownloadBitrate);

音量の変更

setVolume を呼び出して音量を変更します。有効な値の範囲は 0 から 2 で、1 は元の音量を表します。1 より大きい値は音声を増幅し、ノイズが発生する可能性があります。音量を 1 より大きい値に設定しないことをお勧めします。

// 音量を設定します。有効な値：0〜2。
aliPlayer.setVolume(1f);
// 現在の音量を取得します。
aliPlayer.getVolume();

プレーヤーのミュート

setMute を呼び出して、プレーヤーをミュートまたはミュート解除します。

aliPlayer.setMute(true); 

UrlSource ベースのライブストリーミング

詳細については、「標準ライブストリーミング再生」をご参照ください。

VidAuth または VidSts ベースの再生

VOD 再生に VidAuth または VidSts を使用する場合、SDK は ApsaraVideo VOD からビデオの解像度を自動的に取得します。追加の設定は不要です。

// 利用可能なすべてのトラックを取得します。
List<TrackInfo> trackInfos = aliPlayer.getMediaInfo().getTrackInfos();
//利用可能な解像度を取得します。
for (TrackInfo trackInfo : trackInfos) {
     if(trackInfo.getType() == TrackInfo.Type.TYPE_VOD){
             // ビデオの解像度を取得します。 
        String vodDefinition = trackInfo.getVodDefinition();
     }
}

aliPlayer.selectTrack(index);

aliPlayer.setOnTrackChangedListener(new IPlayer.OnTrackChangedListener() {
    @Override
    public void onChangedSuccess(TrackInfo trackInfo) { }

    @Override
    public void onChangedFail(TrackInfo trackInfo, ErrorInfo errorInfo) { }
});

PlayerConfig config = aliPlayer.getConfig();
config.mSelectTrackBufferMode = 1;
aliPlayer.setConfig(config);

サポートされているストリームタイプ

以下のストリームタイプで音声トラックを切り替えることができます。切り替えの動作はストリームタイプによって異なります。

使用例

1. onSubTrackReady コールバックを設定します。このコールバックは通常、onPrepared コールバックの前にトリガーされます。

   aliPlayer.setOnSubTrackReadyListener(new IPlayer.OnSubTrackReadyListener() {
       @Override
       // onSubTrackReady。通常、onPrepared コールバックの前にトリガーされます。
       public void onSubTrackReady(MediaInfo mediaInfo) {
           if (mPlayerTrackFragment != null) {
               //mPlayerTrackFragment.showMediaInfo();
               // このコールバックがトリガーされた後に getSubMediaInfo を呼び出します。このコールバックの前に呼び出すと、空の結果が返されます。
               MediaInfo subMediaInfo = aliPlayer.getSubMediaInfo();
               TrackInfos = subMediaInfo.getTrackInfos();
               // トラックリストからターゲットの音声トラックを見つけます。
               myTrack = myfunc(TrackInfos)
           }
       }
   });

2. ターゲットの音声トラックに切り替えます。

   index = myTrack.getIndex();
   aliPlayer.selectTrack(index);

方法 1：開発ツールのコンソールでログを表示する

この方法は、デバイスで問題を確実に再現できる場合に使用します。

1. ロギングを有効にし、ログレベルを設定します。

   // ログは com.cicada.player.utils 配下に保存されます。
   Logger.getInstance(context).enableConsoleLog(true);
   // デフォルト： AF_LOG_LEVEL_INFO。トラブルシューティングには AF_LOG_LEVEL_TRACE を使用します。
   Logger.getInstance(context).setLogLevel(Logger.LogLevel.AF_LOG_LEVEL_INFO);

2. (オプション) トラブルシューティングのためにフレームレベルのロギングを有効にします。

   // 0： 無効、1： 有効。
   Logger.getInstance(this).setLogOption(Logger.LogOption.FRAME_LEVEL_LOGGING_ENABLED, value);

3. 問題を再現し、Logcat または開発ツールのコンソールからエラーログを取得します。

方法 2：LogCallback を設定してプログラムでログを受信する

この方法は、デバイスで問題を確実に再現できない場合に使用します。コールバックは、ログをアプリケーションのログチャネルにエクスポートします。

1. ロギングを有効にし、ログレベルを設定します。

   // ログは com.cicada.player.utils 配下に保存されます。
   // デフォルト： AF_LOG_LEVEL_INFO。トラブルシューティングには AF_LOG_LEVEL_TRACE を使用します。
   Logger.getInstance(context).setLogLevel(Logger.LogLevel.AF_LOG_LEVEL_INFO);
   Logger.getInstance(context).setLogCallback(new Logger.OnLogCallback(){
           @Override
           public void onLog(Logger.LogLevel logLevel, String s){
               // ログエントリを処理します。
           }
   });

2. エラーが発生すると、SDK は自動的にエラーログをアプリケーションのログチャネルにエクスポートします。