このトピックでは、Android 向け ApsaraVideo Real-time Communication（ARTC）SDK が提供する AliRtcEngine クラスのメソッドについて説明します。
メソッドの一覧
基本的なメソッド
メソッド | 説明 |
AliRtcEngine インスタンスを作成します。このメソッドはメインスレッドで呼び出す必要があります。プライマリインスタンスは 1 つのみ許可されます。 | |
AliRtcEngine インスタンスを作成します。このメソッドはメインスレッドで呼び出す必要があります。プライマリインスタンスは 1 つのみ許可されます。 | |
AliRtcEngine インスタンスを破棄します。 | |
HTML5 互換モードを有効にするかどうかを指定します。 | |
HTML5 互換モードが有効になっているかどうかを照会します。 | |
ローカルユーザーのコールバックイベントをリッスンするリスナーを設定します。 | |
リモートユーザーのコールバックイベントをリッスンするリスナーを設定します。 |
チャンネル関連メソッド
メソッド | 説明 |
チャンネルモードを設定します。 | |
オーディオプロファイルを設定します。 | |
音声のみモードが有効になっているかどうかを照会します。 | |
音声のみモードまたは音声ビデオモードを有効にします。 | |
チャンネルに参加します。 | |
チャンネルに参加します。 | |
チャンネルに参加します。 | |
チャンネルから退出します。 | |
チャンネルに参加しているかどうかを確認します。 | |
ユーザー ロールを指定します。 | |
ユーザー ロールを照会します。 | |
認証情報を更新します。 | |
認証情報を更新します。 |
公開およびサブスクリプション関連のメソッド
メソッド | 説明 |
オーディオトラックを公開するかどうかを指定します。デフォルトでは、オーディオトラックは公開されます。 | |
オーディオトラックが公開されているかどうかを照会します。 | |
リモートユーザーのオーディオトラックをサブスクライブするかどうかを指定します。デフォルトでは、すべてのリモートオーディオトラックがサブスクライブされます。ユーザーがチャンネルに参加する前に、このメソッドを呼び出すことをお勧めします。 | |
すべてのリモートユーザーのオーディオトラックのサブスクライブを開始または停止します。 | |
特定のリモートユーザーのオーディオトラックのサブスクライブを開始または停止します。 | |
ビデオトラックを公開するかどうかを指定します。 | |
ビデオトラックが公開されているかどうかを照会します。 | |
リモートユーザーのビデオトラックをサブスクライブするかどうかを指定します。デフォルトでは、すべてのリモートビデオトラックがサブスクライブされます。ユーザーがチャンネルに参加する前に、このメソッドを呼び出すことをお勧めします。 | |
すべてのリモートユーザーのビデオトラックのサブスクライブを開始または停止します。 | |
特定のリモートユーザーのメディアストリームのサブスクライブを開始または停止します。オーディオトラックとビデオトラックの両方が利用可能で、管理する必要がある場合は、このメソッドを呼び出すことをお勧めします。 | |
チャンネルをまたいで特定のリモートユーザーのメディアストリームのサブスクライブを開始または停止します。 |
オーディオデバイス管理関連のメソッド
メソッド | 説明 |
ローカルオーディオをミュートするかどうかを指定します。 | |
特定のリモートユーザーのオーディオトラックの再生を停止するかどうかを指定します。 | |
すべてのリモートユーザーのオーディオトラックの再生を停止するかどうかを指定します。 | |
オーディオ収集を開始します。 | |
オーディオ収集を開始します。 | |
オーディオ収集を停止します。 | |
ヘッドセットまたはスピーカーをオーディオ出力デバイスとして設定します。 | |
現在のオーディオ出力デバイスがヘッドセットかスピーカーかを照会します。 | |
音量検出を有効にします。 | |
インイヤーモニタリングを有効にします。 |
音声変更と残響に関連するメソッド
メソッド | 説明 |
音声変更モードを設定します。 | |
オーディオ ピッチを設定します。 | |
残響モードを設定します。 | |
残響モードのパラメーターを設定します。 |
カスタム音声入力関連のメソッド
メソッド | 説明 |
外部音声トラックを追加します。 | |
外部音声データを取り込みます。 | |
アップストリーミング用の外部音声のボリュームを設定します。 | |
アップストリーミング用の外部音声のボリュームを照会します。 | |
外部音声の再生ボリュームを設定します。 | |
外部音声の再生ボリュームを照会します。 |
効果音関連のメソッド
メソッド | 説明 |
効果音をプリロードします。 | |
プリロードされた効果音を削除します。 | |
効果音の再生を開始します。 | |
効果音の再生を停止します。 | |
すべての効果音の再生を停止します。 | |
効果音の再生を一時停止します。 | |
すべての効果音の再生を一時停止します。 | |
効果音の再生を再開します。 | |
すべての効果音の再生を再開します。 | |
アップストリーミング用の効果音の音量を設定します。 | |
アップストリーミング用の効果音の音量を照会します。 | |
アップストリーミング用のすべての効果音の音量を設定します。 | |
ローカル再生用の効果音の音量を設定します。 | |
ローカル再生用の効果音の音量を照会します。 | |
ローカル再生用のすべての効果音の音量を設定します。 |
ビデオデバイス管理に関連するメソッド
メソッド | 説明 |
SurfaceView レンダリングビューを作成します。 | |
ローカルプレビューのレンダリングビューと描画パラメーターを設定します。 | |
カメラの収集プリファレンスを設定します。 | |
ローカルビデオの収集を無効化または再度有効化します。 | |
ローカルビデオトラックの公開を停止するかどうかを指定します。 | |
リモートユーザーのビデオトラックのレンダリングビューと描画パラメーターを設定します。 | |
カメラがオンになっているかどうかを照会します。 | |
ビデオエンコーディングのプロパティを設定します。 | |
ビデオデコーディングのプロパティを設定します。 | |
前面カメラと背面カメラを切り替えます。デフォルトでは、前面カメラが使用されます。 | |
現在のカメラタイプを照会します。 | |
ローカルプレビューを開始します。 | |
ローカルプレビューを停止します。 |
カスタムビデオ入力関連のメソッド
メソッド | 説明 |
外部ビデオソースを有効にするかどうかを指定します。 | |
外部ビデオデータをインポートします。 |
画面共有関連のメソッド
メソッド | 説明 |
画面共有ストリームの取り込みを開始します。 | |
画面共有と音声ストリームの取り込みを開始します。 説明 このメソッドは廃止予定です。 | |
画面共有を開始します。 説明 このメソッドは廃止予定です。 | |
画面共有ストリームの取り込みを停止します。 | |
共有されている音声ストリームの音量を設定します。 | |
画面共有ストリームが取り込まれているかどうかを照会します。 |
リレーライブストリーミング関連のメソッド
メソッド | 説明 |
リレーライブストリーミングを開始します。 | |
リレーライブストリーミングのパラメーターを更新します。 | |
リレーライブストリーミングを停止します。 | |
リレーライブストリーミングのステータスを照会します。 |
ネットワーク品質テスト関連のメソッド
API | 説明 |
ネットワーク品質テストを開始します。 | |
ネットワーク品質テストを停止します。 |
コールバック
コールバック | 説明 |
ネットワーク接続ステータスが変化したときに呼び出されるコールバックです。このコールバックに注意してください。 | |
ローカルデバイスの例外が発生したときに呼び出されるコールバックです。このコールバックに注意してください。 | |
ユーザー認証の期限切れが近づいたときに呼び出されるコールバックです。このコールバックを受け取ってから 30 秒後に認証の期限が切れます。このコールバックに注意してください。 | |
認証の期限が切れた場合のコールバックです。ユーザーが認証を必要とするメソッドを呼び出すと、サーバーから期限切れ情報が返されます。 | |
チャンネルへの参加結果を返すために呼び出されるコールバックです。 | |
チャンネルへの参加結果を返すために呼び出されるコールバックです。 | |
チャンネルからの退出結果を返すために呼び出されるコールバックです。 | |
リモートユーザーがオフラインになったときに呼び出されるコールバックです。 | |
リモートユーザーがオンラインになったときに呼び出されるコールバックです。 | |
リモートユーザーのストリームが変化したときに呼び出されるコールバックです。 | |
ユーザーがチャンネルから強制的に退出させられたときに呼び出されるコールバックです。 | |
音声トラックのアップストリーミングのステータスが変化したときに呼び出されるコールバックです。 | |
音声トラックのストリームフェッチングのステータスが変化したときに呼び出されるコールバックです。 | |
リモートユーザーが音声トラックをミュートにしたときに呼び出されるコールバックです。 | |
オーディオデバイスの割り込みが開始されたときに呼び出されるコールバックです。 | |
オーディオデバイスの割り込みが終了したときに呼び出されるコールバックです。 | |
ビデオトラックのアップストリーミングのステータスが変化したときに呼び出されるコールバックです。 | |
ビデオトラックのサブスクリプションステータスが変化したときに呼び出されるコールバックです。 | |
リモートユーザーが黒いフレームを送信したときに呼び出されるコールバックです。 | |
リモートユーザーがカメラトラックのデータ収集を無効にしたときに呼び出されるコールバックです。 | |
リモートユーザーがアプリをバックグラウンドに切り替えたときに呼び出されるコールバックです。 | |
リモートユーザーがアプリをフォアグラウンドに戻したときに呼び出されるコールバックです。 | |
リアルタイム統計情報のコールバックです。このコールバックは 2 秒ごとに呼び出されます。 | |
効果音のローカル再生が終了したときに呼び出されるコールバックです。 | |
音量に関する情報を返すために呼び出されるコールバックです。 | |
アクティブなユーザーが話していることが検出されたときに呼び出されるコールバックです。 | |
リレーライブストリーミングのステータスが変化したときに呼び出されるコールバックです。 | |
リレーライブストリーミングタスクのステータスが変化したときに呼び出されるコールバックです。 | |
ネットワーク品質が変化したときに呼び出されるコールバックです。 | |
ネットワーク品質テスト開始後、約 3 秒後に呼び出されるコールバックです。 | |
ネットワーク品質テスト開始後、約 30 秒後にテスト結果を提供するために呼び出されるコールバックです。 |
その他のメソッド
メソッド | 説明 |
カスタム パラメーターを設定します。 | |
カスタム パラメーターをクエリします。 | |
音量データのエクスポートに使用するオブジェクトを登録します。 | |
音量データのエクスポートに使用するオブジェクトの登録を解除します。 | |
ビデオデータのエクスポートに使用するオブジェクトを登録します。 | |
ビデオデータのエクスポートに使用するオブジェクトの登録を解除します。 | |
ローカル カメラ トラックの OpenGL (Open Graphics Library) テクスチャ データのエクスポートに使用するオブジェクトを登録します。 | |
ローカル カメラ トラックの OpenGL テクスチャ データのエクスポートに使用するオブジェクトの登録を解除します。 | |
SDK のログファイルを保存するパスを設定します。 | |
ログ レベルを設定します。 |
メソッドのリスト
getInstance[1/2]
AliRtcEngineImpl インスタンスを取得します。
public static AliRtcEngineImpl getInstance(Context context);パラメータ
パラメータ | 型 | 説明 |
context | Context | Android アクティビティのコンテキスト。 |
このメソッドはメインスレッドで呼び出す必要があります。プライマリインスタンスは 1 つのみ許可されます。
getInstance[2/2]
AliRtcEngineImpl インスタンスを取得します。
public static AliRtcEngineImpl getInstance(Context context, String extras);パラメーター
パラメーター | 型 | 説明 |
context | Context | Android アクティビティのコンテキスト。 |
extras | String | Canary リリースで配信される追加パラメーターを指定します。 JSON 文字列を使用して、特別な SDK 機能を構成します。 このパラメーターは空のままにすることができます。 |
このメソッドはメインスレッドで呼び出す必要があります。 プライマリインスタンスは 1 つだけ許可されます。
destroy
AliRtcEngine インスタンスを破棄します。
public abstract void destroy(); // AliRtcEngine インスタンスを破棄します。すべての操作が完了した後に、このメソッドを呼び出します。
setH5CompatibleMode
HTML5 互換モードを有効にするかどうかを指定します。
public static int setH5CompatibleMode(int enable);パラメータ
パラメータ | 型 | 説明 |
enable | int | HTML5 互換モードを有効にするかどうかを指定します。有効な値：
|
AliRtcEngine インスタンスを作成した後は、現在のバージョンの HTML5 互換設定を変更することはできません。 AliRtcEngine インスタンスを作成する前に、このメソッドを呼び出す必要があります。
getH5CompatibleMode
HTML5 互換モードが有効になっているかどうかを照会します。
public static int getH5CompatibleMode(); // HTML5 互換モードが有効になっているかどうかを返します。戻り値の型 | 説明 |
int |
|
setRtcEngineEventListener
ローカルユーザーのコールバックイベントをリッスンするリスナーを設定します。
public abstract void setRtcEngineEventListener(AliRtcEngineEventListener listener); // ローカルユーザーのコールバックイベントをリッスンするリスナーを設定します。パラメーター
パラメーター | 型 | 説明 |
listener | AliRtcEngineEventListener | ローカルユーザーのコールバックイベントをリッスンするリスナーです。 |
setRtcEngineNotify
リモートユーザーのコールバックイベントをリッスンするリスナーを設定します。
public abstract void setRtcEngineNotify(AliRtcEngineNotify listener); // リモートユーザーのコールバックイベントをリッスンするリスナーを設定します。パラメーター
パラメーター | 型 | 説明 |
listener | AliRtcEngineNotify | リモートユーザーのコールバックイベントをリッスンするリスナー。 |
setChannelProfile
チャンネルモードを設定します。
public abstract int setChannelProfile(AliRTCSdkChannelProfile channelProfile);パラメータ
パラメータ | 型 | 説明 |
channelProfile | チャンネルモードです。デフォルト値：AliEngineCommunication。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
このメソッドは、チャンネルに参加する前にのみ呼び出すことができます。チャンネルに参加しているときは、チャンネルのモードを変更することはできません。ただし、チャンネルから退出した後は、チャンネルのモードを変更できます。
setAudioProfile
オーディオプロファイルを 設定 します。
public abstract int setAudioProfile(AliRtcAudioProfile profile, AliRtcAudioScenario scenario);パラメータ
パラメータ | 型 | 説明 |
profile | int | オーディオの 収集 または エンコード モード。デフォルト値：AliEngineBasicQualityMode。詳細については、「AliRtcAudioProfile」をご参照ください。 |
scenario | int | オーディオシナリオのモード。既定値: AliEngineSceneDefaultMode。詳細については、「」をご参照ください。 オーディオ シナリオの モード。デフォルト値：AliEngineSceneDefaultMode。詳細については、「AliRtcAudioScenario」をご参照ください。 |
isAudioOnly
音声のみモードが有効になっているかどうかを照会します。
public abstract boolean isAudioOnly(); // 音声のみモードが有効になっているかどうかを返します。レスポンスの説明
値が true の場合は、音声のみモードが有効になっていることを示します。値が false の場合は、音声ビデオモードが有効になっていることを示します。
setAudioOnlyMode
音声のみモードまたは音声ビデオモードを有効にします。
public abstract int setAudioOnlyMode(boolean audioOnly);パラメータ
パラメータ | タイプ | 説明 |
audioOnly | boolean | 音声のみモードまたは音声ビデオモードを有効にするかどうかを指定します。有効な値：
|
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
joinChannel[1/3]
チャネルに参加します。
public abstract int joinChannel(String token, String channelId, String userId, String userName); // チャネルに参加します。現在のチャネルから別のチャネルに参加する場合、最初に leaveChannel メソッドを呼び出して現在のチャネルから退出する必要があります。チャネルへの参加に失敗した後に再試行する場合、leaveChannel メソッドを呼び出す必要はありません。
パラメーター
パラメーター | 型 | 説明 |
token | String | 単一パラメーター入力の認証情報。 |
channelId | String | 参加するチャネルの ID。この値は、トークンの生成に使用されたチャネル ID と同じである必要があります。 |
userId | String | チャネルに参加するユーザーの ID。この値は、トークンの生成に使用されたユーザー ID と同じである必要があります。 |
userName | String | ユーザーの表示名。ユーザー ID ではありません。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
joinChannel メソッドは非同期です。onJoinChannelResult[1/2] コールバックから、チャネルへの参加に成功したかどうかを確認できます。
joinChannel[2/3]
チャンネルに参加します。
public abstract int joinChannel(AliRtcAuthInfo authInfo, String userName); // チャンネルに参加現在のチャンネルから別のチャンネルに参加する場合は、最初に leaveChannel メソッドを呼び出して、現在のチャンネルから退出する必要があります。チャンネルの参加に失敗した後に再試行する場合は、leaveChannel メソッドを呼び出す必要はありません。
パラメータ
パラメータ | タイプ | 説明 |
authInfo | 認証情報。 | |
userName | String | ユーザーの表示名。 ユーザー ID ではありません。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
joinChannel メソッドは非同期です。 onJoinChannelResult[2/2] コールバックから、チャンネルへの参加に成功したかどうかを確認できます。
joinChannel[3/3]
チャンネルに参加します。
public abstract int joinChannel(String token, AliRTCSdkChannelParam channelParam); // チャンネルに参加現在のチャンネルから別のチャンネルに参加する場合は、最初に leaveChannel メソッドを呼び出して現在のチャンネルから退出する必要があります。チャンネルへの参加に失敗した後に再試行する場合、leaveChannel メソッドを呼び出す必要はありません。
パラメーター
パラメーター | 型 | 説明 |
token | String | 認証情報。 |
channelParam | AliRTCSdkChannelParam | チャンネル参加のためのパラメーター。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
joinChannel メソッドは非同期です。 onJoinChannelResult[2/2] コールバックから、チャンネルへの参加に成功したかどうかを確認できます。
leaveChannel
チャンネルから退出します。
public abstract int leaveChannel();レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
チャンネルに参加していないときに leaveChannel メソッドを呼び出した場合、AliRtcEngine インスタンスは影響を受けません。ただし、チャンネル内の他のユーザーに通知するためのメッセージが生成されます。
isInCall
チャンネルに参加しているかどうかを確認します。
public abstract boolean isInCall(); // チャンネルに参加しているかどうかを確認します。レスポンスの説明
値が true の場合は、チャンネルに参加しています。値が false の場合は、チャンネルに参加していません。
setClientRole
ユーザー ロールを指定します。
public abstract int setClientRole(AliRTCSdkClientRole clientRole); // ユーザーロールを設定します。パラメーター
パラメーター | 型 | 説明 |
clientRole | ユーザー ロール。デフォルト値は AliRTCSdkLive で、視聴者を表します。このパラメーターは、非通信モードでのみ有効です。 |
getCurrentClientRole
ユーザー ロールをクエリします。
public abstract AliRTCSdkClientRole getCurrentClientRole(); // ユーザーロールを取得します。レスポンスの説明
ユーザー ロールが返されます。
refreshAuthInfo[1/2]
認証情報をリフレッシュします。
public abstract int refreshAuthInfo(String token); // 認証情報をリフレッシュします。パラメーター
パラメーター | 型 | 説明 |
token | String | 単一パラメーター入力の認証情報です。 |
レスポンスの説明
値 0 は呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
refreshAuthInfo[2/2]
認証情報を更新します。
public abstract int refreshAuthInfo(AliRtcAuthInfo authInfo); // 認証情報を更新します。パラメータ
パラメータ | 型 | 説明 |
authInfo | 認証情報。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
publishLocalAudioStream
オーディオトラックを公開するかどうかを指定します。
public abstract int publishLocalAudioStream(boolean enable); // オーディオトラックを公開するかどうかを指定します。パラメータ
パラメータ | 型 | 説明 |
enable | boolean | オーディオトラックを公開するかどうかを指定します。有効な値：
|
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
isLocalAudioStreamPublished
オーディオトラックが公開されているかどうかを照会します。
public abstract boolean isLocalAudioStreamPublished();レスポンスの説明
値が true の場合は、オーディオトラックが公開されていることを示します。値が false の場合は、オーディオトラックが公開されていないことを示します。
setDefaultSubscribeAllRemoteAudioStreams
リモートユーザーのオーディオトラックをサブスクライブするかどうかを指定します。
public abstract int setDefaultSubscribeAllRemoteAudioStreams(boolean sub);パラメータ
パラメータ | 型 | 説明 |
sub | boolean | リモートユーザーのオーディオトラックをサブスクライブするかどうかを指定します。有効な値：
|
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
subscribeAllRemoteAudioStreams
すべてのリモートユーザーのオーディオトラックをサブスクライブする、またはサブスクライブを停止します。
public abstract int subscribeAllRemoteAudioStreams(boolean sub);パラメータ
パラメータ | 型 | 説明 |
sub | boolean | すべてのリモートユーザーのオーディオトラックをサブスクライブするかどうかを指定します。有効な値：
|
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
subscribeRemoteAudioStream
特定のリモートユーザーの音声トラックのサブスクライブを開始または停止します。
public abstract int subscribeRemoteAudioStream(String uid, boolean sub);パラメータ
パラメータ | 型 | 説明 |
uid | String | リモートユーザーの ID です。 |
sub | boolean | リモートユーザーの音声トラックをサブスクライブするかどうかを指定します。有効な値：
|
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
publishLocalVideoStream
ビデオトラックを公開するかどうかを指定します。
public abstract int publishLocalVideoStream(boolean enable); // ビデオトラックを公開するかどうかを指定します。パラメータ
パラメータ | 型 | 説明 |
enable | boolean | ビデオトラックを公開するかどうかを指定します。有効な値：
|
isLocalVideoStreamPublished
ビデオトラックが公開されているかどうかを照会します。
public abstract boolean isLocalVideoStreamPublished(); // ローカルのビデオストリームが公開されているかどうかを返します。レスポンスの説明
値が true の場合は、ビデオトラックが公開されていることを示します。 値が false の場合は、ビデオトラックが公開されていないことを示します。
setDefaultSubscribeAllRemoteVideoStreams
リモートユーザーのビデオトラックをサブスクライブするかどうかを指定します。
public abstract int setDefaultSubscribeAllRemoteVideoStreams(boolean sub); // リモートユーザーのビデオトラックをサブスクライブするかどうかを設定します。パラメータ
パラメータ | 型 | 説明 |
sub | boolean | リモートユーザーのビデオトラックをサブスクライブするかどうかを指定します。有効な値：
|
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
subscribeAllRemoteVideoStreams
すべてのリモートユーザーのビデオトラックをサブスクライブする、またはサブスクライブを停止します。
public abstract int subscribeAllRemoteVideoStreams(boolean sub);パラメータ
パラメータ | 型 | 説明 |
sub | boolean | すべてのリモートユーザーのビデオトラックをサブスクライブするかどうかを指定します。有効な値：
|
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
subscribeRemoteMediaStream
特定のリモートユーザーのメディアストリームのサブスクライブを開始または停止します。
public abstract int subscribeRemoteMediaStream(String uid, AliRtcVideoTrack videoTrack, boolean subVideo, boolean subAudio);パラメータ
パラメータ | 型 | 説明 |
uid | String | リモートユーザーの ID です。 |
videoTrack | ビデオトラックのソースです。 | |
subVideo | boolean | リモートユーザーのビデオトラックをサブスクライブするかどうかを指定します。有効な値：
|
subAudio | boolean | リモートユーザーのオーディオトラックをサブスクライブするかどうかを指定します。有効な値：
|
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
subscribeRemoteDestChannelStream
チャンネルを跨いで、特定のリモートユーザーのメディアストリームのサブスクライブを開始または停止します。
public abstract int subscribeRemoteDestChannelStream(String channelId, String uid, AliRtcVideoTrack track, boolean sub_audio, boolean sub);パラメーター
パラメーター | 型 | 説明 |
channelId | String | リモートチャンネルの ID です。 |
uid | String | リモートユーザーの ID です。 |
track | サブスクライブするビデオトラックです。 | |
sub_audio | boolean | リモートユーザーの音声トラックをサブスクライブするかどうかを指定します。有効な値：
|
sub | boolean | チャンネルを跨いでリモートユーザーのストリームをサブスクライブするかどうかを指定します。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
muteLocalMic
ローカル音声のミュートを設定します。
public abstract int muteLocalMic(boolean mute, AliRtcMuteLocalAudioMode mode); // ローカル音声のミュートを設定パラメーター
パラメーター | 型 | 説明 |
mute | boolean | ローカル音声をミュートするかどうかを指定します。有効な値：
|
mode | ミュートモード。デフォルトでは、マイクミュートモードが使用されます。 |
レスポンスの説明
0 は呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。 mute パラメーターを true に設定すると、ローカル音声はミュートされますが、収集とエンコードのプロセスは影響を受けません。
muteRemoteAudioPlaying
特定のリモートユーザーのオーディオトラックの再生を停止するかどうかを指定します。
public abstract int muteRemoteAudioPlaying(String uid, boolean mute);パラメータ
パラメータ | 型 | 説明 |
uid | String | リモートユーザーの ID です。 |
mute | boolean | リモートユーザーのオーディオトラックの再生を停止するかどうかを指定します。有効な値：
|
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
muteAllRemoteAudioPlaying
すべてのリモートユーザーのオーディオトラックの再生を停止するかどうかを指定します。
public abstract int muteAllRemoteAudioPlaying(boolean mute); // すべてのリモートユーザーのオーディオトラックの再生を停止するかどうかを指定します。パラメータ
パラメータ | 型 | 説明 |
mute | boolean | すべてのリモートユーザーのオーディオトラックの再生を停止するかどうかを指定します。有効な値：
|
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
startAudioCapture[1/2]
音声収集を開始します。
public abstract int startAudioCapture();レスポンスの説明
値 0 は呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
startAudioCapture[2/2]
音声収集を開始します。
public abstract int startAudioCapture(boolean keepAlive); // 音声収集を開始するパラメータ
パラメータ | 型 | 説明 |
keepAlive | boolean | チャンネル退出後の音声収集デバイスの状態。有効な値：
|
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
stopAudioCapture
音声の収集を停止します。
public abstract int stopAudioCapture(); // 音声の収集を停止します。レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
enableSpeakerphone
ヘッドセットまたはスピーカーをオーディオ出力デバイスとして設定します。
public abstract int enableSpeakerphone(boolean enable); // ヘッドセットまたはスピーカーをオーディオ出力デバイスとして設定します。パラメータ
パラメータ | 型 | 説明 |
enable | boolean | ヘッドセットまたはスピーカーをオーディオ出力デバイスとして設定するかどうかを指定します。有効な値：
|
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
isSpeakerOn
現在のオーディオ出力デバイスがヘッドセットかスピーカーかを照会します。
public abstract boolean isSpeakerOn(); // 現在のオーディオ出力デバイスがスピーカーかどうかを返します。レスポンスの説明
値が true の場合は、現在のオーディオ出力デバイスがスピーカーであることを示します。値が false の場合は、現在のオーディオ出力デバイスがヘッドセットであることを示します。
enableAudioVolumeIndication
音量コールバックの間隔とスムージング係数を設定します。
public abstract int enableAudioVolumeIndication(int interval, int smooth, int reportVad);パラメーター
パラメーター | 型 | 説明 |
interval | int | 音量検出を実行する間隔です。
|
smooth | int | スムージング係数。値が大きいほど、スムージングの度合いが高くなります。値が小さいほど、スムージングの度合いは低くなりますが、リアルタイム パフォーマンスは向上します。
|
reportVad | int | ローカル音声の検出に使用するスイッチ。有効な値：
|
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
enableEarBack
イヤモニを有効にします。
public abstract int enableEarBack(boolean enable); // イヤモニを有効にするかどうかを指定します。パラメータ
パラメータ | 型 | 説明 |
enable | boolean | イヤモニを有効にするかどうかを指定します。有効な値：
|
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
setAudioEffectVoiceChangerMode
ボイスチェンジモードを設定します。
public abstract int setAudioEffectVoiceChangerMode(AliRtcAudioEffectVoiceChangerMode mode);パラメータ
パラメータ | 型 | 説明 |
mode | ボイスチェンジモード。デフォルト値は AliRtcSdk_AudioEffect_Voice_Changer_OFF で、ボイスチェンジなしを示します。 |
レスポンスの説明
値 0 は呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
setAudioEffectPitchValue
オーディオピッチを設定します。
public abstract int setAudioEffectPitchValue(double value); // オーディオピッチ値を設定パラメータ
パラメータ | 型 | 説明 |
value | double | ピッチ値。有効な値： 0.5 ～ 2.0 。デフォルト値は 1.0 で、ピッチが変更されないことを示します。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
setAudioEffectReverbMode
残響モードを設定します。
public abstract int setAudioEffectReverbMode(AliRtcAudioEffectReverbMode mode);パラメータ
パラメータ | 型 | 説明 |
mode | 残響モード。デフォルト値は AliRtcAudioEffectReverb_Off で、残響なしを示します。 |
レスポンスの説明
値 0 は呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
setAudioEffectReverbParamType
残響モードのパラメーターを設定します。
public abstract int setAudioEffectReverbParamType(AliRtcAudioEffectReverbParamType type, float value);パラメーター
パラメーター | 型 | 説明 |
type | 効果音パラメーター。 | |
value | float | 効果音パラメーターの値。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
addExternalAudioStream
外部音声トラックを追加します。
public abstract int addExternalAudioStream(AliRtcExternalAudioStreamConfig config);パラメータ
パラメータ | 型 | 説明 |
config | AliRtcExternalAudioStreamConfig | 外部音声トラックの構成。 |
レスポンスの説明
0 より大きい値は、呼び出しが成功したことを示し、外部音声トラックの ID です。 0 以下の値は、呼び出しが失敗したことを示します。
pushExternalAudioStreamRawData
外部音声データを読み込みます。
public abstract int pushExternalAudioStreamRawData(int streamId, AliRtcAudioFrame rawData);パラメータ
パラメータ | 型 | 説明 |
streamId | int | 外部音声トラックの ID です。 |
rawData | AliRtcAudioFrame | 音声データです。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
setExternalAudioStreamPublishVolume
アップストリーミング用の外部音声のボリュームを設定します。
public abstract int setExternalAudioStreamPublishVolume(int streamId, int publishVolume);パラメータ
パラメータ | 型 | 説明 |
streamId | int | 外部音声トラックの ID です。 |
publishVolume | int | アップストリーミング用の外部音声のボリュームです。有効な値：0 ～ 100 です。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
getExternalAudioStreamPublishVolume
アップストリーミング用の外部音声のボリュームを照会します。
public abstract int getExternalAudioStreamPublishVolume(int streamId);パラメータ
パラメータ | 型 | 説明 |
streamId | int | 外部音声トラックの ID です。 |
レスポンスの説明
ボリュームの有効値は 0 ～ 100 です。 0 未満の値は、呼び出しが失敗したことを示します。
setExternalAudioStreamPlayoutVolume
外部オーディオの再生ボリュームを設定します。
public abstract int setExternalAudioStreamPlayoutVolume(int streamId, int playoutVolume); // 外部オーディオストリームの再生音量を設定します。パラメーター
パラメータ | タイプ | 説明 |
streamId | int | 外部オーディオトラックの ID です。 |
playoutVolume | int | 再生ボリュームです。有効な値：0 ～ 100 です。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
getExternalAudioStreamPlayoutVolume
外部音声の再生ボリュームを照会します。
public abstract int getExternalAudioStreamPlayoutVolume(int streamId);パラメータ
パラメータ | 型 | 説明 |
streamId | int | 外部オーディオトラックの ID です。 |
レスポンスの説明
ボリュームの有効値は 0 ～ 100 です。0 未満の値は、呼び出しが失敗したことを示します。
preloadAudioEffect
効果音をプリロードします。
public abstract int preloadAudioEffect(int soundId, String filePath);パラメータ
パラメータ | 型 | 説明 |
soundId | int | ユーザーが効果音に割り当てた ID です。 |
filePath | String | 効果音のパスです。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
unloadAudioEffect
プリロードされた効果音を削除します。
public abstract int unloadAudioEffect(int soundId); // ユーザーが効果音に割り当てた IDパラメータ
パラメータ | 型 | 説明 |
soundId | int | ユーザーが効果音に割り当てた ID です。 |
レスポンスの説明
値 0 は呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
playAudioEffect
効果音の再生を開始します。
public abstract int playAudioEffect(int soundId, String filePath, int cycles, boolean publish);パラメータ
パラメータ | 型 | 説明 |
soundId | int | ユーザーが効果音に割り当てた ID です。 |
filePath | String | 効果音のパスです。 |
cycles | int | 再生ループの回数です。 -1 の値は、無限の再生ループを指定します。 |
publish | boolean | リモートユーザーに効果音を配信するかどうかを指定します。有効な値：
|
レスポンスの説明
0 の値は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
stopAudioEffect
効果音を停止します。
public abstract int stopAudioEffect(int soundId);パラメータ
パラメータ | 型 | 説明 |
soundId | int | ユーザーが効果音に割り当てた ID です。 |
レスポンスの説明
値 0 は呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
stopAllAudioEffects
すべての効果音の再生を停止します。
public abstract int stopAllAudioEffects(); // すべての効果音の再生を停止します。レスポンスの説明
値 0 は呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
setAudioEffectPublishVolume
アップストリーミング用の効果音の音量を設定します。
public abstract int setAudioEffectPublishVolume(int soundId, int volume);パラメータ
パラメータ | 型 | 説明 |
soundId | int | ユーザーが効果音に割り当てた ID です。 |
volume | int | ミキシングされたオーディオの音量です。有効な値：0 ～ 100。デフォルト値：50。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
getAudioEffectPublishVolume
アップストリーミング用の効果音の音量を照会します。
public abstract int getAudioEffectPublishVolume(int soundId); // ユーザーが効果音に割り当てた ID を取得します。パラメータ
パラメータ | 型 | 説明 |
soundId | int | ユーザーが効果音に割り当てた ID です。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
setAudioEffectPlayoutVolume
ローカル再生用の効果音の音量を設定します。
public abstract int setAudioEffectPlayoutVolume(int soundId, int volume);パラメータ
パラメータ | 型 | 説明 |
soundId | int | ユーザーが効果音に割り当てた ID です。 |
volume | int | ミキシングされたオーディオの音量です。有効な値：0 ～ 100。デフォルト値：50。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
getAudioEffectPlayoutVolume
ローカル再生用の効果音の音量を照会します。このメソッドは Android と iOS に適用されます。
public abstract int getAudioEffectPlayoutVolume(int soundId); // ユーザーが効果音に割り当てた IDパラメータ
パラメータ | 型 | 説明 |
soundId | int | ユーザーが効果音に割り当てた ID です。 |
レスポンスの説明
値 0 は呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
setAllAudioEffectsPublishVolume
アップストリーミング用のすべての効果音の音量を設定します。
public abstract int setAllAudioEffectsPublishVolume(int volume);パラメータ
パラメータ | 型 | 説明 |
volume | int | ミキシングされたオーディオの音量。有効な値：0～100。デフォルト値：50。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
setAllAudioEffectsPlayoutVolume
ローカル再生のすべての効果音の音量を設定します。このメソッドは、Android および iOS に適用されます。
public abstract int setAllAudioEffectsPlayoutVolume(int volume); // ローカル再生のすべての効果音の音量を設定します。パラメータ
パラメータ | 型 | 説明 |
volume | int | ミキシングされたオーディオの音量。有効な値：0～100。デフォルト値：50。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
pauseAudioEffect
効果音を一時停止します。
public abstract int pauseAudioEffect(int soundId);パラメータ
パラメータ | 型 | 説明 |
soundId | int | ユーザーが効果音に割り当てた ID です。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
pauseAllAudioEffects
すべての効果音の再生を一時停止します。
public abstract int pauseAllAudioEffects(); // すべてのオーディオエフェクトを一時停止します。レスポンスの説明
値 0 は、呼び出しが成功したことを示す。 0 以外の値は、呼び出しが失敗したことを示します。
resumeAudioEffect
効果音の再生を再開します。
public abstract int resumeAudioEffect(int soundId); // 効果音の再生を再開するパラメータ
パラメータ | 型 | 説明 |
soundId | int | ユーザーが効果音に割り当てた ID です。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
resumeAllAudioEffects
すべての効果音の再生を再開します。
public abstract int resumeAllAudioEffects(); // すべての効果音の再生を再開します。レスポンスの説明
値 0 は呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
createRenderSurfaceView
SurfaceView レンダリングビューを作成します。
public abstract SophonSurfaceView createRenderSurfaceView(Context context);パラメーター
パラメーター | 型 | 説明 |
context | Context | Android アクティビティのコンテキスト。 |
基本メソッド
ローカルプレビューのレンダリングビューと描画パラメーターを設定します。
public abstract int setLocalViewConfig(AliRtcVideoCanvas viewConfig, AliRtcVideoTrack track); // ローカルビューの設定を適用します。チャンネルに参加する前と後でビューを切り替えることができます。AliRtcVideoCanvas の view パラメーターが空の場合、レンダリングは停止します。再生中にレンダリングモードをリセットする必要がある場合は、AliRtcVideoCanvas の renderMode パラメーターの値のみを変更し、他のパラメーターの値は変更しないでください。再生中にミラーリングモードをリセットする必要がある場合は、AliRtcVideoCanvas の mirrorMode パラメーターの値のみを変更し、他のパラメーターの値は変更しないでください。
パラメーター
パラメーター | 種類 | 説明 |
viewConfig | レンダリングビューとレンダリングモードを含む、レンダリング構成です。 | |
トラック | ビデオトラックのソースです。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
setCameraCapturerConfiguration
カメラのコレクション プリファレンスを設定します。
public abstract int setCameraCapturerConfiguration(AliEngineCameraCapturerConfiguration cameraCapturerConfiguration);パラメータ
パラメータ | 型 | 説明 |
cameraCapturerConfiguration | カメラのコレクション プリファレンス。デフォルト値：
「-1」は SDK のデフォルト設定を使用することを示します。 |
レスポンスの説明
値 0 は呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
enableLocalVideo
ローカルビデオの収集を無効化または再度有効化します。
public abstract int enableLocalVideo(boolean enable);パラメータ
パラメータ | 型 | 説明 |
enable | boolean | ローカルビデオの収集を無効にするか、再度有効にするかを指定します。有効な値：
|
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
muteLocalCamera
ローカルビデオトラックの公開を停止するかどうかを指定します。
public abstract int muteLocalCamera(boolean mute, AliRtcVideoTrack track); // ローカルビデオトラックの公開を停止するかどうかを指定します。パラメータ
パラメータ | 型 | 説明 |
mute | boolean | ローカルビデオトラックの公開を停止するかどうかを指定します。有効な値：
|
track | 公開ステータスを変更するビデオトラックのソース。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。
このメソッドは、指定されたビデオトラックで黒いフレームを送信するかどうかを制御するために使用されます。コレクションとデータ送信プロセスは影響を受けません。ビデオコレクションを無効にする場合は、enableLocalVideo メソッドを呼び出します。ビデオトラックのデータ送信を停止する場合は、publishLocalVideoStream メソッドを呼び出します。
setRemoteViewConfig
リモートユーザーのビデオトラックのレンダリングビューと描画パラメーターを設定します。
public abstract int setRemoteViewConfig(AliVideoCanvas canvas, String uid,AliRtcVideoTrack track);チャンネルに参加する前後にビューを切り替えることができます。AliRtcVideoCanvas のビューパラメーターが空の場合、レンダリングは停止します。再生中にレンダリングモードをリセットする必要がある場合は、AliRtcVideoCanvas の renderMode パラメーターの値のみを変更し、その他のパラメーターの値は変更しないでください。再生中にミラーリングモードをリセットする必要がある場合は、AliRtcVideoCanvas の mirrorMode パラメーターの値のみを変更し、その他のパラメーターの値は変更しないでください。
パラメーター
パラメーター | 型 | 説明 |
canvas | レンダリングビューとレンダリングモードを含む、レンダリング設定。 | |
uid | String | リモートユーザーの ID。 |
track | ビデオトラックのソース。 |
レスポンスの説明
0 は呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
isCameraOn
カメラがオンになっているかどうかを照会します。
public abstract boolean isCameraOn(); // カメラがオンになっているかどうかを返します。レスポンスの説明
値が true の場合は、カメラがオンになっていることを示します。値が false の場合は、カメラがオフになっていることを示します。
setVideoEncoderConfiguration
ビデオエンコーディングのプロパティを設定します。
public abstract void setVideoEncoderConfiguration(AliRtcVideoEncoderConfiguration config);パラメータ
パラメータ | 型 | 説明 |
config | 事前定義されたエンコーディングのプロパティ。エンコーディングのプロパティのデフォルト値：
「-1」は SDK のデフォルト設定を使用することを示します。 |
setVideoDecoderConfiguration
ビデオデコードプロパティを設定します。
public abstract void setVideoDecoderConfiguration(AliRtcVideoDecoderConfiguration config);パラメータ | 型 | 説明 |
config | AliRtcVideoDecoderConfiguration | 事前定義されたデコードプロパティ。デフォルト値：
「-1」は SDK のデフォルト設定を使用することを示します。 |
switchCamera
前面カメラと背面カメラを切り替えます。デフォルトでは、前面カメラが使用されます。
public abstract int switchCamera(); // 前面カメラと背面カメラを切り替えます。レスポンスの説明
値 0 は呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
getCurrentCameraDirection
現在のカメラタイプを照会します。
public abstract AliRTCCameraDirection getCurrentCameraDirection(); // 現在のカメラの方向を取得します。レスポンスの説明
CAMERA_REAR(0) の値は、背面カメラを示します。
CAMERA_FRONT(1) の値は、前面カメラを示します。
CAMERA_INVALID(-1) の値は、呼び出しが無効であることを示します。
このメソッドは、カメラがオンになった後にのみ呼び出すことができます。それ以外の場合、CAMERA_INVALID(-1) が返されます。
startPreview
ローカルプレビューを開始します。
public abstract int startPreview();レスポンスの説明
値 0 は呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
stopPreview
ローカル プレビューを停止します。
public abstract int stopPreview(); // プレビューの停止レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
チャネル関連メソッド
外部ビデオソースを有効にするかどうかを指定します。
public abstract void setExternalVideoSource(boolean enable,boolean useTexture,
AliRtcVideoTrack streamType,AliRtcRenderMode renderMode); // 外部ビデオソースを設定します。パラメーター
パラメーター | 種類 | 説明 |
有効化 | boolean | 外部ビデオ ソースを有効にするかどうかを指定します。有効な値：
|
useTexture | boolean | テクスチャモードを使用するかどうかを指定します。
|
種類 | ビデオトラックのソースです。 | |
レンダーモード | レンダリングモードです。 |
pushExternalVideoFrame
外部ビデオデータをインポートします。
public abstract int pushExternalVideoFrame(AliRtcRawDataFrame aliRawDataFrame,AliRtcVideoTrack streameType);パラメータ
パラメータ | 型 | 説明 |
aliRawDataFrame | ビデオデータ。 | |
streameType | ビデオトラックのソース。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
startPublishLiveStream
リレーライブストリーミングを開始します。
public abstract int startPublishLiveStream(String streamUrl,AliRtcLiveTranscodingParam transcodingParam);パラメーター
パラメーター | 型 | 説明 |
streamUrl | String | アップストリーミング URL。 |
transcodingParam | リレーライブストリーミングのパラメーター。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
updatePublishLiveStream
リレーライブストリーミングのパラメーターを更新します。
public abstract int updatePublishLiveStream(String streamUrl,AliRtcLiveTranscodingParam transcodingParam);パラメーター
パラメーター | 型 | 説明 |
streamUrl | String | アップストリーミング URL。 |
transcodingParam | リレーライブストリーミングのパラメーター。 |
レスポンスの説明
0 は呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
stopPublishLiveStream
リレーライブストリーミングを停止します。
public abstract int stopPublishLiveStream(String streamUrl);パラメータ
パラメータ | 型 | 説明 |
streamUrl | String | アップストリーミング URL です。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
getPublishLiveStreamState
リレーライブストリーミングのステータスを照会します。
public abstract AliRtcEngine.AliRtcLiveTranscodingState getPublishLiveStreamState(String streamUrl); // リレーライブストリーミングの状態を取得しますパラメータ
パラメータ | 型 | 説明 |
streamUrl | String | リレーライブストリーミングのアップストリーミング URL です。 |
レスポンスの説明
リレーライブストリーミングのステータスが返されます。
startNetworkQualityProbeTest
ネットワーク品質テストを開始します。
public abstract int startNetworkQualityProbeTest(AlirtcNetworkQualityProbeConfig config); // ネットワーク品質テストを開始します。パラメータ
パラメータ | 型 | 説明 |
config | AlirtcNetworkQualityProbeConfig | ネットワーク品質テストの構成。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
stopNetworkQualityProbeTest
ネットワーク品質テストを停止します。
public abstract int stopNetworkQualityProbeTest();レスポンスの説明
値 0 は呼び出しが成功したことを示します。 0 以外の値は、呼び出しが失敗したことを示します。
onConnectionStatusChange
ネットワーク接続ステータスが変化したときに呼び出されるコールバックです。このコールバックに注意してください。
public void onConnectionStatusChange(AliRtcEngine.AliRtcConnectionStatus status,
AliRtcEngine.AliRtcConnectionStatusChangeReason reason); // 接続ステータスの変更時に呼び出されます。前提条件
パラメーター | タイプ | 説明 |
status | ネットワーク接続の現在のステータスです。 | |
reason | ネットワーク接続のステータスが変化した理由です。 |
OnLocalDeviceException
ローカルデバイス例外が発生したときに呼び出されるコールバックです。このコールバックに注意してください。
public void OnLocalDeviceException(AliRtcEngine.AliRtcEngineLocalDeviceType deviceType, AliRtcEngine.AliRtcEngineLocalDeviceExceptionType exceptionType, String msg)パラメータ
パラメータ | タイプ | 説明 |
deviceType | AliRtcEngineLocalDeviceType | デバイスタイプ。 |
exceptionType | AliRtcEngineLocalDeviceExceptionType | デバイス例外のタイプ。 |
msg | String | 例外に含まれる情報。 |
onAuthInfoWillExpire
ユーザー認証の有効期限が切れそうになると呼び出されるコールバックです。認証の有効期限は、このコールバックを受信してから 30 秒後に切れます。このコールバックに注意してください。
public void onAuthInfoWillExpire();onAuthInfoExpired
認証情報の期限切れに関するコールバックです。期限切れ情報は、認証が必要なメソッドをユーザーが呼び出したときにサーバーから返されます。
public void onAuthInfoExpired();onJoinChannelResult[1/2]
チャンネル参加の結果を返すために呼び出されるコールバックです。
public void onJoinChannelResult(int result, String channel, int elapsed);パラメータ
パラメータ | 型 | 説明 |
result | int | チャンネル参加リクエストの結果。 0 はリクエストが成功したことを示します。 0 以外の値は、リクエストが失敗した場合に返されるエラーコードを示します。 詳細については、「エラーコード」をご参照ください。 |
channel | String | チャンネルの ID です。 |
elapsed | int | チャンネル参加に要した時間です。単位：ミリ秒。 |
onJoinChannelResult[2/2]
チャンネル参加の結果を返すために呼び出されるコールバックです。
public void onJoinChannelResult(int result, String channel, String userId, int elapsed);パラメータ
パラメータ | 型 | 説明 |
result | int | チャンネル参加リクエストの結果。 0 の値は、リクエストが成功したことを示します。 0 以外の値は、リクエストが失敗した場合に返されるエラーコードを示します。詳細については、「エラーコード」をご参照ください。 |
channel | String | チャンネルの ID です。 |
userId | String | ユーザーの ID です。 |
elapsed | int | チャンネル参加に要した時間です。単位：ミリ秒。 |
onLeaveChannelResult
チャンネル離脱の結果を返すために呼び出されるコールバックです。
このコールバックは、leaveChannel メソッドを呼び出してチャンネルを離脱した後に返されます。チャンネルを離脱した直後に SDK インスタンスを破棄すると、このコールバックは受信されません。
public void onLeaveChannelResult(int result, AliRtcEngine.AliRtcStats stats);パラメータ
パラメータ | 型 | 説明 |
result | int | チャンネル離脱リクエストの結果です。 0 はリクエストが成功したことを示します。 0 以外の値は、リクエストが失敗した場合に返されるエラーコードを示します。 |
stats | チャンネル内のセッションの統計情報です。 |
onRemoteUserOffLineNotify
リモートユーザーがオフラインになったときに呼び出されるコールバックです。
public void onRemoteUserOffLineNotify(String uid, AliRtcUserOfflineReason reason);パラメータ
パラメータ | 型 | 説明 |
uid | String | リモートユーザーの ID です。 |
reason | リモートユーザーがオフラインになった理由です。 |
onRemoteUserOnLineNotify
リモートユーザーがオンラインになるときに呼び出されるコールバック。
public void onRemoteUserOnLineNotify(String uid, int elapsed); // リモートユーザーがオンラインになったことを通知しますKey features:
パラメーター | タイプ | 説明 |
uid | String | リモートユーザーの ID です。 |
elapsed | int | リモートユーザーがチャンネルに参加するのにかかった時間です。単位：ミリ秒。 |
onRemoteTrackAvailableNotify
リモートユーザーのストリームが変更されたときに呼び出されるコールバックです。
public void onRemoteTrackAvailableNotify(String uid, AliRtcAudioTrack audioTrack,
AliRtcVideoTrack videoTrack);パラメータ
パラメータ | 型 | 説明 |
uid | String | リモートユーザーの ID です。 |
audioTrack | 変更後のオーディオトラックのソースです。 | |
videoTrack | 変更後のビデオトラックのソースです。 |
公開およびサブスクリプション関連メソッド
ユーザーがチャンネルから強制的に退出させられたときに呼び出されるコールバック。
public void onBye(int code); // 切断時の処理パラメーター
前提条件 | 種類 | 説明 |
code | 整数 | ユーザーがチャンネルから強制退出させられた理由。詳細については、「AliRtcOnByeType」をご参照ください。 |
onAudioPublishStateChanged
音声トラックのアップストリーミングのステータスが変化したときに呼び出されるコールバックです。
public void onAudioPublishStateChanged(AliRtcEngine.AliRtcPublishState oldState ,
AliRtcEngine.AliRtcPublishState newState,
int elapseSinceLastState, String channel);パラメータ
パラメータ | 型 | 説明 |
oldState | 音声トラックのアップストリーミングの以前のステータス。 | |
newState | 音声トラックのアップストリーミングの現在のステータス。 | |
elapseSinceLastState | int | 変更にかかった時間。単位：ミリ秒。 |
channel | String | チャンネルの ID。 |
onAudioSubscribeStateChanged
音声トラックのサブスクリプション ステータスが変化したときに呼び出されるコールバックです。
public void onAudioSubscribeStateChanged(String uid,
AliRtcEngine.AliRtcSubscribeState oldState,
AliRtcEngine.AliRtcSubscribeState newState,
int elapseSinceLastState, String channel);パラメータ
パラメータ | 型 | 説明 |
uid | String | リモートユーザーの ID です。 |
oldState | 以前のサブスクリプション ステータスです。 | |
newState | 現在のサブスクリプション ステータスです。 | |
elapseSinceLastState | int | 変更にかかった時間です。単位：ミリ秒。 |
channel | String | チャンネルの ID です。 |
onUserAudioMuted
ユーザーが音声トラックをミュートしたときに呼び出されるコールバックです。
public void onUserAudioMuted(String uid ,boolean isMute);パラメーター
パラメーター | 型 | 説明 |
uid | String | 音声トラックをミュートしたユーザーの ID です。 |
isMute | boolean | 音声トラックがミュートされているかどうかを示します。有効な値：
|
onUserAudioInterruptedBegin
ユーザーのオーディオトラックが中断されたときに呼び出されるコールバックです。
public void onUserAudioInterruptedBegin(String uid); // ユーザーのオーディオトラックが中断されたときに呼び出されるコールバックパラメーター
パラメーター | 型 | 説明 |
uid | String | オーディオトラックが中断されたユーザーの ID です。 |
onUserAudioInterruptedEnded
ユーザーのオーディオトラックの中断が終了したときに呼び出されるコールバックです。
public void onUserAudioInterruptedEnded(String uid); // ユーザーのオーディオトラックの中断が終了したときに呼び出されるコールバックパラメータ
パラメータ | 型 | 説明 |
uid | String | オーディオトラックが中断されたユーザーの ID です。 |
onVideoPublishStateChanged
ビデオトラックのストリーム取り込みのステータスが変更されたときに呼び出されるコールバック。
public void onVideoPublishStateChanged(AliRtcEngine.AliRtcPublishState oldState ,
AliRtcEngine.AliRtcPublishState newState,
int elapseSinceLastState, String channel); // ビデオ公開状態が変更されたときに呼び出されます。パラメーター
パラメーター | タイプ | 説明 |
oldState | 音声トラックのアップストリーミングの以前の状態。 | |
newState | 音声トラックのアップストリーミングの現在の状態。 | |
elapseSinceLastState | int | 変更に経過した時間。単位：ミリ秒。 |
channel | String | チャンネルの ID。 |
onVideoSubscribeStateChanged
ビデオトラックのサブスクリプションステータスが変化したときに呼び出されるコールバックです。
public void onVideoSubscribeStateChanged(String uid,
AliRtcEngine.AliRtcSubscribeState oldState,
AliRtcEngine.AliRtcSubscribeState newState,
int elapseSinceLastState, String channel);パラメータ
パラメータ | タイプ | 説明 |
uid | String | リモートユーザーの ID です。 |
oldState | 以前のサブスクリプションステータスです。 | |
newState | 現在のサブスクリプションステータスです。 | |
elapseSinceLastState | int | 変更にかかった時間です。 |
channel | String | チャンネルの ID です。 |
onUserVideoMuted
リモートユーザーが黒いフレームを送信したときに呼び出されるコールバックです。
public void onUserVideoMuted(String uid, boolean isMute);パラメータ
パラメータ | 型 | 説明 |
uid | String | enableLocalVideo メソッドを呼び出すユーザーの ID です。 |
isMute | boolean | 黒いフレームが送信されるかどうかを示します。有効な値：
|
onUserVideoEnabled
リモートユーザーがカメラトラックのデータ収集を無効にしたときに呼び出されるコールバックです。
public void onUserVideoEnabled(String uid, boolean isMute);パラメータ
パラメータ | 型 | 説明 |
uid | String | リモートユーザーの ID です。 |
isMute | boolean | カメラトラックのデータ収集が有効かどうかを示します。有効な値：
|
onUserWillResignActive
リモートユーザーがアプリをバックグラウンドに切り替えたときに呼び出されるコールバックです。
public void onUserWillResignActive(String uid); // リモートユーザーが非アクティブ状態になる時に呼び出されるコールバックパラメータ
パラメータ | 型 | 説明 |
uid | String | リモートユーザーの ID です。 |
onUserWillBecomeActive
リモートユーザーがアプリをフォアグラウンドに戻したときに呼び出されるコールバックです。
public void onUserWillBecomeActive(String uid); // リモートユーザーがアクティブになる直前に呼び出されます。パラメーター
パラメーター | 型 | 説明 |
uid | String | リモートユーザーの ID です。 |
onAliRtcStats
現在のセッションの統計情報を返すために呼び出されるコールバックです。SDK はこのコールバックを 2 秒ごとにトリガーします。
public void onAliRtcStats(AliRtcEngine.AliRtcStats stats);パラメータ
パラメータ | 型 | 説明 |
stats | セッションの統計情報。 |
onAudioEffectFinished
ローカルで効果音が再生終了したときに呼び出されるコールバックです。
void OnAudioEffectFinished(int soundId); // 効果音の再生が終了したときに呼び出されるコールバックパラメーター
パラメーター | 型 | 説明 |
soundId | int | ユーザーが効果音に割り当てた ID です。 |
onAudioVolume
音声ボリュームに関する情報を返すために呼び出されるコールバックです。
public void onAudioVolume(List<AliRtcEngine.AliRtcAudioVolume> speakers, int totalVolume); // 各ユーザーの音量情報を含む配列と、ミキシング後の音量を受け取るコールバックパラメーター
パラメーター | 型 | 説明 |
speakers | List<AliRtcEngine.AliRtcAudioVolume> | 各ユーザーの音量情報を含む配列。UID、音声ステータス、音量が含まれます。 UID が 0 の場合はローカルユーザーを示します。 |
totalVolume | int | 音声ミキシング後の音量です。有効な値：0 ～ 255。 このコールバックがローカルユーザーに返される場合、このパラメーターの値はローカルユーザーの音声がミキシングされた後の音量を示します。このコールバックがリモートユーザーに返される場合、このパラメーターの値はすべてのスピーカーからの音声がミキシングされた後の音量を示します。 |
onActiveSpeaker
ユーザーが発言したときに呼び出されるコールバックです。
public void OnActiveSpeaker(String uid); // ユーザーが発言したときに呼び出されるコールバックパラメータ
パラメータ | 型 | 説明 |
uid | String | 発言しているユーザーの ID です。 値 0 はローカルユーザーを示します。 複数のユーザーが同時に話している場合、現在の期間で音量が最も大きいユーザーの ID が返されます。 |
オーディオデバイス管理関連メソッド
リレーライブストリーミングのステータスが変化したときに呼び出されるコールバックです。
public void onPublishLiveStreamStateChanged(String streamUrl, AliRtcLiveTranscodingState state, AliEngineLiveTranscodingErrorCode errorCode); // ライブストリーミングの公開状態が変化したときに呼び出されます。パラメーター
パラメーター | 種類 | 説明 |
streamUrl | String | アップストリーミング URL です。 |
この方法では、デプロイ プロセスをより詳細に制御できます。 | リレーライブストリーミングのステータスです。 | |
エラーコード | エラーコードです。 |
onPublishTaskStateChanged
リレー配信タスクのステータスが変化したときに呼び出されるコールバックです。
public void onPublishTaskStateChanged(String streamUrl, AliRtcTrascodingPublishTaskStatus state);パラメータ
パラメータ | 型 | 説明 |
streamUrl | String | アップストリーミング URL です。 |
state | リレー配信タスクのステータスです。 |
onNetworkQualityChanged
ネットワーク品質が変化したときに呼び出されるコールバックです。
public void onNetworkQualityChanged(String uid, AliRtcNetworkQuality upQuality, AliRtcNetworkQuality downQuality);パラメータ
パラメータ | 型 | 説明 |
uid | String | ユーザー ID です。空の値はローカルユーザーを示します。 |
upQuality | 上りネットワークの品質です。 | |
downQuality | 下りネットワークの品質です。 |
onNetworkQualityProbeTest
ネットワーク品質テストの開始から約 3 秒後に呼び出されるコールバックです。
public void onNetworkQualityProbeTest(AliRtcNetworkQuality quality){} // ネットワーク品質テストの開始から約3秒後に呼び出されるコールバックパラメータ
パラメータ | 型 | 説明 |
quality | AliRtcNetworkQuality | ネットワーク品質。 |
onNetworkQualityProbeTestResult
ネットワーク品質テスト開始後、約 30 秒後に呼び出され、テスト結果を提供するコールバックです。
public void onNetworkQualityProbeTestResult(int code, AliRtcEngine.AlirtcNetworkQualityProbeResult result){} // ネットワーク品質テスト結果を提供するために呼び出されるコールバックパラメーター
パラメーター | 型 | 説明 |
code | int | 0 はテストが成功したことを示します。 -1 は、ネットワーク切断のために失敗したことを示します。 |
result | AlirtcNetworkQualityProbeResult | ネットワーク品質。 |
setParameter
カスタム パラメーターを設定します。
public abstract int setParameter(String param); // カスタム パラメーターを設定します。パラメーター
パラメーター | 型 | 説明 |
param | String | カスタム パラメーター。 |
getParameter
カスタム パラメーターをクエリします。
public abstract String getParameter(String param);パラメーター
パラメーター | 型 | 説明 |
param | String | カスタム パラメーター。 |
registerAudioVolumeObserver
ボリューム データをエクスポートするために使用されるオブジェクトを登録します。
public abstract void registerAudioVolumeObserver(AliRtcAudioVolumeObserver observer);パラメーター
パラメーター | 型 | 説明 |
observer | AliRtcAudioVolumeObserver | ボリューム データをエクスポートするために使用されるオブジェクトです。 |
unRegisterAudioVolumeObserver
ボリュームデータのエクスポートに使用するオブジェクトの登録を解除します。
public abstract void unRegisterAudioVolumeObserver();registerVideoSampleObserver
ビデオデータのエクスポートに使用するオブジェクトを登録します。
public abstract void registerVideoSampleObserver(AliVideoObserver observer);パラメータ
パラメータ | 型 | 説明 |
observer | AliRtcVideoObserver | ビデオデータのエクスポートに使用するオブジェクトです。 |
レスポンスの説明
エクスポートされたデータは、AliVideoObserver のコールバックで返されます。
unRegisterVideoSampleObserver
ビデオデータのエクスポートに使用するオブジェクトの登録を解除します。
public abstract void unRegisterVideoSampleObserver();registerLocalVideoTextureObserver
ローカルカメラトラックの OpenGL テクスチャデータをエクスポートするために使用されるオブジェクトを登録します。
public abstract void registerLocalVideoTextureObserver(AliTextureObserver observer);パラメータ
パラメータ | 型 | 説明 |
observer | AliRtcTextureObserver | OpenGL テクスチャデータをエクスポートするために使用されるオブジェクト。 |
レスポンスの説明
エクスポートされたデータは、AliVideoObserver のコールバックで返されます。
unRegisterLocalVideoTextureObserver
ローカルカメラトラックの OpenGL テクスチャデータを出力するために使用されるオブジェクトの登録を解除します。
public abstract void unRegisterLocalVideoTextureObserver();setLogDirPath
SDK のログファイルを保存するパスを設定します。
public static int setLogDirPath(String logDirPath);パラメーター
パラメーター | 型 | 説明 |
logDirPath | String | SDK のログファイルを保存する絶対パス。デフォルトパス：アプリディレクトリ。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。注：ログの損失を避けるため、他のすべてのメソッドを呼び出す前に、このメソッドを呼び出してください。このメソッドを呼び出す前に、logDirPath パラメーターで指定されたパスが存在し、ログファイルをパスに書き込むことができることを確認してください。
setLogLevel
ログレベルを設定します。
public static void setLogLevel(AliRtcLogLevel logLevel);パラメータ
パラメータ | 型 | 説明 |
logLevel | ログレベル。 |
startScreenShare
このメソッドは段階的に廃止される予定です。startScreenShare (new) の使用をお勧めします。
画面共有と音声ストリームの取り込みを開始します。
public abstract int startScreenShare(Intent intent);パラメータ
パラメータ | 説明 |
intent | 画面共有用のアクティビティを起動するための Intent を作成します。外部アクティビティが作成されない場合は、null を渡します。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
startScreenShare
このメソッドは段階的に廃止される予定です。startScreenShare (new) の使用をお勧めします。
画面共有を開始します。
public abstract int startScreenShare(); // 画面共有を開始します。レスポンスの説明
値が 0 の場合は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
startScreenShare
画面共有ストリームの取り込みを開始します。
public abstract int startScreenShare(Intent intent, AliRtcScreenShareMode screenShareMode);パラメータ
パラメータ | 説明 |
intent | 画面共有用のアクティビティを起動するための Intent を作成します。外部アクティビティが作成されない場合は、null を渡します。 |
screenShareMode | 画面共有モード。詳細については、「AliRtcScreenShareMode」をご参照ください。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
stopScreenShare
画面共有と音声ストリームを停止します。
public abstract int stopScreenShare(); // 画面共有を停止します。レスポンスの説明
値 0 は、呼び出しが成功したことを示す。 0 以外の値は、呼び出しが失敗したことを示します。
setAudioShareVolume
共有オーディオストリームの音量を設定します。
public abstract int setAudioShareVolume(int volume); // 共有オーディオストリームの音量を設定します。パラメータ
パラメータ | 説明 |
volume | 音量。有効な値：0～100。デフォルト値：50。 |
レスポンスの説明
値 0 は、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。
isScreenSharePublished
画面共有ストリームが取り込まれているかどうかをクエリします。
public abstract boolean isScreenSharePublished();レスポンスの説明
true: 画面共有ストリームが取り込まれています。
false: 画面共有ストリームは取り込まれていません。