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-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 を使用してプレビュービューを設定できます。そうしないと、プレビューは失敗しますが、アップストリーミングは影響を受けません。

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

戻り値の説明

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 は状態を保存し、プレビューまたはエンコーディング (アップストリーミング) 中にミラーリングを適用します。

制限事項

このメソッドは、mirrorMode パラメーターをサポートする setLocalViewConfig および setVideoEncoderConfiguration と重複します。このメソッドのみを使用することを推奨します。

パラメーター

ビデオリンクのスケーリングモードを設定できます。

-(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 はメディア拡張メッセージの送受信をサポートしています。メッセージは Supplemental Enhancement Information (SEI) プロトコルを使用して送信されます。受信者は 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 はメディア拡張メッセージの送受信をサポートしています。このメソッドは、Supplemental Enhancement Information (SEI) プロトコルを使用してメッセージを送信します。受信者は、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 パラメーターを使用して原因を特定し、適切に処理できます。

トリガー条件

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

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

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

パラメーター