このトピックでは、Push SDK for Androidが提供する方法について説明します。
API 参照資料
次のリンクをクリックして、さまざまなSDKバージョンのAPIドキュメントを表示します。 APIドキュメントは、SDKパッケージでも使用できます。
インタラクティブ版
v6.17.0 (最新)
基本版
v6.17.0 (最新)
基本クラス
クラス | 説明 | ||||||
AlivcLiveBase | ストリーム取り込みの基本クラス。 | ||||||
AlivcLivePusher | ストリーム取り込み機能のクラス。 | ||||||
AlivcLivePushConfig | ストリーム取り込み設定を初期化するために使用されるクラス。 | ||||||
AlivcLivePushErrorListener | ストリーム取り込みのエラーリスナーのクラス。 | ||||||
AlivcLivePushNetworkListener | ストリーム取り込み用のネットワークリスナーのクラス。 | ||||||
AlivcLivePushInfoListener | ストリーム取り込みの通知リスナーのクラス。 | ||||||
AlivcLiveBaseListener | ストリーム取り込みコールバックのクラスです。 | ||||||
AlivcLivePushBGMListener | BGMを再生するための通知リスナーのクラス。 | ||||||
AlivcLivePlayer | ストリームプル用の抽象クラス。 | ||||||
AlivcLivePlayConfig | ストリームプル設定を初期化するために使用されるクラス。 | ||||||
AlivcLivePlayInfoListener | ストリームプルコールバックのクラス。 | ||||||
AlivcLiveBase-ストリーム取り込みに関連する基本的なメソッドを提供
移動方法 | 説明 | ||||||
getSDKVersion | SDKのバージョン番号を照会します。 | ||||||
isSupportLiveMode | SDKでサポートされているストリーム取り込みモードを照会します。 | ||||||
registerSDK | SDKのライセンスを登録します。 | ||||||
setConsoleEnabled | コンソールでログ印刷を有効にするかどうかを指定します。 | ||||||
setListener | コールバック通知を有効にして、ライセンス登録結果を非同期で受信するかどうかを指定します。 | ||||||
setLogDirPath | ログファイルを保存するパスとログシャードのサイズを指定します。 パスが存在し、データがパスに書き込まれることを確認します。 | ||||||
setLogLevel | ログレベルを指定します。 重要 すべてのログに対してこの機能を有効にすると、アプリケーションのパフォーマンスが低下する可能性があります。 | ||||||
AlivcLivePusher-ストリーム取り込み機能に関連するメソッドを提供
移動方法 | 説明 | ||||||
init | ストリーム取り込みパラメーターを初期化します。 | ||||||
destroy | ストリーム取り込みエンジンを破棄します。 | ||||||
startPreview | プレビューを開始します。 インタラクティブモードでは、FrameLayoutパラメーターを指定するstartPreviewメソッドを呼び出します。 | ||||||
startPreviewAysnc | プレビューを非同期で開始します。 | ||||||
stopPreview | プレビューを停止します。 | ||||||
startPush | ストリームの取り込みを開始します。 | ||||||
startPushAysnc | ストリームの取り込みを非同期で開始します。 | ||||||
restartPush | ストリームの取り込みを再開します。 | ||||||
restartPushAync | ストリームの取り込みを非同期で再開します。 | ||||||
reconnectPushAsync | ストリーム取り込みを再結合して続行します。 | ||||||
stopPush | ストリームの取り込みを停止します。 | ||||||
pause | ストリームの取り込みを一時停止します。 | ||||||
resume | ストリーム取り込みを再開します。 | ||||||
resumeAsync | ストリームの取り込みを非同期的に再開します。 | ||||||
switchCamera | フロントカメラとリアカメラを切り替えます。 | ||||||
setAutoFocus | オートフォーカスを有効にするかどうかを指定します。 | ||||||
focusCameraAtAdjustedPoint | フォーカスを設定します。 フォーカスポイントの座標は ([0,Screen width],[0,Screen width]) です。 | ||||||
setZoom | ズーム倍率を設定します。 有効値: [0,getMaxZoom()] 。 | ||||||
getMaxZoom | カメラでサポートされている最大ズーム倍率を照会します。
| ||||||
getCurrentZoom | 現在のズーム倍率を照会します。 | ||||||
setMute | ストリームの取り込み中にオーディオをミュートするかどうかを指定します。 | ||||||
setFlash | フラッシュを有効にするかどうかを指定します。 | ||||||
setPushMirror | ストリーム取り込みのミラーリングモードを有効にするかどうかを指定します。 | ||||||
setPreviewMirror | プレビューのミラーリングモードを有効にするかどうかを指定します。 | ||||||
setTargetVideoBitrate | ターゲットビデオのビットレートを指定します。 有効な値: [100,5000] 。 単位：Kbit/秒 | ||||||
setMinVideoBitrate | ビデオの最小ビットレートを指定します。 有効な値: [100,5000] 。 単位：Kbit/秒 | ||||||
isCameraSupportAutoFocus | オートフォーカスがサポートされているかどうかを照会します。 | ||||||
isCameraSupportFlash | フラッシュがサポートされているかどうかを照会します。 | ||||||
isPushing | ストリームが取り込まれているかどうかを照会します。 | ||||||
isNetworkPushing | ストリーム取り込みの現在のネットワークステータスを照会します。 | ||||||
setCustomDetect | カスタム顔認識のコールバックを設定します。 | ||||||
setCustomFilter | カスタムレタッチのコールバックを設定します。 | ||||||
setCustomAudioFilter | カスタムオーディオ処理のコールバックを設定します。 | ||||||
getCurrentStatus | 現在のステータスを照会します。 | ||||||
setLivePushErrorListener | ストリーム取り込みに関連するエラーのリスナーを設定します。 | ||||||
setLivePushInfoListener | ストリーム取り込みに関する通知のリスナーを設定します。 | ||||||
setLivePushNetworkListener | ネットワークに関する通知のリスナーを設定します。 | ||||||
setLivePushBGMListener | バックグラウンドミュージックの再生に関する通知のリスナーを設定します。 | ||||||
setLivePushRenderContextListener | レンダリングコンテキストのリスナーを設定します。 | ||||||
getLivePushStatsInfo | ストリームの取り込みに関する統計を照会します。 | ||||||
getPushUrl | 取り込みURLを照会します。 | ||||||
setPreviewOrientation | ストリームの取り込み方向を設定します。 デフォルトでは、ストリームはポートレートモードで取り込まれます。 | ||||||
setAudioEffectVoiceChangeMode | 音声変更モードを設定します。 | ||||||
setAudioEffectReverbMode | 残響モードを設定します。 | ||||||
startBGMAsync | バックグラウンドミュージックを再生します。 | ||||||
stopBGMAsync | バックグラウンドミュージックの再生を停止します。 | ||||||
pauseBGM | バックグラウンドミュージックの再生を一時停止します。 | ||||||
resumeBGM | バックグラウンドミュージックの再生を再開します。 | ||||||
setBGMLoop | BGMのループ再生を有効にするかどうかを指定します。 | ||||||
setBGMEarsBack | インイヤーモニタリングを有効にするかどうかを指定します。 | ||||||
setBGMVolume | ミックスされたバックグラウンドミュージックの音楽ボリュームを設定します。 | ||||||
setCaptureVolume | ミックスされたバックグラウンドミュージックの音声ボリュームを設定します。 | ||||||
setAudioDenoise | ノイズリダクションを有効にするかどうかを指定します。 | ||||||
startIntelligentDenoise | インテリジェントなノイズリダクションを可能にします。 | ||||||
stopIntelligentDenoise | インテリジェントなノイズリダクションを無効にします。 | ||||||
setQualityMode | ビデオ解像度を設定します。 | ||||||
setPreviewMode | プレビューモードを設定します。 | ||||||
pauseScreenCapture | プライバシー保護を有効にして、ストリーム取り込み中の画面録画を一時停止します。 | ||||||
resumeScreenCapture | プライバシー保護を無効にして、ストリーム取り込み中に画面録画を再開します。 | ||||||
getLastError | 最近返されたエラーコードを照会します。 | ||||||
changeResolution | ビデオの解像度を動的に調整します。 | ||||||
addWaterMark | 透かしを追加します。 最大3つの透かしを追加できます。 初期位置の座標は、([0,width),[0,height)) である。 widthの値の範囲は (0,width) です。 startPreviewメソッドを呼び出した後、このメソッドを呼び出すことができます。 | ||||||
setWatermarkVisible | 透かしを表示するかどうかを指定します。 | ||||||
startCamera | 画面録画中にカメラのプレビューを有効にします。 プレビューが不要な場合は、surfaceviewパラメーターをnullに設定します。 | ||||||
stopCamera | 画面録画中のカメラプレビューを無効にします。 | ||||||
setScreenOrientation | 画面録画中の画面の回転角度を設定します。 | ||||||
startCameraMix | 画面録画中のカメラミキシングを有効にします。 | ||||||
stopCameraMix | 画面録画中のカメラミキシングを無効にします。 | ||||||
snapshot | ビデオストリームのスナップショットをキャプチャします。 | ||||||
inputStreamVideoPtr | カスタムビデオストリームのポインタを指定します。 | ||||||
inputStreamVideoData | カスタムビデオストリームのデータを指定します。 | ||||||
inputStreamAudioPtr | カスタムオーディオストリームのポインタを指定します。 | ||||||
inputStreamAudioData | カスタムオーディオストリームのデータを指定します。 | ||||||
addDynamicsAddons | アニメーションステッカーを追加します。 | ||||||
removeDynamicsAddons | アニメーションステッカーを削除します。 | ||||||
setExposure | カメラの露出値を設定します。 | ||||||
getCurrentExposure | カメラの露出値を照会します。 | ||||||
getSupportedMinExposure | カメラでサポートされている最小露出値を照会します。 | ||||||
getSupportedMaxExposure | カメラでサポートされている最大露出値を照会します。 | ||||||
sendMessage | ストリームの取り込み側でカスタムの追加拡張情報 (SEI) を送信します。 | ||||||
setLiveMixTranscodingConfig | クラウドベースのストリームミキシング (トランスコーディング) のパラメーターを設定します。 | ||||||
getLiveTraceId | トレースIDを照会します。 | ||||||
AlivcLivePlayer-ストリームプルに関連するメソッドを提供
このクラスは、インタラクティブモードでのストリームプルにのみ使用できます。
移動方法 | 説明 | ||||||
setupWithConfig | ストリームプルパラメーターを初期化します。 | ||||||
setPlayView | 再生プレビューを設定します。 | ||||||
setPlayInfoListener | ストリームのプルに関する通知のリスナーを設定します。 | ||||||
setPlayoutVolume | 再生ボリュームを設定します。 | ||||||
startPlay | オーディオストリームとビデオストリームの再生を開始します。 | ||||||
stopPlay | オーディオおよびビデオストリームの再生を停止します。 | ||||||
pauseAudioPlaying | オーディオストリームの再生を一時停止します。 | ||||||
pauseVideoPlaying | ビデオストリームの再生を一時停止します。 | ||||||
resumeAudioPlaying | オーディオストリームの再生を再開します。 | ||||||
resumeVideoPlaying | ビデオストリームの再生を再開します。 | ||||||
destroy | エンジンを引っ張るストリームを破壊します。 | ||||||
getMode | 現在のストリームのプルモードを照会します。 | ||||||
クラスリスナー
AlivcLiveBaseListener
コールバック | 説明 | ||||||
onLicenseCheck | SDKライセンスの認証結果の非同期コールバック。 | ||||||
AlivcLivePushErrorListener
コールバック | 説明 | ||||||
onSDKError | SDKエラーのコールバック。 | ||||||
onSystemError | システムエラーのコールバック。 | ||||||
AlivcLivePushNetworkListener
コールバック | 説明 | ||||||
onConnectFail | 接続が失敗したことを示します。 | ||||||
onConnectionLost | 接続が中断されたことを示します。 | ||||||
onNetworkPoor | ネットワーク状態が悪いことを示します。 | ||||||
onNetworkRecovery | ネットワークが回復することを示します。 | ||||||
onPacketsLost | ストリーム取り込み中のパケット損失のコールバック。 | ||||||
onPushURLAuthenticationOverdue | 認証の有効期限を示します。 | ||||||
onReconnectFail | 再接続が失敗したことを示します。 | ||||||
onReconnectStart | 再接続の開始を示します。 | ||||||
onReconnectSucceed | 再接続が成功したことを示します。 | ||||||
onSendDataTimeout | データ送信がタイムアウトしたことを示します。 | ||||||
onSendMessage | SEIが送信されることを示します。 | ||||||
AlivcLivePushInfoListener
コールバック | 説明 | ||||||
onAdjustBitrate | ビットレートが調整されていることを示します。 | ||||||
onAdjustFps | フレームレートが調整されていることを示します。 | ||||||
onDropFrame | フレームがドロップすることを示します。 | ||||||
onFirstAVFramePushed | 最初のオーディオおよびビデオパケットが送信されたことを示します。 | ||||||
onFirstFramePreviewed | 最初のフレームがレンダリングされることを示します。 | ||||||
onPreviewStarted | プレビューの開始を示します。 | ||||||
onPreviewStopped | プレビューが終了することを示します。 | ||||||
onPushPaused | ストリーム取り込みが一時停止されていることを示します。 | ||||||
onPushRestarted | ストリーム取り込みが再起動することを示します。 | ||||||
onPushResumed | ストリーム取り込みが再開されたことを示します。 | ||||||
onPushStarted | ストリームの取り込みが開始されることを示します。 | ||||||
onPushStatistics | ストリーム取り込み時のデータ統計のコールバック。 このコールバックは2秒ごとに返されます。 | ||||||
onPushStopped | ストリームの取り込みが終了することを示します。 | ||||||
onSetLiveMixTranscodingConfig | クラウドベースのストリームミキシング (トランスコーディング) パラメーターを設定するためのコールバック。 | ||||||
AlivcLivePushBGMListener
コールバック | 説明 | ||||||
onCompleted | 再生が終了することを示します。 | ||||||
onDownloadTimeout | プレイヤーがタイムアウトしたことを示します。 プレーヤーは再接続され、前の再生位置を求めます。 | ||||||
onOpenFailed | ストリームが無効でアクセスできないことを示します。 | ||||||
onPaused | 再生が一時停止されていることを示します。 | ||||||
onProgress | 再生の進行状況を示します。 | ||||||
onResumed | 再生が再開されることを示します。 | ||||||
onStarted | 再生が開始されることを示します。 | ||||||
onStopped | 再生が停止することを示します。 | ||||||
AlivcLivePlayInfoListener
コールバック | 説明 | ||||||
onError | エラーのコールバック。 | ||||||
onFirstVideoFrameDrawn | ビデオの再生のためのコールバック。 | ||||||
onPlayStarted | 再生開始のコールバック。 | ||||||
onPlayStopped | 再生停止のコールバック。 | ||||||