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

シングルトンパターンを使用して AliRtcEngine インスタンスを作成します。

+ (instancetype _Nonnull )sharedInstance:(id<AliRtcEngineDelegate>_Nullable)delegate extras:(NSString *_Nullable)extras;

呼び出しタイミング

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

制限事項

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

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

関連コールバック

エンジンインスタンスを作成する際、ユースケースに基づいて AliRtcEngineDelegate のコールバックを実装します。SDK が動作中に例外に遭遇した場合、まず内部リトライを試みて自動的に回復します。内部で解決できないエラーについては、SDK は定義済みのコールバックを通じてアプリケーションに通知します。以下は、アプリケーションレベルでの処理が必要な主要なコールバックです。

パラメーター

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

+ (void)destroy;

AliRtcEngine シングルトンオブジェクトを破棄します。このメソッドを呼び出した後、内部で使用されるすべてのリソースが解放されます。他の AliRtcEngine メソッドやコールバックは使用できなくなります。AliRtcEngine を再度使用するには、<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#2db21d4f16s77" id="96631a9306wq8">sharedInstance</a> を呼び出して新しいインスタンスを作成する必要があります。

このメソッドと destroy[2/2] はどちらもエンジンインスタンスを破棄しますが、destroy[2/2] では破棄完了のモニターオブジェクトを渡すことができる点が異なります。

お問い合わせのタイミング

リアルタイム通信が終了した後（つまり、AliRtcEngine の機能が不要になったとき）にこのメソッドを呼び出してインスタンスを解放します。これにより、不要なリソース使用量を削減できます。

制限事項

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

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

+ (void)destroy:(id<AliRtcEngineDestroyDelegate>_Nullable)delegate;

AliRtcEngine シングルトンオブジェクトを破棄します。このメソッドを呼び出した後、オブジェクトが内部で使用するすべてのリソースが解放されます。他の AliRtcEngine メソッドやコールバックは使用できなくなります。AliRtcEngine を再度使用するには、<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#2db21d4f16s77" id="115fd691743nx">sharedInstance</a> を呼び出して新しいインスタンスを作成する必要があります。

呼び出しタイミング

リアルタイム通信を完了した後に、このメソッドを呼び出してインスタンスを解放することを推奨します。

制限事項

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

パラメーター

HTML5 互換モードを有効にするかどうかを指定します。

+ (void)setH5CompatibleMode:(BOOL)comp;

パラメーター

HTML5 互換モードが有効になっているかどうかを照会します。

+ (BOOL)getH5CompatibleMode;

戻り値の説明

YES の値は HTML5 互換モードが有効であることを示します。NO の値は HTML5 互換モードが無効であることを示します。

SDK のバージョン番号を取得します。

+ (NSString *_Nonnull)getSdkVersion;

戻り値

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

注意事項

これは静的メソッドです。いつでも呼び出してバージョン番号を取得できます。

チャネルモードを設定します。

- (int)setChannelProfile:(AliRtcChannelProfile)profile;

このメソッドはチャネルプロファイルを設定します。利用可能な主なプロファイルは 2 つあります。

• 通信プロファイル：すべてのユーザーがストリーマーとして機能し、ストリームの配信とサブスクライブの両方が可能です。

• インタラクティブライブストリーミングプロファイル：<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#892915dd4edcy" id="d88dccff391by">setClientRole</a> を呼び出してクライアントの役割を設定する必要があります。チャネル内でストリームをアップロードするユーザーの役割をストリーマー（AliRTCSdkInteractive）に設定します。ユーザーがストリームをプルするだけでストリームをアップロードしない場合は、その役割を視聴者（AliRTCSdkLive）に設定します。このプロファイルは RTC シナリオに推奨されます。

呼び出しのタイミング

このメソッドはチャネルに参加する前にのみ呼び出すことができます。チャネルに参加中はプロファイルを変更できません。チャネルから退出した後に変更できます。

パラメーター

戻り値の説明

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

音声プロファイルを設定します。

- (int)setAudioProfile:(AliRtcAudioProfile)audio_profile audio_scene:(AliRtcAudioScenario)audio_scene;

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

呼び出しタイミング

このメソッドはチャネルに参加する前にのみ呼び出すことができます。参加後に変更することはできません。チャネルから退出した後に変更できます。

パラメーター

戻り値の説明

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

音声のみモードが有効になっているかどうかを照会します。

- (BOOL)isAudioOnly;

戻り値の説明

YES の値は音声のみモードが有効であることを示します。NO の値は音声・映像モードが有効であることを示します。

音声のみモードまたは音声・映像モードを有効にします。

- (int)setAudioOnlyMode:(BOOL)audioOnly;

パラメーター

返品手順

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

チャネルに参加します（つまり、会議に参加します）。

- (int)joinChannel:(NSString *_Nonnull)token channelId:(NSString *_Nullable)channelId userId:(NSString *_Nullable)userId name:(NSString *_Nullable)userName onResultWithUserId:(void(^_Nullable)(NSInteger errCode, NSString * _Nonnull channel, NSString * _Nonnull userId, NSInteger elapsed))onResult;

このメソッドはチャネルに参加します。ARTC はユーザーをチャネルに編成します。ユーザーは音声および映像ストリームを配信またはサブスクライブするためにチャネルに参加する必要があります。このメソッドは、joinChannel[2/3] および joinChannel[3/3] とともに、チャネルに参加するために使用できます。違いは、認証方式と渡されるユーザー情報にあります。

• これは単一パラメーターの参加メソッドです。トークン認証を使用して生成されたトークンを渡します。RTC シナリオではこのメソッドを推奨します。

• joinChannel[2/3] は複数パラメーターの参加メソッドです。トークン認証を使用して生成されたトークンを渡し、トークン生成に使用されたユーザー情報も渡します。

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

呼び出しタイミング

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

制限事項

• チャネルに正常に参加した後、セッション中に別のチャネルに参加するには、まず <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#449873b819cz2" id="37299758eavvg">leaveChannel</a> を呼び出して現在のチャネルから退出する必要があります。そして、再度チャネルに参加する前に <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3721f1f2a3kpd" id="50039f328fdk7">onLeaveChannelResult</a> コールバックを受信したことを確認してください。

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

• 異なる App ID を持つアプリは相互運用できません。

• 参加に失敗した後の再試行時にこのメソッドを呼び出す必要はありません。

関連コールバック

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

• ローカルクライアントがチャネルに参加した結果は、<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#e6d2a213d7sl2" id="903005c54be4d">onJoinChannelResult</a> コールバックを通じて通知されます。

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

パラメーター

戻り値の説明

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

複数参加者セッションであるチャネルに参加します。

- (int)joinChannel:(AliRtcAuthInfo *_Nonnull)authInfo name:(NSString *_Nullable)userName onResultWithUserId:(void(^_Nullable)(NSInteger errCode, NSString * _Nonnull channel, NSString * _Nonnull userId, NSInteger elapsed))onResult;

このメソッドはチャネルに参加します。ARTC はユーザーをチャネルに編成します。ユーザーは音声および映像ストリームを配信またはサブスクライブするためにチャネルに参加する必要があります。このメソッドは、joinChannel[1/3] および joinChannel[3/3] とともに、チャネルに参加するために使用できます。違いは、認証方式と渡されるユーザー情報にあります。

• joinChannel[1/3] は単一パラメーターの参加メソッドです。トークン認証を使用して生成されたトークンを渡します。RTC シナリオではこのメソッドを推奨します。

• これは複数パラメーターの参加メソッドです。トークン認証を使用して生成されたトークンを渡し、トークン生成に使用されたユーザー情報も渡します。

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

制限事項

• チャネルに参加した後で別のチャネルに切り替えるには、まず <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#449873b819cz2" id="4283c6cc013bz">leaveChannel</a> を呼び出して現在のチャネルから退出する必要があります。<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3721f1f2a3kpd" id="9e6478b2f0hen">onLeaveChannelResult</a> コールバックを受信した後にのみ、新しいチャネルに参加できます。

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

• 異なる App ID を持つアプリは相互運用できません。

関連コールバック

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

• <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#e6d2a213d7sl2" id="df00346ea8928">onJoinChannelResult</a> コールバックは、ローカルユーザーがチャネルに参加した結果を返します。

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

パラメーター

チャネルに参加します。

- (int)joinChannel:(NSString *_Nonnull)token channelParam:(AliRtcChannelParam *_Nonnull)channelParam onResultWithUserId:(void(^_Nullable)(NSInteger errCode, NSString * _Nonnull channel, NSString * _Nonnull userId, NSInteger elapsed))onResult;

このメソッドはチャネルに参加します。ARTC はユーザーをチャネルに編成します。ユーザーは音声および映像ストリームを配信またはサブスクライブするためにチャネルに参加する必要があります。このメソッドは、joinChannel[1/3] および joinChannel[2/3] とともに、チャネルに参加するために使用できます。違いは、認証方式と渡されるユーザー情報にあります。

• joinChannel[1/3] は RTC シナリオの単一パラメーター参加メソッドです。トークン認証を使用して生成されたトークンを渡します。RTC シナリオではこのメソッドを推奨します。

• joinChannel[2/3] は複数パラメーターの参加メソッドです。トークン認証を使用して生成されたトークンを渡し、トークン生成に使用されたユーザー情報も渡します。

• このメソッドは AI リアルタイムインタラクションシナリオ用です。単一パラメーターのトークンを渡し、ユーザープロパティ capabilityProfile を設定します。AI エージェントと通信する場合は、これを AliRtcCapabilityProfileAiHuman に設定します。

制限事項

• チャネルに正常に参加した後、別のチャネルに参加するには、まず <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#449873b819cz2" id="923190466431o">leaveChannel</a> を呼び出して現在のチャネルから退出する必要があります。そして、再度チャネルに参加する前に <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3721f1f2a3kpd" id="dfd794c32covq">onLeaveChannelResult</a> コールバックを受信したことを確認してください。

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

• 異なる App ID を持つアプリは相互運用できません。

• 参加に失敗した後の再試行時にこのメソッドを呼び出す必要はありません。

関連コールバック

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

• ローカルユーザーがチャネルに参加した結果は、<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#e6d2a213d7sl2" id="f83d0aff9btwh">onJoinChannelResult</a> コールバックによって返されます。

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

パラメーター

チャネルから退出します。

- (int)leaveChannel;

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

呼び出しタイミング

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

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

関連コールバック

• ローカルユーザー：このメソッドが呼び出された後、<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3721f1f2a3kpd" id="ea2e36a41csu0">onLeaveChannelResult</a> コールバックがトリガーされ、チャネルからの退出結果が報告されます。

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

戻り値の説明

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

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

- (BOOL)isInCall;

戻り値の説明

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

ユーザーの役割を指定します。

- (int)setClientRole:(AliRtcClientRole)role;

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

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

• ユーザーの役割をストリーマーに設定：SDK は自動的にローカルの音声および映像ストリームを配信し、他のストリーマーのストリームをサブスクライブします。

• ユーザーの役割を視聴者に設定：SDK はローカルの音声または映像ストリームを配信しませんが、他のストリーマーのストリームをサブスクライブします。

呼び出しタイミング

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

制限事項

このメソッドはインタラクティブモードでのみ有効です。つまり、<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#fc9626a99f5kj" id="cd8138c77fv4r">setChannelProfile</a> メソッドを呼び出し、チャネルプロファイルを AliRtcInteractivelive に設定した場合です。

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

パラメーター

戻り値の説明

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

ユーザーの役割を照会します。このメソッドは iOS のみで利用可能です。

- (AliRtcClientRole)getCurrentClientRole;

戻り値

ユーザーの役割が返されます。

認証情報を更新します。

- (int)refreshAuthInfo:(AliRtcAuthInfo *_Nonnull)authInfo;

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

呼び出しのタイミング

以下の場合：

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

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

パラメーター

戻り値の説明

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

認証情報を更新します。

- (int)refreshAuthInfoWithToken:(NSString *_Nonnull)token;

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

呼び出しタイミング

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

<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#6766cdfb40z1a" id="b1dbfcb71d5ys">onAuthInfoWillExpire</a> コールバックを受信し、認証情報がまもなく期限切れになることが報告されたとき。

パラメーター

戻り値の説明

呼び出しが成功した場合は 0、失敗した場合は 0 以外の値が返されます。

音声トラックを配信するかどうかを指定します。

- (int)publishLocalAudioStream:(BOOL)enable;

このメソッドは、ローカルでキャプチャされた音声の配信を制御します。デフォルトでは、SDK は音声を配信します。デフォルトで音声を配信したくない場合は、チャネルに参加する前に publishLocalAudioStream(false) を呼び出してください。

呼び出しタイミング

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

関連コールバック

ローカル音声ストリームのアップロード状態が変更されると、ローカルクライアントは <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#86b2d8735bm71" id="e5ef180ba6e2i">onAudioPublishStateChanged</a> コールバックをトリガーして最新のアップロード状態を報告し、リモートクライアントは <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#6da9cf330aoer" id="299ef35806ttb">onRemoteTrackAvailableNotify</a> コールバックをトリガーしてリモートユーザーの音声および映像ストリームの変更を報告します。

パラメーター

戻り値の説明

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

音声トラックが配信されているかどうかを照会します。

- (BOOL)isLocalAudioStreamPublished;

戻り値の説明

YES はプッシュが許可されていることを示します。NO はプッシュが許可されていないことを示します。

音声ストリームを受け入れるデフォルトの動作を設定します。

- (int)setDefaultSubscribeAllRemoteAudioStreams:(BOOL)sub;

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

呼び出しタイミング

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

• 参加前：

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

• 参加後：

  • デフォルトのサブスクリプションを停止したい場合は、<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#8b515d9855osk" id="a467e60e4eyhk">setDefaultSubscribeAllRemoteAudioStreams</a>(false) を呼び出すことができます。システムは、後でチャネルに参加するユーザーからの音声ストリームをサブスクライブしなくなります。

  • デフォルトのサブスクリプションを停止した後、指定したユーザーの音声ストリームのサブスクリプションを再開したい場合は、<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#c8249fb568gms" id="9806dd9a750pf">subscribeRemoteAudioStream</a> API を呼び出します。複数のユーザーに対して再開したい場合は、複数回呼び出します。

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

パラメーター

戻り値の説明

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

特定のリモートユーザーの音声トラックへのサブスクリプションを開始または停止します。

- (int)subscribeRemoteAudioStream:(NSString *_Nonnull)uid sub:(BOOL)sub;

このインターフェイスを使用して、特定のリモートユーザーからの音声ストリームを停止または再開します。ほとんどのシナリオでは、このパラメーターを true に設定してください。

パラメーター

戻り値の説明

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

すべてのリモートユーザーの音声トラックへのサブスクリプションを開始または停止します。

- (int)subscribeAllRemoteAudioStreams:(BOOL)sub;

このメソッドは、リモート音声トラックのサブスクリプションのマスターコントロールです。YES に設定することを推奨します。NO に設定すると、以下のようになります。

• 現在のセッションのリモート音声トラックはサブスクライブされなくなります。

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

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

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

パラメーター

戻り値の説明

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

映像トラックを配信するかどうかを指定します。

- (int)publishLocalVideoStream:(BOOL)enable;

このメソッドは、ローカルでキャプチャされた映像の配信を制御します。

呼び出しタイミング

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

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

関連コールバック

ローカル音声ストリームのアップロード状態が変更されると、ローカルクライアントは <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#bd67711e63tnk" id="f966292202q3d">onVideoPublishStateChanged</a> コールバックをトリガーして最新の音声ストリームアップロード状態を報告します。リモートクライアントは <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#6da9cf330aoer" id="2fdc208ccczr1">onRemoteTrackAvailableNotify</a> コールバックをトリガーしてリモートユーザーの音声および映像ストリームの変更を報告します。

パラメーター

映像トラックが配信されているかどうかを照会します。

- (BOOL)isLocalVideoStreamPublished;

戻り値の説明

YES の値は映像トラックが配信されていることを示します。NO の値は映像トラックが配信されていないことを示します。

デフォルトで映像ストリームを受け入れるかどうかを設定できます。

- (int)setDefaultSubscribeAllRemoteVideoStreams:(BOOL)sub;

デフォルトでは、SDK はリモートユーザーの映像トラックをサブスクライブします。この動作を変更するには、このメソッドを使用します。

呼び出しタイミング

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

• 参加前：

  • このメソッドを使用して、デフォルトのサブスクリプションを無効にすることができます。

• 参加後：

  • デフォルトのサブスクリプションを無効にするには、setDefaultSubscribeAllRemoteVideoStreams(false) を呼び出します。後でチャネルに参加するユーザーの音声ストリームも自動的にサブスクライブされなくなります。

  • デフォルトのサブスクリプションを停止した後、subscribeRemoteVideoStream インターフェイスを呼び出して、特定のユーザーの音声ストリームのサブスクリプションを再開できます。複数のユーザーのサブスクリプションを再開するには、ユーザーごとにこのインターフェイスを 1 回呼び出します。

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

パラメーター

戻り値の説明

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

リモートユーザーからの映像ストリームのサブスクリプションを停止または再開します。

- (int)subscribeRemoteVideoStream:(NSString *_Nonnull)uid track:(AliRtcVideoTrack)track sub:(BOOL)sub;

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

呼び出しタイミング

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

説明

すべてのリモートユーザーの映像トラックへのサブスクリプションを開始または停止します。

- (int)subscribeAllRemoteVideoStreams:(BOOL)sub;

このメソッドは、リモート映像ストリームのサブスクリプションのマスターコントロールとして機能します。sub を false に設定すると、以下のようになります。

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

• 後で参加する新しいユーザーもサブスクライブされません（デフォルトのサブスクリプション設定 <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#a975297480yoj" id="0464849a17dks">setDefaultSubscribeAllRemoteVideoStreams</a> が有効であっても）。

• <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#1cc7ef76fdawz" id="498e782f414zz">subscribeRemoteVideoStream</a> を使用して、特定のユーザーの音声ストリームを個別に制御することはできません。

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

パラメーター

戻り値の説明

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

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

- (int)subscribeRemoteMediaStream:(NSString *_Nonnull)uid videoTrack:(AliRtcVideoTrack)videoTrack subVideo:(BOOL)subVideo subAudio:(BOOL)subAudio;

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

関連 API 操作

subscribeRemoteMediaStream[2/2] とは異なり、このインターフェイスは 2 つのブール値パラメーター（subVideo と subAudio）を使用してリモートの映像および音声ストリームをサブスクライブするかどうかを制御し、videoTrack パラメーターはどの映像ストリームをプルするかを指定します。

注：この API では、AliRtcVideoTrack の AliRtcVideoTrackNo は無効であり、設定しても効果はありません。

パラメーター

応答の説明

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

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

- (int)subscribeRemoteMediaStream:(NSString *_Nonnull)uid videoTrack:(AliRtcVideoTrack)videoTrack audioTrack:(AliRtcAudioTrack)audioTrack;

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

関連 API

subscribeRemoteMediaStream[1/2] とは異なり、このインターフェイスは videoTrack と audioTrack パラメーターを使用して、1 回の呼び出しで SDK に望ましいサブスクリプション状態を指定します。例：

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

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

• すべてのトラックをキャンセルしたい場合は、再度呼び出す際に videoTrack と audioTrack をそれぞれ AliRtcVideoTrackNo と AliRtcAudioTrackNo に設定します。

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

パラメーター

戻り値の説明

戻り値 0 は成功を示します。それ以外の値は失敗を示します。

チャネル間で特定のリモートユーザーのメディアストリームをサブスクライブまたはサブスクライブ解除します。

- (int)subscribeRemoteDestChannelStream:(NSString *_Nonnull)channelId uid:(NSString *_Nonnull)uid track:(AliRtcVideoTrack)track subAudio:(BOOL)subAudio sub:(BOOL)sub;

パラメーター

戻り値の説明

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

対象チャネル内のすべてのユーザーストリームをサブスクライブします。

- (int)subscribeRemoteDestChannelAllStream:(NSString *_Nonnull)channelId track:(AliRtcVideoTrack)track subAudio:(BOOL)subAudio sub:(BOOL)sub;

パラメーター

戻り値

0 は成功を示します。それ以外の値は失敗を示します。

リモート音声のボリュームを設定できます。

- (int)setRemoteAudioVolume:(NSString *_Nonnull)uid volume:(NSInteger)volume;

パラメーター

戻り値

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

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

- (int)muteLocalMic:(BOOL)mute mode:(AliRtcMuteLocalAudioMode)mode;

呼び出しタイミング

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

関連コールバック

呼び出しが成功した後、リモートユーザーは <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3189c59d9fipb" id="1579c3523779c">onUserAudioMuted</a> コールバックをトリガーして、ユーザーがミュートされているかどうかを示します。

パラメーター

戻り値

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

リモート音声の再生を停止または再開できます。

- (int)muteRemoteAudioPlaying:(NSString *_Nonnull)uid mute:(BOOL)mute;- (int)muteRemoteAudioPlaying:(NSString *_Nonnull)uid mute:(BOOL)mute;- (int)muteRemoteAudioPlaying:(NSString *_Nonnull)uid mute:(BOOL)mute;

この API は、指定されたリモートユーザーからの音声の再生を停止または再開しますが、リモート音声のストリームフェッチングやデコーディングには影響しません。ユーザーの音声ストリームのサブスクリプションを解除するには、<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#c8249fb568gms" id="dd9dbbad0bkni">subscribeRemoteAudioStream</a> を呼び出してください。

呼び出しタイミング

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

パラメーター

戻り値の説明

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

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

- (int)muteAllRemoteAudioPlaying:(BOOL)mute;

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

呼び出しのタイミング

この設定は、チャネルに参加する前または後に構成できます。

パラメーター

戻り値の説明

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

音声収集を開始します。

- (void)startAudioCapture;

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

呼び出しタイミング

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

関連メソッド

startAudioCapture[2/2] API は、指定されたパラメーターに基づいて、会議から退出した後も音声キャプチャデバイスを有効にしておくかどうかを制御します。

関連コールバック

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

戻り値の説明

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

音声収集を開始します。

- (void)startAudioCapture:(BOOL)keepAlive;

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

このメソッドは音声キャプチャを開始します。チャネルに参加する前に呼び出して、早期に音声キャプチャを開始できます。このメソッドを呼び出さない場合、SDK は自動的に音声キャプチャデバイスを管理します。

呼び出しタイミング

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

関連メソッド

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

関連コールバック

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

パラメーター

戻り値の説明

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

音声収集を停止します。

- (void)stopAudioCapture;

<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3103c368bexf8" id="ddef64f9b93zq">startAudioCapture</a> を呼び出して音声デバイスからの音声キャプチャを有効にした後、このメソッドを呼び出して音声キャプチャを停止できます。

関連コールバック

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

戻り値の説明

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

ヘッドセットまたはスピーカーを音声出力デバイスとして設定します。このメソッドは iOS のみで利用可能です。

- (int)enableSpeakerphone:(BOOL)enable;

このメソッドは、チャネルに参加した後に音声再生デバイスをスピーカーまたはヘッドセットに設定します。このメソッドを呼び出さない場合、SDK はデフォルトの音声ルートを使用します。

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

呼び出しタイミング

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

関連メソッド

<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#83be8cc066qqq" id="f8de149ef8so0">setDefaultAudioRoutetoSpeakerphone</a> メソッドは、デフォルトの音声ルーティング設定を変更し、現在の音声出力デバイスを設定します。

パラメーター

戻り値の説明

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

現在の音声出力デバイスがヘッドセットかスピーカーかを照会します。このメソッドは iOS のみで利用可能です。

- (BOOL)isEnableSpeakerphone;

戻り値の説明

YES の値は現在の音声出力デバイスがスピーカーであることを示します。NO の値は現在の音声出力デバイスがヘッドセットであることを示します。

ボリュームコールバックの間隔と平滑化係数を設定します。

- (int)enableAudioVolumeIndication:(NSInteger)interval smooth:(NSInteger)smooth reportVad:(NSInteger)reportVad;

このメソッドは、SDK がローカルの配信ユーザーと、瞬間的な音量が最も高いリモートユーザーの音量情報を定期的に報告するようにします。

呼び出しタイミング

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

関連コールバック

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

• SDK は、onAudioVolumeCallback コールバックを通じて話しているユーザーの音量を報告します。コールバックの頻度は interval パラメーターに依存します。

• 音声区間検出の場合、アクティブなスピーカーが検出されると、SDK は onActiveSpeaker コールバックを通じてその UID を報告します。

パラメーター

戻り値

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

イヤーモニター機能を有効にできます。

- (int)enableEarBack:(BOOL)enable;

このメソッドはイヤーモニター機能を有効または無効にします。最適な結果を得るために、有線または Bluetooth ヘッドホンを使用する際にイヤーモニターを有効にすることを推奨します。

呼び出しタイミング

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

パラメーターの説明

戻り値の説明

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

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

- (int)setEarBackVolume:(NSInteger)volume;

このインターフェイスはイヤーモニターのボリュームを設定します。<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#bd665d0f894ux" id="b0fa866c9bcuq">enableEarBack</a> を呼び出してイヤーモニターを有効にした後にのみ有効になります。

呼び出しタイミング

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

パラメーター

戻り値の説明

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

音声再生を開始します。

- (void)startAudioPlayer;

音声再生を停止します。

- (void)stopAudioPlayer;

再生ボリュームを設定します。

- (int)setPlayoutVolume:(NSInteger)volume;

パラメーター

戻り値

戻り値 0 は成功を示し、それ以外の値は失敗を示します。

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

- (int)setRecordingVolume:(NSInteger)volume;

パラメーター

戻り値

戻り値 0 は成功を示します。それ以外の値は失敗を示します。

音声ファイルを再生します。

- (int)playAudioFileTest:(NSString *_Nonnull)filePath;

パラメーター

戻り値

戻り値 0 は成功を示します。それ以外の値は失敗を示します。

音声ファイルの再生を停止します。

- (int)stopAudioFileTest;

戻り値

戻り値 0 は成功を示します。それ以外の値は失敗を示します。

通話前に音声キャプチャデバイスの検出を有効にします。

- (void)startAudioCaptureTest;

通話を終了する前に音声収集デバイスを検出します。

- (void)stopAudioCaptureTest;

デフォルトの音声出力をスピーカーに設定します。デフォルトでは、音声はスピーカーから再生されます。

- (int)setDefaultAudioRouteToSpeakerphone:(BOOL)defaultToSpeakerphone;

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

SDK は音声ルーティングの固定優先順位を定義し、現在の周辺機器の接続状態に基づいて自動切り替えを実行します。優先順位は次のとおりです：有線ヘッドセット > Bluetooth ヘッドセット > ユーザー設定 > デフォルト設定。したがって、周辺機器が接続されておらず、<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#f7d0d8b64fzkz" id="30798b686b5qk">enableSpeakerphone</a> を通じて音声ルーティングを構成していない場合、SDK はデフォルト設定を適用します。

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

モバイルデバイスは通常、ヘッドセットとスピーカーの 2 つの音声ルートをサポートします。

• ヘッドセットを使用する場合、音は静かで、電話を耳に近づける必要があります。これによりプライバシーが向上し、通話に適しています。

• スピーカーを使用する場合、音は大きく、電話を耳に当てなくても聞こえます。これによりハンズフリー操作が可能になります。

関連メソッド

この API はデフォルトの音声ルーティング設定を変更します。<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#f7d0d8b64fzkz" id="6001aa98ebapw">enableSpeakerphone</a> API は現在の音声ルーティングデバイスを設定します。

呼び出しタイミング

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

パラメーター

戻り値

戻り値 0 は成功を示します。それ以外の値は失敗を示します。

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

- (int)setAudioEffectVoiceChangerMode:(AliRtcAudioEffectVoiceChangerMode)mode;

パラメーター

戻り値の説明

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

音声のピッチを設定します。

- (int)setAudioEffectPitchValue:(double)value;

パラメーター

戻り値の説明

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

リバーブモードを設定します。

- (int)setAudioEffectReverbMode:(AliRtcAudioEffectReverbMode)mode;

パラメーター

応答の説明

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

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

- (int)setAudioEffectReverbParamType:(AliRtcAudioEffectReverbParamType)type value:(float)value;

パラメーター

戻り値の説明

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

あらかじめ定義された音声美化エフェクトモードを設定します。

- (int)setAudioEffectBeautifyMode:(AliRtcAudioEffectBeautifyMode)mode;

このメソッドは、SDK に組み込まれた音声美化モードを構成します。音声ライブストリーミング、カラオケ、音声ベースのソーシャルアプリなど、音声品質の向上が求められるシナリオに適しています。異なる美化モードを選択すると、声の豊かさや明瞭さを高めるなど、知覚される声の特性が変化し、リモートユーザーのリスニング体験が向上します。

呼び出しタイミング

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

パラメーター

戻り値の説明

• 0：成功。

• 0 以外：失敗。

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

- (int)setAudioEffectEqualizationParam:(AliRtcAudioEffectEqualizationBandFrequency)bandIndex gain:(float)gain;

このメソッドは、ローカルでキャプチャされた音声またはオーディオ信号にグラフィックイコライザー調整を適用します。10 の固定周波数帯域のゲインをデシベル（dB）単位で調整して、音質をカスタマイズできます。このメソッドは、音声の明瞭度の最適化、音声品質の向上、ノイズの低減に適しています。

イコライザーは、10 の標準周波数帯域で 31 Hz から 16 kHz までの全スペクトル調整をサポートします。各帯域のゲインは、-15 dB から 15 dB まで独立して調整できます。デフォルトのゲインは 0 dB で、ブーストも減衰もないことを示します。

制限事項

• イコライザーを使用する前に、setAudioEffectBeautifyMode を呼び出して音声美化を有効にする必要があります。

パラメーター

戻り値の説明

0：成功。

0 以外：失敗。

外部音声トラックを追加します。

- (int)addExternalAudioStream:(AliRtcExternalAudioStreamConfig *_Nonnull)config;

外部音声ストリームを追加するには、次の手順に従います。

1. <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#d71bbfd2f242b" id="c310321e9eu35">addExternalAudioStream</a> インターフェイスを呼び出して外部音声ストリームを追加し、その ID を取得します。

2. pushExternalAudioStream を呼び出して、音声データをストリームに供給します。

3. 通話が終了したら、<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#282d70095duaw" id="16f621608d94x">removeExternalAudioStream</a> を呼び出して外部音声ストリームを削除します。

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

パラメーター

戻り値の説明

0 より大きい値は呼び出しが成功し、外部音声トラックの ID であることを示します。0 以下の値は呼び出しが失敗したことを示します。

外部音声データをインポートします。

- (int)pushExternalAudioStream:(int)streamId rawData:(AliRtcAudioFrame * _Nonnull)audioFrame;

このメソッドは、指定されたストリームに音声データを供給します。次の手順に従います。

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

2. このメソッドを呼び出して、作成されたストリームに音声データを供給します。

3. 通話が終了したら、<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#282d70095duaw" id="a9ebc8d599dz4">removeExternalAudioStream</a> を呼び出して外部音声ストリームを削除する必要があります。

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

パラメーター

戻り値の説明

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

外部音声ストリームのアップロードボリュームを設定します。

- (int)setExternalAudioStream:(int)streamId
                publishVolume:(int)publishVolume;

パラメーター

戻り値の説明

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

ストリームアップロード用の外部音声のボリュームを照会します。

- (int)getExternalAudioStreamPublishVolume:(int)streamId;

パラメーター

戻り値の説明

ボリュームの有効な値は 0 から 100 の範囲です。0 未満の値は呼び出しが失敗したことを示します。

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

- (int)setExternalAudioStream:(int)streamId
                playoutVolume:(int)playoutVolume;

パラメーター

戻り値の説明

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

外部音声の再生ボリュームを照会します。

- (int)getExternalAudioStreamPlayoutVolume:(int)streamId;

パラメーター

応答の説明

ボリュームの有効な値は 0 から 100 の範囲です。0 未満の値は呼び出しが失敗したことを示します。

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

- (int)removeExternalAudioStream:(int)streamId;

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

呼び出しタイミング

カスタム音声入力機能を使用するには、addExternalAudioStream メソッドを呼び出して音声ストリームを追加し、外部音声ストリーム ID を取得してから、pushExternalAudioStream インターフェイスを呼び出して音声データを SDK にプッシュします。カスタム音声入力を停止したい場合は、対応するメソッドを呼び出して外部音声ストリームを削除し、リソースを解放します。

パラメーター

戻り値

0 は成功を示します。それ以外の値は失敗を示します。

音声ファイル情報を取得します。

- (int)getAudioFileInfo:(NSString *_Nonnull)filePath;

パラメーター

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

- (int)startAudioAccompanyWithFile:(NSString *_Nonnull)filePath config:(AliRtcAudioAccompanyConfig *_Nonnull)config;

パラメーター

戻り値

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

音声伴奏ミキシングを停止します。

- (int)stopAudioAccompany;

戻り値

戻り値 0 は成功を示します。それ以外の値は失敗を示します。

伴奏ボリュームを設定します。

- (int)setAudioAccompanyVolume:(NSInteger)volume;

パラメーター

戻り値

0 は成功、それ以外は失敗です。

音声伴奏の配信ボリュームを設定します。

- (int)setAudioAccompanyPublishVolume:(NSInteger)volume;

パラメーター

戻り値

成功した場合は 0 を返します。失敗した場合はエラーコードが返されます。

音声伴奏の配信ボリュームレベルを取得できます。

- (int)getAudioAccompanyPublishVolume;

戻り値

[0, 100] の範囲の値は成功を示します。それ以外の値は失敗を示します。

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

- (int)setAudioAccompanyPlayoutVolume:(NSInteger)volume;

パラメーター

戻り値

戻り値が 0 の場合、成功です。それ以外の場合は失敗です。

伴奏のローカル再生ボリュームを取得できます。

- (int)getAudioAccompanyPlayoutVolume;

戻り値

0 から 100 の範囲の値は成功を示し、それ以外の値は失敗を示します。

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

- (int)pauseAudioAccompany;

戻り値

戻り値が 0 の場合、成功です。それ以外の場合は失敗です。

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

- (int)resumeAudioAccompany;

戻り値

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

伴奏ファイルの再生時間（ミリ秒単位）を取得します。

- (int)getAudioAccompanyDuration;

戻り値

成功した場合は伴奏ファイルの再生時間をミリ秒単位で返します（>= 0）。失敗した場合は 0 未満の値を返します。

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

- (int)getAudioAccompanyCurrentPosition;

戻り値

0 以上の値は、現在の再生位置（ミリ秒単位）を示します。負の値は失敗を示します。

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

- (int)setAudioAccompanyPosition:(int)pos;

パラメーター

戻り値

戻り値が 0 の場合、成功です。それ以外の場合は失敗です。

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

- (int)preloadAudioEffectWithSoundId:(NSInteger)soundId filePath:(NSString *_Nonnull)filePath;

パラメーター

戻り値の説明

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

プリロード済みの効果音を削除します。

- (int)unloadAudioEffectWithSoundId:(NSInteger)soundId;

パラメーター

戻り値の説明

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

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

- (int)playAudioEffectWithSoundId:(NSInteger)soundId filePath:(NSString *_Nonnull)filePath cycles:(NSInteger)cycles publish:(BOOL)publish;

パラメーター

戻り値の説明

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

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

- (int)stopAudioEffectWithSoundId:(NSInteger)soundId;

パラメーター

戻り値の説明

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

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

- (int)stopAllAudioEffects;

戻り値の説明

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

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

- (int)pauseAudioEffectWithSoundId:(NSInteger)soundId;

パラメーター

戻り値の説明

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

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

- (int)pauseAllAudioEffects;

応答の説明

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

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

- (int)resumeAudioEffectWithSoundId:(NSInteger)soundId;

パラメーター

戻り値の説明

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

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

- (int)resumeAllAudioEffects;

戻り値の説明

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

ストリームアップロード用の効果音のボリュームを設定します。

- (int)setAudioEffectPublishVolumeWithSoundId:(NSInteger)soundId volume:(NSInteger)volume;

パラメーター

戻り値の説明

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

ストリームアップロード用の効果音のボリュームを照会します。

- (int)getAudioEffectPublishVolumeWithSoundId:(NSInteger)soundId;

パラメーター

戻り値の説明

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

すべての効果音をストリームアップロードにミックスする際のボリュームを設定します。

- (int)setAllAudioEffectsPublishVolume:(NSInteger)volume;

パラメーター

応答の説明

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

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

- (int)setAaudioEffectPlayoutVolumeWithSoundId:(NSInteger)soundId volume:(NSInteger)volume;

パラメーター

戻り値の説明

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

ローカル再生用の効果音のボリュームを照会します。

- (int)getAudioEffectPlayoutVolumeWithSoundId:(NSInteger)soundId;

パラメーター

戻り値の説明

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

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

- (int)setAllAudioEffectsPlayoutVolume:(NSInteger)volume;

パラメーター

戻り値の説明

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

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

- (BOOL)startRecord:(AliRtcRecordType)recordType recordFormat:(AliRtcRecordFormat)recordFormat filePath:(NSString*)filePath audioConfig:(AliRtcRecordAudioConfig*)audioConfig videoConfig:(AliRtcRecordVideoConfig*)videoConfig;

パラメーター

戻り値の説明

TRUE の値は成功を示します。それ以外の値は失敗を示します。

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

- (void)stopRecord 

パラメーター

なし。

ローカルプレビューのレンダリングビューおよび描画パラメーターを設定します。

- (int)setLocalViewConfig:(AliVideoCanvas *_Nullable)viewConfig forTrack:(AliRtcVideoTrack)track;

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

呼び出しのタイミング

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

パラメーターの説明

戻り値の説明

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

カメラの収集設定を設定します。

- (int)setCameraCapturerConfiguration:(AliRtcCameraCapturerConfiguration* _Nonnull)config;

このメソッドは、カメラ方向やフレームレートなどのカメラキャプチャ設定を構成します。

呼び出しのタイミング

カメラをオンにする前に設定する必要があります。たとえば、次の操作の前：

• startPreview

• joinChannel（チャネルへの参加）

パラメーター

戻り値の説明

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

ローカル映像収集を無効または再有効にします。

- (int)enableLocalVideo:(BOOL)enable;

このメソッドはローカル映像キャプチャを有効または無効にします。無効にすると、ローカルプレビューおよびストリームアップロードでは映像が表示されません。ただし、リモート映像の受信には影響しません。ローカルカメラキャプチャを無効にすると、ローカルプレビューおよびストリームアップロードは最後のフレームでフリーズします。

呼び出しタイミング

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

関連コールバック

• このメソッドを正常に呼び出した後、onUserVideoEnabled コールバックがリモートユーザーに通知されます。

パラメーター

戻り値の説明

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

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

- (int)muteLocalCamera:(BOOL)mute forTrack:(AliRtcVideoTrack)track;

このメソッドを呼び出して、配信時に黒いフレームを送信します。ローカルプレビューは通常どおり表示されます。キャプチャ、エンコーディング、送信モジュールはアクティブなままになり、黒いフレームのみ送信されます。

パラメーターの説明

戻り値の説明

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

リモートユーザーの映像トラックのレンダリングビューおよび描画パラメーターを設定します。

- (int)setRemoteViewConfig:(AliVideoCanvas *_Nullable)canvas uid:(NSString *_Nonnull)uid forTrack:(AliRtcVideoTrack)track;

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

• AliVideoCanvas：レンダリングキャンバス の view パラメーターが null の場合、レンダリングは停止します。

• 再生中に AliVideoCanvas：レンダリングキャンバス の renderMode パラメーターをリセットするには、renderMode 値のみを変更し、他のパラメーターは変更しないでください。

• 再生中に AliVideoCanvas：レンダリングキャンバス の mirrorMode パラメーターをリセットするには、mirrorMode 値のみを変更し、他のパラメーターは変更しないでください。

呼び出しタイミング

リモートユーザーの映像が利用可能になったときにトリガーされる onRemoteTrackAvailableNotify コールバックを受信したときに、このメソッドを呼び出すことを推奨します。

パラメーター

応答の説明

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

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

- (BOOL)isCameraOn;

応答の説明

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

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

- (void)setVideoEncoderConfiguration:(AliRtcVideoEncoderConfiguration* _Nonnull)config;

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

呼び出しタイミング

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

制限事項

このメソッドと setVideoMirrorMode の両方が映像ストリームのミラー表示を制御します。どちらか一方のみ使用することを推奨します。両方を使用すると、重複したミラー効果が発生し、不適切な動作につながる可能性があります。

パラメーター

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

- (void)setVideoDecoderConfiguration:(AliRtcVideoDecoderConfiguration* _Nonnull)config;

このメソッドは、カメラストリームの映像デコーディングパラメーターを設定します。

呼び出しタイミング

会議に参加する前にこのメソッドを呼び出すことができます。

パラメーター

前面および背面カメラを切り替えます。デフォルトでは前面カメラが使用されます。このメソッドは iOS のみで利用可能です。

- (int)switchCamera;

このメソッドは、前面または背面カメラのいずれを使用するかを制御します。ハードウェアの可用性に基づいてアプリケーション実行中に動的にカメラを切り替えることができ、映像ストリームを再起動したり、映像ソースを再構成したりする必要はありません。

呼び出しタイミング

このメソッドは、カメラが正常にオンになった後のみ呼び出すことができます。

制限事項

このメソッドは iOS および Android プラットフォームでのみサポートされています。

戻り値の説明

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

現在のカメラタイプを照会します。デフォルトでは前面カメラが使用されます。このメソッドは iOS のみで利用可能です。

- (AliRtcCameraDirection)getCurrentCameraDirection;

戻り値の説明

カメラ方向列挙型を返します。

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

- (int)startPreview;

この API はローカル映像プレビューを有効にし、自動的にカメラを起動します。ローカルプレビューを停止するには、`stopPreview` API を呼び出します。

呼び出しタイミング

• このメソッドを呼び出す前に、setLocalViewConfig を使用してプレビュー表示を設定できます。そうしないとプレビューは失敗しますが、ストリームアップロードには影響しません。

• チャネルに参加する前にこのメソッドを呼び出して早期にプレビューを開始できます。カメラは自動的に起動します。

戻り値の説明

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

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

- (int)stopPreview;

このメソッドはローカル映像プレビューを停止し、カメラを無効にします。停止後、ローカルプレビューは最後のフレームでフリーズします。ストリームアップロードには影響しません。

呼び出しタイミング

プレビューを停止するためにこのメソッドを呼び出すことができます。

戻り値の説明

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

カメラズームを設定します。

 - (int)setCameraZoom:(float)zoom;

パラメーター

戻り値

成功時は 0 を返します。それ以外の値は失敗を示します。

カメラの最大ズーム係数を取得します。

 - (float)GetCameraMaxZoomFactor;

戻り値

カメラの最大ズーム係数です。

現在のカメラズームレベルを取得します。

- (float)GetCurrentZoom;

戻り値

現在のカメラズームレベルです。

カメラ露出レベルを設定できます。

- (int)SetExposure:(float)exposure;

パラメーター

戻り値

0 は成功を示します。それ以外の値は失敗を示します。

カメラ露出を取得できます。

- (float)GetCurrentExposure;

戻り値

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

最小カメラ露出を取得します。

- (float)GetMinExposure;

戻り値

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

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

- (float)GetMaxExposure;

戻り値

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

カメラフラッシュのトグルを設定できます。

- (int)setCameraFlash:(BOOL)flash;

パラメーター

戻り値

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

手動フォーカスがサポートされているかどうかを確認します。

- (BOOL)isCameraFocusPointSupported;

戻り値

手動フォーカスがサポートされている場合は TRUE を返し、そうでない場合は FALSE を返します。

カメラは露出ポイントの設定をサポートしていますか？

- (BOOL)isCameraExposurePointSupported;

戻り値

TRUE は露出ポイントの設定がサポートされていることを示します。FALSE はサポートされていないことを示します。

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

- (int)setCameraFocusPoint:(CGPoint)point;

パラメーター

戻り値

成功時は 0 を返します。それ以外の値は失敗を示します。

指定されたポイントでの露出値を設定します。

- (int)setCameraExposurePoint:(CGPoint)point;

パラメーター

戻り値

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

カメラは顔フォーカスをサポートしていますか？

- (BOOL)isCameraAutoFocusFaceModeSupported;

戻り値

TRUE の値は顔自動フォーカスがサポートされていることを示し、FALSE の値はサポートされていないことを示します。

顔自動フォーカスを有効または無効にできます。

- (BOOL)setCameraAutoFocusFaceModeEnabled:(BOOL)enable;

パラメーター

戻り値

戻り値が TRUE の場合、成功です。戻り値が FALSE の場合、失敗です。

映像ミラー表示モードを設定します。

- (int)setVideoMirrorMode:(AliRtcVideoPipelineMirrorMode)mirrorMode;

ローカルプレビューおよび公開映像ストリームにミラー表示を適用するかどうかを設定します。

呼び出しタイミング

このメソッドはチャネルに参加する前または後に動的に呼び出すことができます。SDK は状態を保存し、プレビューまたはエンコーディング（ストリームアップロード）時にミラー表示を適用します。

制限事項

このメソッドは setLocalViewConfig および setVideoEncoderConfiguration と重複しており、どちらにも mirrorMode パラメーターが含まれています。これらのうち 1 つだけを使用することを推奨します。

パラメーター

映像リンクのスケーリングモードを設定できます。

-(void)setCapturePipelineScaleMode:(AliRtcCapturePipelineScaleMode)mode;

キャプチャ時またはエンコーディング時のどちらで映像データをスケーリングするかを指定します。たとえば、キャプチャ解像度とエンコーディング解像度が異なる場合、この設定により、プレビュー用データとストリームアップロード用データが一致するかどうかが決まります。

呼び出しタイミング

カメラを起動する前にこのメソッドを設定する必要があります。たとえば、startPreview または joinChannel を呼び出す前です。

パラメーター

戻り値

0 の値は成功を示します。それ以外の値は失敗を示します。

映像データ出力オブザーバーを登録します。

- (void)registerVideoFrameWithObserver:(id<AliRtcVideoFrameDelegate> _Nullable)observer;

このメソッドを使用して、映像データをエクスポートするオブジェクトを登録できます。登録解除するには、unregisterVideoSampleWithObserver を呼び出します。

呼び出しのタイミング

生の映像データ（YUV や RGBA 形式など）をさまざまな段階で取得するには、このインターフェイスを呼び出して映像データモニターを登録できます。

関連コールバック

映像データ出力オブザーバーを正常に登録した後、SDK は各映像フレームのキャプチャ時に実装したコールバックをトリガーします。必要に応じて以下のコールバックを実装してください。

• onCaptureVideoSample：ローカルでキャプチャされた映像データのコールバック。

• onRemoteVideoSample：リモート映像データのコールバック。

• onPreEncodeVideoSample：エンコーディング前のローカル映像データのコールバック。

パラメーター

映像データ出力オブジェクトをキャンセルできます。

- (void)unregisterVideoSampleWithObserver:(id<AliRtcVideoFrameDelegate> _Nullable)observer;

このインターフェイスは <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#9a3437ab16j1w" id="f524bad30a6ys">registerVideoSampleObserver</a> インターフェイスに対応し、映像データ出力オブジェクトを登録解除します。

パラメーター

ローカルカメラ映像用の OpenGL テクスチャオブザーバーを登録します。

- (void)registerLocalVideoTextureObserver:(id<AliRtcTextureDelegate> _Nullable)observer;

生の映像データを取得するには、registerVideoSampleObserver を呼び出します。内部テクスチャデータを取得するには、このメソッドを呼び出します。オブザーバーを登録解除するには、unRegisterLocalVideoTextureObserver を呼び出します。

関連コールバック

ローカルカメラ映像用の OpenGL テクスチャオブザーバーを正常に登録した後、SDK は各映像フレームがキャプチャされるたびに AliRtcTextureObserver で実装したコールバックをトリガーします。必要に応じて以下のコールバックを実装できます。

• onTextureCreate：SDK が内部 OpenGL コンテキストを作成したときにトリガーされるコールバックです。

• onTextureUpdate：各映像フレームが OpenGL テクスチャにアップロードされた後にトリガーされるコールバックです。外部テクスチャオブザーバーが登録されている場合、テクスチャを処理し、更新されたテクスチャ ID を返すことができます。返される値は有効なテクスチャ ID でなければなりません。処理を行わない場合は、入力された textureId を返します。

• onTextureDestroy：SDK が内部 OpenGL コンテキストを破棄したときにトリガーされるコールバックです。

パラメーター

ローカルカメラ映像用の OpenGL テクスチャオブザーバーを登録解除します。

- (void)unregisterLocalVideoTextureObserver:(id<AliRtcTextureDelegate> _Nullable)observer;

このメソッドは registerLocalVideoTextureObserver に対応し、その登録解除を処理します。

パラメーター

映像のスナップショットを撮影します。

- (int)snapshotVideo:(NSString*_Nullable)userId type:(AliRtcVideoTrack)type;

パラメーター

戻り値

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

外部映像ソースを有効にするかどうかを指定します。

- (int)setExternalVideoSource:(BOOL)enable sourceType:(AliRtcVideoSource)type renderMode:(AliRtcRenderMode)renderMode;

パラメーター

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

- (int)pushExternalVideoFrame:(AliRtcVideoDataSample *_Nonnull)frame sourceType:(AliRtcVideoSource)type;

パラメーター

戻り値の説明

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

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

- (int)startPublishLiveStreamWithURL:(NSString *_Nonnull)streamURL liveTranscoding:(AliRtcLiveTranscodingParam *_Nonnull)trancoding;

パラメーター

戻り値の説明

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

リレー型ライブストリーミングのパラメーターを更新します。

- (int)updatePublishLiveStreamWithURL:(NSString *_Nonnull)streamURL liveTranscoding:(AliRtcLiveTranscodingParam *_Nonnull)trancoding;

パラメーター

戻り値

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

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

- (int)stopPublishLiveStreamWithURL:(NSString *_Nonnull)streamURL;

パラメーター

戻り値の説明

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

リレー型ライブストリーミングのステータスを照会します。

- (AliRtcLiveTranscodingState)GetPublishLiveStreamStateWithURL:(NSString *_Nonnull)streamURL;

パラメーター

戻り値の説明

リレー型ライブストリーミングのステータスが返されます。

ネットワーク品質テストを開始します。

- (int)startLastmileDetect:(AliRtcNetworkQualityProbeConfig *_Nonnull)config;

パラメーター

戻り値の説明

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

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

- (int)stopLastmileDetect;

戻り値の説明

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

リバーブモードのパラメーターを設定します。

- (int)sendMediaExtensionMsg:(NSData *_Nonnull)data repeatCount:(int)repeatCount delay:(int)delay isKeyFrame:(bool)isKeyFrame;

SDK はメディア拡張メッセージの送受信をサポートしています。SEI (Supplemental Enhancement Information) プロトコルを使用してメッセージを送信します。受信者は onMediaExtensionMsgReceived コールバックをリッスンすることでメッセージを取得できます。

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

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

• メディア拡張メッセージを使用して、最大 4 KB のペイロードで記述情報を送信できます。小さなペイロードには、JSON またはプレーン文字列を使用します。

呼び出しタイミング

ストリームアップロードが開始された後にこのメソッドを呼び出します。

制限事項

メディア拡張メッセージは音声・映像データチャネルを再利用します。そのため、メッセージの頻度とサイズを制御する必要があります。以下の制限が適用されます。

• 1 秒あたりの最大メッセージ数は、プロファイルの 1 秒あたりのフレーム数（FPS）設定と同じです。SEI メッセージは H.264 または H.265 ストリームに埋め込まれるため、拡張データをアタッチするには映像フレームのエンコーディングが必要です。

• メディア転送品質に影響を与えないように、メッセージ本文のサイズは 4 KB に制限されています。この制限は小さなペイロードに適しています。

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

• パケット損失によるメッセージ損失を防ぐため、チャネル内の他のユーザーも重複したメッセージを受信します。重複排除を行う必要があります。

• リレー型ライブストリーミングセッションのサブスクライバーもカスタムメッセージを受信します。

• 一度に送信できる MediaExtensionMsg は 1 つだけです。sendMediaExtensionMsg を複数回呼び出すと、新しい呼び出しのデータが前の呼び出しのデータを上書きします。

関連コールバック

パブリッシャーがメディア拡張メッセージを送信すると、サブスクライバーは onMediaExtensionMsgReceived コールバックを通じてそれらを受信します。

パラメーターの説明

戻り値

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

メディア拡張情報は、SEI を使用して下位層で送信および実装されます。

- (int)sendMediaExtensionMsgEx:(NSData *_Nonnull)data repeatCount:(int)repeatCount delay:(int)delay isKeyFrame:(bool)isKeyFrame payloadType:(int)payloadType;

SDK はメディア拡張メッセージの送受信をサポートしています。このメソッドは、SEI (Supplemental Enhancement Information) プロトコルを使用してメッセージを送信します。受信者は、onMediaExtensionMsgReceived コールバックをリッスンすることでメッセージを取得できます。payloadType が 5 の場合、このメソッドは sendMediaExtensionMsg と同じように機能します。

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

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

• メディア拡張メッセージを使用して、記述情報を送信できます。最大 4 KB のデータを送信できます。小さなペイロードには、JSON またはプレーン文字列を使用します。

呼び出しタイミング

ストリームアップロードを開始した後に呼び出すことができます。

呼び出し制限

メディア拡張メッセージは音声・映像データチャネルを再利用します。そのため、これらのメッセージの頻度とサイズを制御する必要があります。制限は次のとおりです。

• 1 秒あたりの最大メッセージ数は、プロファイルの 1 秒あたりのフレーム数（FPS）設定と同じです。SEI メッセージは H.264 または H.265 ストリームに埋め込まれるため、拡張データをアタッチするには映像フレームのエンコーディングが必要です。

• メディア転送品質に影響を与えないように、メッセージ本文のサイズは 4 KB に制限されています。この制限は小さなペイロードに適しています。

• sendMediaExtensionMsg 関数の repeatCount パラメーターは、メッセージの冗長性を定義します。1 より大きい値は複数回の送信をトリガーします。

• パケット損失によるメッセージ損失を防ぐため、チャネル内の他のユーザーも重複したメッセージを受信します。重複排除を行う必要があります。

• リレー型ライブストリーミングセッションのサブスクライバーもカスタムメッセージを受信します。

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

パラメーター

戻り値の説明

• 0：成功。

• < 0：失敗。エラーコードを返します。

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

ネットワーク接続ステータスが変更されたときに呼び出されるコールバックです。

- (void)onConnectionStatusChange:(AliRtcConnectionStatus)status reason:(AliRtcConnectionStatusChangeReason)reason;

パラメーター

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

- (void)onLocalDeviceException:(AliRtcLocalDeviceType)deviceType exceptionType:(AliRtcLocalDeviceExceptionType)exceptionType message:(NSString *_Nullable)msg;

パラメーター

ユーザー認証が期限切れになる直前に呼び出されるコールバックです。このコールバックを受信してから 30 秒後に認証が期限切れになります。このコールバックに注意してください。

- (void)onAuthInfoWillExpire;

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

• <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#e6a4495191bmd" id="918ba91977wi6">refreshAuthInfo</a> API を呼び出して認証情報を更新します。

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

トリガー条件

SDK は、認証が期限切れになる 30 秒前にこのコールバックをトリガーします。これを受信したら、速やかに認証を更新してください。

ユーザーが認証済み API を呼び出し、サーバーから期限切れの応答が返されます。

- (void)onAuthInfoExpired;

このコールバックは、ユーザー認証が期限切れになったことを示します。セッションを続行するには、サーバーで新しいトークンを生成し、次のいずれかの方法で認証を更新します。

• <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#449873b819cz2" id="21390e77a1307">leaveChannel</a> を呼び出して現在のチャネルから退出してから、joinChannel を呼び出してチャネルに再参加します。

トリガーされたとき

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

このコールバックは、チャネルへの参加結果を報告します。joinChannel メソッドのブロッキング操作と機能的に同等です。チャネルに参加した後のイベントを処理するために、どちらのアプローチも使用できます。

- (void)onJoinChannelResult:(int)result channel:(NSString *_Nonnull)channel elapsed:(int) elapsed;

トリガー条件

このコールバックは、アプリが joinChannel メソッドを呼び出したときにトリガーされます。操作が成功したか失敗したかを報告し、参加遅延を含む関連情報を返します。

パラメーター

このコールバックは、leaveChannel を呼び出した後に呼び出されます。leaveChannel の直後に destroy を呼び出すと、このコールバックはトリガーされません。

- (void)onLeaveChannelResult:(int)result stats:(AliRtcStats)stats;

パラメーター

リモートユーザーがオフラインになったときに呼び出されるコールバックです。

- (void)onRemoteUserOffLineNotify:(NSString *_Nonnull)uid offlineReason:(AliRtcUserOfflineReason)reason;

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

トリガー条件

• このコールバックは、リモートユーザーがチャネルから退出したときにトリガーされます。

• リモートストリーマーが <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#892915dd4edcy" id="78b1952ad5lwp">setClientRole</a> を呼び出して視聴者ロール（AliRtcClientRoleLive）に切り替えると、コールバックがトリガーされます。

• システムがリモートストリーマーから長期間データを受信していないことを検出し、オフラインと見なした場合。

パラメーター

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

- (void)onRemoteUserOnLineNotify:(NSString *_Nonnull)uid elapsed:(int)elapsed;

このメソッドは、リモートユーザーがチャネルに参加したときにトリガーされます。

トリガー条件

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

• ローカルユーザーがチャネルに参加した後、すでにチャネルにいたユーザーの参加コールバックを受信して、以前に参加したユーザーを表示します。

パラメーター

リモートユーザーのストリームが変更されたときに呼び出されるコールバックです。

- (void)onRemoteTrackAvailableNotify:(NSString *_Nonnull)uid audioTrack:(AliRtcAudioTrack)audioTrack videoTrack:(AliRtcVideoTrack)videoTrack;

このコールバックは、リモートユーザーの配信ステータスが変更されたときにトリガーされます。これを使用して、リモートユーザーが音声および映像ストリームを配信しているかどうかを監視し、メディアを表示または非表示にすることで UI を更新できます。

トリガー条件

このコールバックは、以下の場合にトリガーされます。

• リモートユーザーが音声および/または映像の配信を開始した場合。

• リモートユーザーが音声および/または映像の配信を停止した場合。

• インタラクティブモードで、リモートユーザーが setClientRole を呼び出して、視聴者からストリーマーに切り替えてストリームを配信した場合。

たとえば、リモートユーザーが映像ストリームのアップロードを無効にした場合、このコールバックはトリガーされません。

• リモートユーザーがカメラ映像の配信を開始した場合（配信ステータス：映像なし → カメラのみ）、このコールバックは AliRtcVideoTrackCamera を返し、リモートユーザーのカメラストリームが利用可能であることを示します。

• 同じユーザーが後で画面共有も配信した場合（配信ステータス：カメラのみ → カメラ + 画面共有）、このコールバックは AliRtcVideoTrackBoth を返し、カメラと画面共有の両方のストリームが利用可能であることを示します。

• ユーザーがカメラ映像の配信を停止し、画面共有を続行した場合（配信ステータス：カメラ + 画面共有 → 画面共有のみ）、このコールバックは AliRtcVideoTrackScreen を返し、画面共有ストリームのみが利用可能であることを示します。

• ユーザーが画面共有の配信を停止した場合（配信ステータス：画面共有のみ → 映像なし）、このコールバックは AliRtcVideoTrackNo を返し、映像ストリームが利用できないことを示します。

パラメーター

ユーザーがチャネルから強制的に退出させられたときに呼び出されるコールバックです。

- (void)onBye:(int)code;

このコールバックは、ユーザーが切断されたり、セッションが終了したりしたときにトリガーされます。開発者は code パラメーターを使用して原因を特定し、適切に処理できます。

トリガー条件

• ユーザーがサーバーによって切断されました。

• セッションが終了しました（サーバーがチャネルを終了しました）。

• ユーザーが受動的に切断されました。クライアントはセッションの回復または再接続を試みる必要があります。

パラメーター

音声トラックのストリームアップロードステータスが変更されたときに呼び出されるコールバックです。

- (void)onAudioPublishStateChanged:(AliRtcPublishState)oldState newState:(AliRtcPublishState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

このコールバックは、ローカルユーザーの音声配信ステータスの変更を監視します。

トリガー条件

このコールバックは、ユーザーの音声配信ステータスが変更されたときにトリガーされます。例：

• ストリームアップロードを停止します。

• <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#892915dd4edcy" id="81771ef0798we">setClientRole</a> を呼び出して視聴者に切り替えることができます。

パラメーター

音声トラックのサブスクリプションステータスが変更されたときに呼び出されるコールバックです。

- (void)onAudioSubscribeStateChanged:(NSString *_Nonnull)uid oldState:(AliRtcSubscribeState)oldState newState:(AliRtcSubscribeState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

このコールバックは、リモートユーザーの音声ストリームのサブスクリプションステータスが変更されたときに、ローカルユーザーに通知します。これを使用して、特定のリモートユーザーのカメラストリームのサブスクリプションステータスの変更および状態間の間隔を追跡できます。

パラメーター

ユーザーが音声トラックをミュートしたときに呼び出されるコールバックです。

- (void)onUserAudioMuted:(NSString *_Nonnull)uid audioMuted:(BOOL)isMute;

パラメーター

ユーザーの音声トラックが中断されたときに呼び出されるコールバックです。たとえば、ユーザーが電話をかけると音声トラックが占有されることがあります。

- (void)onUserAudioInterruptedBegin:(NSString *_Nonnull)uid;

パラメーター

ユーザーの音声トラックの中断が終了したときに呼び出されるコールバックです。このコールバックは onUserAudioInterruptedBegin コールバックと対になっています。

- (void)onUserAudioInterruptedEnded:(NSString *_Nonnull)uid;

パラメーター

映像トラックのストリームアップロードステータスが変更されたときに呼び出されるコールバックです。

- (void)onVideoPublishStateChanged:(AliRtcPublishState)oldState newState:(AliRtcPublishState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

このコールバックは、ローカルユーザーの映像配信ステータスの変更を監視します。

パラメーター

映像トラックのサブスクリプションステータスが変更されたときに呼び出されるコールバックです。

- (void)onVideoSubscribeStateChanged:(NSString *_Nonnull)uid oldState:(AliRtcSubscribeState)oldState newState:(AliRtcSubscribeState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

このコールバックは、リモートユーザーのカメラストリームのサブスクリプションステータスの変更をローカルユーザーに通知します。新しいサブスクリプションステータスと、状態変更間の経過時間を提供します。

関連コールバック

映像ストリームには、カメラストリームと画面共有ストリームが含まれます。このコールバックは、カメラストリームのサブスクリプション変更によってトリガーされます。画面共有ストリームのサブスクリプション変更は、onScreenShareSubscribeStateChanged コールバックをトリガーします。

パラメーター

ユーザー映像ミュート通知。

- (void)onUserVideoMuted:(NSString *_Nonnull)uid videoMuted:(BOOL)isMute;

パラメーター

ローカル映像キャプチャが無効または再有効になったときに通知が送信されます。

- (void)onUserVideoEnabled:(NSString *_Nullable)uid videoEnabled:(BOOL)isEnable;

パラメーター

リモートユーザーがアプリケーションをバックグラウンドに切り替えたときに呼び出されるコールバックです。

- (void)onUserWillResignActive:(NSString *_Nonnull)uid;

パラメーター