ApsaraVideo Live:AliRtcEngine API

AliRtcEngine インスタンスを作成します。

static AliEngine *Create(const char *extras);

呼び出すタイミング

ARTC SDK の他の API を呼び出す前に、このメソッドを呼び出して AliRtcEngine インスタンスを作成します。

制限事項

SDK は、アプリケーションごとに 1 つの AliRtcEngine インスタンスのみをサポートします。

メトリックの説明

戻り値

AliEngine クラスのシングルトンオブジェクトを返します。

AliRtcEngine インスタンスを破棄します。

static void Destroy(AliEngineDestroyCompletionCallback *callback = nullptr);

このメソッドは AliRtcEngine シングルトンオブジェクトを破棄し、そのすべての内部リソースを解放します。このメソッドを呼び出した後は、他の AliRtcEngine メソッドやコールバックは使用できなくなります。再度使用するには、Create を呼び出して新しいインスタンスを作成する必要があります。

呼び出すタイミング

リアルタイムコミュニケーションの使用が終了したら、このメソッドを呼び出してインスタンスを解放します。

制限事項

デッドロックを避けるため、SDK のコールバック内ではこのメソッドを呼び出さないでください。

パラメーター

機能インターフェイスのインスタンスを取得します。

virtual int QueryInterface(AliEngineInterfaceIdType iid, void** pInterface) = 0;

このメソッドは、特定の機能インターフェイスのインスタンスを取得します。Windows プラットフォームでリアルタイムコミュニケーション用のアプリケーションを開発する場合、オーディオデバイス管理 (AliEngineInterfaceAudioDeviceManager)、ビデオデバイス管理 (AliEngineInterfaceVideoDeviceManager)、メディアエンジン (AliEngineInterfaceMediaEngine) など、多くの高度な機能が対応するインターフェイスクラスを通じて提供されます。関連するメソッドを呼び出す前に、QueryInterface メソッドを使用してこれらのインターフェイスのインスタンスを取得する必要があります。

パラメーター

戻り値

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

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

H5 互換モードを有効または無効にします。

static void SetH5CompatibleMode(bool comp);

パラメーター

H5 互換モードが有効になっているかどうかを確認します。

static bool GetH5CompatibleMode();

戻り値

true：H5 互換性が有効です。false：H5 互換性が無効です。

イベントリスナーのコールバックを設定します。

virtual int SetEngineEventListener(AliEngineEventListener *listener) = 0;

このメソッドは、SDK のコールバックリスナーを設定します。このリスナーを設定することで、チャンネルへのユーザーの参加や退出、ネットワークステータスの変更、音声およびビデオストリームのステータスなど、エンジンからのさまざまな通知イベントを受け取ることができます。

AliEngineEventListener クラスを実装して、リッスンしたいイベントメソッドをカスタマイズする必要があります。デフォルトでは、すべてのメソッドは空の実装を持っているため、すべてを実装する必要はありません。必要なイベントメソッドのみを実装できます。

関連するコールバック

操作中に例外が発生した場合、SDK はまず内部のリトライメカニズムを使用して自動的に回復を試みます。自動的に解決できないエラーについては、SDK は定義済みのコールバックインターフェイスを通じてアプリケーションに通知します。以下は、SDK が処理できず、アプリケーションがリッスンして応答する必要がある問題に関する主要なコールバックです：

パラメーター

戻り値

• 0：成功。

• 0 以外の値：失敗。これは、listener パラメーターが無効であるか、SDK が正しく初期化されていないことが原因である可能性があります。

現在の SDK バージョンを照会します。

static const char *GetSDKVersion();

戻り値

現在の SDK バージョン番号を文字列形式で返します。例：「2.5.0.x」。

チャンネルプロファイルを設定します。

virtual int SetChannelProfile(const AliEngineChannelProfile channelProfile) = 0;

このメソッドはチャンネルプロファイルを設定します。現在、ビデオ通話シナリオとインタラクティブストリームシナリオのプロファイルを提供しています：

• ビデオ通話プロファイル：すべてのユーザーがストリーマーロールを持ち、ストリームをパブリッシュおよびサブスクライブできます。

• インタラクティブストリームモード：<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#c99c2b257dd8o" id="4e50f781a01e1">SetClientRole</a> メソッドを呼び出してユーザーロールを設定する必要があります。チャンネルでストリームをプッシュするユーザーのロールをストリーマー (AliRTCSdkInteractive) に設定します。ユーザーがストリームをプルするだけでストリームをプッシュしない場合は、ロールを視聴者 (AliRTCSdkLive) に設定します。このモードは RTC シナリオに推奨されます。

呼び出すタイミング

このメソッドは、チャンネルに参加する前にのみ呼び出すことができます。チャンネル内ではリセットできません。チャンネルを退出した後にリセットできます。

パラメーター

戻り値

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

• その他の値：メソッドの呼び出しは失敗しました。

  • -1：SDK が初期化されていないか、破棄されています。

オーディオプロファイルを設定します。

virtual int SetAudioProfile(int audioProfile, int audioScene) = 0;

このメソッドは、オーディオエンコーディングプロファイルとオーディオシナリオを設定します。詳細については、「一般的なオーディオ操作と構成」をご参照ください。ARTC SDK は、デフォルトで高品質モード (AliEngineHighQualityMode) と音楽シナリオモード (AliEngineSceneMusicMode) を使用します。デフォルト設定がニーズに合わない場合は、このメソッドを呼び出して構成できます。

呼び出すタイミング

このメソッドは、チャンネルに参加する前にのみ呼び出すことができます。チャンネルに参加した後はリセットできません。チャンネルを退出した後にリセットできます。

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

現在のモードが音声のみかどうかを確認します。

virtual bool IsAudioOnlyMode() = 0;

戻り値

true：現在のモードは音声のみです。false：現在のモードは音声とビデオです。

モードを音声のみ、または音声と映像に設定します。

virtual int SetAudioOnlyMode(bool audioOnly) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

チャンネルに参加します。

virtual int JoinChannel(const char *token, const char *channelId, const char *userId, const char *userName) = 0;

このメソッドはチャンネルに参加します。ARTC では、ユーザーはチャンネルによって整理されます。ユーザーは、音声およびビデオストリームをパブリッシュまたはサブスクライブするためにチャンネルに参加する必要があります。このメソッド、JoinChannel[2/3]、および JoinChannel[3/3] はすべてチャンネルへの参加に使用できます。認証方法と渡すユーザー情報が異なります：

• このメソッドは、単一パラメーターでチャンネルに参加するためのものです。トークンベースの認証を使用して単一パラメーター参加用に生成されたトークンを渡す必要があります。RTC シナリオでチャンネルに参加するには、このメソッドを使用することを推奨します。

• JoinChannel[2/3] は、複数のパラメーターでチャンネルに参加するためのものです。トークンベースの認証を使用して生成された複数パラメーターのトークンと、トークンの生成に使用されたユーザー情報を渡す必要があります。

• JoinChannel[3/3] は、AI リアルタイムインタラクションシナリオ用です。単一パラメーターのトークンを渡し、シナリオに基づいてユーザープロパティ capabilityProfile を設定する必要があります。

呼び出すタイミング

エンジンを作成した後にこのメソッドを呼び出します。

制限事項

• チャンネルに正常に参加した後、別のチャンネルに参加するには、まず LeaveChannel を呼び出して現在のチャンネルを退出する必要があります。<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="b2522e57e4vom">OnLeaveChannelResult</a> コールバックを受信した後にのみ、別のチャンネルに参加できます。

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

• 異なる App ID を持つアプリケーションは相互に通信できません。

• チャンネルへの参加に失敗した後のリトライ時にこのメソッドを呼び出さないでください。

関連するコールバック

このメソッドの呼び出しが成功すると、次のコールバックがトリガーされます：

• ローカルクライアントがチャンネルに参加した結果は、AliRtcEngineEventListener の <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#7cbf47a35bcel" id="cad6eb9b1bwx7">OnJoinChannelResult</a> コールバックを通じて返されます。

• チャンネルに正常に参加した後、リモートクライアントで <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#3333f6e9d344q" id="fab4a94264m28">OnRemoteUserOnLineNotify</a> コールバックがトリガーされます。

パラメーター

戻り値

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

チャンネルに参加します。

virtual int JoinChannel(const AliEngineAuthInfo &authInfo,
                                 const char *userName) = 0;

このメソッドはチャンネルに参加します。ARTC では、ユーザーはチャンネルによって整理されます。ユーザーは、音声およびビデオストリームをパブリッシュまたはサブスクライブするためにチャンネルに参加する必要があります。このメソッド、JoinChannel[1/3]、および JoinChannel[3/3] はすべてチャンネルへの参加に使用できます。認証方法と渡すユーザー情報が異なります：

• JoinChannel[1/3] は、単一パラメーターでチャンネルに参加するためのものです。トークンベースの認証を使用して単一パラメーター参加用に生成されたトークンを渡す必要があります。RTC シナリオでチャンネルに参加するには、このメソッドを使用することを推奨します。

• このメソッドは、複数のパラメーターでチャンネルに参加するためのものです。トークンベースの認証を使用して生成された複数パラメーターのトークンと、トークンの生成に使用されたユーザー情報を渡す必要があります。

• JoinChannel[3/3] は、AI リアルタイムインタラクションシナリオ用です。単一パラメーターのトークンを渡し、シナリオに基づいてユーザープロパティ capabilityProfile を設定する必要があります。

制限事項

• チャンネルに正常に参加した後、別のチャンネルに参加するには、まず LeaveChannel を呼び出して現在のチャンネルを退出する必要があります。<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="fcd2fac6abf0y">OnLeaveChannelResult</a> コールバックを受信した後にのみ、別のチャンネルに参加できます。

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

• 異なる App ID を持つアプリケーションは相互に通信できません。

関連するコールバック

このメソッドの呼び出しが成功すると、次のコールバックがトリガーされます：

• ローカルクライアントは、<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#7cbf47a35bcel" id="b3db8c610ewua">OnJoinChannelResult</a> コールバックを通じてチャンネルへの参加結果を通知されます。

• チャンネルに正常に参加した後、リモートクライアントで <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#3333f6e9d344q" id="a1297d33bcd92">OnRemoteUserOnLineNotify</a> コールバックがトリガーされます。

パラメーター

チャンネルに参加します。

virtual int JoinChannel(const char *token, const char *channelId, const char *userId, const AliEngineChannelParam &userParam) = 0;

このメソッドはチャンネルに参加します。ARTC では、ユーザーはチャンネルによって整理されます。ユーザーは、音声およびビデオストリームをパブリッシュまたはサブスクライブするためにチャンネルに参加する必要があります。このメソッド、JoinChannel[1/3]、および JoinChannel[2/3] はすべてチャンネルへの参加に使用できます。認証方法と渡すユーザー情報が異なります：

• JoinChannel[1/3] は、RTC シナリオでチャンネルに参加するための単一パラメーターのメソッドです。トークンベースの認証を使用して単一パラメーター参加用に生成されたトークンを渡す必要があります。RTC シナリオでチャンネルに参加するには、このメソッドを使用することを推奨します。

• JoinChannel[2/3] は、複数のパラメーターでチャンネルに参加するためのものです。トークンベースの認証を使用して生成された複数パラメーターのトークンと、トークンの生成に使用されたユーザー情報を渡す必要があります。

• このメソッドは、AI リアルタイムインタラクションシナリオ用です。単一パラメーターのトークンを渡し、シナリオに基づいてユーザープロパティ capabilityProfile を設定する必要があります。AI エージェントと通信するには、AliCapabilityProfileHuman に設定します。

制限事項

• チャンネルに正常に参加した後、別のチャンネルに参加するには、まず leaveChannel を呼び出して現在のチャンネルを退出する必要があります。<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="15ec544e3985m">OnLeaveChannelResult</a> コールバックを受信した後にのみ、再度チャンネルに参加できます。

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

• 異なる App ID を持つアプリケーションは相互に通信できません。

• チャンネルへの参加に失敗した後のリトライ時にこのメソッドを呼び出さないでください。

関連するコールバック

このメソッドの呼び出しが成功すると、次のコールバックがトリガーされます：

• ローカルユーザーがチャンネルに参加した結果は、<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#7cbf47a35bcel" id="5d109191c950l">OnJoinChannelResult</a> コールバックを通じて提供されます。

• チャンネルに正常に参加した後、リモートクライアントは <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#3333f6e9d344q" id="fa6f8d9357glx">OnRemoteUserOnLineNotify</a> コールバックをトリガーします。

パラメーター

戻り値

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

チャンネルを退出できます。

virtual int LeaveChannel() = 0;

このメソッドを呼び出すと、SDK は音声およびビデオ通話を終了し、現在のチャンネルを退出します。

呼び出すタイミング

• チャンネルを退出するためにこのメソッドを呼び出します。

• 新しいチャンネルに参加する前に、このメソッドを呼び出して現在のチャンネルを退出する必要があります。

関連するコールバック

• このメソッドを呼び出すと、ローカルクライアントで <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="9626ae24d89ue">OnLeaveChannelResult</a> コールバックがトリガーされ、クライアントがチャンネルを正常に退出したかどうかが報告されます。

• リモートユーザー：この API の呼び出しが成功すると、<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#44ce12a0ecj52" id="0dfcab6a6fylt">OnRemoteUserOffLineNotify</a> コールバックがトリガーされます。

レスポンスの説明

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

ユーザーが現在チャンネルに参加しているかどうかを確認します。

virtual bool IsInCall() = 0;

戻り値

true：ユーザーはチャンネルに参加しています。false：ユーザーはチャンネルに参加していません。

ユーザーロールを設定します。

virtual int SetClientRole(const AliEngineClientRole clientRole) = 0;

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

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

• ユーザーロールをストリーマーに設定すると、SDK はデフォルトでローカルの音声およびビデオストリームをパブリッシュし、他のストリーマーの音声およびビデオストリームを受信します。

• ユーザーロールを視聴者に設定すると、SDK はローカルの音声およびビデオストリームをパブリッシュせず、他のストリーマーの音声およびビデオストリームを受信します。

呼び出すタイミング

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

制限事項

このメソッドは、インタラクティブストリームモードでのみ有効です。つまり、<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#901e748242y3g" id="322c3da902jpt">SetChannelProfile</a> メソッドを呼び出し、チャンネルプロファイルを AliEngineInteractiveLive に設定する必要があります。

インタラクティブストリームモードでは、チャンネルに参加する前にこのメソッドを明示的に呼び出してユーザーロールを設定することを推奨します。

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

現在のユーザーロールタイプ (ストリーマーまたは視聴者) を取得します。

virtual AliEngineClientRole GetClientRole() = 0;

戻り値

メソッドの呼び出しが成功した場合、AliEngineClientRole オブジェクトを返します。これは、ロールがストリーマー (0) または視聴者 (1) であることを示す列挙型です。

認証情報を更新します。

virtual int RefreshAuthInfo(const AliEngineAuthInfo &authInfo) = 0;

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

呼び出すタイミング

次の状況で：

• <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#9f8ebe177degw" id="f52a19bb78yoi">OnAuthInfoWillExpire</a> コールバックを受信したとき、これは認証情報がまもなく期限切れになることを示します。サーバーで新しいトークンを再生成し、このメソッドを新しいトークンで呼び出すことを推奨します。

• トークンを時間内に更新しない場合、<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#09c4ec9160eom" id="440c501877fxr">OnAuthInfoExpired</a> コールバックがトリガーされ、認証が期限切れになったことが通知されます。その後、トークンを再生成し、JoinChannel を呼び出してチャンネルに再参加する必要があります。

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

認証情報を更新します。

virtual int RefreshAuthInfo(const char *token) = 0;

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

呼び出すタイミング

次の状況では、サーバーでトークンを再生成し、このメソッドを呼び出して新しいトークンを渡すことを推奨します：

• <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#9f8ebe177degw" id="b21949148djrc">OnAuthInfoWillExpire</a> コールバックを受信したとき、これは認証情報がまもなく期限切れになることを示します。

• トークンが時間内に更新されない場合、<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#09c4ec9160eom" id="62df9bf63786v">OnAuthInfoExpired</a> コールバックがトリガーされ、認証が期限切れになったことが示されます。この場合、JoinChannel を呼び出してチャンネルに再参加する必要があります。

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

ローカルオーディオストリームのパブリッシュを有効または無効にします。

virtual int PublishLocalAudioStream(bool enabled) = 0;

このメソッドは、ローカルで収集されたオーディオストリームをパブリッシュするかどうかを制御します。SDK はデフォルトでオーディオストリームをパブリッシュします。デフォルトでオーディオストリームをパブリッシュしたくない場合は、チャンネルに参加する前に PublishLocalAudioStream(false) を呼び出してオーディオストリームのパブリッシュを無効にすることができます。

呼び出すタイミング

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

関連するコールバック

ローカルオーディオストリームのプッシュ状態が変更されると、ローカルクライアントは <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#eb8fab7f5ak7v" id="c584949653jn5">OnAudioPublishStateChanged</a> コールバックをトリガーして、オーディオストリームのプッシュの最新の状態を報告します。リモートクライアントは <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#ff1f7c8581r3r" id="75f2096b1efxy">OnRemoteTrackAvailableNotify</a> コールバックをトリガーして、リモートユーザーの音声およびビデオストリームの変更を報告します。

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

現在オーディオストリームのパブリッシュが許可されているかどうかを照会します。

virtual bool IsLocalAudioStreamPublished() = 0;

戻り値

true：パブリッシュが許可されています。false：パブリッシュが許可されていません。

デフォルトでリモートオーディオストリームをサブスクライブするかどうかを設定します。

virtual int SetDefaultSubscribeAllRemoteAudioStreams(bool sub) = 0;

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

呼び出すタイミング

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

• チャンネルに参加する前：

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

• チャンネルに参加した後：

  • デフォルトのサブスクリプションを停止したい場合は、<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e51a461de2k9t" id="e95a7e2d6fjwt">SetDefaultSubscribeAllRemoteAudioStreams</a>(false) を呼び出します。これにより、後でチャンネルに参加するユーザーのオーディオストリームはサブスクライブされません。

  • デフォルトのサブスクリプションを停止した後、<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#957e547813q56" id="1a391bcabc66e">SubscribeRemoteAudioStream</a> を呼び出して、特定のユーザーのオーディオストリームのサブスクリプションを再開できます。複数のユーザーのサブスクリプションを再開したい場合は、このメソッドを複数回呼び出す必要があります。

  • デフォルトのサブスクリプションを停止した後、<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e51a461de2k9t" id="e79b5ad58awcw">SetDefaultSubscribeAllRemoteAudioStreams</a>(true) を呼び出すと、後続でチャンネルに参加するユーザーのオーディオストリームのみがサブスクライブされます。サブスクリプションが停止している間に参加したリモートユーザーのストリームはサブスクライブされません。

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

特定のリモートユーザーのオーディオストリームのサブスクリプションを停止または再開します。

virtual int SubscribeRemoteAudioStream(const char* uid, bool sub) = 0;

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

パラメーター

レスポンスの説明

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual int SubscribeAllRemoteAudioStreams(bool sub) = 0;

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

• 現在のチャンネル内のすべてのリモートオーディオストリームのサブスクリプションが停止します。

• 後で参加するユーザーもサブスクライブされません。

• <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#957e547813q56" id="aface4ad3920l">SubscribeRemoteAudioStream</a> を使用して特定のユーザーのオーディオストリームを制御することはできません。

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

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

カメラストリームをパブリッシュまたはパブリッシュを停止します。

virtual int PublishLocalVideoStream(bool enabled) = 0;

このメソッドは、ローカルで収集されたビデオストリームをパブリッシュするかどうかを制御します。

呼び出すタイミング

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

チャンネルに参加する前に呼び出すと、デフォルトの構成が変更され、チャンネルに参加したときに有効になります。

関連するコールバック

ローカルオーディオストリームのプッシュ状態が変更されると、ローカルクライアントは <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#6bf4efbd1cadl" id="d37709b09147d">OnVideoPublishStateChanged</a> コールバックをトリガーして新しいオーディオストリームのプッシュステータスを報告し、リモートクライアントは <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#ff1f7c8581r3r" id="f16e4b51bchqb">OnRemoteTrackAvailableNotify</a> コールバックをトリガーしてリモートユーザーの音声およびビデオストリームの変更を報告します。

パラメーター

戻り値

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

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

ビデオストリームの送信を有効または無効にします。

virtual int PublishLocalVideoStream(bool enabled, AliEngineVideoTrack track) = 0;

このメソッドは、ローカルで収集されたビデオストリームをパブリッシュするかどうかを制御します。

呼び出すタイミング

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

チャンネルに参加する前に呼び出すと、デフォルトの構成が変更され、チャンネルに参加したときに有効になります。

関連するコールバック

ローカルビデオストリームのプッシュ状態が変更されると、ローカルクライアントは <a baseurl="t2713962_v5_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#6bf4efbd1cadl" id="18a9d4b47ezcc">OnVideoPublishStateChanged</a> コールバックをトリガーしてビデオストリームのプッシュの最新の状態を報告します。リモートクライアントは <a baseurl="t2713962_v5_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#ff1f7c8581r3r" id="d01e7a574f92o">OnRemoteTrackAvailableNotify</a> コールバックをトリガーして、リモートユーザーの音声およびビデオストリームが変更されたことを通知します。

パラメーター

戻り値

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

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

現在ビデオストリームのパブリッシュが許可されているかどうかを照会します。

virtual bool IsLocalVideoStreamPublished() = 0;

戻り値

true：カメラストリームはパブリッシュされます。false：カメラストリームはパブリッシュされません。

デフォルトでビデオストリームを受信するかどうかを設定します。

virtual int SetDefaultSubscribeAllRemoteVideoStreams(bool sub) = 0;

このメソッドは、デフォルトでビデオストリームをサブスクライブするかどうかを設定します。SDK はデフォルトでサブスクライブします。

呼び出すタイミング

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

• チャンネルに参加する前：

  • このメソッドを使用して、デフォルトのサブスクリプション設定をキャンセルできます。

• チャンネルに参加した後：

  • デフォルトのサブスクリプションを停止するには、SetDefaultSubscribeAllRemoteVideoStreams(false) を呼び出します。これにより、後続でチャンネルに参加するユーザーのビデオストリームのサブスクリプションが防止されます。

  • デフォルトのサブスクリプションを停止した後、特定のユーザーのビデオストリームのサブスクリプションを再開したい場合は、SubscribeRemoteVideoStream メソッドを呼び出します。複数のユーザーのサブスクリプションを再開するには、複数回呼び出す必要があります。

  • デフォルトのサブスクリプションが停止された後、SetDefaultSubscribeAllRemoteVideoStreams(false) を呼び出すと、後でチャンネルに参加するユーザーのオーディオストリームのみが再開されます。

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

リモートユーザーのビデオストリームのサブスクライブを停止または再開します。

virtual int SubscribeRemoteVideoStream(const char* uid, AliEngineVideoTrack track, bool sub) = 0;

このメソッドは、特定のユーザーのビデオストリームをサブスクライブまたはサブスクライブ解除します。

呼び出すタイミング

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

パラメーター

戻り値

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

• false：設定は失敗しました。

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

virtual int SubscribeAllRemoteVideoStreams(bool sub) = 0;

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

• 現在のチャンネル内のすべてのリモートビデオストリームのサブスクリプションが停止します。

• デフォルトでサブスクライブするように <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#2cbc54790brn3" id="b7b0080f3cnoq">SetDefaultSubscribeAllRemoteVideoStreams</a>(true) を呼び出した場合でも、後でチャンネルに参加する新しいユーザーからのビデオストリームはサブスクライブされません。

• <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#jyGTp" id="0e2edf97aa1g6">SubscribeRemoteVideoStream</a> を使用して、指定されたユーザーのオーディオストリームを個別に制御することはできません。

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

パラメーター

レスポンスの説明

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual int SubscribeRemoteMediaStream(const char* uid, AliEngineVideoTrack videoTrack, bool subVideo,  bool subAudio) = 0;

このメソッドは、リモートの音声およびビデオストリームを一緒にサブスクライブします。

関連メソッド

SubscribeRemoteMediaStream[2/2] と比較して、このメソッドは 2 つのブール値パラメーター subVideo と subAudio を使用して、リモートの音声およびビデオストリームをサブスクライブするかどうかを決定します。videoTrack パラメーターは、どのビデオストリームをプルするかを制御します。

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual int SubscribeRemoteMediaStream(const char* uid, AliEngineVideoTrack videoTrack, AliEngineAudioTrack audioTrack) = 0;

このメソッドは、リモートの音声およびビデオストリームを一緒にサブスクライブします。

関連メソッド

SubscribeRemoteMediaStream[1/2] と比較して、このメソッドは videoTrack と audioTrack パラメーターを使用して、1 回の呼び出しで SDK に目的のサブスクリプション状態を通知します。例：

• カメラストリームとマイクストリームをサブスクライブするには、メソッドを呼び出すときに videoTrack と audioTrack をそれぞれ AliRtcVideoTrackCamera と AliRtcAudioTrackMic に設定します。

• カメラストリームのサブスクライブを解除し、マイクストリームを維持するには、メソッドを再度呼び出し、videoTrack と audioTrack をそれぞれ AliRtcVideoTrackNo と AliRtcAudioTrackMic に設定します。

• 両方のサブスクリプションをキャンセルするには、メソッドを再度呼び出し、videoTrack と audioTrack をそれぞれ AliRtcVideoTrackNo と AliRtcAudioTrackNo に設定します。

• カメラストリームと画面共有ストリームの両方を同時にサブスクライブするには、videoTrack を AliRtcVideoTrackBoth に設定します。オーディオも同様です。

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual int SubscribeRemoteDestChannelStream(const char* channelId, const char* uid, AliEngineVideoTrack track, bool sub_audio, bool sub) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

指定されたリモートユーザーの再生音量を調整します。

virtual int SetRemoteAudioVolume(const char *uid, int volume) = 0;

パラメーター

戻り値

• 0：成功。

• 0 以外の値：失敗。

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

virtual int MuteLocalMic(bool mute, AliEngineMuteLocalAudioMode mode = AliEngineMuteLocalAudioModeDefault) = 0;

呼び出すタイミング

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

関連するコールバック

呼び出しが成功した後、リモートクライアントで <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#a15f0a6cf6id7" id="f4ae88f094vqy">OnUserAudioMuted</a> コールバックがトリガーされ、ユーザーがミュートされているかどうかが示されます。

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

リモートオーディオの再生を停止または再開します。

virtual int MuteRemoteAudio(const char *uid,
                                    bool mute) = 0;

この API は、指定されたリモートユーザーのオーディオ再生を停止または再開するためにのみ使用されます。リモートオーディオのストリームプルやデコードには影響しません。ユーザーのオーディオストリームのサブスクリプションを解除するには、<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#957e547813q56" id="89841a0989t7y">SubscribeRemoteAudioStream</a> を呼び出します。

呼び出すタイミング

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

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

すべてのリモートユーザーのオーディオトラックの再生を停止または再開します。

virtual int MuteAllRemoteAudio(bool mute) = 0;

このメソッドを使用して、すべてのリモートオーディオ再生を停止または再開します。

呼び出すタイミング

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

パラメーター

戻り値

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

音声収集を開始します。

virtual int StartAudioCapture() = 0;

このメソッドは音声収集を開始します。チャンネルに参加する前に呼び出して、事前に音声収集を開始することもできます。設定されていない場合、SDK は自動的に音声収集デバイスを制御します。stopAudioCapture を呼び出して停止した音声収集を再開するには、このメソッドを呼び出します。

呼び出すタイミング

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

関連メソッド

• StartAudioCapture[2/2] メソッドは、パラメーターを使用して、チャンネルを退出した後に音声収集デバイスをオンのままにするかどうかを制御できます。

関連するコールバック

このメソッドを呼び出してローカルの音声収集状態を変更した後、OnLocalAudioStateChange コールバックを通じて状態の変更を取得できます。

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

音声収集を開始します。

virtual int StartAudioCapture(bool keepAlive) = 0;

ミュート後にマイクの音声キャプチャを停止します。

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

呼び出すタイミング

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

関連メソッド

StartAudioCapture[1/2] と比較して、このメソッドでは keepAlive パラメーターを使用して、チャンネルを退出した後に収集デバイスをオンのままにするかどうかを制御できます。

関連するコールバック

このメソッドを呼び出してローカルの音声収集状態を変更した後、OnLocalAudioStateChange コールバックを通じて状態の変更を取得できます。

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

音声収集を停止します。

virtual int StopAudioCapture() = 0;

StartAudioCapture でオーディオデバイスの収集を開始した後、このメソッドを呼び出して停止できます。

関連するコールバック

このメソッドを呼び出してローカルの音声収集状態を変更した後、OnLocalAudioStateChange コールバックを通じて状態の変更を取得できます。

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

音量コールバックの頻度と平滑化係数を設定します。

virtual int EnableAudioVolumeIndication(int interval, int smooth, int reportVad) = 0;

このメソッドにより、SDK はローカルのパブリッシュユーザーと、瞬間的な音量が最も高いリモートユーザーに関する音量関連情報を定期的にアプリケーションに報告できます。

呼び出すタイミング

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

関連するコールバック

このメソッドの呼び出しが成功した後、チャンネルにパブリッシュしているユーザーがいる場合、SDK は設定された時間間隔で次の 2 つのコールバックをトリガーします：

• スピーカーの音量は、OnAudioVolumeCallback コールバックを通じて報告されます。コールバックの頻度は `interval` パラメーターによって決まります。

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

呼び出すタイミング

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

パラメーター

レスポンスの説明

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

オーディオ再生デバイスを開始します。

virtual int StartAudioPlayer() = 0;

このメソッドは、事前にオーディオ再生を開始できます。設定されていない場合、SDK はオーディオストリームをサブスクライブした後に自動的にオーディオ再生を開始します。

戻り値

• 0：成功。

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

オーディオ再生を停止します。

virtual int StopAudioPlayer() = 0;

このメソッドはオーディオ再生を停止できます。AliEngine::StartAudioPlayer に対応します。

パラメーター

なし。

戻り値

• 0：成功。

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

再生音量を設定します。

virtual int SetPlayoutVolume(int volume) = 0;

パラメーター

戻り値

• 0：成功。

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

virtual int SetRecordingVolume(int volume) = 0;

パラメーター

レスポンスの説明

• 0：成功。

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

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

virtual int PlayAudioFileTest(const char* filePath) = 0;

パラメーター

戻り値

• 0：成功。

• <0：失敗。

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

virtual int StopAudioFileTest() = 0;

戻り値

• 0：成功。

• <0：失敗。

通話前に音声収集テストを開始します。

virtual int StartAudioCaptureTest() = 0;

このメソッドは音声収集テストを開始できます。AliEngineEventListener::OnTestAudioVolumeCallback コールバックの結果を使用して、音声収集が正常かどうかを判断できます。

戻り値

• 0：成功。

• <0：失敗。

音声収集テストを停止します。

virtual int StopAudioCaptureTest() = 0;

戻り値

• 0：成功。

• <0：失敗。

システム音声の収集とパブリッシュを有効または無効にします。

virtual int EnableSystemAudioRecording(bool enable, const char *path = nullptr, const char *device_id = nullptr) = 0;

このメソッドは、ブラウザやアプリケーションで再生されるサウンドなど、システムオーディオの収集を有効または無効にします。

パラメーター

戻り値

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

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

現在、システムオーディオの収集とパブリッシュが有効になっているかどうかを確認します。

virtual bool IsSystemAudioRecording() = 0;

戻り値

• true：有効。

• false：無効。

システムオーディオの収集とパブリッシュの音量を設定します。

virtual int SetSystemAudioRecordingVolume(int volume) = 0;

このメソッドは Windows と macOS プラットフォームでのみ有効です。

このメソッドは、システムオーディオの収集とパブリッシュが有効になった後にのみ設定できます。それ以外の場合、設定は無効です。

パラメーター

戻り値

• 0：成功。

• <0：失敗。

現在のシステムオーディオの収集とパブリッシュの音量を取得します。

virtual int GetSystemAudioRecordingVolume() = 0;

このメソッドは Windows と macOS プラットフォームでのみ有効です。

戻り値

システムコレクションの公開ボリューム。

システム音声の再生音量を設定します。

virtual int SetSystemAudioPlayoutVolume(int volume) = 0;

このメソッドは Windows と macOS プラットフォームでのみ有効です。

このメソッドは、システムオーディオの収集とパブリッシュが有効になった後にのみ設定できます。それ以外の場合、設定は無効です。

パラメーター

戻り値

• 0：成功。

• <0：失敗。

現在のシステムオーディオの再生音量を取得します。

virtual int GetSystemAudioPlayoutVolume() = 0;

このメソッドは Windows と macOS プラットフォームでのみ有効です。

戻り値

システムは再生ボリュームを管理します。

システム内の録音デバイスのリストを取得します。

virtual AliEngineDeviceInfoList* GetAudioCaptureList() = 0;

戻り値

録音デバイスのリストへのポインター、AliEngineDeviceInfoList *。

使用中の録音デバイスの名前を取得します。

virtual String GetCurrentAudioCaptureName() = 0;

戻り値

現在の音声収集デバイスの名前。

使用中の録音デバイスの ID を取得します。

virtual String GetCurrentAudioCaptureID() = 0;

戻り値

現在使用中の録音デバイスの ID。

名前で録音デバイスを選択します。

virtual int SetCurrentAudioCaptureName(const char* captureName) = 0;

パラメーター

戻り値

成功の場合は 0、失敗の場合はその他の値。

ID で録音デバイスを選択します。

virtual int SetCurrentAudioCaptureID(const char* captureID) = 0;

パラメーター

戻り値

成功の場合は 0、失敗の場合はその他の値。

システム内のスピーカーのリストを取得します。

virtual AliEngineDeviceInfoList* GetAudioPlayerList() = 0;

戻り値

システム内のスピーカーのリストへのポインター、AliEngineDeviceInfoList *。

システム内の録音可能なスピーカーのリストを取得します (システム内録音用)。

virtual AliEngineDeviceInfoList* GetSystemRecordAudioPlayerList() = 0;

戻り値

オーディオ再生デバイスリストは、主に EnableSystemAudioRecording の最後のパラメーターとして使用され、システム再生オーディオを収集します。

現在使用中のスピーカーの名前を取得します。

virtual String GetCurrentAudioPlayerName() = 0;

戻り値

現在のオーディオ再生デバイスの名前。

現在使用中のスピーカーの ID を取得します。

virtual String GetCurrentAudioPlayerID() = 0;

戻り値

現在のオーディオ再生デバイスの ID。

名前でスピーカーを選択します。

virtual int SetCurrentAudioPlayerName(const char* playerName) = 0;

戻り値

オーディオ再生デバイス名。

ID でスピーカーを選択します。

virtual int SetCurrentAudioPlayerID(const char* playerID) = 0;

パラメーター

戻り値

成功の場合は 0、失敗の場合はその他の値。

音声収集デバイスの音量を設定します。音量範囲は [0, 100] です。

virtual int SetRecordingDeviceVolume(int volume) = 0;

パラメーターリスト

戻り値

成功の場合は 0、失敗の場合はその他の値。

音声収集デバイスの音量を取得します。

virtual int GetRecordingDeviceVolume() = 0;

戻り値

>=0 は音量を返します。その他の値は失敗を示します。

オーディオ再生デバイスの音量を設定します。音量範囲は [0, 100] です。

virtual int SetPlaybackDeviceVolume(int volume) = 0;

パラメーター

戻り値

成功の場合は 0、失敗の場合はその他の値。

オーディオ再生デバイスの音量を取得します。

virtual int GetPlaybackDeviceVolume() = 0;

戻り値

システムボリュームの場合は >=0。失敗の場合はその他の値。

音声収集デバイスをミュートします。

virtual int SetRecordingDeviceMute(bool mute) = 0;

パラメーター

戻り値

成功の場合は 0、失敗の場合はその他の値。

音声収集デバイスのミュート状態を取得します。

virtual bool GetRecordingDeviceMute() = 0;

戻り値

録音がミュートされているかどうか。

オーディオ再生デバイスをミュートします。

virtual int SetPlaybackDeviceMute(bool mute) = 0;

パラメーター

戻り値

成功の場合は 0、失敗の場合はその他の値。

オーディオ再生デバイスのミュート状態を取得します。

virtual bool GetPlaybackDeviceMute() = 0;

戻り値

再生デバイスがミュートされているかどうか。

ボイスチェンジエフェクトモードを設定します。

virtual int SetAudioEffectVoiceChangerMode(const AliEngineAudioEffectVoiceChangerMode &mode) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

ピッチパラメーターを設定します。

virtual int SetAudioEffectPitchValue(double value) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

リバーブエフェクトモードを設定します。

virtual int SetAudioEffectReverbMode(const AliEngineAudioEffectReverbMode& mode) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

リバーブエフェクトのタイプと特定のパラメーターを設定します。

virtual int SetAudioEffectReverbParamType(const AliEngineAudioEffectReverbParamType& type,
                                                  float value) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

プリセットの美声エフェクトモードを設定します。

virtual int SetAudioEffectBeautifyMode(const AliEngineAudioEffectBeautifyMode& mode) = 0;

このメソッドは、SDK 内のプリセットの美声モードを設定します。音声ライブストリーミング、カラオケ、音声ソーシャルネットワーキングなど、人の声の質を美しくする必要があるシナリオに適しています。さまざまな美声モードを選択することで、人の声の聴覚効果を変更できます。たとえば、磁性を高めたり、明瞭度を向上させたりできます。これにより、リモートユーザーのリスニング体験が向上します。

呼び出すタイミング

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

パラメーター

戻り値

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

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

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

virtual int SetAudioEffectEqualizationParam(const AliEngineAudioEffectEqualizationBandFrequency &bandIndex, float gain) = 0;

このメソッドは、グラフィックイコライザーを使用して、ローカルで収集された人の声またはオーディオ信号を調整します。10 の固定周波数帯のいずれかのゲイン (dB) を調整することで、音色をカスタマイズできます。音声の明瞭度の最適化、人の声の強調、ノイズリダクションの補助などのシナリオに適しています。

イコライザーは、31 Hz から 16 kHz までの全オーディオスペクトルの調整をサポートし、合計 10 の標準周波数帯があります。各帯域のゲイン値は個別に設定でき、範囲は [-15, 15] dB で、デフォルトは 0 dB (強調も減衰もなし) です。

制限事項

• イコライザーは、美声モードが有効になる前に単独で使用することはできません。このメソッドは、setAudioEffectBeautifyMode を呼び出した後に呼び出す必要があります。

パラメーター

レスポンスの説明

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

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

外部オーディオストリームを追加します。

virtual int AddExternalAudioStream(const AliEngineExternalAudioStreamConfig& config) = 0;

このメソッドは、新しい外部オーディオストリームを追加します。手順は次のとおりです：

1. <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#991b862eb353w" id="08ee3d1ed35jj">AddExternalAudioStream</a> を呼び出して外部オーディオストリームを追加し、外部オーディオストリーム ID を取得します。

2. <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e6cf3f7cef0g6" id="fae817d0f00p3">PushExternalAudioStreamRawData</a> を呼び出して、作成されたオーディオストリームにオーディオデータをプッシュします。

3. 通話が終了したら、<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#u27oe" id="3b9a3eb119umh">RemoveExternalAudioStream</a> を呼び出して外部オーディオストリームを削除する必要があります。

チャンネルでカスタム収集されたオーディオをパブリッシュする方法の詳細については、「カスタムオーディオ収集」をご参照ください。

パラメーター

戻り値

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

外部オーディオストリームデータを入力します。

virtual int PushExternalAudioStreamRawData(int streamId, AliEngineAudioRawData& data) = 0;

このメソッドは、指定されたオーディオストリームにデータを渡します。手順は次のとおりです：

1. <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#991b862eb353w" id="3836ac109732c">AddExternalAudioStream</a> API を呼び出して外部オーディオストリームを追加し、外部オーディオストリーム ID を取得します。

2. PushExternalAudioStreamRawData を呼び出して、作成されたオーディオストリームにオーディオデータを渡します。

3. 通話が終了したら、<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#u27oe" id="398ea88d61fn0">RemoveExternalAudioStream</a> を呼び出して外部オーディオストリームを削除する必要があります。

チャンネルでカスタム収集されたオーディオをパブリッシュする方法の詳細については、「カスタムオーディオ収集」をご参照ください。

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

外部オーディオストリームのパブリッシュ音量を設定します。

virtual int SetExternalAudioStreamPublishVolume(int streamId, int vol) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

外部オーディオストリームのパブリッシュ音量を設定します。

virtual int SetExternalAudioStreamPlayoutVolume(int streamId, int vol) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

外部オーディオストリームのパブリッシュ音量を取得します。

virtual int GetExternalAudioStreamPublishVolume(int streamId) = 0;

パラメーター

戻り値

[0, 100]：パブリッシュ音量。0 未満の値は失敗を示します。

外部オーディオストリームの再生音量を取得します。

virtual int GetExternalAudioStreamPlayoutVolume(int streamId) = 0;

パラメーター

戻り値

[0, 100]：再生音量。0 未満の値は失敗を示します。

外部オーディオストリームを削除します。

virtual int RemoveExternalAudioStream(int streamId) = 0;

このメソッドは、渡された streamId に基づいて対応する外部オーディオストリームを削除します。これは AddExternalAudioStream メソッドに対応します。

呼び出すタイミング

カスタムオーディオ入力機能を使用したい場合は、AddExternalAudioStream メソッドを呼び出してオーディオストリームを追加し、外部オーディオストリーム ID を取得する必要があります。その後、<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e6cf3f7cef0g6" id="bdab74f108i1p">PushExternalAudioStreamRawData</a> インターフェイスを呼び出してオーディオデータを SDK に入力できます。カスタムオーディオ入力を停止したい場合は、このインターフェイスを呼び出して対応する外部オーディオストリームを削除し、リソースをクリーンアップします。

パラメーター

戻り値

成功の場合は 0、失敗の場合はその他の値。

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

virtual int GetAudioFileInfo(const char *filePath) = 0;

これは非同期メソッドです。AliEngineEventListener::OnAudioFileInfo を通じてオーディオファイル情報を取得できます。

パラメーター

戻り値

• 0：成功。

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

伴奏のオーディオミキシングを開始します。

virtual int StartAudioAccompany(const char *filePath, const AliEngineAudioAccompanyConfig& config) = 0;

これは非同期メソッドです。AliEngineEventListener::OnAudioAccompanyStateChanged を通じてオーディオ伴奏プレーヤーの状態をリッスンできます。

パラメーター

戻り値

• 0：成功。

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

伴奏のオーディオミキシングを停止します。

virtual int StopAudioAccompany() = 0;

戻り値

• 0：成功。

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

伴奏の音量を設定します。

 virtual int SetAudioAccompanyVolume(int volume) = 0;

パラメーター

戻り値

• 0：成功。

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

伴奏のパブリッシュ音量を設定します。

virtual int SetAudioAccompanyPublishVolume(int volume) = 0;

パラメーター

戻り値

• 0：成功。

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

伴奏のパブリッシュ音量を取得します。

virtual int GetAudioAccompanyPublishVolume() = 0;

戻り値

伴奏のパブリッシュ音量。範囲は [0-100] です。

伴奏のローカル再生音量を設定します。

virtual int SetAudioAccompanyPlayoutVolume(int volume) = 0;

パラメーター

戻り値

• 0：成功。

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

伴奏のローカル再生音量を取得します。

virtual int GetAudioAccompanyPlayoutVolume() = 0;

戻り値

伴奏のローカル再生音量。範囲は [0-100] です。

伴奏のオーディオミキシングを一時停止します。

virtual int PauseAudioAccompany() = 0;

レスポンスの説明

• 0：成功。

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

伴奏のオーディオミキシングを再開します。

virtual int ResumeAudioAccompany() = 0;

レスポンスの説明

• 0：成功。

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

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

virtual int GetAudioAccompanyDuration() = 0;

レスポンスの説明

オーディオ伴奏ファイルの長さをミリ秒単位で返します。

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

virtual int GetAudioAccompanyCurrentPosition() = 0;

戻り値

オーディオ伴奏ファイルの現在の再生位置をミリ秒単位で返します。

伴奏ファイルの再生位置を設定します。

virtual int SetAudioAccompanyPosition(int pos) = 0;

レスポンスの説明

• 0：成功。

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

効果音ファイルをプリロードします。

virtual int PreloadAudioEffect(unsigned int soundId,
                                       const char *filePath) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual int UnloadAudioEffect(unsigned int soundId) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual int PlayAudioEffect(unsigned int soundId, const char *filePath, const AliEngineAudioEffectConfig& config) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual int StopAudioEffect(unsigned int soundId) = 0;

パラメーター

戻り値

0: メソッドの呼び出しは成功。その他の値: メソッドの呼び出しは失敗。

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

- (int)StopAllAudioEffects;

戻り値

0：メソッドの呼び出しは成功です。その他の値：メソッドの呼び出しは失敗です。

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

virtual int PauseAudioEffect(unsigned int soundId) = 0;

パラメーター

レスポンスの説明

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual int PauseAllAudioEffects() = 0;

レスポンスの説明

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual int ResumeAudioEffect(unsigned int soundId) = 0;

パラメーター

レスポンスの説明

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual int ResumeAllAudioEffects() = 0;

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

効果音のパブリッシュ音量を設定します。

virtual int SetAudioEffectPublishVolume(unsigned int soundId, int volume) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

効果音のパブリッシュ音量を取得します。

virtual int GetAudioEffectPublishVolume(unsigned int soundId) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

すべての効果音のローカル再生音量を設定します。

virtual int SetAllAudioEffectsPublishVolume(int volume) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

効果音のローカル再生音量を設定します。

virtual int SetAudioEffectPlayoutVolume(unsigned int soundId, int volume) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

効果音のローカル再生音量を取得します。

virtual int GetAudioEffectPlayoutVolume(unsigned int soundId) = 0;

パラメーター

レスポンスの説明

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

すべての効果音の再生音量を設定します。

virtual int SetAllAudioEffectsPlayoutVolume(int volume) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

すべての効果音のパブリッシュ音量を設定します。

virtual int SetAllAudioEffectsPublishVolume(int volume) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual int SetLocalViewConfig(AliEngineVideoCanvas renderConfig,
                                         AliEngineVideoTrack track) = 0;

このメソッドは、ローカルプレビュービューを設定します。ローカルビデオストリームの表示ビューをバインドし、ローカルユーザーのビューのレンダリングモード、ミラーモード、回転角度を設定します。これはローカルユーザーのプレビューにのみ影響し、パブリッシュされたビデオには影響しません。リモートユーザーのビューを設定するには、SetRemoteViewConfig を呼び出します。

呼び出すタイミング

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

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

カメラ収集のプリファレンスを設定します。

virtual int SetCameraCapturerConfiguration(const AliEngineCameraCapturerConfiguration& config) = 0;

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

呼び出すタイミング

これはカメラを開く前に設定する必要があります。たとえば、次の操作の前に呼び出します：

• StartPreview (プレビューを開始)

• JoinChannel (チャンネルに参加)

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

ローカルビデオ収集を無効または再度有効にします。

virtual int EnableLocalVideo(bool enabled) = 0;

このメソッドは、ローカルビデオ収集の有効化と無効化を制御します。ローカルビデオ収集が無効になっている場合、ローカルプレビューとパブリッシュされたストリームの両方にビデオデータはありませんが、これはリモートビデオの受信には影響しません。このメソッドを呼び出してローカルカメラ収集を無効にすると、ローカルプレビューとリモートパブリッシュされたストリームの両方が最後のフレームで停止します。

呼び出すタイミング

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

関連するコールバック

このメソッドの呼び出しが成功した後、OnUserVideoEnabled コールバックがリモートユーザーに通知します。

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual int MuteLocalCamera(bool mute, AliEngineVideoTrack track) = 0;

ストリームをパブリッシュするときに、このメソッドを呼び出してオールブラックのビデオフレームをパブリッシュできます。ローカルプレビューは正常に表示され、収集、エンコーディング、送信モジュールは引き続き動作しますが、ビデオコンテンツはブラックフレームで構成されます。

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

リモートビデオのレンダリングウィンドウと描画パラメーターを設定します。

virtual int SetRemoteViewConfig(AliEngineVideoCanvas renderConfig,
                                          const char *uid,
                                          AliEngineVideoTrack track) = 0;

このメソッドは、リモートユーザーからの指定されたビデオストリームの表示ビューをアタッチし、レンダリングモード、ミラーモード、回転角度など、リモートビューのローカル表示のプロパティを設定します。このアクションは、ローカルユーザーが見るビデオ画像にのみ影響します。ローカルプレビュービューを設定するには、<a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#fbc8ab10f5e03" id="c0f59b8c26y7o">SetLocalViewConfig</a> を呼び出します。

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

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

• 再生中に AliEngineVideoCanvas の mirrorMode パラメーターをリセットするには、他のパラメーターを変更せずに mirrorMode のみを変更します。

呼び出すタイミング

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

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual bool IsCameraOn() = 0;

戻り値

true：カメラはオンです。false：カメラはオンではありません。

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

virtual void SetVideoEncoderConfiguration(const AliEngineVideoEncoderConfiguration& config) = 0;

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

呼び出すタイミング

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

制限事項

このメソッドの `mirrorMode` と setVideoMirrorMode は両方ともビデオパブリッシュミラーを設定できます。どちらか一方のみを使用することを推奨します。複数のメソッドを同時に使用すると、ミラー効果が重なり、ミラー設定が失敗したり、正しくなくなったりする可能性があります。

パラメーター

ビデオデコーディングプロパティを設定します。このメソッドは、ソフトウェアおよびハードウェアデコーディング設定や B フレームを有効にするかどうかなど、カメラストリームのビデオデコーディングプロパティを設定します。

virtual void SetVideoDecoderConfiguration(const AliEngineVideoDecoderConfiguration& config) = 0;

呼び出すタイミング

チャンネルに参加してストリームをプルする前にこれを呼び出すことを推奨します。

パラメーター

ローカルプレビューを開始し、自動的にカメラをオンにします。

virtual int StartPreview(int width = 0, int height = 0) = 0;

このメソッドはローカルビデオプレビューを開始し、自動的にカメラをオンにします。ローカルプレビューを停止するには、StopPreview メソッドを呼び出します。

呼び出すタイミング

• このメソッドを呼び出す前に、SetLocalViewConfig を通じてローカルプレビューのビューを設定する必要があります。そうしないと、ビデオをプレビューできませんが、パブリッシュには影響しません。

• 必要に応じて、JoinChannel でチャンネルに参加する前にこのメソッドを呼び出してプレビューを開始し、カメラを自動的にオンにすることができます。

レスポンスの説明

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual int StopPreview() = 0;

このメソッドはローカルビデオプレビューを閉じ、カメラをオフにします。プレビューを停止した後、ローカルエンドは最後のフレームで停止しますが、パブリッシュには影響しません。

呼び出すタイミング

プレビューを開始した後に停止するには、このメソッドを呼び出すことができます。

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

プレビューとパブリッシュのミラー機能を設定します。

virtual int setVideoMirrorMode(AliEngineVideoPipelineMirrorMode mirrorMode) = 0;

このメソッドは、ローカルプレビュービデオとパブリッシュされたビデオストリームにミラーモードを有効にするかどうかを設定します。

呼び出すタイミング

このメソッドは、チャンネルに参加する前後で動的に設定できます。SDK は状態を記録し、プレビューとエンコーディング (パブリッシュ) が操作可能になったときにビデオを操作します。

制限事項

このメソッドは、SetLocalViewConfig と SetVideoEncoderConfiguration の mirrorMode パラメーターと重複します。このメソッドのみを使用することを推奨します。

パラメーター

戻り値

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

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

  • AliRtcErrInner：内部 SDK 状態エラー。SDK インスタンスが正常に作成されたかどうかを確認してください。

収集スケーリングのタイミングを設定します。ビデオデータは、収集直後またはエンコーディング中にスケーリングされます。

virtual void SetCapturePipelineScaleMode(const AliEngineCapturePipelineScaleMode mode) = 0;

このメソッドは、ビデオデータ収集のスケーリングが収集直後に行われるか、エンコーディング中に行われるかを設定します。たとえば、収集解像度がエンコーディング解像度と一致しない場合、スケーリングのタイミングを設定して、プレビューデータとパブリッシュされたデータが一致するかどうかを決定できます。

呼び出すタイミング

このメソッドは、カメラを開く前に設定する必要があります。たとえば、StartPreview でプレビューを開始する前、または JoinChannel でチャンネルに参加する前です。

パラメーター

カメラリストを取得します。

virtual AliEngineDeviceInfoList* GetCameraList() = 0;

戻り値

カメラリストオブジェクトへのポインター、AliEngineDeviceInfoList*。

現在使用中のカメラの名前を取得します。

virtual String GetCurrentCameraName() = 0;

戻り値

現在使用中のカメラデバイスの名前。

現在使用中のカメラの ID を取得します。

virtual String GetCurrentCameraID() = 0;

戻り値

現在使用中のカメラの ID。

名前でカメラを選択します。

virtual int SetCurrentCameraName(const char* cameraName) = 0;

パラメーター

戻り値

成功の場合は 0、失敗の場合はその他の値。

ID でカメラを選択します。

virtual int SetCurrentCameraID(const char* cameraID) = 0;

パラメーター

戻り値

成功の場合は 0、失敗の場合はその他の値。

サポートされている解像度を取得します。

virtual AliEngineVideoResolutionList * GetCurrentCameraSupportedResolutionList(int source) = 0 ;

パラメーター

戻り値

値が NULL でない場合、サポートされている解像度のリストを取得します。NULL は失敗を示します。

外部ビデオ入力ソースを有効にします。

virtual int SetExternalVideoSource(bool enable,
        AliEngineVideoTrack type,
        AliEngineRenderMode renderMode) = 0;

パラメーター

ビデオデータを入力します。

virtual int PushExternalVideoFrame(const AliEngineVideoRawData &frame,
        AliEngineVideoTrack type) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual int StartPublishLiveStream(const String& streamURL, const AliEngineLiveTranscodingParam &transcoding) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

更新はライブストリームパラメーターをバイパスします。

virtual int UpdatePublishLiveStream(const String& streamURL, const AliEngineLiveTranscodingParam &transcoding) = 0;

パラメーター

戻り値

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual int StopPublishLiveStream(const String& streamURL) = 0;

パラメーター

レスポンスの説明

0：メソッドの呼び出しは成功しました。その他の値：メソッドの呼び出しは失敗しました。

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

virtual AliEngineLiveTranscodingState GetPublishLiveStreamState(const String& streamURL) = 0;

パラメーター

レスポンスの説明

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

ネットワーク品質検出を開始します。一部のオンプレミスネットワークの問題により、音声およびビデオ通話が失敗する可能性があります。このメソッドを呼び出すことで、上りおよび下りネットワーク帯域幅、パケット損失率、ジッター、リンク RTT などの情報を取得して、関連するネットワーク問題の特定と解決に役立てることができます。

 virtual int StartLastmileDetect(bool uplink, bool downlink, int uplinkBandWidth, int downlinkBandWidth) = 0;

呼び出すタイミング

このメソッドは JoinChannel の前に呼び出す必要があります。検出結果はコールバックを通じて提供されます。ネットワーク検出には時間がかかる場合があります。必要に応じて StopLastmileDetect を呼び出してネットワーク検出を停止できます。

制限事項

SDK は一度に 1 つのネットワーク検出しか実行できません。前回の検出が完了する前に繰り返し呼び出しても無効です。

関連するコールバック

このメソッドの呼び出しが成功すると、2 つのコールバックがトリガーされます：

• OnLastmileDetectResultWithQuality：このコールバックは約 3 秒でトリガーされ、ネットワーク品質レベルを大まかに判断します。

• OnLastmileDetectResultWithBandWidth：このコールバックは約 30 秒でトリガーされ、詳細な検出結果を提供します。

パラメーター

戻り値

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

• <0：メソッドの呼び出しは失敗しました。たとえば、すでにチャンネルに参加している場合に発生する可能性があります。

ネットワーク品質検出を停止します。このメソッドを呼び出してネットワーク品質検出を停止します。

virtual int StopLastmileDetect() = 0;

呼び出すタイミング

エンジンを作成した後、チャンネルに参加する前にこのメソッドを呼び出すことができます。

戻り値

• 0：このメソッドは正常に呼び出されました。

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

メディア拡張情報を送信します。これは内部的に SEI を使用して実装されます。

virtual int SendMediaExtensionMsg(const int8_t * message, uint32_t length, int32_t repeatCount, uint32_t delay, bool isKeyFrame) = 0;

SDK は、メディア拡張情報の送受信機能を提供します。受信側は AliEngineEventListener::OnMediaExtensionMsgReceived を参照します。メディア拡張情報を使用する場合、音声およびビデオデータチャンネルを再利用する必要があるため、カスタムメッセージの送信頻度とデータ長を制御する必要があります。使用制限は次のとおりです：

• プロファイルで設定された fps メッセージを 1 秒あたり最大で送信します。

• メディアデータの伝送品質に影響を与えないように、カスタムメッセージ本文の長さは 4 KB に制限されており、少量のデータを送信するために使用できます。

• sendMediaExtensionMsg 関数の repeatCount パラメーターは、カスタムメッセージの冗長性です。1 より大きい場合、ネットワークのパケット損失によるメッセージ損失を防ぐために複数回送信されます。この場合、ルーム内の他の人も同じメッセージを複数回受信するため、重複を削除する必要があります。

• カスタムメッセージが送信されると、ルーム内のサブスクライバーもバイパスライブストリーミング中にそれを受信します。-1 に設定すると、sendMediaExtensionMsg が再度呼び出されない限り、データが永続的に送信されることを意味します。

• 一度に 1 つの sendMediaExtensionMsg のみが送信されます。つまり、sendMediaExtensionMsg を呼び出すと、前の呼び出しが送信されていないか完了していない場合、前の呼び出しが上書きされます。

パラメーター

戻り値

• 0：成功。

• <0：失敗。エラーコードが返されます。

  • ERR_INNER(-1)：内部 SDK エラー。SDK が初期化されていないか、破棄された後に呼び出された場合に発生する可能性があります。

メディア拡張情報を送信します。これは内部的に SEI を使用して実装されます。

virtual int SendMediaExtensionMsgEx(const int8_t * message, uint32_t length, int32_t repeatCount, uint32_t delay, bool isKeyFrame, int32_t payloadType) = 0;

SDK は、メディア拡張情報の送受信機能を提供します。受信側は AliEngineEventListener::OnMediaExtensionMsgReceived を参照します。メディア拡張情報を使用する場合、音声およびビデオデータチャンネルを再利用する必要があるため、カスタムメッセージの送信頻度とデータ長を制御する必要があります。使用制限は次のとおりです：

• プロファイルで設定された fps メッセージを 1 秒あたり最大で送信します。

• メディアデータの伝送品質に影響を与えないように、カスタムメッセージ本文の長さは 4 KB に制限されており、少量のデータを送信するために使用できます。

• sendMediaExtensionMsg 関数の repeatCount パラメーターは、カスタムメッセージの冗長性です。1 より大きい場合、ネットワークのパケット損失によるメッセージ損失を防ぐために複数回送信されます。この場合、ルーム内の他の人も同じメッセージを複数回受信するため、重複を削除する必要があります。

• カスタムメッセージが送信されると、ルーム内のサブスクライバーもバイパスライブストリーミング中にそれを受信します。-1 に設定すると、sendMediaExtensionMsg が再度呼び出されない限り、データが永続的に送信されることを意味します。

• 一度に 1 つの sendMediaExtensionMsg のみが送信されます。つまり、sendMediaExtensionMsg を呼び出すと、前の呼び出しが送信されていないか完了していない場合、前の呼び出しが上書きされます。

パラメーター

戻り値

• 0：成功。

• <0：失敗。エラーコードが返されます。

  • ERR_INNER(-1)：内部 SDK エラー。SDK が初期化されていないか、破棄された後に呼び出された場合に発生する可能性があります。

ネットワーク接続ステータスの変更に関するコールバック。

virtual void OnConnectionStatusChange(int status, int reason) {};

パラメーター

オンプレミスデバイスの例外に関するコールバック。お客様はこのコールバックに注意を払う必要があります。

virtual void OnLocalDeviceException(AliEngineLocalDeviceType deviceType, AliEngineLocalDeviceExceptionType exceptionType, const char* msg){};

パラメーター

ユーザー認証情報がまもなく期限切れになるという通知。この通知を受信してから 30 秒後に認証が期限切れになります。お客様はこのコールバックに注意を払う必要があります。

virtual void OnAuthInfoWillExpire() {};

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

• RefreshAuthInfo メソッドを呼び出して認証情報を更新します。

• LeaveChannel を呼び出して現在のチャンネルから退出した後、JoinChannel を呼び出してチャンネルに再参加します。

トリガーされるタイミング

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

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

virtual void OnAuthInfoExpired() {};

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

• LeaveChannel を呼び出して現在のチャンネルから退出した後、JoinChannel を呼び出してチャンネルに再参加します。

トリガーされるタイミング

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

チャンネルへの参加結果のコールバック。このコールバックは、JoinChannel メソッドを呼び出すブロック操作と同等で、チャンネルに参加した後のイベントを処理します。どちらか一方を選択してください。

virtual void OnJoinChannelResult(int result, const char *channel, const char *userId, int elapsed) {}

トリガー条件

アプリケーションが JoinChannel メソッドを呼び出すと、このコールバックはチャンネルに正常に参加できたかどうかを示し、チャンネル参加に関する情報と参加にかかった時間を返します。

パラメーター

チャンネルからの退出結果のコールバック。LeaveChannel メソッドを呼び出した後に返されます。この直後に Destroy を呼び出すと、このコールバックは受信されません。

virtual void OnLeaveChannelResult(int result, AliEngineStats stats) {}

トリガー条件

アプリケーションが LeaveChannel を正常に呼び出してチャンネルを退出すると、このコールバックがトリガーされ、退出の結果とこのチャンネルセッションの統計が返されます。

パラメーター

リモートユーザーがオフラインになったときのコールバック。

virtual void OnRemoteUserOffLineNotify(const char *uid, AliEngineUserOfflineReason reason) {}

このコールバックは、リモートユーザーがさまざまな理由でチャンネルを退出したことをローカルユーザーに通知します。リモートユーザーがオフラインになると、このメソッドがトリガーされます。

トリガー条件

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

• リモートストリーマーが <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#c99c2b257dd8o" id="03e45f655fcxx">SetClientRole</a> を呼び出してロールを視聴者 (AliEngineClientRoleLive に設定) に切り替えたときにコールバックがトリガーされます。

• リモートストリーマーから長時間データが受信されず、ドロップしたと見なされたときにコールバックがトリガーされます。

パラメーター

リモートユーザーがオンラインになったときのコールバック。

virtual void OnRemoteUserOnLineNotify(const char *uid, int elapsed) {}

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

トリガー条件

• リモートユーザーが正常にチャンネルに参加しました。

• 現在のユーザーがチャンネルに参加した後、すでにチャンネルにいるユーザーの参加コールバックを受信します。これは、以前に参加したユーザーを表示するために使用されます。

パラメーター

リモートユーザーのストリームが変更されたときのコールバック。

virtual void OnRemoteTrackAvailableNotify(const char *uid,
                                                  AliEngineAudioTrack audioTrack,
                                                  AliEngineVideoTrack videoTrack) {}

このコールバックは、リモートユーザーのパブリッシュ状態が変更されたときにトリガーされます。このコールバックを通じて、リモートユーザーが音声およびビデオストリームをパブリッシュしているかどうかをリアルタイムで知ることができます。その後、UI 上でリモートユーザーの音声およびビデオ情報を表示または非表示にすることができます。

トリガー条件

このコールバックは、次のシナリオでトリガーされます：

• リモートユーザーがパブリッシュしていない状態からパブリッシュする状態に変わったとき (音声とビデオを含む)。

• リモートユーザーがパブリッシュしている状態からパブリッシュしていない状態に変わったとき (音声とビデオを含む)。

• インタラクティブストリームモードで、リモートユーザーが SetClientRole を呼び出して視聴者からストリーマーに切り替え、パブリッシュも設定した場合、このコールバックがトリガーされます。

ビデオを例にとると、リモートユーザーがパブリッシュしないように設定されているとします。その場合、このコールバックはトリガーされません。

• リモートユーザーがカメラストリームのパブリッシュを開始すると (パブリッシュ状態：ビデオストリームなし -> カメラストリームのみ)、ローカルコールバックは AliEngineVideoTrackCamera を返し、リモートユーザーのカメラストリームが利用可能であることを示します。

• リモートユーザーが画面共有ストリームもパブリッシュすると (パブリッシュ状態：カメラストリームのみ -> カメラストリームと画面共有ストリーム)、ローカルコールバックは AliEngineVideoTrackBoth を返し、リモートユーザーのカメラストリームと画面共有ストリームの両方が利用可能であることを示します。

• リモートユーザーがカメラストリームのパブリッシュを停止し、画面共有ストリームのみを維持すると (パブリッシュ状態：カメラストリームと画面共有ストリーム -> 画面共有ストリームのみ)、ローカルコールバックは AliEngineVideoTrackScreen を返し、現在画面共有ストリームのみが利用可能であることを示します。

• リモートユーザーが画面共有ストリームのパブリッシュを停止すると (パブリッシュ状態：画面共有ストリームのみ -> ビデオストリームなし)、ローカルコールバックは AliEngineVideoTrackNo を返し、現在ビデオストリームが利用できないことを示します。

パラメーター

ユーザーがサーバーによってキックアウトされたり、チャンネルが閉じられたりした場合のコールバック。

virtual void OnBye(int code) {}

ユーザーが何らかの理由で切断されたり、チャンネルが閉じられたりすると、このコールバックがトリガーされます。コールバックパラメーター code を使用して切断の理由を特定し、それに応じて処理できます。

トリガー条件

• 現在のユーザーがサーバーによってキックアウトされました。

• チャンネルが閉じられました (サーバーが積極的にチャンネルを削除しました)。

• 受動的な退出。クライアントがセッションを復元または再接続しようとする必要があります。

パラメーター

オーディオパブリッシュの変更に関するコールバック。

virtual void OnAudioPublishStateChanged(AliEnginePublishState oldState, AliEnginePublishState newState, int elapseSinceLastState, const char *channel) {};

このコールバックは、ローカルユーザーのオーディオストリームのパブリッシュ状態の変更をリッスンします。

トリガー条件

ユーザーのオーディオパブリッシュ状態が変更されたとき、たとえば：

• パブリッシュを停止します。

• <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#c99c2b257dd8o" id="904fc4e83a35n">SetClientRole</a> を呼び出して視聴者に切り替えます。

パラメーター

オーディオサブスクリプションの変更に関するコールバック。

virtual void OnAudioSubscribeStateChanged(const char *uid,
                                                  AliEngineSubscribeState oldState, 
                                                  AliEngineSubscribeState newState,
                                                  int elapseSinceLastState,
                                                  const char *channel) {};

このコールバックは、リモートユーザーのオーディオストリームのサブスクリプション状態の変更をローカルユーザーに通知します。このコールバックを通じて、リモートユーザーのカメラストリームのサブスクリプション状態の変更と、前の状態から現在の状態までの時間間隔を知ることができます。

パラメーター

ユーザーがオーディオをミュートしたことの通知。

virtual void OnUserAudioMuted(const char* uid, bool isMute) {}

パラメーター

ユーザーの音声が中断されたという通知。これは通常、電話などの音声が優先されるシナリオで発生します。

virtual void OnUserAudioInterruptedBegin(const char* uid) {}

パラメーター

ユーザーの音声中断が終了したという通知。これは OnUserAudioInterruptedBegin に対応します。

virtual void OnUserAudioInterruptedEnded(const char* uid) {}

パラメーター

ビデオパブリッシュの変更に関するコールバック。

virtual void OnVideoPublishStateChanged(AliEnginePublishState oldState, AliEnginePublishState newState, int elapseSinceLastState, const char *channel) {};

このコールバックは、ローカルユーザーのビデオパブリッシュ状態の変更をリッスンします。

パラメーター

カメラストリームのサブスクリプション変更に関するコールバック。

virtual void OnVideoSubscribeStateChanged(const char *uid, 
                                                  AliEngineSubscribeState oldState, 
                                                  AliEngineSubscribeState newState,
                                                  int elapseSinceLastState,
                                                  const char *channel) {};

このコールバックは、リモートユーザーのカメラストリームのサブスクリプション状態の変更をローカルユーザーに通知します。このコールバックを通じて、リモートユーザーのカメラストリームのサブスクリプション状態の変更と、前の状態から現在の状態までの時間間隔を知ることができます。

関連するコールバック

ビデオストリームには、主にカメラストリームと画面共有ストリームが含まれます。このメソッドは、カメラストリームのサブスクリプション状態の変更に関するものです。画面共有ストリームに関連するコールバックメソッドは OnScreenShareSubscribeStateChanged です。

パラメーター

ユーザーがビデオをミュートしたことの通知。

virtual void OnUserVideoMuted(const char* uid, bool isMute) {}

パラメーター