API リファレンス - - Alibaba Cloud ドキュメントセンター

このトピックでは、Flutter 用 Push SDK によって提供されるクラスとメソッドについて説明します。

クラスとメソッドの詳細については、ライブラリをご参照ください。

基本クラス

クラス	Dart ファイル	説明
AlivcBase	live_base.dart	ストリームインジェストの基底クラスです。
AlivcLivePusherConfig	live_push_config.dart	ストリームインジェストの設定に使用するクラスです。
AlivcLivePusher	live_pusher.dart	ストリームインジェストエンジンを設定するために使用するクラスです。
AlivcPusherPreview	live_pusher_preview.dart	プレビュービューを制御するために使用するクラスです。
-	live_push_def.dart	ストリームインジェストパラメーターを定義するために使用するクラスです。

基本的なストリームインジェストメソッド

AlivcBase

メソッド	説明
init	AlivcBase インスタンスを作成します。
getSdkVersion	SDK のバージョン番号を取得します。
setObserver	コールバックのリスナーを指定します。
setLogLevel	ログレベルを指定します。
setConsoleEnable	コンソールのログを有効にするかどうかを指定します。
setLogPath	ログパスを指定します。
registerSDK	SDK を登録します。
setOnLicenceCheck	ライセンス検証のコールバックを設定します。コールバックは setObserver によって返されます。

ストリームインジェスト設定メソッド

AlivcLivePusherConfig

メソッド	説明
init	AlivcLivePusherConfig インスタンスを作成します。
setResolution	解像度を指定します。
getResolution	解像度を照会します。
setEnableAutoBitrate	適応ビットレートストリーミングを有効にするかどうかを指定します。
getEnableAutoBitrate	適応ビットレートストリーミングが有効になっているかどうかを照会します。
setEnableAutoResolution	適応解像度を有効にするかどうかを指定します。
getEnableAutoResolution	適応解像度が有効になっているかどうかを照会します。
setQualityMode	ビットレート制御モードを指定します。
getQualityMode	ビットレート制御モードを照会します。
setTargetVideoBitrate	動画の期待ビットレートを指定します。
getTargetVideoBitrate	動画の期待ビットレートを照会します。
setMinVideoBitrate	動画の最小ビットレートを指定します。
getMinVideoBitrate	動画の最小ビットレートを照会します。
setInitialVideoBitrate	動画の初期ビットレートを指定します。
getInitialVideoBitrate	動画の初期ビットレートを照会します。
setAudioBitrate	オーディオビットレートを指定します。
getAudioBitrate	オーディオビットレートを照会します。
setAudioSampleRate	オーディオサンプリングレートを指定します。
getAudioSampleRate	オーディオサンプリングレートを照会します。
setFps	フレームレートを指定します。
getFps	フレームレートを照会します。
setMinFps	最小フレームレートを指定します。
getMinFps	最小フレームレートを照会します。
setVideoEncodeGop	グループオブピクチャ (GOP) サイズを指定します。
getVideoEncodeGop	GOP サイズを照会します。
setAudioEncoderProfile	オーディオエンコード形式を指定します。
getAudioEncoderProfile	オーディオエンコード形式を照会します。
setAudioChannel	サウンドチャネル数を指定します。
getAudioChannel	サウンドチャネル数を照会します。
setAudioOnly	インジェストされるストリームがオーディオのみのストリームかどうかを指定します。
getAudioOnly	インジェストされるストリームがオーディオのみのストリームかどうかを照会します。
setVideoOnly	インジェストされるストリームがビデオのみのストリームかどうかを指定します。
getVideoOnly	インジェストされるストリームがビデオのみのストリームかどうかを照会します。
setAudioEncoderMode	オーディオエンコードモードを指定します。
getAudioEncoderMode	オーディオエンコードモードを照会します。
setVideoEncoderMode	ビデオエンコードモードを指定します。
getVideoEncoderMode	ビデオエンコードモードを照会します。
setVideoHardEncoderCodec	ハードウェアエンコードのエンコード形式を指定します。
getVideoHardEncoderCodec	ハードウェアエンコードのエンコード形式を照会します。
setOpenBFrame	ハードウェアエンコードモードで B フレームを有効にするかどうかを指定します。
getOpenBFrame	ハードウェアエンコードモードで B フレームが有効になっているかどうかを照会します。
setOrientation	ストリームインジェストの向きを指定します。
getOrientation	ストリームインジェストの向きを照会します。
setPreviewDisplayMode	プレビューモードを指定します。
getPreviewDisplayMode	プレビューモードを照会します。
setConnectRetryInterval	再接続間隔を指定します。
getConnectRetryInterval	再接続間隔を照会します。
setConnectRetryCount	再接続試行回数を指定します。
getConnectRetryCount	再接続試行回数を照会します。
setPushMirror	ストリームインジェストのミラーリングモードを有効にするかどうかを指定します。
getPushMirror	ストリームインジェストのミラーリングモードが有効になっているかどうかを照会します。
setPreviewMirror	プレビューのミラーリングモードを有効にするかどうかを指定します。
getPreviewMirror	プレビューのミラーリングモードが有効になっているかどうかを照会します。
setCameraType	カメラタイプを指定します。
getCameraType	カメラタイプを照会します。
setAutoFocus	オートフォーカスを有効にするかどうかを指定します。
getAutoFocus	オートフォーカスが有効になっているかどうかを照会します。
setPauseImg	ストリームインジェストが一時停止された場合に表示される画像を指定します。
setNetworkPoorImg	低ビットレートの場合に表示される画像を指定します。
setExternAudioFormat	外部カスタムオーディオデータを指定します。
getExternAudioFormat	外部カスタムオーディオデータを照会します。
setExternVideoFormat	外部カスタムビデオデータを指定します。
getExternVideoFormat	外部カスタムビデオデータを照会します。
setAudioScene	オーディオシナリオを指定します。
getAudioScene	オーディオシナリオを照会します。
setExternMainStream	ストリームインジェストに外部カスタムデータを使用するかどうかを指定します。
getExternMainStream	ストリームインジェストに外部カスタムデータが使用されているかどうかを照会します。

ストリームインジェストエンジン設定メソッド

AlivcLivePusher

メソッド	説明
init	AlivcLivePusher インスタンスを作成します。
createConfig	AlivcLivePusherConfig を AlivcLivePusher に関連付ける Config オブジェクトを作成します。
initLivePusher	ストリームインジェストエンジンを作成します。
setErrorDelegate	ストリームインジェストエラーのリスナーを指定します。
setInfoDelegate	ストリームインジェストステータスのリスナーを指定します。
setNetworkDelegate	ストリームインジェスト中のネットワークステータスのリスナーを指定します。
setBGMDelegate	バックグラウンドミュージックのリスナーを指定します。
startPreview	プレビューを開始します。これは同期メソッドです。
startPreviewAsync	プレビューを開始します。これは非同期メソッドです。
startPushWithURL	ストリームインジェストを開始します。これは同期メソッドです。
startPushWithURLAsync	ストリームインジェストを開始します。これは非同期メソッドです。
stopPreview	プレビューを停止します。
stopPush	ストリームインジェストを停止します。
restartPush	ストリームインジェストを再起動します。これは同期メソッドです。
restartPushAsync	ストリームインジェストを再起動します。これは非同期メソッドです。
pause	カメラからのストリームインジェストを一時停止します。
resume	カメラからのストリームインジェストを再開します。
resumeAsync	ストリームインジェストを再開します。これは非同期メソッドです。
switchCamera	前面カメラと背面カメラを切り替えます。
reconnectPushAsync	再接続します。これは非同期メソッドです。
reconnectPushAsyncWithPushURL	インジェスト URL を再接続します。これは非同期メソッドです。
destroy	ストリームインジェストエンジンを破棄します。
destroyConfigForIOS	iOS で Config オブジェクトをリセットします。 iOS で AlivcLivePusherConfig を使用する必要がなくなった場合、このメソッドを使用して Config オブジェクトによって設定された設定をクリアできます。
setAutoFocus	オートフォーカスを有効にするかどうかを指定します。
focusCameraAtAdjustedPoint	フォーカスの設定を行います。
setZoom	ズームの設定を行います。
getMaxZoom	サポートされている最大ズーム値を照会します。
getCurrentZoom	現在のズーム値を照会します。
setFlash	フラッシュをオンにするかどうかを指定します。
setExposure	露出レベルを指定します。
getCurrentExposure	現在の露出レベルを照会します。
getSupportedMinExposure	サポートされている最小露出レベルを照会します。
getSupportedMaxExposure	サポートされている最大露出レベルを照会します。
setPushMirror	ストリームインジェストのミラーリングモードを有効にするかどうかを指定します。
setPreviewMirror	プレビューのミラーリングモードを有効にするかどうかを指定します。
setMute	インジェストされるストリームをミュートします。
setQualityMode	ストリームインジェストモードを指定します。
setTargetVideoBitrate	期待ビットレートを指定します。
setMinVideoBitrate	最小ビットレートを指定します。
setPreviewDisplayMode	プレビューモードを指定します。
setResolution	インジェストされるストリームの解像度を指定します。このメソッドはプレビューモードでのみ有効で、ストリームインジェスト中は呼び出すことができません。
startBGMWithMusicPathAsync	バックグラウンドミュージックを再生します。
stopBGMAsync	バックグラウンドミュージックの再生を停止します。
pauseBGM	バックグラウンドミュージックの再生を一時停止します。
resumeBGM	バックグラウンドミュージックの再生を再開します。
setBGMLoop	バックグラウンドミュージックのループ再生を有効にするかどうかを指定します。
setBGMEarsBack	バックグラウンドミュージックのインイヤーモニタリングを有効にするかどうかを指定します。
setAudioDenoise	ノイズリダクションを有効にするかどうかを指定します。
setAudioEffectVoiceChangeMode	ボイスチェンジモードを指定します。
setAudioEffectReverbMode	残響モードを指定します。
setBGMVolume	ミキシングされたオーディオのバックグラウンドミュージックの音量を指定します。
setCaptureVolume	ミキシングされたオーディオの音声の音量を指定します。
sendMessage	カスタムの補足強化情報 (SEI) メッセージを指定します。
isPushing	ストリームがインジェストされているかどうかを照会します。
getPushURL	インジェスト URL を照会します。
getLiveStatus	ストリームインジェストステータスを照会します。
addWatermark	ウォーターマークを追加します。
setWatermarkVisible	ウォーターマークを表示するか非表示にするかを指定します。
addDynamicWaterMarkImageData	アニメーションステッカーを追加します。
removeDynamicWaterMark	アニメーションステッカーを削除します。
snapshot	スナップショットの設定を指定します。
setSnapshotDelegate	スナップショットキャプチャのリスナーを指定します。このメソッドは、snapshot メソッドを呼び出した後にのみ呼び出すことができます。
sendVideoData	カスタムビデオデータを送信します。
sendPCMData	カスタムオーディオデータを送信します。
setOnSDKError	SDK エラーのコールバックを指定します。コールバックは setErrorDelegate によって返されます。
setOnSystemError	システムエラーのコールバックを指定します。コールバックは setErrorDelegate によって返されます。
setOnPreviewStarted	プレビュースタートのコールバックを指定します。コールバックは setInfoDelegate によって返されます。
setOnPreviewStoped	プレビューストップのコールバックを指定します。コールバックは setInfoDelegate によって返されます。
setOnFirstFramePreviewed	最初のフレームレンダリングのコールバックを指定します。コールバックは setInfoDelegate によって返されます。
setOnPushStarted	ストリームインジェスト開始のコールバックを指定します。コールバックは setInfoDelegate によって返されます。
setOnPushPaused	カメラからのストリームインジェスト一時停止のコールバックを指定します。コールバックは setInfoDelegate によって返されます。
setOnPushResumed	カメラからのストリームインジェスト再開のコールバックを指定します。コールバックは setInfoDelegate によって返されます。
setOnPushRestart	ストリームインジェスト再起動のコールバックを指定します。コールバックは setInfoDelegate によって返されます。
setOnPushStoped	ストリームインジェスト終了のコールバックを指定します。コールバックは setInfoDelegate によって返されます。
setOnConnectFail	ストリームインジェスト失敗のコールバックを指定します。コールバックは setNetworkDelegate によって返されます。
setOnConnectRecovery	ネットワーク回復のコールバックを指定します。コールバックは setNetworkDelegate によって返されます。
setOnConnectionLost	ストリームインジェスト切断のコールバックを指定します。コールバックは setNetworkDelegate によって返されます。
setOnNetworkPoor	ネットワーク状態不良のコールバックを指定します。コールバックは setNetworkDelegate によって返されます。
setOnReconnectError	再接続失敗のコールバックを指定します。コールバックは setNetworkDelegate によって返されます。
setOnReconnectStart	再接続試行のコールバックを指定します。コールバックは setNetworkDelegate によって返されます。
setOnReconnectSuccess	再接続成功のコールバックを指定します。コールバックは setNetworkDelegate コールバックによって返されます。
setOnSendDataTimeout	データ送信タイムアウトのコールバックを指定します。コールバックは setNetworkDelegate によって返されます。
setOnSendSeiMessage	SEI メッセージを送信するためのプロンプトのコールバックを指定します。コールバックは setNetworkDelegate によって返されます。
setOnBGMCompleted	バックグラウンドミュージックの再生完了のコールバックを指定します。コールバックは setBGMDelegate によって返されます。
setOnBGMDownloadTimeout	バックグラウンドミュージックダウンロードのタイムアウトのコールバックを指定します。コールバックは setBGMDelegate によって返されます。
setOnBGMOpenFailed	バックグラウンドミュージックの再生失敗のコールバックを指定します。コールバックは setBGMDelegate によって返されます。
setOnBGMPaused	バックグラウンドミュージックの再生一時停止のコールバックを指定します。コールバックは setBGMDelegate によって返されます。
setOnBGMProgress	再生進捗状況のコールバックを指定します。コールバックは setBGMDelegate によって返されます。
setOnBGMResumed	バックグラウンドミュージックの再生再開のコールバックを指定します。コールバックは setBGMDelegate によって返されます。
setOnBGMStarted	バックグラウンドミュージックの再生開始のコールバックを指定します。コールバックは setBGMDelegate によって返されます。
setOnBGMStoped	バックグラウンドミュージックの再生停止のコールバックを指定します。コールバックは setBGMDelegate によって返されます。
setOnSnapshot	スナップショットキャプチャのコールバックを指定します。コールバックは setSnapshotDelegate によって返されます。