このトピックでは、Push SDK for Flutterによって提供される方法について説明します。
背景情報
メソッドの詳細については、「LIBRARIES」をご参照ください。
基本クラス
クラス | ダーツファイル | 説明 |
AlivcBase | live_base.dart | ストリーム取り込みの基本クラス。The basic class for stream ingest. |
AlivcLivePusherConfig | live_push_config.dart | ストリーム取り込み構成のクラス。The class for stream ingest configuration. |
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を再接続します。 これは非同期の方法です。 |
破壊する | ストリーム取り込みエンジンを破棄します。 |
destryConfigForIOS | iOSでConfigオブジェクトをリセットします。 このメソッドを使用すると、AlivcLivePusherConfigがiOSで使用されていないときに、Configオブジェクトによって構成されている設定をクリアできます。 |
setAutoFocus | オートフォーカスを有効にするかどうかを指定します。 |
focusCameraAtAdjustedPoint | フォーカスを設定します。 |
setZoom | ズームを設定します。 |
getMaxZoom | サポートされている最大ズーム値を照会します。 |
getCurrentZoom | 現在のズーム値を照会します。 |
setFlash | フラッシュをオンにするかどうかを指定します。 |
setExposure | 露出レベルを設定します。 |
getCurrentExposure | 現在の露出レベルを照会します。 |
getSupportedMinExposure | サポートされている最小露出レベルを照会します。 |
getSupportedMaxExposure | サポートされている最大露出レベルを照会します。 |
setPushMirror | ストリーム取り込みのミラーリングモードを有効にするかどうかを指定します。 |
setPreviewMirror | プレビューのミラーリングモードを有効にするかどうかを指定します。 |
setMute | 取り込まれたストリームをミュートします。 |
setQualityMode | ストリーム取り込みモードを設定します。 |
setTargetVideoBitrate | 目標ビットレートを設定します。 |
setMinVideoBitrate | 最小ビットレートを設定します。 |
setPreviewDisplayMode | プレビューモードを設定します。 |
setResolution | 取り込まれたストリームの解像度を設定します。 このメソッドはプレビューモードでのみ有効で、ストリームの取り込み中に呼び出すことはできません。 |
startBGMWithMusicPathAsync | バックグラウンドミュージックを再生します。 |
stopBGMAsync | バックグラウンドミュージックの再生を停止します。 |
pauseBGM | バックグラウンドミュージックの再生を一時停止します。 |
resumeBGM | バックグラウンドミュージックの再生を再開します。 |
setBGMLoop | BGMのループ再生を有効にするかどうかを指定します。 |
setBGMEarsBack | バックグラウンドミュージックのインイヤーモニタリングを有効にするかどうかを指定します。 |
setAudioDenoise | ノイズリダクションを有効にするかどうかを指定します。 |
setAudioEffectVoiceChangeMode | 音声変更モードを設定します。 |
setAudioEffectReverbMode | 残響モードを設定します。 |
setBGMVolume | ミックスオーディオの音楽の音量を設定します。 |
setCaptureVolume | ミックスオーディオのボーカルの音量を設定します。 |
sendMessage | カスタムSEIメッセージを設定します。 |
isPushing | ストリームが取り込まれているかどうかを照会します。 |
getPushURL | 取り込みURLを照会します。 |
getLiveStatus | ストリーム取り込みステータスを照会します。 |
addWatermark | 透かしを追加します。 |
setWatermarkVisible | 透かしを表示するか非表示にするかを指定します。 |
addDynamicWaterMarkImageData | アニメーションステッカーを追加します。 |
removeDynamicWaterMark | アニメーションステッカーを削除します。 |
スナップショット | スナップショット設定を構成します。 |
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 | BGMのダウンロードのタイムアウトのコールバックを設定します。 コールバックはsetBGMDelegateによって返されます。 |
setOnBGMApened失敗しました | バックグラウンドミュージックの再生に失敗したコールバックを設定します。 コールバックはsetBGMDelegateによって返されます。 |
setOnBGMPaused | BGMの一時停止再生用のコールバックを設定します。 コールバックはsetBGMDelegateによって返されます。 |
setOnBGMProgress | 再生の進行状況のコールバックを設定します。 コールバックはsetBGMDelegateによって返されます。 |
setOnBGMResumed | バックグラウンドミュージックの再生を再開するためのコールバックを設定します。 コールバックはsetBGMDelegateによって返されます。 |
setOnBGMSTorted | バックグラウンドミュージックの再生開始のコールバックを設定します。 コールバックはsetBGMDelegateによって返されます。 |
setOnBGMStoped | BGMの再生停止のコールバックを設定します。 コールバックはsetBGMDelegateによって返されます。 |
setOnSnapshot | スナップショットキャプチャのコールバックを設定します。 コールバックはsetSnapshotDelegateによって返されます。 |