ApsaraVideo Live:プッシュ SDK for Android の使用

SDK を登録

ライセンスを取得して設定するには、Push SDK ライセンスを統合してください。

Push SDK for Android を使用する前に、アプリケーションのライフサイクルの早い段階でライセンス登録 API を呼び出してください。

AlivcLiveBase.setListener(new AlivcLiveBaseListener() {
  @Override
  public void onLicenceCheck(AlivcLivePushConstants.AlivcLiveLicenseCheckResultCode result, String reason) {
    Log.e(TAG, "onLicenceCheck: " + result + ", " + reason);
  }
});
AlivcLiveBase.registerSDK();

• AlivcLiveBase クラスを使用して、ログレベルの設定、ローカルログパスの指定、SDK バージョンの取得を行います。

• SDK ライセンスを登録するには、AlivcLiveBase の registerSDK メソッドを呼び出す必要があります。

• onLicenceCheck コールバックを AlivcLiveBase#setListener インターフェイスで実装して、ライセンス設定を非同期で検証します。

  説明

  このコールバックは、プッシャーインスタンスを初期化した後にのみトリガーされます。

カメラストリームのアップストリーミング

1. 初期化

   アップストリーミングパラメーターを設定した後、init メソッドを呼び出します。

   AlivcLivePusher mAlivcLivePusher = new AlivcLivePusher();
   mAlivcLivePusher.init(mContext, mAlivcLivePushConfig);

   説明

   AlivcLivePusher は複数のインスタンスをサポートしていません。各 init 呼び出しには、対応する destroy 呼び出しが必要です。

2. プレビューコールバックの登録

   setLivePushInfoListener メソッドを呼び出して、プレビューコールバックを登録します。

   /**
    * アップストリーミングイベント通知用のリスナーを設定します。
    *
    * @param infoListener 通知リスナー
    */
   mAlivcLivePusher.setLivePushInfoListener(new AlivcLivePushInfoListener() {
       @Override
       public void onPreviewStarted(AlivcLivePusher pusher) {
           // プレビューが開始されたことを通知します。
       }
       // その他のオーバーライドメソッド
       //....
       //....
   });

3. プレビューの開始

   カメラプレビュー用の SurfaceView を渡して、プレビューを開始します。

   mAlivcLivePusher.startPreview(mSurfaceView); // プレビューを開始します。必要に応じて、非同期の startPreviewAsync メソッドを呼び出すこともできます。

4. アップストリーミングの開始

   onPreviewStarted コールバックメソッド内に、以下のコードを追加します。

   mAlivcLivePusher.startPush(mPushUrl);

   説明

   • RTMP および RTS (artc://) のアップストリーミング URL がサポートされています。URL を取得するには、「アップストリーミング URL とストリーミング URL の生成」をご参照ください。

   • ApsaraVideo Live は、同じ URL への同時アップストリーミングリクエストを拒否します。

/* アップストリーミング中のストリームを一時停止するために呼び出します。一時停止後、ビデオプレビューとビデオストリームのアップストリーミングは最後のフレームで静止し、オーディオストリームのアップストリーミングは継続されます。*/
mAlivcLivePusher.pause();
/* 一時停止中のストリームを再開するために呼び出します。再開後、オーディオとビデオのプレビューおよびアップストリーミングは正常に戻ります。*/
mAlivcLivePusher.resume();
/* アップストリーミング中のストリームを停止するために呼び出します。完了後、アップストリーミングが停止します。*/
mAlivcLivePusher.stopPush();
/* プレビュー状態のときにのみ、プレビューを停止するために呼び出します。ストリームのアップストリーミング中に呼び出しても効果はありません。プレビュー停止後、プレビューフレームは最後のフレームで静止します。*/
mAlivcLivePusher.stopPreview();
/* ストリームのアップストリーミング中、またはエラーに関するコールバックを受信した後に、アップストリーミングを再起動するために呼び出します。エラー状態では、この API、reconnectPushAsync、または destroy のみを呼び出すことができます。再起動により、プレビューとアップストリーミングを含む AlivcLivePusher のすべての内部リソースが再初期化されます。*/
mAlivcLivePusher.restartPush();
/* ストリームのアップストリーミング中、または AlivcLivePusherNetworkDelegate に関するエラーコールバックを受信した後に、ストリームを再接続するために呼び出します。エラー状態では、この API、restartPush、または destroy のみを呼び出すことができます。再接続により、アップストリーミング用の RTMP 接続が再確立されます。*/
mAlivcLivePusher.reconnectPushAsync();
/* アップストリーミングインスタンスを破棄するために呼び出します。破棄後、アップストリーミングとプレビューが停止し、プレビューサーフェスが削除されます。AlivcLivePusher のすべてのリソースが解放されます。*/
mAlivcLivePusher.destroy();

/* フロントカメラとリアカメラを切り替えます。*/
mAlivcLivePusher.switchCamera();
/* フラッシュをオンまたはオフにします。フロントカメラ使用時にフラッシュをオンにしても効果はありません。*/
mAlivcLivePusher.setFlash(true); 
/* 焦点距離を調整して、キャプチャされた画像をズームします。ズーム範囲は [0, getMaxZoom()] です。*/
mAlivcLivePusher.setZoom(5);
/* カメラのフォーカスを手動で合わせます。これには 2 つのパラメーターが必要です。1. `point` (フォーカスを合わせるポイントの座標)、2. `autoFocus` (この操作に限りオートフォーカスを有効にするかどうか)。その後のオートフォーカス動作は、setAutoFocus API で設定された値に従います。*/
mAlivcLivePusher.focusCameraAtAdjustedPoint(x, y, true);
/* オートフォーカスを有効にするかどうかを設定します。*/
mAlivcLivePusher.setAutoFocus(true);
/* ミラーリングを設定します。ミラーリング API には 2 つあります。プッシュするストリーム用の PushMirror と、ローカルプレビュー用の PreviewMirror です。PushMirror は再生表示にのみ影響し、PreviewMirror はプレビュー表示にのみ影響します。これらは互いに影響しません。*/
mAlivcLivePusher.setPreviewMirror(false);
mAlivcLivePusher.setPushMirror(false);

画面共有ストリームのインジェスト

画面共有では MediaProjection を使用し、ユーザー権限が必要です。権限結果データを SDK に渡してください。画面共有中は、カメラはデフォルトで無効になります。

// resultData は画面共有のシステムインテントです。
mAlivcLivePushConfig.setMediaProjectionPermissionResultData(resultData);

mAlivcLivePusher.setScreenOrientation(0);

mAlivcLivePusher.pauseScreenCapture(); // プライバシー保護を有効にします。
mAlivcLivePusher.resumeScreenCapture(); // プライバシー保護を無効にします。

カメラストリームと画面共有ストリームのインジェスト

画面共有中にカメラのインジェストを有効にできます。方法は 2 つあります。

1. ストリーマーがカメラプレビューを表示する場合

   ストリーマーと視聴者の両方がカメラフィードを確認できます。

2. ストリーマーがカメラプレビューを表示しない場合

   たとえばゲームストリームでは、ストリーマーがゲーム画面をカメラ映像で隠したくない場合があります。ただし、視聴者は配信映像でストリーマーのカメラフィードを引き続き確認できます。

mAlivcLivePusher.startCamera(surfaceView); // カメラプレビューを開始します。
mAlivcLivePusher.stopCamera(); // カメラプレビューを停止します。

mAlivcLivePusher.startCameraMix(x, y, w, h); // カメラのストリームミキシングを有効にし、ミックス後のストリームのレイアウト (x, y, w, h) を設定します。
mAlivcLivePusher.stopCameraMix(); // カメラのストリームミキシングを停止します。

プレビュー表示モード

3 つのプレビュー表示モードが利用できます。表示モードはストリームインジェストに影響しません。

• ALIVC_LIVE_PUSHER_PREVIEW_SCALE_FILL：スケールフィル。ビデオがプレビューウィンドウ全体に表示されます。ビデオとウィンドウのアスペクト比が異なる場合、プレビューは歪んで表示されます。

• ALIVC_LIVE_PUSHER_PREVIEW_ASPECT_FIT：アスペクトフィット。ビデオのアスペクト比は維持されます。ビデオとウィンドウのアスペクト比が異なる場合、プレビューに黒帯が表示されます。

• ALIVC_LIVE_PUSHER_PREVIEW_ASPECT_FILL：アスペクトフィル。ビデオはウィンドウのアスペクト比に合わせてクロップされます。アスペクト比が異なる場合、ビデオはクロップされます。

以下にコード例を示します。

mAlivcLivePushConfig.setPreviewDisplayMode(AlivcPreviewDisplayMode.ALIVC_LIVE_PUSHER_PREVIEW_ASPECT_FIT);

画像ストリームのインジェスト

SDK は、アプリがバックグラウンドにあるとき、または劣悪なネットワーク状態のときに、プレースホルダー画像をインジェストできます。

アプリがバックグラウンドに移行すると、ビデオインジェストは一時停止しますが、オーディオは継続します。視聴者に通知するため、プレースホルダー画像を設定します。

mAlivcLivePushConfig.setPausePushImage("path/to/background.png"); // バックグラウンドでのインジェスト画像を設定します。

SDK は、低ビットレートを検出すると、この画像をインジェストし、ビデオのスタッタリングを軽減します。

mAlivcLivePushConfig.setNetworkPoorPushImage("path/to/network_poor.png"); // 劣悪なネットワーク状態でのインジェスト画像を設定します。

音声のみのストリームインジェスト

mAlivcLivePushConfig.setAudioOnly(true);

外部オーディオおよびビデオストリームのインジェスト

SDK は、ビデオファイルなどの外部ソースからのオーディオとビデオのインジェストをサポートしています。

まず、カスタムオーディオおよびビデオ入力を有効にします。

mAlivcLivePushConfig.setExternMainStream(true, AlivcImageFormat.IMAGE_FORMAT_YUVNV12, AlivcSoundFormat.SOUND_FORMAT_S16);

カスタムオーディオおよびビデオ入力を有効にすると、外部ストリームをインジェストできるようになります。

/**
* この API はタイミングを制御しません。入力オーディオフレームのタイミングは、呼び出し元で制御する必要があります。
*/
mAlivcLivePusher.inputStreamAudioData(byte[] data, int size, int sampleRate, int channels, long pts);

/**
* この API はタイミングを制御しません。入力ビデオフレームのタイミングは、呼び出し元で制御する必要があります。
*/
mAlivcLivePusher.inputStreamVideoData(byte[] data, int width, int height, int stride, int size, long pts, int rotation);

ウォーターマークの設定

PNG フォーマットのウォーターマークを 1 つ以上追加します：

mAlivcLivePushConfig.addWaterMark(waterPath,0.1,0.2,0.3); // ウォーターマークを追加します。

動画品質の設定

解像度優先モード、流暢性優先モード、カスタムモードの 3 つの動画品質モードをサポートしています。

mAlivcLivePushConfig.setQualityMode(AlivcQualityModeEnum.QM_RESOLUTION_FIRST); // 解像度を優先します。

mAlivcLivePushConfig.setQualityMode(AlivcQualityModeEnum.QM_FLUENCY_FIRST); // 滑らかさを優先します。

mAlivcLivePushConfig.setQualityMode(AlivcQualityModeEnum.QM_CUSTOM); // カスタムモード
mAlivcLivePushConfig.setTargetVideoBitrate(1000); // ターゲットビットレート： 1,000 kbit/s
mAlivcLivePushConfig.setMinVideoBitrate(300); // 最小ビットレート： 300 kbit/s
mAlivcLivePushConfig.setInitialVideoBitrate(800); // 初期ビットレート： 800 kbit/s

適応解像度

適応解像度は、ネットワーク状況が悪い場合に解像度を自動的に下げて、スムーズさを向上させます。

mAlivcLivePushConfig.setEnableAutoResolution(true); // 適応解像度を有効にします。デフォルトは false です。

バックグラウンドミュージック

SDK は、バックグラウンドミュージック (BGM) の再生、ミキシング、ノイズ除去、インイヤーモニタリング、ミュートに対応しています：

/* BGM の再生を開始します。 */
mAlivcLivePusher.startBGMAsync(mPath);
/* BGM の再生を停止します。 BGM が再生中に曲を切り替える場合は、BGM の開始 API を再度呼び出すだけで十分です。 現在の BGM を停止する必要はありません。 */
mAlivcLivePusher.stopBGMAsync();
/* BGM を一時停止します。 BGM の再生開始後にのみ呼び出せます。 */
mAlivcLivePusher.pauseBGM();
/* BGM を再開します。 BGM が一時停止中の場合にのみ呼び出せます。 */
mAlivcLivePusher.resumeBGM();
/* BGM のループ再生を有効にします。 */
mAlivcLivePusher.setBGMLoop(true);
/* ノイズ除去を設定します。 有効にすると、キャプチャした音声から人の声以外の音が除去されます。 これにより、人の声がわずかに抑制される場合があります。 この機能を有効にするかどうかは、ユーザーが選択できるようにすることを推奨します。 デフォルトでは無効になっています。 */
mAlivcLivePusher.setAudioDenoise(true);
/* インイヤーモニタリングを設定します。 この機能は主にカラオケなどのシーンで利用されます。 イヤホン接続時に有効にすると、配信者は自分の声を聞くことができます。 無効にすると聞こえなくなります。 イヤホンが接続されていない場合、この機能は無効です。 */
mAlivcLivePusher.setBGMEarsBack(true);
/* ミキシングを設定し、BGM とキャプチャした音声のボリュームを調整します。 */
mAlivcLivePusher.setBGMVolume(50); // BGM のボリュームを設定します。
mAlivcLivePusher.setCaptureVolume(50); // キャプチャした音声のボリュームを設定します。
/* 音声をミュートします。 これにより、BGM とマイク入力の両方がミュートされます。 BGM またはマイク入力の片方のみをミュートする場合は、ボリューム調整用のミキシング API を使用してください。 */
mAlivcLivePusher.setMute(true);

ストリームスナップショット

ローカルビデオストリームのスナップショットを取得します。

// ビデオストリームのスナップショットを取得します。パラメーター：キャプチャ枚数、キャプチャ間の間隔 (秒単位、複数枚キャプチャする場合に適用)、コールバックリスナー。
pusher.snapshot(1, 1, new AlivcSnapshotListener() {
    @Override
    public void onSnapshot(Bitmap bmp) {
        // スナップショットをローカルの PNG ファイルとして保存できます。以下のコードは一例です。
        String dateFormat = new SimpleDateFormat("yyyy-MM-dd-hh-mm-ss-SS").format(new Date());
        File f = new File(context.getExternalFilesDir(Environment.DIRECTORY_PICTURES), "snapshot-" + dateFormat + ".png");
        if (f.exists()) {
            f.delete();
        }
        try {
            FileOutputStream out = new FileOutputStream(f);
            bmp.compress(Bitmap.CompressFormat.PNG, 90, out);
            out.flush();
            out.close();
        } catch (FileNotFoundException e) {
            // TODO 自動生成された catch ブロック
            e.printStackTrace();
        } catch (IOException e) {
            // TODO 自動生成された catch ブロック
            e.printStackTrace();
        }
    }
});

バックグラウンド実行と画面ロック

• アプリがバックグラウンドに移行した場合、または画面がロックされた場合は、AlivcLivePusher の pause() または resume() メソッドを呼び出して、アップストリーミングを一時停止または再開できます。

• システム以外のオーディオ / ビデオ通話では、SDK が音声をキャプチャしてアップストリーミングします。ビジネス要件に応じて、mAlivcLivePusher.setMute(true or false) API を呼び出して、アプリがバックグラウンドにある場合や画面がロックされている場合に音声をキャプチャするかどうかを設定できます。

コールバック

一般的なメソッドと API

/* カスタムモードでは、最小ビットレートとターゲットビットレートをリアルタイムで調整できます。 */
mAlivcLivePusher.setTargetVideoBitrate(800);
mAlivcLivePusher.setMinVideoBitrate(400);
/* カメラがオートフォーカスをサポートしているかどうかを確認します。 */
mAlivcLivePusher.isCameraSupportAutoFocus();
/* カメラがフラッシュをサポートしているかどうかを確認します。 */
mAlivcLivePusher.isCameraSupportFlash();
/* 現在のストリームインジェストのステータスを取得します。 */
mAlivcLivePusher.isPushing(); 
/* インジェスト URL を取得します。 */
mAlivcLivePusher.getPushUrl();
/* ストリームインジェストのパフォーマンスとデバッグ情報を取得します。パフォーマンスパラメーターの詳細については、API リファレンスまたはインターフェイスのコメントをご参照ください。 */
mAlivcLivePusher.getLivePushStatsInfo();
/* SDK のバージョン番号を取得します。 */
mAlivcLivePusher.getSDKVersion();
/* 必要に応じてデバッグ情報をフィルタリングするため、ログレベルを設定します。 */
mAlivcLivePusher.setLogLevel(AlivcLivePushLogLevelAll);
/* SDK の現在のステータスを取得します。 */
mAlivcLivePusher.getCurrentStatus();
/* 最後のエラーコードを取得します。エラーがない場合は ALIVC_COMMON_RETURN_SUCCESS を返します。 */
mAlivcLivePusher.getLastError();

美顔の統合

美顔ライブラリをインポートし、コールバックを設定して美顔機能を有効にします。

1. Maven 経由で美顔ライブラリをインポートします。build.gradle ファイルに以下を追加してください。SDK のバージョンについては、最新の Demo を確認してください。

   implementation "com.aliyun.maliang.android:queen:2.5.0-official-full"
   implementation("com.aliyun.maliang.android:queen_menu:2.5.0-official-full") {
       exclude group: 'com.aliyun.maliang.android', module: 'queen'
   }

   また、デモから LiveBeauty モジュールを統合することもできます。

   ファイルまたはフォルダー	説明
   live_beauty	美顔用の基本抽象クラス。
   queen_beauty	美顔用の基本 UI コントロール。

2. LiveBeauty 美顔プラグインライブラリを取得します。

   1. clone コマンドを使用して、LiveBeauty パスから関連するプラグインライブラリコードをローカルマシンにダウンロードします。

      git clone https://github.com/MediaBox-Demos/amdemos-android-live.git

   2. Android Studio プロジェクトのルートディレクトリでコマンドラインを開きます。以下のコードを実行してから、File > New > Import Module  を使用して LiveBeauty モジュールを Android プロジェクトにインポートします。

      git submodule add https://github.com/MediaBox-Demos/amdemos-android-live.git ***/***/***

      説明

      サンプルコードでは、/*** は LiveBeauty モジュールへのパスのプレースホルダーです。

   3. プロジェクトの settings.gradle ファイルに、モジュールのパスを追加します。

      include ':app', ':LiveBeauty', ':LiveBeauty:live_queenbeauty'

      説明

      サンプルコードでは、app がメインモジュールです。

   4. また、プロジェクトのメインモジュールの build.gradle ファイルに、LiveBeauty モジュールへの依存関係を追加します。

      dependencies {
          implementation project(':LiveBeauty')
          implementation project(':LiveBeauty:live_queenbeauty')
      }

   5. File > Sync Project with Gradle Files をクリックします。Gradle の同期が完了すると、LiveBeauty モジュールを使用できます。

3. 美顔プラグインの UI モジュールを設定します。

   1. プロジェクトのレイアウト XML ファイルに QueenBeautyMenu コントロールを追加します。例：

      <com.aliyunsdk.queen.menu.QueenBeautyMenu
          android:id="@+id/beauty_beauty_menuPanel"
          android:layout_width="match_parent"
          android:layout_height="wrap_content"
          android:layout_alignParentBottom="true"
          android:layout_centerHorizontal="true" />

   2. Activity で QueenBeautyMenu を初期化します。例：

      // 美顔メニューパネルを初期化します。
      QueenMenuPanel beautyMenuPanel = QueenMenuPanel.getPanel(context);
      beautyMenuPanel.onHideMenu(); 
      beautyMenuPanel.onHideValidFeatures(); 
      beautyMenuPanel.onHideCopyright(); 
      
      // 美顔メニューをレイアウトに追加します。
      QueenBeautyMenu beautyBeautyContainerView = findViewById(R.id.beauty_beauty_menuPanel);
      beautyBeautyContainerView.addView(beautyMenuPanel);

4. 顔認識と美顔のコールバックを設定します。

   サードパーティ製の美顔ライブラリを統合する必要がある場合は、setCustomDetect と setCustomFilter コールバックを設定します。

   • customDetectProcess では、dataPtr パラメーターは、サードパーティ処理用にキャプチャされたデータへのポインターです。

   • customFilterProcess では、inputTexture パラメーターは処理用の画像テクスチャです。処理済みのテクスチャ ID を返すか、変更がない場合は元の inputTexture を返します。

   サンプルコード

   /**
    * 顔認識コールバック。
    */
   mAlivcLivePusher.setCustomDetect(new AlivcLivePushCustomDetect() {
       @Override
       public void customDetectCreate() {
   
       }
   
       @Override
       public long customDetectProcess(long dataPtr, int width, int height, int rotation, int format, long extra) {
           return 0;
       }
   
       @Override
       public void customDetectDestroy() {
   
       }
   });
   
   /**
    * 美顔コールバック。
    */
   mAlivcLivePusher.setCustomFilter(new AlivcLivePushCustomFilter() {
       /**
        * BeautyManager を初期化します。
        */
       @Override
       public void customFilterCreate() {
           initBeautyManager();
       }
   
       /**
        * インジェストされたビデオストリームを処理し、美顔エフェクトを追加します。
        */
       @Override
       public int customFilterProcess(int inputTexture, int textureWidth, int textureHeight, long extra) {
           if (mBeautyManager == null) {
               return inputTexture;
           }
   
           return mBeautyManager.onTextureInput(inputTexture, textureWidth, textureHeight);
       }
   
       @Override
       public void customFilterDestroy() {
           destroyBeautyManager();
       }
   });