ApsaraVideo Live:AliRtcEngine インターフェイス

マルチパーティ会議に参加します。

public abstract int joinChannel(AliRtcAuthInfo authInfo, String userName);

このメソッドはチャネルに参加します。ARTC はユーザーをチャネルにまとめます。ユーザーはチャネルに参加して初めて、音声・映像ストリームのアップストリーミングまたはサブスクリプションが可能になります。このメソッド、joinChannel[1/3]、および joinChannel[3/3] はすべてチャネルに参加しますが、認証方法と渡されるユーザー情報が異なります。

• joinChannel[1/3] はチャネル参加の単一パラメーターインターフェイスです。チャネルに参加するには、トークン認証 を使用して生成されたトークンを渡します。このインターフェイスは RTC シナリオでのチャネル参加に推奨されます。

• このインターフェイスは複数パラメーターのチャネル参加インターフェイスです。チャネルに参加するには、トークン認証 によって生成された複数パラメーターのチャネル参加トークンと、トークン生成に使用されたユーザー情報を提供する必要があります。

• joinChannel[3/3] は AI リアルタイムインタラクションシナリオ用です。単一パラメーターのトークンを渡し、ユーザー属性 capabilityProfile を設定します。

制限事項

• チャネル参加に成功した後、セッション中に別のチャネルに参加する必要がある場合は、まず <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="e2525ba6a0k3s">leaveChannel</a> を呼び出して現在のチャネルから退出し、<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8c189be470bsp" id="6aefdfedb0op3">onLeaveChannelResult</a> コールバックを AliRtcEngineEventListener から確実に受信した後でなければ、再度チャネルに参加できません。

• このメソッドは一度に 1 つのチャネルにのみ参加できます。

• 異なる App ID を使用するアプリケーションは相互運用できません。

関連コールバック

このメソッドを正常に呼び出した後、以下のコールバックがトリガーされます。

• ローカルクライアントのチャネル参加結果は、AliRtcEngineEventListener の <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#89f5ad2d0bnd1" id="fb41cdcfc6acj">onJoinChannelResult</a> コールバックを通じて通知されます。

• チャネルに正常に参加した後、リモート側は <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7298cad465wnd" id="8e9d69ebe54sr">onRemoteUserOnLineNotify</a> コールバックをトリガーします。

パラメーター

戻り値の説明

値が 0 の場合、成功を示します。その他の値は失敗を示します。

AI リアルタイムインタラクションシナリオ用にチャネルに参加します。

public abstract int joinChannel(String token, AliRTCSdkChannelParam channelParam);

このメソッドはチャネルに参加します。ARTC はユーザーをチャネルにまとめます。ユーザーはチャネルに参加して初めて、音声・映像ストリームのアップストリーミングまたはサブスクリプションが可能になります。このメソッド、joinChannel[1/3]、および joinChannel[2/3] はすべてチャネルに参加しますが、認証方法と渡されるユーザー情報が異なります。

• joinChannel[1/3] は RTC シナリオ用の単一パラメーターのチャネル参加インターフェイスです。トークン認証 を通じて生成されたトークンを渡すことで、チャネルに参加できます。RTC シナリオでのチャネル参加にはこのインターフェイスの使用を推奨します。

• joinChannel[2/3] はマルチ参加者参加用のインターフェイスです。トークン認証 を通じて生成されたトークンを渡す必要があり、トークン生成に使用されたユーザー情報を同時に渡す必要があります。

• このメソッドは AI リアルタイムインタラクションシナリオ用です。単一パラメーターのトークンを渡し、ユーザー属性 capabilityProfile を設定します。AI エージェントとの通信時には、AliCapabilityProfileAiHuman に設定してください。

制限事項

• チャネル参加に成功した後、チャネル内にいる間に別のチャネルに参加する必要がある場合は、まず <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="719d580348a95">leaveChannel</a> を呼び出して現在のチャネルから退出し、<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8c189be470bsp" id="d128acfee2fpd">onLeaveChannelResult</a> コールバックを AliRtcEngineEventListener から確実に受信した後でなければ、再度チャネルに参加できません。

• このメソッドは一度に 1 つのチャネルにのみ参加できます。

• 異なる App ID を使用するアプリケーションは相互運用できません。

• チャネル参加失敗時の再試行では、このメソッドを再度呼び出す必要はありません。

関連コールバック

このメソッドを正常に呼び出した後、以下のコールバックがトリガーされます。

• ローカルクライアントのチャネル参加結果は、AliRtcEngineEventListener の <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#89f5ad2d0bnd1" id="879ae2fa04zjd">onJoinChannelResult</a> コールバックを通じて報告されます。

• チャネルに正常に参加した後、リモートユーザーは <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7298cad465wnd" id="9b5662c5a0nvf">onRemoteUserOnLineNotify</a> コールバックをトリガーします。

パラメーター

戻り値の説明

値が 0 の場合、成功を示します。その他の値は失敗を示します。

チャネルから退出します。このメソッドを呼び出すと、SDK はリアルタイム通信を終了し、現在のチャネルから退出します。

public abstract int leaveChannel();

呼び出しタイミング

• チャネルに参加した後、退出する必要がある場合にこのメソッドを呼び出します。

• チャネルに参加している状態で別のチャネルに参加する必要がある場合は、まずこのメソッドを呼び出します。

関連コールバック

• ローカル側：このメソッドを呼び出した後、<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8c189be470bsp" id="80f5e30245vfn">onLeaveChannelResult</a> コールバックがトリガーされ、チャネル退出の結果が通知されます。

• リモート側：この操作を正常に呼び出した後、リモートユーザーは <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#75c700a2376c1" id="69bf5ff199oda">onRemoteUserOffLineNotify</a> コールバックをトリガーします。

戻り値の説明

値が 0 の場合、成功を示します。その他の値は失敗を示します。

チャネル内にいるかどうかを確認します。

public abstract boolean isInCall();

戻り値の説明

true の値はチャネル内にいることを示し、false の値はチャネル内にいないことを示します。

ユーザーのロールを指定します。

public abstract int setClientRole(AliRTCSdkClientRole clientRole);

このメソッドは、ユーザーのロールをストリーマーまたは視聴者として設定します。

インタラクティブモードで、チャネルに参加する前に：

• ユーザーのロールをストリーマーに設定すると、SDK は自動的にローカルの音声・映像ストリームをアップストリーミングし、他のストリーマーの音声・映像ストリームをフェッチングします。

• ユーザーのロールを視聴者に設定すると、SDK はローカルの音声・映像ストリームをアップストリーミングせず、他のストリーマーの音声・映像ストリームをフェッチングします。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。参加前にロールを設定するか、参加後にロールを切り替えることができます。

制限事項

このメソッドはインタラクティブモードでのみ機能します。つまり、setChannelProfile が AliRTCSdkInteractiveLive に設定されている場合に限ります。

インタラクティブモードでは、チャネルに参加する前にユーザーのロールを明示的に設定することを推奨します。

パラメーター

ユーザーのロールを照会します。

public abstract AliRTCSdkClientRole getCurrentClientRole();

戻り値の説明

現在のユーザーのロールを返します。

認証情報を更新します。

public abstract int refreshAuthInfo(AliRtcAuthInfo authInfo);

このメソッドは認証情報を更新します。トークンは一定期間後に期限切れとなり、SDK がサーバーに接続できなくなります。

呼び出しタイミング

以下の場合：

• <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e9acb46a25uym" id="7e1510bec7s3s">onAuthInfoWillExpire</a> コールバックで認証情報がまもなく期限切れになると報告された場合、サーバー側でトークンを再生成し、このメソッドを呼び出して新しいトークンを渡すことを推奨します。

• トークンを時間内に更新しない場合、<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8fa7e60f9f5qq" id="97664f9e46fhp">onAuthInfoExpired</a> コールバックがトリガーされ、認証が期限切れになったことが通知されます。この時点で、トークンを再生成し、joinChannel を呼び出してチャネルに再参加する必要があります。

パラメーター

戻り値の説明

値が 0 の場合、成功を示します。その他の値は失敗を示します。

認証情報を更新します。

public abstract int refreshAuthInfo(String token);

このメソッドはトークンを更新します。トークンは一定期間後に期限切れとなり、SDK がサーバーに接続できなくなります。

呼び出しタイミング

以下の場合は、サーバーでトークンを再生成し、このメソッドを新しいトークンで呼び出すことを推奨します。

• <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e9acb46a25uym" id="d708af68eevs9">onAuthInfoWillExpire</a> コールバックで認証情報がまもなく期限切れになると報告された場合。

• トークンを時間内に更新しない場合、<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8fa7e60f9f5qq" id="3fd674e985gl8">onAuthInfoExpired</a> がトリガーされ、認証が期限切れになったことが通知されます。この時点で、joinChannel を呼び出してチャネルに再参加する必要があります。

パラメーター

戻り値の説明

値が 0 の場合、成功を示します。その他の値は失敗を示します。

ローカルの映像ストリームの配信を停止または再開できます。

public abstract int publishLocalAudioStream(boolean enable);

このメソッドは、ローカルでキャプチャされた音声ストリームを配信するかどうかを制御します。デフォルトでは、SDK は音声ストリームを配信します。音声ストリームの配信を無効にするには、チャネルに参加する前に publishLocalAudioStream(false) を呼び出します。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。参加前に呼び出すと、デフォルトの構成が変更され、参加時に有効になります。

関連コールバック

ローカル音声ストリームのアップストリーミング結果が変更されると、ローカルクライアントは <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#b7e3bb51c2ga9" id="4ced92c3f5hmj">onAudioPublishStateChanged</a> コールバックをトリガーしてローカル音声ストリームのアップストリーミングステータスが変更されたことを通知し、リモートクライアントは <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7078e15087a0z" id="2b5460d448ga9">onRemoteTrackAvailableNotify</a> コールバックをトリガーしてリモートユーザーの音声・映像ストリームが変更されたことを通知します。

パラメーター

戻り値の説明

値が 0 の場合、成功を示します。その他の値は失敗を示します。

音声ストリームが配信されているかどうかを照会します。

public abstract boolean isLocalAudioStreamPublished();

返品手順

true の値は音声ストリームが配信されていることを示し、false の値は音声ストリームが配信されていないことを示します。

リモートユーザーの音声ストリームをデフォルトでサブスクライブするかどうかを指定します。

public abstract int setDefaultSubscribeAllRemoteAudioStreams(boolean sub);

このメソッドは、システムがリモートユーザーの音声ストリームをデフォルトでサブスクライブするかどうかを構成します。この設定は、チャネルに参加する新しいユーザーの音声ストリームサブスクリプションの動作に影響します。特別な要件がない限り、これを true に設定することを推奨します。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

• 参加前：

  • デフォルトでは、SDK はチャネル参加時にリモートユーザーの音声ストリームをサブスクライブします。この動作を変更するには、参加前にこのメソッドを呼び出します。

• 参加後：

  • デフォルトのサブスクリプションを停止するには、setDefaultSubscribeAllRemoteAudioStreams(false) を呼び出します。その後、新しく参加したユーザーの音声ストリームはサブスクライブされません。

  • デフォルトのサブスクリプションを停止した後、subscribeRemoteAudioStream API を呼び出して指定したユーザーの音声ストリームのサブスクリプションを再開し、複数回呼び出すことで複数のユーザーのサブスクリプションを再開できます。

  • デフォルトのサブスクリプションを停止した後、setDefaultSubscribeAllRemoteAudioStreams(true) を呼び出すと、呼び出し後に参加したユーザーのサブスクリプションのみが再開されます。停止期間中に参加したリモートユーザーのサブスクリプションは再開されません。

パラメーター

戻り値の説明

値が 0 の場合、成功を示します。その他の値は失敗を示します。

特定のリモートユーザーの音声ストリームのフェッチを停止または再開します。

public abstract int subscribeRemoteAudioStream(String uid, boolean sub);

このメソッドは、特定のリモートユーザーの音声ストリームのサブスクリプションを停止または再開します。特別な要件がない限り、これを true に設定することを推奨します。

パラメーター

戻り値の説明

値が 0 の場合、成功を示します。その他の値は失敗を示します。

すべてのリモートユーザーの音声ストリームを受信するかどうかを指定します。

public abstract int subscribeAllRemoteAudioStreams(boolean sub);

このメソッドは、リモート音声ストリームのサブスクリプションのマスター スイッチです。true に設定することを推奨します。false に設定すると、以下のようになります。

• 現在のセッション内のすべてのリモート音声ストリームのサブスクリプションが停止します。

• 後から参加する新しいユーザーもサブスクライブされません。

• <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e09342eeb0z4k" id="a56b5f2a3f56k">subscribeRemoteAudioStream</a> を使用して、指定したユーザーの音声ストリームを個別に制御することはできません。

サブスクリプションを再開するには、このメソッドを再度呼び出して true に設定します。

パラメーター

戻り値の説明

値が 0 の場合、成功を示します。その他の値は失敗を示します。

カメラストリームを配信するかどうかを指定します。

public abstract int publishLocalVideoStream(boolean enable);

このメソッドは、ローカルでキャプチャされた映像ストリームを配信するかどうかを制御します。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

参加前に呼び出すと、デフォルトの構成が変更され、参加時に有効になります。

関連コールバック

ローカル音声ストリームのアップストリーミングステータスが変更されると、ローカル側は <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#afe6d3c4b1rvg" id="8b70bc353aj68">onVideoPublishStateChanged</a> コールバックをトリガーして、音声ストリームのアップストリーミングの最新ステータスを通知し、リモート側は <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7078e15087a0z" id="176ee94b46lb7">onRemoteTrackAvailableNotify</a> コールバックをトリガーして、リモートユーザーの音声・映像ストリームが変更されたことを通知します。

パラメーター

戻り値の説明

値が 0 の場合、成功を示します。その他の値は失敗を示します。

カメラストリームが配信されているかどうかを照会します。

public abstract boolean isLocalVideoStreamPublished();

戻り値の説明

true の値はカメラストリームが配信されていることを示し、false の値はカメラストリームが配信されていないことを示します。

リモートユーザーの映像ストリームをデフォルトでサブスクライブするかどうかを指定します。

public abstract int setDefaultSubscribeAllRemoteVideoStreams(boolean sub);

このメソッドは、リモートユーザーの映像ストリームをデフォルトでサブスクライブするかどうかを指定します。SDK はデフォルトでサブスクライブします。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。参加後に setDefaultSubscribeAllRemoteVideoStreams(false) を呼び出すと、その後参加するユーザーの映像ストリームは受信されません。

映像ストリームの受信を停止した後、subscribeRemoteVideoStream を呼び出してリモートユーザーの ID を指定することで、そのユーザーの映像ストリームの受信を再開できます。複数のユーザーの映像ストリームの受信を再開するには、subscribeRemoteVideoStream を複数回呼び出す必要があります。setDefaultSubscribeAllRemoteVideoStreams(true) は、後からチャネルに参加するユーザーの映像ストリームの受信のみを再開します。

このメソッドは、リモートユーザーの映像ストリームをデフォルトでサブスクライブするかどうかを指定します。

パラメーター

戻り値の説明

値が 0 の場合、成功を示します。その他の値は失敗を示します。

指定されたリモート映像ストリームのサブスクリプションを停止または再開します。

public abstract int subscribeRemoteVideoStream(String uid, AliRtcVideoTrack track, boolean sub);

指定されたユーザーの映像ストリームをサブスクライブまたはサブスクライブ解除します。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

パラメーター

戻り値の説明

• 0：メソッドは正常に実行されました。

• 0 以外：メソッドは失敗しました。

すべてのリモート映像ストリームの受信を停止または再開します。

public abstract int subscribeAllRemoteVideoStreams(boolean sub);

このメソッドは、リモート映像ストリームのサブスクリプションのマスター スイッチです。false に設定すると、以下のようになります。

• 現在のセッション内のすべてのリモート映像ストリームのサブスクリプションが停止します。

• 後から参加する新しいユーザーはサブスクライブしません（デフォルトのサブスクリプションを有効化するために setDefaultSubscribeAllRemoteVideoStreams(true) を設定した場合でも）。

• <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#b738a1b498bc1" id="19b0cea8593i5">subscribeRemoteVideoStream</a> を使用して、指定したユーザーの映像ストリームを個別に制御することはできません。

サブスクリプションを再開するには、このメソッドを再度呼び出して true に設定します。

パラメーター

戻り値の説明

値が 0 の場合、成功を示します。その他の値は失敗を示します。

特定のリモートユーザーのメディアストリームを停止または再開します。

public abstract int subscribeRemoteMediaStream(String uid, AliRtcVideoTrack videoTrack, boolean subVideo, boolean subAudio);

このメソッドは、リモートの音声・映像ストリームのサブスクリプションを組み合わせます。

関連メソッド

<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#4cec275051vr6" id="faff82a053mev">subscribeRemoteMediaStream[2/2]</a> と比較して、この API は 2 つのブール値パラメーター subVideo と subAudio を利用して、リモートの音声・映像ストリームをサブスクライブするかどうかを指定します。videoTrack パラメーターは、どの映像ストリームをフェッチングするかを制御します。

パラメーター

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は、呼び出しが失敗したことを示します。

リモートユーザーの音声・映像ストリームのサブスクリプションを 1 回の呼び出しで停止または再開します。

public abstract int subscribeRemoteMediaStream(String uid, AliRtcVideoTrack videoTrack, AliRtcAudioTrack audioTrack) ;

このインターフェイスは、サブスクライブされたリモートの音声・映像ストリームをマージします。

関連メソッド

subscribeRemoteMediaStream[1/2] とは異なり、このメソッドは videoTrack と audioTrack パラメーターを使用して、1 回の API 呼び出しで目的のサブスクリプション状態を指定します。例：

• カメラストリームとマイクストリームをサブスクライブしたい場合は、呼び出し時に videoTrack と audioTrack をそれぞれ AliRtcVideoTrackCamera と AliRtcAudioTrackMic に設定します。

• カメラストリームのサブスクリプションを解除し、マイクストリームのサブスクリプションを継続するには、videoTrack パラメーターを AliRtcVideoTrackNo に、audioTrack パラメーターを AliRtcAudioTrackMic に設定します。

• 両方のサブスクリプションを解除するには、videoTrack と audioTrack をそれぞれ AliRtcVideoTrackNo と AliRtcAudioTrackNo に設定します。

• カメラストリームと画面共有ストリームの両方をサブスクライブするには、videoTrack パラメーターを AliRtcVideoTrackBoth に設定します。音声ストリームにも同じロジックが適用されます。

パラメーター

戻り値の説明

• 0：成功。

• <0：失敗。

チャネル間で特定のユーザーのストリームをサブスクライブします。

public abstract int subscribeRemoteDestChannelStream(String channelId, String uid, AliRtcVideoTrack track, boolean sub_audio, boolean sub);

パラメーター

戻り値の説明

戻り値が 0 の場合、メソッド呼び出しが成功したことを示し、その他の値は呼び出しが失敗したことを示します。

チャネル間で全ユーザーのストリームのサブスクリプションを停止または再開します。

public abstract int subscribeRemoteDestChannelAllStream(String channelId, AliRtcVideoTrack track, boolean sub_audio, boolean sub);

パラメーター

戻り値の説明

• 0：メソッド呼び出しは成功しました。

• 0 以外：メソッド呼び出しは失敗しました。

フェッチした音声ストリームの再生ボリュームを調整します。

public abstract int setRemoteAudioVolume(String uid, int volume);

このメソッドを使用して、ローカルデバイスで指定されたユーザーの音声ストリームの再生ボリュームを調整できます。

パラメーター

戻り値の説明

• 0：メソッド呼び出しは成功しました。

• 0 以外：メソッド呼び出しは失敗しました。例えば、無効なボリューム値が原因です。

ローカル音声データの送信を停止または再開します。

public abstract int muteLocalMic(boolean mute, AliRtcMuteLocalAudioMode mode);

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

関連コールバック

呼び出しが成功すると、リモートユーザーは <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#ea457055e4izi" id="cce3d390a3xud">onUserAudioMuted</a> 通知をトリガーして、ミュートされているかどうかを示します。

パラメーター

戻り値の説明

戻り値が 0 の場合、成功を示します。その他の値は失敗を示します。ミュートすると無音フレームが送信されますが、音声キャプチャとエンコーディングは引き続き実行されます。

リモート音声ストリームの再生を停止または再開します。

public abstract int muteRemoteAudioPlaying(String uid, boolean mute);

この API は、指定されたリモートユーザーの音声ストリームの再生のみを制御します。リモート音声のストリームフェッチングやデコーディングには影響しません。ユーザーの音声ストリームのサブスクリプションを解除するには、<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e09342eeb0z4k" id="66a2ef0919jjg">subscribeRemoteAudioStream</a> を呼び出します。

呼び出しタイミング

チャネル参加前または参加後に設定できます。

パラメーター

戻り値の説明

戻り値が 0 の場合、成功を示します。その他の値は失敗を示します。

すべてのリモート音声ストリームの再生を停止または再開します。

public abstract int muteAllRemoteAudioPlaying(boolean mute);

このメソッドは、すべてのリモート音声ストリームを停止または再開します。

呼び出しタイミング

チャネルに参加する前または後に設定できます。

パラメーター

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は失敗を示します。

音声キャプチャを開始します。

public abstract int startAudioCapture();

このメソッドは音声キャプチャを開始します。チャネルに参加する前にこのメソッドを呼び出すことで、事前に音声キャプチャを有効にできます。このメソッドが呼び出されない場合、SDK は自動的に音声キャプチャデバイスを制御します。また、stopAudioCapture を呼び出した後に、このメソッドを呼び出して音声キャプチャを再度有効にすることもできます。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

関連メソッド

<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#b71a48f4b84n0" id="4565abdceeq8i">startAudioCapture[2/2]</a> API は、会議から退出した後も音声キャプチャデバイスを有効にしておくかどうかをパラメーターで制御します。

関連コールバック

このメソッドを呼び出した後、onLocalAudioStateChanged コールバックがローカル音声キャプチャステータスの変更を通知します。

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は、呼び出しが失敗したことを示します。

音声キャプチャを開始します。

public abstract int startAudioCapture(boolean keepAlive);

ミュート後にマイクキャプチャを無効にします。

このメソッドは音声キャプチャを開始します。チャネルに参加する前に呼び出すことで、事前に音声キャプチャを有効にできます。このメソッドを設定しない場合、SDK は自動的に音声キャプチャデバイスを制御します。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

関連メソッド

startAudioCapture[1/2] と比較して、このメソッドは keepAlive パラメーターを使用して、チャネル退出後もキャプチャデバイスをアクティブにしておくかどうかを制御できます。

関連コールバック

このメソッドを呼び出してローカル音声キャプチャステータスを変更した後、onLocalAudioStateChanged コールバックを通じてステータスの変更を取得できます。

パラメーター

戻り値の説明

戻り値が 0 の場合、成功を示します。その他の値は失敗を示します。

音声キャプチャを停止します。

public abstract int stopAudioCapture();

SDK はデフォルトで音声キャプチャを有効にします。プレビューを開始するか、チャネルに参加すると、音声キャプチャが自動的に開始されます。このメソッドを呼び出して、音声デバイスのキャプチャを停止します。

関連コールバック

このメソッドを呼び出した後、SDK は onLocalAudioStateChanged コールバックをトリガーして、ローカル音声キャプチャステータスの変更を報告します。

戻り値の説明

戻り値が 0 の場合、呼び出しが成功したことを示します。その他の値は、呼び出しが失敗したことを示します。

デフォルトの音声出力デバイスをスピーカーフォンにするかどうかを設定します。

public abstract int setDefaultAudioRoutetoSpeakerphone(boolean defaultToSpeakerphone);

このメソッドは、チャネルに参加する前にデフォルトの音声ルーティングデバイスを構成します。デフォルトの出力をイヤホンまたはスピーカーフォンのいずれかに設定できます。デフォルトでは、SDK はスピーカーフォンを使用します。このデフォルトを変更するには、チャネルに参加する前にこのメソッドを呼び出します。

SDK は、現在の周辺機器の接続状況に基づいて自動的に切り替える音声ルーティングの優先順位を定義しています。優先順位は次のとおりです：有線ヘッドセット > Bluetooth ヘッドセット > ユーザー設定 > デフォルト設定。したがって、周辺機器が接続されておらず、enableSpeakerphone が設定されていない場合、SDK はデフォルト設定を適用します。

音声ルーティング設定の詳細については、「音声ルーティング設定」をご参照ください。

モバイルデバイスは通常、イヤホンとスピーカーフォンの 2 つの音声出力デバイスをサポートしています。

• 音声がイヤホンにルーティングされると、音は静かになり、電話を耳に近づける必要があります。これによりプライバシーが向上し、通話に適しています。

• 音声がスピーカーフォンにルーティングされると、音は大きくなり、電話を耳に近づけずにハンズフリーで使用できます。

関連メソッド

このメソッドはデフォルトの音声ルーティング構成を変更します。enableSpeakerphone メソッドは現在の音声ルーティングデバイスを設定します。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

パラメーター

応答の説明

• 0：メソッド呼び出しは成功しました。

• <0：メソッド呼び出しは失敗しました。

音声出力デバイスをヘッドセットまたはスピーカーのいずれかに設定します。

public abstract int enableSpeakerphone(boolean enable);

このメソッドは、チャネルに参加した後、現在の音声再生デバイスを選択し、イヤホンとスピーカーを切り替えます。このメソッドを呼び出さない場合、再生はデフォルトの音声ルートで指定されたデバイスを使用します。

SDK は、音声ルーティングの事前定義された優先順位を定義し、現在の周辺機器の接続状況に基づいて自動的に切り替えを行います。優先順位は次のとおりです：有線ヘッドセット > Bluetooth ヘッドセット > ユーザー設定 > デフォルト設定。したがって、周辺機器が接続されている場合、この API 呼び出しは効果がありません。音声ルーティング設定の詳細については、「音声ルーティング設定」をご参照ください。

呼び出しのタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

関連メソッド

<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#d4dab00b21ebx" id="944fb5797e773">setDefaultAudioRoutetoSpeakerphone</a> はデフォルトの音声ルーティング設定を変更し、現在のルーティングデバイスを設定します。

パラメーター

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は失敗を示します。

現在の音声出力デバイスがイヤホンかスピーカーかを判断します。

public abstract boolean isSpeakerOn();

戻り値の説明

true の値はスピーカーを示し、false の値はイヤホンを示します。

ユーザーのボリュームプロンプトを有効にします。

public abstract int enableAudioVolumeIndication(int interval, int smooth, int reportVad);

このメソッドは、SDK がローカルユーザーと現在最も音量の大きいリモートユーザーの音量を定期的に報告するようにします。この機能を使用するには、AliRtcAudioVolumeObserver クラスを実装し、registerAudioVolumeObserver を呼び出してオブザーバーを登録します。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

関連コールバック

このメソッドを正常に呼び出した後、チャネル内でユーザーがストリームを配信している場合、SDK は指定された間隔で以下の 2 つのコールバックをトリガーします。

• AliRtcAudioVolumeObserver#onAudioVolume コールバックは、各スピーカーの音量を報告します。このコールバックの頻度は interval パラメーターによって決まります。

• 音声アクティビティ検出：アクティブなスピーカーが検出されると、そのユーザー ID（UID）が AliRtcAudioVolumeObserver#onActiveSpeaker コールバックを通じて報告されます。

パラメーター

戻り値の説明

戻り値が 0 の場合、メソッド呼び出しが成功したことを示します。その他の値は、呼び出しが失敗したことを示します。

インイヤーモニタリングを有効にします。

public abstract int enableEarBack(boolean enable);

このメソッドはインイヤーモニタリングを有効または無効にします。有線または Bluetooth ヘッドフォンを装着している場合、インイヤーモニタリングを有効にすることでより良い結果が得られます。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

パラメーター

戻り値の説明

値が 0 の場合、成功を示します。その他の値は失敗を示します。

インイヤーモニタリングのボリュームを設定します。

public abstract int setEarBackVolume(int volume) ;

このメソッドは、enableEarBack を呼び出してインイヤーモニタリングを有効にした後にのみ有効になります。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

パラメーター

返却手順

• 0：メソッド呼び出しは成功しました。

• <0：メソッド呼び出しは失敗しました。

音声再生デバイスを開始します。

public abstract int startAudioPlayer();

このメソッドを使用して、事前に音声再生を有効にできます。このメソッドを呼び出さない場合、SDK は音声ストリームをサブスクライブした後に自動的に音声再生を有効にします。

戻り値の説明

• 0：呼び出しは成功しました。

• 0 以外：呼び出しは失敗し、エラーコードを返します。

音声再生デバイスを停止します。

 public abstract int stopAudioPlayer();

このインターフェイスは音声再生を停止し、startAudioPlayer の対となるものです。

戻り値の説明

• 0：呼び出しは成功しました。

• 0 以外：呼び出しは失敗しました。エラーコードが返されます。

ローカル再生ボリュームを設定できます。

public abstract int setPlayoutVolume(int volume);

パラメーター

応答の説明

• 0：呼び出しは成功しました。

• 0 以外：呼び出しは失敗しました。

録音ボリュームを設定できます。

public abstract int setRecordingVolume(int volume);

パラメーター

戻り値の説明

• 0：メソッド呼び出しは成功しました。

• 0 以外のリターンコードは、呼び出しが失敗したことを示します。

オーディオファイルを再生できます。

public abstract int playAudioFileTest(String filePath) ;

このメソッドを使用して、チャネルに参加する前にオーディオファイルを再生し、音声再生をテストできます。

呼び出しタイミング

このメソッドはチャネル参加前のみに呼び出すことができます。

呼び出し制限

複数回の呼び出しは以前のものを上書きします。このメソッドを呼び出すと、現在再生中のファイルは停止します。

パラメーター

戻り値の説明

• 0：メソッド呼び出しは成功しました。

• 0 以外の値は、呼び出しが失敗したことを示します。

オーディオファイルの再生を停止します。

public abstract int stopAudioFileTest();

このインターフェイスは playAudioFileTest インターフェイスに対応し、オーディオファイルの再生を停止します。

制限事項

このメソッドはチャネルに参加する前にのみ呼び出すことができます。

戻り値の説明

• 0：呼び出しが成功しました。

• 0 以外：呼び出しが失敗しました。

通話前に音声キャプチャデバイスのテストを開始します。

public abstract int startAudioCaptureTest();

通話の前にこのメソッドを呼び出して、ローカルオーディオキャプチャデバイスが正常に動作しているかテストできます。このメソッドを呼び出すと、SDK は AliRtcAudioVolumeObserver::OnTestAudioVolume コールバックを介してオーディオキャプチャデバイスのボリュームを報告します。

呼び出しタイミング

このメソッドはチャネルに参加する前に呼び出す必要があります。テストが完了したら、stopAudioCaptureTest を呼び出してテストを停止し、音声デバイスを解放する必要があります。

戻り値の説明

• 0：呼び出しは成功です。

• 0 以外：呼び出しは失敗しました。エラーコードが返されます。

音声キャプチャ検出を無効にします。

public abstract int stopAudioCaptureTest();

このメソッドは音声キャプチャデバイスのテストを停止します。startAudioCaptureTest を呼び出した後、このメソッドを呼び出してテストを停止する必要があります。

呼び出しタイミング

このメソッドはチャネル参加前に呼び出すことができます。

戻り値の説明

• 0：呼び出しは成功しました。

• 0 以外：呼び出しは失敗し、エラーコードが返されます。

音声変更モードを設定します。

public abstract int setAudioEffectVoiceChangerMode(AliRtcAudioEffectVoiceChangerMode mode);

パラメーター

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は失敗を示します。

ピッチ調整パラメーターを設定できます。

public abstract int setAudioEffectPitchValue(double value);

パラメーター

戻り値の説明

値が 0 の場合、メソッド呼び出しが成功したことを示します。その他の値は失敗したことを示します。

残響モードを設定します。

public abstract int setAudioEffectReverbMode(AliRtcAudioEffectReverbMode mode);

パラメーター

戻り値の説明

戻り値が 0 の場合、メソッド呼び出しが成功したことを示します。その他の値は、メソッド呼び出しが失敗したことを示します。

残響サウンドエフェクトのタイプとパラメーターを設定できます。

public abstract int setAudioEffectReverbParamType(AliRtcAudioEffectReverbParamType type, float value);

パラメーター

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は失敗を示します。

事前定義された音声美化モードを設定します。

public abstract int setAudioEffectBeautifyMode(AliRtcAudioEffectBeautifyMode mode);

このメソッドは、SDK が提供する事前定義された音声美化モードを設定します。音声ライブストリーミング、カラオケ、音声ソーシャルネットワーキングなど、ボーカル品質の向上が求められるシナリオに適しています。音声美化モードを選択することで、人の声の響きを良くしたり、明瞭度を向上させたりするなど、音質を変更できます。これにより、リモートユーザーのリスニング体験が向上します。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

パラメーター

戻り値

• 0：操作は成功しました。

• 0 以外：操作は失敗しました。

オーディオイコライザー（EQ）パラメーターを設定して、指定された周波数帯のゲインを調整します。

public abstract int setAudioEffectEqualizationParam(AliRtcAudioEffectEqualizationBandFrequency bandIndex, float gain);

このメソッドは、ローカルでキャプチャされた音声およびオーディオ信号のグラフィックイコライザーを調整します。特定の周波数帯のゲイン（dB）を調整することで、音声の明瞭度の最適化、ボーカルの強調、ノイズリダクションの改善などの目的でサウンドをカスタマイズできます。

イコライザーは、31 Hz から 16 kHz までの全オーディオスペクトルを 10 の標準バンドでサポートします。各バンドのゲインは、-15 dB から 15 dB の値に独立して設定できます。デフォルト値は 0 dB で、これは強調も減衰もないことを示します。

制限事項

• このメソッドを呼び出す前に、setAudioEffectBeautifyMode を呼び出して音声美化モードを有効にする必要があります。

パラメーター

戻り値の説明

0：メソッド呼び出しは成功しました。

0 以外：メソッド呼び出しは失敗しました。

外部音声ストリームを追加できます。

public abstract int addExternalAudioStream(AliRtcExternalAudioStreamConfig config);

このメソッドは外部音声ストリームを追加します。以下の手順に従ってください。

1. <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#42b363024fich" id="20c33a9acb0ui">addExternalAudioStream</a> API を呼び出して外部音声ストリームを追加し、その ID を取得します。

2. <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#930f22d3dcdco" id="d3deb62b2fl0f">pushExternalAudioStreamRawData</a> を呼び出して、外部音声ストリームに音声データをプッシュします。

3. 通話終了時には、<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#0333f86114078" id="16d826dedcli6">removeExternalAudioStream</a> を呼び出して外部音声ストリームを削除する必要があります。

チャネルでカスタム音声キャプチャを配信したい場合は、「カスタム音声キャプチャ」をご参照ください。

呼び出しタイミング

戻り値の説明

戻り値が 0 より大きい場合、メソッド呼び出しが成功し、外部音声ストリームの ID を表します。その他の値は、メソッド呼び出しが失敗したことを示します。

外部音声ストリームデータを入力できます。

public abstract int pushExternalAudioStreamRawData(int streamId, AliRtcAudioFrame rawData);

このインターフェイスを使用して、指定された音声ストリームにデータを送信します。手順は次のとおりです。

1. <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#42b363024fich" id="8822f2932e9ep">addExternalAudioStream</a> を呼び出して外部音声ストリームを追加し、外部音声ストリーム ID を取得します。

2. <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#930f22d3dcdco" id="880fe8cd02j10">pushExternalAudioStreamRawData</a> を呼び出して、作成した音声ストリームに音声データをプッシュします。

3. 通話終了後、<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#0333f86114078" id="106c7aefa27c0">removeExternalAudioStream</a> を呼び出して外部音声ストリームを削除します。

チャネルでカスタムソースから音声を配信する方法の詳細については、「カスタム音声キャプチャ」をご参照ください。

呼び出しタイミング

チャネル参加後にこのメソッドを呼び出します。

パラメーター

戻り値の説明

戻り値が 0 の場合、メソッド呼び出しが成功したことを示します。その他の値は、メソッド呼び出しが失敗したことを示します。

外部音声ストリームの配信ボリュームを設定します。

public abstract int setExternalAudioStreamPublishVolume(int streamId, int publishVolume);

パラメーター

戻り値の説明

戻り値が 0 の場合、呼び出しが成功したことを示します。その他の値は、呼び出しが失敗したことを示します。

外部音声ストリームのアップストリーミングボリュームを取得します。

public abstract int getExternalAudioStreamPublishVolume(int streamId);

パラメーター

戻り値の説明

アップストリーミングボリューム：有効値は 0 から 100 です。0 未満の値は失敗を示します。

外部音声ストリームの再生ボリュームを設定します。

public abstract int setExternalAudioStreamPlayoutVolume(int streamId, int playoutVolume);

パラメーター

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は、呼び出しが失敗したことを示します。

外部音声ストリームの再生ボリュームを取得します。

public abstract int getExternalAudioStreamPlayoutVolume(int streamId);

パラメーター

応答の説明

再生ボリュームの有効値は 0 から 100 です。0 未満の値は失敗を示します。

外部音声ストリームを削除します。

public abstract int removeExternalAudioStream(int streamId);

このメソッドは、指定されたストリーム ID に対応する外部音声ストリームを削除します。addExternalAudioStream メソッドの対となるものです。

呼び出しタイミング

カスタム音声入力機能を使用するには、まず addExternalAudioStream メソッドを呼び出して音声ストリームを追加し、そのストリーム ID を取得する必要があります。次に、pushExternalAudioStreamRawData メソッドを呼び出して音声データを SDK にプッシュします。カスタム音声入力の使用を停止したい場合は、このメソッドを呼び出して音声ストリームを削除し、そのリソースを解放します。

パラメーター

戻り値の説明

• 0：呼び出しは成功です。

• <0：呼び出しは失敗しました。エラーコードが返されます。

オーディオファイル情報を取得します。

public abstract int getAudioFileInfo(String fileName);

このインターフェイスを非同期で呼び出すと、ファイルの持続時間を取得できます。これは非同期インターフェイスであり、onAudioFileInfo を使用して音声ファイル情報を取得できます。

パラメーター

はじめにに戻る

• 0：呼び出しは成功しました。

• 0 以外：エラーコードが返されます。

音声伴奏ミキシングを開始します。

public abstract int startAudioAccompany(String fileName, AliRtcAudioAccompanyConfig config) ;

このインターフェイスは、ローカルまたはオンラインの伴奏ファイルを再生します。これは非同期インターフェイスです。このインターフェイスを呼び出した後、AliRtcEngineNotify#onAudioAccompanyStateChanged を使用して伴奏の再生ステータスをモニターできます。

呼び出しタイミング

このメソッドはチャネルに参加した後にのみ呼び出すことができます。

制限事項

効果音とは異なり、一度に再生できる伴奏は 1 つだけです。繰り返し呼び出すと、以前の伴奏再生が上書きされます。

パラメーター

戻り値の説明

• 0：呼び出しは成功しました。

• 0 以外：呼び出しは失敗し、エラーコードを返します。

ヘッドセットまたはスピーカーを音声出力デバイスとして設定します。

public abstract int stopAudioAccompany() ;

このインターフェイスは startAudioAccompany の対となるもので、音声伴奏の再生を停止します。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

応答の説明

• 0：呼び出しは成功しました。

• 0 以外：呼び出しは失敗し、エラーコードを返します。

音声伴奏のローカル再生およびアップストリーミング用のボリュームを設定します。

public abstract int setAudioAccompanyVolume( int volume) ;

この API は、ローカル再生および配信用の音声伴奏のボリュームを設定します。ローカル再生用のボリュームのみを設定するには、setAudioAccompanyPlayoutVolume を使用します。配信用のボリュームのみを設定するには、setAudioAccompanyPublishVolume を使用します。

パラメーター

応答の説明

• 0：呼び出しは成功しました。

• 0 以外：呼び出しは失敗し、エラーコードを返します。

アップストリーミングの音声伴奏のボリュームを設定します。

public abstract int setAudioAccompanyPublishVolume(int volume) ;

パラメーター

戻り値の説明

• 0：呼び出しは成功しました。

• 0 以外：呼び出しは失敗しました。返される値はエラーコードです。

伴奏ストリームのインジェスト ボリュームを取得します。

public abstract int getAudioAccompanyPublishVolume() ;

応答の説明

伴奏音楽ストリームのアップストリーミングボリュームです。

• 0 から 100：成功。

• その他の値：エラーコード。

伴奏のローカル再生ボリュームを設定します。

public abstract int setAudioAccompanyPlayoutVolume(int volume) ;

パラメーター

戻り値の説明

• 0：呼び出しは成功しました。

• 0 以外：呼び出しは失敗し、エラーコードが返されます。

伴奏のローカル再生ボリュームを照会します。

public abstract int getAudioAccompanyPlayoutVolume() ;

戻り値の説明

伴奏のローカル再生ボリュームです。

• [0-100]：成功。

• その他の値：エラーコード。

伴奏ミキシングを一時停止します。

public abstract int pauseAudioAccompany();

戻り値の説明

• 0：呼び出しは成功しました。

• 0 以外：呼び出しは失敗し、エラーコードが返されました。

伴奏ミキシングを再開できます。

public abstract int resumeAudioAccompany();

戻り値の説明

• 値が 0 の場合、呼び出しが成功したことを示します。

• 0 以外の値は、呼び出しが失敗し、エラーコードを返すことを示します。

伴奏ファイルの長さをミリ秒単位で取得します。

public abstract int getAudioAccompanyDuration();

このメソッドは、現在の伴奏ファイルの長さを取得します。

戻り値の説明

• >= 0：伴奏ファイルの長さ。

• < 0：呼び出しは失敗し、エラーコードを返します。

伴奏ファイルの再生進捗をミリ秒単位で取得します。

public abstract int getAudioAccompanyCurrentPosition();

このメソッドは、現在の伴奏ファイルの再生進捗をミリ秒単位で取得します。

応答の説明

• 0 以上の値：伴奏ファイルの再生進捗。

• 0 未満の値：呼び出しは失敗しました。エラーコードが返されます。

伴奏の再生位置を設定します。

public abstract int setAudioAccompanyPosition(int posMs);

このメソッドは伴奏の再生進捗を設定します。プログレスバーのドラッグなどの機能に便利です。このメソッドが正常に呼び出されると、伴奏は指定された位置から再生されます。

パラメーター

戻り値の説明

• 0：呼び出しは成功しました。

• 0 以外：呼び出しは失敗しました。エラーコードが返されます。

効果音をプリロードします。

public abstract int preloadAudioEffect(int soundId, String filePath);

パラメーター

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は失敗を示します。

プリロードされた効果音ファイルを削除します。

public abstract int unloadAudioEffect(int soundId);

パラメーター

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は失敗を示します。

効果音の再生を開始します。

public abstract int playAudioEffect(int soundId, String filePath, int cycles, boolean publish);

パラメーター

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。

効果音の再生を停止します。

public abstract int stopAudioEffect(int soundId);

パラメーター

戻り値の説明

戻り値が 0 の場合、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。

すべての効果音の再生を停止します。

public abstract int stopAllAudioEffects();

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。0 以外の値は、呼び出しが失敗したことを示します。

効果音ストリームのアップストリーミングボリュームを設定します。

public abstract int setAudioEffectPublishVolume(int soundId, int volume);

パラメーター

戻り値の説明

戻り値が 0 の場合、成功を示します。その他の値は失敗を示します。

効果音ストリームのアップストリーミングボリュームを照会します。

public abstract int getAudioEffectPublishVolume(int soundId);

パラメーター

応答の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は失敗を示します。

効果音のローカル再生ボリュームを設定します。

public abstract int setAudioEffectPlayoutVolume(int soundId, int volume);

パラメーター

戻り値の説明

戻り値が 0 の場合、呼び出しが成功したことを示します。その他の値は失敗を示します。

Android および iOS デバイスの効果音のローカル再生ボリュームを取得します。

public abstract int getAudioEffectPlayoutVolume(int soundId);

パラメーター

戻り値の説明

戻り値が 0 の場合、成功を示します。その他の値は失敗を示します。

アップストリーミング内のすべての効果音のミキシングボリュームを設定します。

public abstract int setAllAudioEffectsPublishVolume(int volume);

パラメーター

戻り値の説明

戻り値が 0 の場合、成功を示します。その他の値は失敗を示します。

すべての効果音のローカル再生ボリュームを設定します（Android および iOS）。

public abstract int setAllAudioEffectsPlayoutVolume(int volume);

パラメーター

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は失敗を示します。

メディアファイルの録画を開始します。

public abstract boolean startRecord(AliRtcRecordType recordType, AliRtcRecordFormat recordFormat, String filePath, AliRtcRecordAudioConfig audioConfig, AliRtcRecordVideoConfig videoConfig, long maxSize, long maxDuration);

パラメーター

戻り値

戻り値が TRUE の場合、成功を示します。その他の値は失敗を示します。

メディアファイルの録画を停止します。

  public abstract void stopRecord();

パラメーター

なし。

効果音を一時停止します。

public abstract int pauseAudioEffect(int soundId);

パラメーター

戻り値の説明

戻り値が 0 の場合、成功を示します。その他の値は失敗を示します。

すべての効果音を一時停止します。

public abstract int pauseAllAudioEffects();

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は失敗を示します。

効果音の再生を再開します。

public abstract int resumeAudioEffect(int soundId);

パラメーター

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は失敗を示します。

すべての効果音の再生を再開できます。

public abstract int resumeAllAudioEffects();

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は失敗を示します。

SurfaceView レンダリングビューを作成します。

public abstract SophonSurfaceView createRenderSurfaceView(Context context);

SurfaceView を直接作成する代わりに、このメソッドを呼び出して映像ビューを表示する必要があります。このメソッドを使用するには：

• 戻り値を AliRtcVideoCanvas#view に割り当てます。

• setLocalViewConfig を呼び出してローカルプレビュービューを設定するか、setRemoteViewConfig を呼び出してリモートプレビュービューを設定します。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

制限事項

このメソッドはメインスレッドで呼び出す必要があります。

パラメーター

ローカルプレビューのレンダリングウィンドウと描画パラメーターを設定できます。

public abstract int setLocalViewConfig(AliRtcVideoCanvas viewConfig, AliRtcVideoTrack track);

このメソッドは、ローカル映像ストリームをビューにバインドし、ローカルユーザーのビューレンダリングモード、ミラーリングモード、回転角度を構成することで、ローカルプレビュービューを設定します。これはローカルユーザーのプレビューにのみ影響し、アップストリーミングされる映像には影響しません。リモートユーザーのインターフェイスビューを設定するには、setRemoteViewConfig を呼び出します。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

パラメーター

返品手順

値が 0 の場合、成功を示します。その他の値は失敗を示します。

リモート映像のレンダリングウィンドウと描画パラメーターを設定できます。

public abstract int setRemoteViewConfig(AliVideoCanvas canvas, String uid,AliRtcVideoTrack track);

このメソッドは、指定されたリモートユーザーの映像ストリームの表示ビューをバインドし、そのユーザーの映像をローカルで表示する際のレンダリングモード、ミラーリングモード、回転角度を構成します。これはローカルユーザーに表示される映像にのみ影響します。ローカルプレビュービューを構成するには、setLocalViewConfig を呼び出します。

• AliRtcVideoCanvas の view パラメーターが空の場合、レンダリングは停止します。

• 再生中に AliRtcVideoCanvas の renderMode パラメーターをリセットするには、他のすべてのパラメーターを変更せずに renderMode の値を変更します。

• 再生中に AliRtcVideoCanvas の `mirrorMode` パラメーターを変更するには、他のパラメーターを変更せずに `mirrorMode` の値を変更します。

呼び出しタイミング

この関数は、onRemoteTrackAvailableNotify コールバックを受信したときに呼び出すことを推奨します。これは、リモートユーザーのビデオが利用可能になったときに設定できます。

パラメーター

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示し、その他の値は失敗を示します。

カメラのキャプチャプリファレンス（カメラの向きやキャプチャフレームレートなど）を設定します。

public abstract int setCameraCapturerConfiguration(AliEngineCameraCapturerConfiguration cameraCapturerConfiguration);

このメソッドは、カメラの向きやフレームレートなどのキャプチャプリファレンスを構成します。

呼び出しタイミング

このメソッドはカメラをオンにする前に呼び出す必要があります。例えば、以下の操作の前に呼び出します。

• startPreview（映像プレビューを開始）

• joinChannel（チャネルに参加）

パラメーター

戻り値の説明

戻り値が 0 の場合、メソッド呼び出しが成功したことを示します。その他の値は失敗を示します。

ローカル映像キャプチャを無効または再有効にします。

public abstract int enableLocalVideo(boolean enable);

このメソッドは、ローカル映像キャプチャの有効化と無効化を制御します。ローカル映像キャプチャが無効になると、ローカルプレビューやアップストリーミング用の映像データはなくなりますが、リモート映像の受信には影響しません。このメソッドを呼び出してローカルカメラキャプチャを無効にすると、ローカルプレビューとリモートアップストリーミングの両方が最後のフレームで停止します。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。

関連コールバック

この API の呼び出しに成功すると、onUserVideoEnabled コールバックを介してリモートユーザーに通知します。

パラメーター

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は失敗を示します。

ローカル映像データの送信を停止または再開します。

public abstract int muteLocalCamera(boolean mute, AliRtcVideoTrack track);

アップストリーミング中に、このメソッドを呼び出して完全に黒い映像フレームを送信できます。ローカルプレビューは正常に表示され、キャプチャ、エンコーディング、送信モジュールは動作し続けますが、映像コンテンツは黒いフレームになります。

パラメーター

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。

カメラがオンになっているか確認します。

public abstract boolean isCameraOn();

戻り値の説明

true の値はカメラがオンであることを示し、false の値はカメラがオフであることを示します。

映像エンコーディングプロパティを設定します。

public abstract void setVideoEncoderConfiguration(AliRtcVideoEncoderConfiguration config);

このメソッドは、映像ストリームの解像度、フレームレート、ビットレート、映像の向きなどの映像エンコーディングプロパティを設定します。すべての映像シナリオでこのメソッドを呼び出すことを推奨します。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に呼び出すことができます。セッションごとにカメラストリームの映像エンコーディングプロパティを一度だけ設定する必要がある場合は、チャネルに参加する前にこのメソッドを呼び出すことを推奨します。

制限事項

このメソッドの mirrorMode パラメーターと setVideoMirrorMode メソッドはどちらも映像ストリームアップストリーミングのミラーリングを設定します。これらのメソッドのいずれかのみを使用することを推奨します。両方のメソッドを使用すると、ミラーリング効果が重複し、ミラーリングの失敗や不整合が発生する可能性があります。

パラメーター

映像デコーディングプロパティを設定します。

    public abstract void setVideoDecoderConfiguration(AliRtcVideoDecoderConfiguration config);

このメソッドは、映像ストリームをデコードするための映像パラメーターを設定します。

呼び出しタイミング

チャネルに参加する前にこのメソッドを呼び出すことを推奨します。

パラメーター

フロントカメラとリアカメラを切り替えることができます。デフォルトではフロントカメラが使用されます。

public abstract int switchCamera();

このメソッドは、フロントカメラとリアカメラのどちらを使用するかを制御します。デフォルトでは、フロントカメラが使用されます。映像ストリームを再起動したり、映像ソースを再構成したりすることなく、利用可能なカメラに基づいてアプリケーションの実行中に動的にカメラを切り替えることができます。

呼び出しタイミング

このメソッドは、カメラが正常に有効化された後にのみ呼び出すことができます。

制限事項

このメソッドは Android と iOS でのみサポートされています。

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は、失敗したことを示します。

現在のカメラの向きを取得します。

public abstract AliRTCCameraDirection getCurrentCameraDirection();

返品手順

• CAMERA_REAR (0) の値はリアカメラを示します。

• CAMERA_FRONT (1) の値はフロントカメラを示します。

• CAMERA_INVALID (-1) の値は無効な値を示します。

ローカルプレビューを開始します。

public abstract int startPreview();

このメソッドはローカル映像プレビューを開始し、自動的にカメラを有効にします。ローカルプレビューを停止するには、stopPreview メソッドを呼び出すことができます。

呼び出しタイミング

• 呼び出しの前に、setLocalViewConfig を呼び出してローカルプレビュー用のビューを設定する必要があります。そうしないと、プレビューは表示されませんが、アップストリーミングには影響しません。

• 必要に応じて、joinChannel を呼び出す前にこのメソッドを呼び出してプレビューを開始できます。カメラは自動的にオンになります。

戻り値の説明

値が 0 の場合、呼び出しが成功したことを示し、その他の値は失敗を示します。

ローカルプレビューを停止します。

public abstract int stopPreview();

このメソッドはローカル映像プレビューを停止し、カメラをオフにします。プレビューが停止した後、ローカルビューには最後にキャプチャされたフレームが表示され、アップストリーミングには影響しません。

呼び出しタイミング

ローカルプレビューを開始した後にこのメソッドを呼び出すことができます。

戻り値の説明

戻り値が 0 の場合、成功を示します。その他の値は失敗を示します。

カメラのズーム比を設定できます。

public abstract int setCameraZoom(float zoom);

カメラのズーム係数を設定できます。

制限事項

このメソッドは iOS および Android デバイスでのみ利用可能です。

呼び出しタイミング

この設定はカメラを有効にした後にのみ有効になります。ズームはカメラが再起動するたびにリセットされます。

パラメーター

戻り値の説明

• 0：呼び出しが成功しました。

• 0 以外：メソッド呼び出しは失敗しました。

カメラがサポートする最大ズーム係数（光学ズーム）を取得します。

public abstract float GetCameraMaxZoomFactor();

戻り値の説明

デバイスのカメラがサポートする最大ズーム係数です。

現在のカメラのズーム係数設定を取得できます。

public abstract float GetCurrentZoom();

戻り値の説明

デバイスの現在のカメラのズーム係数です。

カメラの露出を設定できます。

public abstract int SetExposure(float exposure);

撮影環境が暗すぎたり明るすぎたりすると、映像キャプチャの品質に影響します。映像品質を向上させるために、このメソッドを使用してカメラの露出レベルを調整できます。GetMinExposure と GetMaxExposure を使用して、サポートされている露出レベルの範囲を取得できます。

パラメーター

応答の説明

• 0：呼び出しが成功しました。

• 0 以外の値は、メソッド呼び出しが失敗したことを示します。

カメラの露出レベルを取得します。

public abstract float GetCurrentExposure();

現在使用中のカメラの露出レベル設定を取得します。

戻り値の説明

カメラの現在の露出レベルです。

カメラがサポートする最小露出を取得できます。

public abstract float GetMinExposure();

戻り値の説明

カメラの最小露出レベルです。

サポートされている最大カメラ露出レベルを取得します。

public abstract float GetMaxExposure();

戻り値の説明

カメラの最大露出レベルです。

カメラのフラッシュを有効または無効にします。

public abstract int setCameraFlash(boolean flash);

フラッシュを有効または無効にします。

制限事項

このメソッドは iOS と Android でのみサポートされています。

パラメーター

戻り値の説明

• 0：設定は成功しました。

• 0 以外：設定は失敗しました。

現在のデバイスで手動フォーカスがサポートされているかどうかを照会します。

public abstract boolean isCameraFocusPointSupported();

現在のカメラが手動フォーカスのためのフォーカスポイント設定をサポートしているかどうかを確認します。

制限事項

このメソッドは iOS および Android デバイスでのみ利用可能です。

応答の説明

• true：デバイスは手動フォーカスをサポートしています。

• false：デバイスは手動フォーカスをサポートしていません。

カメラの露出ポイントの設定がサポートされているか確認します。

public abstract boolean isCameraExposurePointSupported();

現在のデバイスで露出ポイントを設定できるかどうかを判断します。

制限事項

このメソッドは iOS および Android デバイスでのみ利用可能です。

戻り値の説明

• true：カメラの露出ポイントを設定できます。

• false：カメラの露出ポイントを設定できません。

カメラの手動フォーカスポイントを設定できます。

public abstract int setCameraFocusPoint(float x, float y);

現在のカメラのフォーカスポイントを設定します。この操作を呼び出した後、カメラは指定されたポイントの露出を調整し、そのフォーカス値を維持します。この操作を呼び出す前に、isCameraFocusPointSupported を呼び出して、デバイスが手動フォーカスをサポートしているかどうかを確認することをお勧めします。

制限事項

このメソッドは iOS および Android デバイスでのみ利用可能です。

このメソッドはチャネルに参加する前にのみ呼び出してください。

戻り値の説明

• 0：呼び出しが成功しました。

• 0 以外：呼び出しが失敗しました。

カメラの露出ポイントを設定できます。

public abstract int setCameraExposurePoint(float x, float y);

この操作はカメラの露出ポイントを設定します。呼び出し後、カメラは指定されたポイントの露出を一度調整し、その露出値を維持します。この操作を呼び出す前に、isCameraExposurePointSupported を呼び出して、デバイスが手動露出ポイント設定をサポートしているかどうかを確認することをお勧めします。

制限事項

このメソッドは iOS および Android デバイスでのみ利用可能です。

パラメーター

戻り値の説明

• 0：メソッド呼び出しは成功しました。

• 0 以外：メソッド呼び出しは失敗しました。

カメラが自動顔フォーカスをサポートしているか確認します。

public abstract boolean isCameraAutoFocusFaceModeSupported();

カメラが自動顔フォーカスをサポートしているかどうかを判断します。

呼び出しタイミング

このメソッドはカメラが有効になった後にのみ呼び出すことができます。カメラが有効で、顔検出とオートフォーカスの両方をサポートしている場合は true を返します。それ以外の場合は false を返します。

制限事項

このメソッドは iOS と Android でのみ利用可能です。

戻り値の説明

• true：自動顔フォーカスがサポートされています。

• false：自動顔フォーカスはサポートされていません。

カメラの顔フォーカスを設定できます。

public abstract boolean setCameraAutoFocusFaceModeEnabled(boolean enable);

このインターフェイスは、人間の顔にリアルタイムのオートフォーカスを可能にします。このメソッドを呼び出す前に、この機能のデバイスサポートを確認するために、isCameraAutoFocusFaceModeSupported を呼び出す必要があります。

制限事項

このメソッドは iOS と Android でのみ利用可能です。

パラメーター

戻り値の説明

• true：呼び出しは成功しました。

• false：呼び出しは失敗しました。

プレビューおよびアップストリーミング用の映像ミラーリングを構成します。

public abstract int setVideoMirrorMode(AliRtcVideoPipelineMirrorMode mirrorMode);

ローカルプレビュー映像およびアップストリーミングされる映像ストリームに対してミラーリングモードを有効にするかどうかを指定します。

呼び出しタイミング

このメソッドはチャネル参加前または参加後に動的に設定できます。SDK は内部的に状態を記録し、プレビューおよびエンコーディング（アップストリーミング）が利用可能になったときに映像操作を適用します。

呼び出し制限

このメソッドは setLocalViewConfig および setVideoEncoderConfiguration の mirrorMode と重複します。これらのメソッドのいずれかのみを使用することを推奨します。

このメソッドはチャネルに参加する前に呼び出してください。

応答の説明

• 0：設定は正常に適用されました。

• <0：設定に失敗しました。

  • AliRtcErrInner：SDK 内部の状態エラーです。SDK インスタンスが正常に作成されたかどうかを確認できます。

映像キャプチャのスケーリングのタイミングを設定します。

public abstract void setCapturePipelineScaleMode(AliRtcCapturePipelineScaleMode mode);

映像データキャプチャのスケーリングが、キャプチャ直後に行われるか、エンコーディング中に行われるかを設定します。例えば、キャプチャ解像度とエンコーディング解像度が異なる場合、スケーリングのタイミングを設定して、プレビューデータとアップストリーミングデータが一致するかどうかを決定できます。

呼び出しタイミング

このメソッドはカメラを有効にする前に設定してください。例えば、startPreview でプレビューを開始する前や、joinChannel でチャネルに参加する前に設定します。

パラメーター

戻り値の説明

なし。

外部映像入力ソースを有効にします。

public abstract void setExternalVideoSource(boolean enable,boolean useTexture,
 AliRtcVideoTrack streamType,AliRtcRenderMode renderMode);

パラメーター

映像データをインポートします。

public abstract int pushExternalVideoFrame(AliRtcRawDataFrame aliRawDataFrame,AliRtcVideoTrack streameType);

パラメーター

応答の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は失敗を示します。

中継ライブストリーミングを開始します。

public abstract int startPublishLiveStream(String streamUrl,AliRtcLiveTranscodingParam transcodingParam);

パラメーター

応答の説明

値が 0 の場合、呼び出しが成功したことを示します。その他の値は失敗を示します。

バイパスライブストリーミングパラメーターを更新できます。

public abstract int updatePublishLiveStream(String streamUrl,AliRtcLiveTranscodingParam transcodingParam);

パラメーター

返品手順

値が 0 の場合、成功を示します。その他の値は失敗を示します。

バイパスライブストリームを停止します。

public abstract int stopPublishLiveStream(String streamUrl);

パラメーター

戻り値の説明

値が 0 の場合、成功を示します。その他の値は失敗を示します。

バイパスライブストリーミングのステータスを取得します。

public abstract AliRtcEngine.AliRtcLiveTranscodingState getPublishLiveStreamState(String streamUrl);

パラメーター

返品手順

バイパスライブストリーミングのステータスを返します。

ネットワーク品質プローブを有効にできます。

public abstract int startNetworkQualityProbeTest(AlirtcNetworkQualityProbeConfig config);

パラメーター

戻り値の説明

値が 0 の場合、成功を示し、0 以外の値は失敗を示します。

ネットワーク品質テストを停止します。

public abstract int stopNetworkQualityProbeTest();

戻り値の説明

値が 0 の場合、成功を示します。その他の値は失敗を示します。

メディア拡張情報を送信できます。

public abstract int sendMediaExtensionMsg(byte[]message, int repeatCount, int delay, boolean isKeyFrame);

SDK はメディア拡張メッセージの送受信を可能にします。送信メソッドは SEI 拡張プロトコルを使用します。受信者は onMediaExtensionMsgReceived イベントをリッスンすることでメッセージを取得できます。

一般的なユースケースは次のとおりです。

• メディア拡張情報を使用してタイムスタンプを送信し、エンドツーエンドのネットワーク遅延を計算したり、他のビジネス運用とデータを同期したりします。

• メディア拡張情報を使用して記述情報を送信します。最大 4 KB のデータを送信でき、少量のデータに適しています。JSON またはプレーンテキストの使用を推奨します。

呼び出しタイミング

アップストリーミングを開始した後、このメソッドを呼び出すことができます。

制限事項

メディア拡張情報を使用するには、音声・映像データチャネルを再利用する必要があります。したがって、カスタムメッセージの送信頻度とメッセージデータの長さを制御する必要があります。制限は次のとおりです。

• SEI 情報は H.264 または H.265 ストリームに埋め込まれ、拡張情報を添付するために映像フレームのエンコーディングが必要なため、プロファイルで指定された fps メッセージを 1 秒あたり最大で送信できます。

• メディアデータ送信品質への影響を避けるため、カスタムメッセージ本文は 4 KB に制限されており、少量の情報に適しています。

• sendMediaExtensionMsg 関数の repeatCount パラメーターは、カスタムメッセージの冗長性レベルを指定します。この値が 1 より大きい場合、メッセージは複数回送信されます。

• この冗長性は、ネットワークパケット損失によるメッセージ損失を防ぐのに役立ちます。このような場合、ルーム内の他の参加者は複数の同一メッセージを受信し、重複排除する必要があります。

• ルーム内のサブスクライバーは、中継ライブストリーミング中にもカスタムメッセージを受信します。

• 一度に送信される MediaExtensionMsg は 1 つだけです。sendMediaExtensionMsg を複数回呼び出すと、以前にキューに入れられたデータが上書きされます。

関連コールバック

ストリームプーラーは、onMediaExtensionMsgReceived コールバックをリッスンすることで、ストリームインジェスターから送信されたメディア拡張情報を取得できます。

パラメーター

返品手順

• 0：呼び出しは成功しました。

• <0：呼び出しは失敗しました。エラーコードが返されます。

  • ERR_INNER(-1)：SDK 内部エラーです。考えられる原因：SDK が初期化されていない、または破棄された後に呼び出された。

メディア拡張情報を送信します。

public abstract int sendMediaExtensionMsgEx(byte[]message, int repeatCount, int delay, boolean isKeyFrame, int payloadType);

SDK はメディア拡張情報を送受信する機能を提供します。このメソッドは SEI 拡張プロトコルを使用してメディア拡張情報を送信します。onMediaExtensionMsgReceived をリッスンすることで情報を取得できます。payloadType が 5 の場合、これは sendMediaExtensionMsg インターフェイスを使用するのと同等です。

一般的なユースケースは次のとおりです。

• メディア拡張情報を使用してタイムスタンプを送信し、エンドツーエンドのネットワーク遅延を計算したり、他のビジネス運用とデータを同期したりします。

• メディア拡張情報を使用して記述情報を送信します。最大 4 KB のデータを送信でき、少量の情報に適しています。JSON またはプレーンテキストの使用を推奨します。

呼び出しタイミング

このメソッドはアップストリーミングを開始した後に呼び出すことができます。

制限事項

メディア拡張情報を使用するには、音声・映像データチャネルを再利用する必要があります。したがって、カスタムメッセージの送信頻度とメッセージデータの長さを制御する必要があります。制限は次のとおりです。

• プロファイルで指定されたとおり、1 秒あたり fps メッセージを送信できます。これは、SEI 情報が H.264 または H.265 ストリームに埋め込まれており、拡張情報をアタッチするためにビデオフレームのエンコーディングが必要となるためです。

• メディアデータ送信品質の低下を避けるため、カスタムメッセージ本文は 4 KB に制限されており、少量の情報に適しています。

• sendMediaExtensionMsg 関数の repeatCount パラメーターは、カスタムメッセージの冗長性レベルを指定します。この値が 1 より大きい場合、メッセージは複数回送信されます。

• この冗長性は、ネットワークパケット損失によるメッセージ損失を防ぐのに役立ちます。このような場合、ルーム内の他の参加者は複数の同一メッセージを受信し、重複排除する必要があります。

• ルーム内のサブスクライバーは、中継ライブストリーミング中にもカスタムメッセージを受信します。

• 一度に送信される MediaExtensionMsg は 1 つだけです。sendMediaExtensionMsg を複数回呼び出すと、以前にキューに入れられたデータが上書きされます。

パラメーターの説明

戻り値の説明

• 0：呼び出しは成功しました。

• <0：呼び出しは失敗し、エラーコードを返します。

  • ERR_INNER(-1)：SDK 内部エラーが発生しました。考えられる原因には、SDK の初期化の失敗や、破棄された後の SDK の呼び出しが含まれます。

このコールバックは、ネットワーク接続ステータスが変更されたときに呼び出されます。このコールバックを監視することが重要です。

public void onConnectionStatusChange(AliRtcEngine.AliRtcConnectionStatus status,
 AliRtcEngine.AliRtcConnectionStatusChangeReason reason);

パラメーター

ローカルデバイスで例外が発生したときに呼び出されるコールバックです。このコールバックには細心の注意を払ってください。

public void OnLocalDeviceException(AliRtcEngine.AliRtcEngineLocalDeviceType deviceType, AliRtcEngine.AliRtcEngineLocalDeviceExceptionType exceptionType, String msg)

パラメーター

このコールバックは、ユーザー認証が 30 秒後に期限切れになることを示します。このコールバックを処理する必要があります。

public void onAuthInfoWillExpire();

このコールバックは、ユーザーの認証情報が 30 秒後に期限切れになることを示します。新しいトークンを取得し、以下のいずれかの方法で認証情報を更新する必要があります。

• <a baseurl="t2309760_v6_4_1.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#975b9af9ecq1a" id="8099ac5a509hn">refreshAuthInfo</a> を呼び出して認証情報を更新します。

• <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="fe88be037dy4g">leaveChannel</a> を呼び出して現在のチャネルから退出した後、joinChannel を呼び出してチャネルに再参加します。

トリガー時間

SDK は、ユーザーの認証情報が期限切れになる 30 秒前にこのコールバックをトリガーします。このコールバックを受信したら、速やかに認証情報を更新する必要があります。

ユーザーが認証を必要とするインターフェイスを呼び出し、サーバーが期限切れ情報を返します。

public void onAuthInfoExpired();

このコールバックは、ユーザーの認証情報が期限切れになったことを示します。セッションを継続したい場合は、サーバーで新しいトークンを生成し、以下の方法で認証情報を更新する必要があります。

• <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="c3b0cf2f19dgm">leaveChannel</a> を呼び出して現在のチャネルを終了できます。その後、joinChannel を呼び出して再入室します。

トリガー時間

このコールバックは、ユーザーの認証情報が期限切れになったときにトリガーされます。

このコールバックは、チャネルに参加した結果を返します。

public void onJoinChannelResult(int result, String channel, String userId, int elapsed);

パラメーター

チャネルから退出した結果を返すコールバックです。

public void onLeaveChannelResult(int result, AliRtcEngine.AliRtcStats stats);

トリガー条件

このコールバックは、アプリケーションが <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="7f3d2133c81tx">leaveChannel</a> を正常に呼び出し、システムがチャネル退出の結果とセッションの統計情報を返したときにトリガーされます。

パラメーター

リモートユーザーのオフラインコールバックです。

public void onRemoteUserOffLineNotify(String uid, AliRtcUserOfflineReason reason);

このコールバックは、リモートユーザーがオフラインになったためにチャネルを退出したことをローカルユーザーに通知します。

トリガー条件

• リモートユーザーが積極的にチャネルを退出すると、コールバックがトリガーされます。

• リモートストリーマーが <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#84f350f904s98" id="4c0adbe948tif">setClientRole</a> を呼び出して視聴者ロールに切り替えると（AliRtcEngine#setClientRole を呼び出してロールを AliRTCSdkLive に設定）、コールバックがトリガーされます。

• リモートストリーマーから長期間データが受信されないためにオフラインと見なされると、コールバックがトリガーされます。

パラメーター

このコールバックは、リモートユーザーがオンラインになったときに呼び出されます。

public void onRemoteUserOnLineNotify(String uid, int elapsed);

このメソッドは、リモートユーザーがチャネルに参加したことをローカルクライアントに通知します。

トリガー条件

• リモートユーザーがチャネルに参加します。

• ローカルユーザーがチャネルに参加した後、このコールバックはすでにチャネルにいる各ユーザーに対して呼び出されます。これにより、ローカルユーザーは既存のユーザーを識別できます。

パラメーター

このコールバックは、リモートユーザーの音声・映像ストリームが変更されたときに呼び出されます。

public void onRemoteTrackAvailableNotify(String uid, AliRtcAudioTrack audioTrack,
 AliRtcVideoTrack videoTrack);

このコールバックは、リモートユーザーのアップストリーミングステータスが変更されたときにトリガーされます。このコールバックを通じて、開発者はリモートユーザーが音声・映像ストリームをアップストリーミングしているかどうかに関するリアルタイム情報を取得し、それに応じてリモートユーザーの音声・映像情報を表示または非表示にすることができます。