このトピックでは、iOS 用 Push SDK によって提供されるクラスとメソッドについて説明します。
基本クラス
クラス | 説明 | ||||||
AlivcLiveBase | 基本的なストリーム取り込みメソッドを提供するクラス。 | ||||||
AlivcLiveBaseObserver | 基本的なストリーム取り込みコールバックを提供するクラス。 | ||||||
AlivcLivePusher | ストリーム取り込みエンジンを作成および管理するために使用されるクラス。 | ||||||
AlivcLivePushConfig | ストリーム取り込み設定を初期化するために使用されるクラス。 | ||||||
AlivcLivePusherErrorDelegate | ストリーム取り込みのエラー関連コールバックを提供するクラス。 | ||||||
AlivcLivePusherNetworkDelegate | ストリーム取り込みのネットワーク関連コールバックを提供するクラス。 | ||||||
AlivcLivePusherInfoDelegate | ストリーム取り込みステータスの通知用コールバックを提供するクラス。 | ||||||
AlivcLivePusherCustomFilterDelegate | レタッチ用の生データを処理するために使用されるカスタムフィルターのコールバックを提供するクラス。 | ||||||
AlivcLivePusherCustomDetectorDelegate | カスタム顔認識のコールバックを提供するクラス。 | ||||||
AlivcLivePusherBGMDelegate | ストリーム再生の通知用コールバックを提供するクラス。 | ||||||
AlivcLivePusherAudioSampleDelegate | 生のオーディオデータのコールバックを提供するクラス。 | ||||||
AlivcLivePlayer | 同時ストリーム配信中にストリームプルのエンジンを作成および管理するために使用されるクラス。 | ||||||
AlivcLivePlayConfig | 同時ストリーム配信設定を初期化するために使用されるクラス。 | ||||||
AliLivePlayerDelegate | 同時ストリーム配信コールバックを提供するクラス。 | ||||||
AlivcLivePlayerStatsInfo | 同時ストリーム配信に関連するメディアデータを格納するクラス。 | ||||||
AlivcLiveTranscodingConfig | ミックスストリームトランスコーディング設定を格納するクラス。 | ||||||
AlivcLiveMixStream | ミックスストリームトランスコーディングにおける各レイヤーの位置情報を格納するクラス。 | ||||||
基本的なストリーム取り込みメソッド
AlivcLiveBase
メソッド | 説明 | ||||||
getSDKVersion | SDK のバージョン番号を照会します。 | ||||||
registerSDK | ライセンスを使用して SDK を登録します。 | ||||||
setConsoleEnabled | コンソールのログを有効または無効にします。 | ||||||
setObserver | ライセンス登録結果を非同期で受信するためのコールバック通知を設定します。 | ||||||
setLogPath:maxPartFileSizeInKB | ログファイルが保存されるパスとログシャードのサイズを設定します。パスが存在し、データがパスに書き込めることを確認してください。 | ||||||
setLogLevel | ログレベルを設定します。すべてのログを生成する機能を有効にすると、アプリケーションのパフォーマンスが低下する可能性があります。 | ||||||
ストリーム取り込みエンジンのメソッド
AlivcLivePusher
メソッド | 説明 | ||||||
initWithConfig | ストリーム取り込みエンジンを作成します。 | ||||||
setErrorDelegate | ストリーム取り込みエラーのコールバックを設定します。 | ||||||
setInfoDelegate | ストリーム取り込みステータスのコールバックを設定します。 | ||||||
setNetworkDelegate | ストリーム取り込み中のネットワークステータスのコールバックを設定します。 | ||||||
setCustomFilterDelegate | レタッチ用の生データを処理するために使用されるカスタムフィルターのコールバックを設定します。 | ||||||
setCustomDetectorDelegate | カスタム顔認識のコールバックを設定します。 | ||||||
setBGMDelegate | バックグラウンドミュージックのコールバックを設定します。 | ||||||
setAudioSampleDelegate | 生のオーディオデータのコールバックを設定します。 | ||||||
destory | ストリーム取り込みエンジンを破棄します。 | ||||||
startPreview | プレビューを開始します。 | ||||||
startPreviewAysnc | プレビューを非同期で開始します。このメソッドを使用してプレビューを開始することをお勧めします。 | ||||||
stopPreview | プレビューを停止します。 | ||||||
startPushWithURL | ストリーム取り込みを開始します。 | ||||||
startPushWithURLAsync | ストリーム取り込みを非同期で開始します。このメソッドを使用してストリーム取り込みを開始することをお勧めします。 | ||||||
stopPush | ストリーム取り込みを停止します。 | ||||||
reconnectPushAsync | 再接続してストリーム取り込みを開始します。 onReconnectError コールバックが返された場合、このメソッドを呼び出すことができます。 | ||||||
pause | カメラからのストリーム取り込みを一時停止します。バックグラウンドストリーム取り込み用の画像が設定されている場合、カメラからのストリーム取り込みが一時停止されると、指定された画像が取り込まれます。 | ||||||
resume | カメラからのストリーム取り込みを再開します。 | ||||||
resumeAsync | カメラからのストリーム取り込みを非同期で再開します。 | ||||||
switchCamera | 前面カメラと背面カメラを切り替えます。 | ||||||
setAutoFocus | オートフォーカスを有効にするかどうかを指定します。 | ||||||
focusCameraAtAdjustedPoint:autoFocus | フォーカスポイントを設定します。フォーカスポイントの座標は（[ 0 , 画面の幅]、[ 0 , 画面の高さ]）です。 | ||||||
setZoom | ズーム係数を設定します。有効な値: [ 0 , getMaxZoom()]。 | ||||||
getMaxZoom | カメラがサポートする最大ズーム係数を照会します。値 0 はズームがサポートされていないことを示します。 0 より大きい値は最大ズーム係数を示します。 | ||||||
getCurrentZoom | 現在のズーム係数を照会します。 | ||||||
setFlash | フラッシュを有効にするかどうかを指定します。 | ||||||
setExposure | カメラの露出値を設定します。 | ||||||
getCurrentExposure | カメラの露出値を照会します。 | ||||||
getSupportedMinExposure | カメラがサポートする最小露出値を照会します。 | ||||||
getSupportedMaxExposure | カメラがサポートする最大露出値を照会します。 | ||||||
setPushMirror | ストリーム取り込みのミラーリングモードを有効にするかどうかを指定します。 | ||||||
setPreviewMirror | プレビューのミラーリングモードを有効にするかどうかを指定します。 | ||||||
setTargetVideoBitrate | 想定ビデオビットレートを設定します。有効な値: [ 100 , 5000 ]。単位: Kbit/s。 | ||||||
setMinVideoBitrate | 最小ビデオビットレートを設定します。有効な値: [ 100 , 5000 ]。単位: Kbit/s。 | ||||||
setpreviewDisplayMode | プレビューモードを設定します。 | ||||||
setResolution | 解像度を設定します。解像度は、ストリーム取り込みとプレビューの両方で変更できます。 | ||||||
setMute | ストリーム取り込み中に音声をミュートするかどうかを指定します。 | ||||||
setAudioEffectVoiceChangeMode | ボイスチェンジモードを設定します。 | ||||||
setAudioEffectReverbMode | 残響モードを設定します。 | ||||||
startBGMWithMusicPathAsync | バックグラウンドミュージックの再生を開始します。 | ||||||
stopBGMAsync | バックグラウンドミュージックの再生を停止します。 | ||||||
pauseBGM | バックグラウンドミュージックの再生を一時停止します。 | ||||||
resumeBGM | バックグラウンドミュージックの再生を再開します。 | ||||||
setBGMLoop | バックグラウンドミュージックのループ再生を有効にするかどうかを指定します。 | ||||||
setBGMEarsBack | インイヤーモニタリングを有効にするかどうかを指定します。 | ||||||
setBGMVolume | オーディオミキシングの音楽の音量を設定します。 | ||||||
setCaptureVolume | オーディオミキシングの音声の音量を設定します。 | ||||||
setAudioDenoise | ノイズリダクションを有効にするかどうかを指定します。 | ||||||
startIntelligentDenoise | インテリジェントノイズリダクションを有効にします。 | ||||||
stopIntelligentDenoise | インテリジェントノイズリダクションを無効にします。 | ||||||
startScreenCapture | 画面共有を開始します。このメソッドはインタラクティブモードではサポートされていません。 | ||||||
sendVideoData:width:height:size:pts:rotation | カスタムビデオデータを送信します。これは、外部ビデオソースの生のビデオデータです。 | ||||||
sendPCMData:size:sampleRate:channel:pts | カスタムオーディオデータを送信します。これは、外部オーディオソースの生のオーディオデータです。 | ||||||
sendMessage:repeatCount:delayTime:KeyFrameOnly | ストリーマーとしてカスタムの補足強化情報 ( SEI ) メッセージを送信します。 | ||||||
addWatermarkWithPath:watermarkCoordX:watermarkCoordY:watermarkWidth | ウォーターマークを追加します。最大 3 つのウォーターマークを追加できます。ウォーターマークの左上頂点の座標は（[ 0 , 画面の幅）、[ 0 , 画面の高さ]）です。ウォーターマークの幅の値の範囲は ( 0 , 画面の幅] です。 startPreview メソッドを呼び出した後に、このメソッドを呼び出すことができます。 | ||||||
setWatermarkVisible | ウォーターマークを表示するかどうかを指定します。 | ||||||
snapshot:interval | ビデオストリームのスナップショットをキャプチャします。 | ||||||
setLiveMixTranscodingConfig | ミックスストリームのトランスコーディングパラメータを設定します。このメソッドはインタラクティブモードでのみサポートされています。 | ||||||
muteLocalCamera | カメラを有効または無効にします。このメソッドはインタラクティブモードでのみサポートされています。 | ||||||
enableSpeakerphone | ヘッドセットまたはスピーカーをオーディオ出力デバイスとして設定します。このメソッドはインタラクティブモードでのみサポートされています。 | ||||||
isEnableSpeakerphone | 現在のオーディオ出力デバイスがヘッドセットかスピーカーかを照会します。 | ||||||
refreshPushURLToken | トークンを更新し、新しい取り込み URL を指定します。 | ||||||
isCameraAutoFocusFaceModeSupported | カメラが顔フォーカスをサポートしているかどうかを照会します。 | ||||||
setCameraAutoFocusFaceModeEnabled | カメラの顔フォーカスを有効にするかどうかを指定します。 | ||||||
AlivcLivePushConfig
メソッド | 説明 | ||||||
livePushMode | ストリーム取り込みモードを設定します。 | ||||||
resolution | 取り込まれたストリームの解像度を設定します。 | ||||||
qualityMode | ストリーム取り込みの動作モードを設定します。 | ||||||
enableAutoBitrate | 適応ビットレートストリーミングを有効にするかどうかを指定します。デフォルトでは、適応ビットレートストリーミングが有効になっています。 | ||||||
enableAutoResolution | 適応解像度を有効にするかどうかを指定します。デフォルトでは、適応解像度は無効になっています。 | ||||||
fps | ビデオのフレームレートを設定します。 | ||||||
targetVideoBitrate | 想定ビデオビットレートを設定します。 | ||||||
audioBitrate | オーディオビットレートを設定します。 | ||||||
audioSampleRate | オーディオサンプリングレートを設定します。 | ||||||
audioChannel | サウンドチャンネルの数を設定します。 | ||||||
audioScene | オーディオシナリオを設定します。音楽シナリオの場合は、値を AlivcLivePusherAudioScenarioMusicMode に設定します。 | ||||||
videoEncodeGop | キーフレーム間隔を設定します。 | ||||||
orientation | ストリーム取り込みの向きを設定します。縦向き、横向き左、横向き右のモードがサポートされています。 | ||||||
cameraType | カメラの種類を設定します。 | ||||||
pushMirror | ストリーム取り込みのミラーリングモードを有効にするかどうかを指定します。 | ||||||
previewMirror | プレビューのミラーリングモードを有効にするかどうかを指定します。 | ||||||
audioOnly | 音声のみのストリーム取り込みを有効にするかどうかを指定します。 | ||||||
videoOnly | ビデオのみのストリーム取り込みを有効にするかどうかを指定します。 | ||||||
pauseImg | カメラからのストリーム取り込みが一時停止されたときに取り込まれる静止画像を設定します。カメラが無効になっているシナリオでこのメソッドを呼び出すことができます。 | ||||||
networkPoorImg | ネットワーク状態が悪いときに取り込まれる静止画像を設定します。上り帯域幅が低いシナリオでこのメソッドを呼び出すことができます。 | ||||||
flash | フラッシュを有効にするかどうかを指定します。 | ||||||
videoEncoderMode | ビデオエンコードモードを設定します。 | ||||||
videoHardEncoderCodec | ビデオのハードウェアエンコードモードを設定します。 H.264 と H.265 がサポートされています。 | ||||||
audioSessionOperationRestriction | AVAudioSession での SDK の制御権限を設定します。 | ||||||
externMainStream | 外部ストリームの入力を有効にするかどうかを指定します。 | ||||||
externVideoFormat | 外部ビデオデータのデータ形式を設定します。 | ||||||
externAudioFormat | 外部オーディオデータのデータ形式を設定します。 | ||||||
enableLocalVideoTexture | テクスチャのコールバックを有効にするかどうかを指定します。デフォルトでは、インタラクティブモードでは CVPixelBuffer データが返されます。 | ||||||
AlivcLiveTranscodingConfig
メソッド | 説明 | ||||||
backgroundColor | ミックスストリームの背景色。デフォルトの色は黒です。 | ||||||
cropMode | ミックスストリームのビデオクロップモード。 | ||||||
mixStreams | ミキシングされるストリーム。 | ||||||
AlivcLiveMixStream
メソッド | 説明 | ||||||
userId | ストリームミキシングに関与するユーザーの ID 。 | ||||||
x | レイヤーの左上頂点の x 座標。値は絶対ピクセル値です。 | ||||||
y | レイヤーの左上頂点の y 座標。値は絶対ピクセル値です。 | ||||||
width | レイヤーの幅。値は絶対ピクセル値です。 | ||||||
height | レイヤーの高さ。値は絶対ピクセル値です。 | ||||||
zOrder | レイヤーのシーケンス番号。 | ||||||
streamType | ミックスストリームの種類。 | ||||||
同時ストリーム配信シナリオでのストリームプルのメソッド
AlivcLivePlayer
このクラスは、インタラクティブモードでのストリームプルでのみ使用できます。
メソッド | 説明 | ||||||
setLivePlayerDelegate | 再生のコールバックを設定します。 | ||||||
setPlayView:playCofig | 再生ビューを設定します。 | ||||||
startPlayWithURL | ビデオおよびオーディオストリームの再生を開始します。 | ||||||
stopPlay | ビデオおよびオーディオストリームの再生を停止します。 | ||||||
pauseAudioPlaying | オーディオストリームの再生を一時停止します。 | ||||||
pauseVideoPlaying | ビデオストリームの再生を一時停止します。 | ||||||
resumeAudioPlaying | オーディオストリームの再生を再開します。 | ||||||
resumeVideoPlaying | ビデオストリームの再生を再開します。 | ||||||
setPlayoutVolume | 再生音量を設定します。 | ||||||
AlivcLivePlayConfig
メソッド | 説明 | ||||||
renderMode | レンダリングモードを設定します。 | ||||||
mirror | 再生がミラーリングされるかどうかを指定します。 | ||||||
rotationMode | 画面回転の角度を設定します。 | ||||||
コールバックのメソッド
AlivcLiveBaseObserver
メソッド | 説明 | ||||||
onLicenceCheck:Reason | SDK ライセンスの検証結果のコールバック。 | ||||||
AlivcLivePusherInfoDelegate
メソッド | 説明 | ||||||
onPreviewStarted | プレビューの開始時にトリガーされるコールバック。 | ||||||
onPreviewStoped | プレビューの停止時にトリガーされるコールバック。 | ||||||
onFirstFramePreviewed | 最初のフレームがレンダリングされたときにトリガーされるコールバック。 | ||||||
onFirstFramePushed | 最初のフレームが送信されたときにトリガーされるコールバック。 | ||||||
onPushStarted | ストリーム取り込みの開始時にトリガーされるコールバック。 | ||||||
onPushPaused | カメラからのストリーム取り込みが一時停止されたときにトリガーされるコールバック。 | ||||||
onPushResumed | カメラからのストリーム取り込みが再開されたときにトリガーされるコールバック。 | ||||||
onPushStoped | ストリーム取り込みの停止時にトリガーされるコールバック。 | ||||||
onPushStatistics | ストリーム取り込みのデータ統計のコールバック。このコールバックは 2 秒ごとに返されます。 | ||||||
onSetLiveMixTranscodingConfig | ミックスストリームトランスコーディングパラメータの設定のコールバック。 | ||||||
onKickedOutByServer | クライアントがサーバーによってキックアウトされたときにトリガーされるコールバック。 | ||||||
AlivcLivePushErrorListener
メソッド | 説明 | ||||||
onSDKError | SDK エラーが発生したときにトリガーされるコールバック。 | ||||||
onSystemError | システムエラーが発生したときにトリガーされるコールバック。 | ||||||
AlivcLivePusherNetworkDelegate
メソッド | 説明 | ||||||
onNetworkPoor | ネットワーク帯域幅が低いときにトリガーされるコールバック。 | ||||||
onConnectRecovery | ネットワークが回復したときにトリガーされるコールバック。 | ||||||
onConnectFail | ストリーム取り込みが失敗したときにトリガーされるコールバック。 | ||||||
onConnectionLost | 接続が切断されたときにトリガーされるコールバック。 | ||||||
onReconnectStart | 再接続の開始時にトリガーされるコールバック。 | ||||||
onReconnectSuccess | 再接続が成功したときにトリガーされるコールバック。 | ||||||
onReconnectError | 再接続が失敗したときにトリガーされるコールバック。 | ||||||
onPushURLTokenWillExpire | 同時ストリーム配信の取り込み URL のトークンの期限切れが近づいているときにトリガーされるコールバック。このコールバックは、トークンの期限切れの 30 秒前に返されます。 | ||||||
onPushURLTokenExpired | 同時ストリーム配信の取り込み URL のトークンの期限が切れたときにトリガーされるコールバック。 | ||||||
onSendSeiMessage | SEI メッセージが送信されたときにトリガーされるコールバック。 | ||||||
AlivcLivePushBGMListener
メソッド | 説明 | ||||||
onCompleted | 再生の終了時にトリガーされるコールバック。 | ||||||
onDownloadTimeout | プレーヤーがタイムアウトしたときにトリガーされるコールバック。プレーヤーは再接続され、以前の再生位置にシークします。 | ||||||
onOpenFailed | ストリームが無効な場合にトリガーされるコールバック。これは、ストリームにアクセスできないことを示します。 | ||||||
onPaused | 再生が一時停止されたときにトリガーされるコールバック。 | ||||||
onProgress | 再生の進捗状況が更新されたときにトリガーされるコールバック。 | ||||||
onResumed | 再生が再開されたときにトリガーされるコールバック。 | ||||||
onStarted | 再生の開始時にトリガーされるコールバック。 | ||||||
onStoped | 再生の停止時にトリガーされるコールバック。 | ||||||
AlivcLivePusherCustomFilterDelegate
メソッド | 説明 | ||||||
onCreate | 外部フィルターの作成時にトリガーされるコールバック。 | ||||||
onProcess:texture:textureWidth:textureHeight:extra | テクスチャが外部フィルターによって処理されたときにトリガーされるコールバック。デフォルトでは、インタラクティブモードでは CVPixelBuffer データが返されます。テクスチャを返すには、enableLocalVideoTexture を YES に設定します。 | ||||||
onProcessVideoSampleBuffer:sampleBuffer | 返されるデータ。デフォルトでは、インタラクティブモードでは CVPixelBuffer データが返されます。 | ||||||
onDestory | 外部フィルターの破棄時にトリガーされるコールバック。 | ||||||
AlivcLivePlayInfoListener
メソッド | 説明 | ||||||
onError | エラーが発生したときにトリガーされるコールバック。 | ||||||
onFirstVideoFrameDrawn | ビデオの再生開始時にトリガーされるコールバック。 | ||||||
onPlayStarted | 再生の開始時にトリガーされるコールバック。 | ||||||
onPlayStoped | 再生の終了時にトリガーされるコールバック。 | ||||||
onNetworkQualityChanged | ネットワーク品質が変化したときにトリガーされるコールバック。 | ||||||
onPlayerStatistics | 再生統計のコールバック。 | ||||||
onReceiveSeiMessage | SEI メッセージを受信したときにトリガーされるコールバック。 | ||||||
onPlayoutVolumeUpdate | プレーヤーの音量と人間の声のコールバック。 | ||||||