ApsaraVideo Live:事前通話デバイステスト

概要

Alibaba Real-Time Communication (ARTC) SDK は、事前通話時のデバイス検出機能を提供しており、マイク、スピーカー、カメラなどのローカル音声・映像デバイスをテストできます。事前にハードウェアの問題を検出することで、予期しないデバイス障害を防止し、円滑な通信体験を確保できます。

サンプルコード

Android: Android/ARTCExample/AdvancedUsage/src/main/java/com/aliyun/artc/api/advancedusage/PreJoinChannelTest/PreJoinChannelTestActivity.java。

iOS: iOS/ARTCExample/AdvancedUsage/PreJoinChannelTest/PreJoinChannelTestVC.swift。

Harmony: Harmony/ARTCExample/entry/src/main/ets/pages/advancedusage/PreJoinChannelTestPage.ets。

実装方法

/**
 * @brief 通話開始前の音声キャプチャデバイステストを開始します。
 * @details このメソッドは音声キャプチャテストを開始します。
 * - 音声キャプチャが正常に動作しているかを確認するには、{@link AliRtcAudioVolumeObserver::onTestAudioVolumeCallback} コールバックを使用します。
 * @return 
 * - 0: 成功。
 * - 0 以外の値: エラーコード。
 * @note このメソッドは、{@link joinChannel} を使用してチャンネルに参加する前に呼び出す必要があります。
 */
public abstract int startAudioCaptureTest();

/**
 * @brief 通話開始前の音声キャプチャデバイステストを開始します。
 * @details このメソッドは音声キャプチャを開始します。
 * - 音声キャプチャが正常に動作しているかを確認するには、{@link onTestAudioVolumeCallback} コールバックを使用します。
 * @note このメソッドは、{@link joinChannel} を使用してチャンネルに参加する前に呼び出す必要があります。
 */
- (void)startAudioCaptureTest;

/**
 * @brief 通話開始前の音声キャプチャテストを開始します。
 * @details このメソッドは音声キャプチャテストを開始します。
 * - 音声キャプチャが正常に動作しているかを確認するには、{@link AliEngineEventListener::OnTestAudioVolumeCallback} コールバックを使用します。
 * @return
 * - 0: 成功。
 * - 0 以外の値: エラーコード。
 * @note このメソッドは、{@link JoinChannel} を使用してチャンネルに参加する前に呼び出す必要があります。
 */
virtual int StartAudioCaptureTest() = 0;

/**
 * @brief ローカルデバイス例外のコールバック。
 * @param deviceType デバイスタイプ。詳細については、{@link AliRtcEngine.AliRtcEngineLocalDeviceType} をご参照ください。
 * @param exceptionType 例外タイプ。詳細については、{@link AliRtcEngine.AliRtcEngineLocalDeviceExceptionType} をご参照ください。
 * @param msg 例外メッセージ。
 * @note このコールバックは、回復不能な内部デバイス例外が発生した際にトリガーされます。このコールバックがトリガーされた場合、デバイスの可用性を確認してください。
 */
public void OnLocalDeviceException(AliRtcEngine.AliRtcEngineLocalDeviceType deviceType, AliRtcEngine.AliRtcEngineLocalDeviceExceptionType exceptionType, String msg){}

/**
 * @brief ローカルデバイス例外のコールバック。
 * @param deviceType デバイスタイプ。詳細については、{@link AliRtcLocalDeviceType} をご参照ください。
 * @param exceptionType 例外タイプ。詳細については、{@link AliRtcLocalDeviceExceptionType} をご参照ください。
 * @param msg 例外メッセージ。
 * @note このコールバックは、回復不能な内部デバイス例外が発生した際にトリガーされます。このコールバックがトリガーされた場合、デバイスの可用性を確認してください。
 */
- (void)onLocalDeviceException:(AliRtcLocalDeviceType)deviceType exceptionType:(AliRtcLocalDeviceExceptionType)exceptionType message:(NSString *_Nullable)msg;

/**
 * @brief ローカルデバイス例外のコールバック。
 * @param deviceType デバイスタイプ。詳細については、{@link AliEngineLocalDeviceType} をご参照ください。
 * @param exceptionType 例外タイプ。詳細については、{@link AliEngineLocalDeviceExceptionType} をご参照ください。
 * @param msg 例外メッセージ。
 * @note このコールバックは、回復不能な内部デバイス例外が発生した際にトリガーされます。このコールバックがトリガーされた場合、デバイスの可用性を確認してください。
 */
virtual void OnLocalDeviceException(AliEngineLocalDeviceType deviceType, AliEngineLocalDeviceExceptionType exceptionType, const char* msg){};

/**
 * @brief 事前通話テスト中の音声ボリュームのコールバック。
 * @param volume 音声ボリューム。
 */
public void OnTestAudioVolume(int volume) {}

/**
 * @brief 事前通話テスト中のキャプチャ音声ボリュームのコールバック。
 * @param volume 音声ボリューム。
 */
- (void)onTestAudioVolumeCallback:(int)volume;

/**
 * @brief 事前通話テスト中のキャプチャ音声ボリュームのコールバック。
 * @param volume 音声ボリューム。
 */
virtual void OnTestAudioVolumeCallback(int volume) {}

/**
 * @brief 音声キャプチャテストを停止します。
 * @return 
 * - 0: 成功。
 * - 0 以外の値: エラーコード。
 * @note このメソッドは、{@link joinChannel} を使用してチャンネルに参加する前に呼び出す必要があります。
 */
public abstract int stopAudioCaptureTest();

/**
 * @brief 音声キャプチャテストを停止します。
 * @note このメソッドは、{@link joinChannel} を使用してチャンネルに参加する前に呼び出す必要があります。
 */
- (void)stopAudioCaptureTest;

/**
 * @brief 音声キャプチャテストを停止します。
 * @return
 * - 0: 成功。
 * - 0 以外の値: エラーコード。
 * @note このメソッドは、{@link JoinChannel} を使用してチャンネルに参加する前に呼び出す必要があります。
 */
virtual int StopAudioCaptureTest() = 0;

/**
 * @brief テスト用に音声ファイルを再生します。
 * @param filePath 音声ファイルのパス。
 * @return 成功時は 0、失敗時は負の値を返します。
 * @note このメソッドは、{@link joinChannel} を使用してチャンネルに参加する前に呼び出す必要があります。
 */
public abstract int playAudioFileTest(String filePath) ;

/**
 * @brief テスト用に音声ファイルを再生します。
 * @param filePath 音声ファイルのパス。
 * @return 成功時は 0、失敗時は負の値を返します。
 * @note このメソッドは、{@link joinChannel} を使用してチャンネルに参加する前に呼び出す必要があります。
 */
- (int)playAudioFileTest:(NSString *_Nonnull)filePath;

/**
 * @brief テスト用に音声ファイルを再生します。
 * @param filePath 音声ファイルのパス。
 * @return 成功時は 0、失敗時は負の値を返します。
 * @note このメソッドは、{@link JoinChannel} を使用してチャンネルに参加する前に呼び出す必要があります。
 */
virtual int PlayAudioFileTest(const char* filePath) = 0;

/**
 * @brief ローカルデバイス例外のコールバック。
 * @param deviceType デバイスタイプ。詳細については、{@link AliRtcEngine.AliRtcEngineLocalDeviceType} をご参照ください。
 * @param exceptionType 例外タイプ。詳細については、{@link AliRtcEngine.AliRtcEngineLocalDeviceExceptionType} をご参照ください。
 * @param msg 例外メッセージ。
 * @note このコールバックは、回復不能な内部デバイス例外が発生した際にトリガーされます。このコールバックがトリガーされた場合、デバイスの可用性を確認してください。
 */
public void OnLocalDeviceException(AliRtcEngine.AliRtcEngineLocalDeviceType deviceType, AliRtcEngine.AliRtcEngineLocalDeviceExceptionType exceptionType, String msg){}

/**
 * @brief ローカルデバイス例外のコールバック。
 * @param deviceType デバイスタイプ。詳細については、{@link AliRtcLocalDeviceType} をご参照ください。
 * @param exceptionType 例外タイプ。詳細については、{@link AliRtcLocalDeviceExceptionType} をご参照ください。
 * @param msg 例外メッセージ。
 * @note このコールバックは、回復不能な内部デバイス例外が発生した際にトリガーされます。このコールバックがトリガーされた場合、デバイスの可用性を確認してください。
 */
- (void)onLocalDeviceException:(AliRtcLocalDeviceType)deviceType exceptionType:(AliRtcLocalDeviceExceptionType)exceptionType message:(NSString *_Nullable)msg;

/**
 * @brief ローカルデバイス例外のコールバック。
 * @param deviceType デバイスタイプ。詳細については、{@link AliEngineLocalDeviceType} をご参照ください。
 * @param exceptionType 例外タイプ。詳細については、{@link AliEngineLocalDeviceExceptionType} をご参照ください。
 * @param msg 例外メッセージ。
 * @note このコールバックは、回復不能な内部デバイス例外が発生した際にトリガーされます。このコールバックがトリガーされた場合、デバイスの可用性を確認してください。
 */
virtual void OnLocalDeviceException(AliEngineLocalDeviceType deviceType, AliEngineLocalDeviceExceptionType exceptionType, const char* msg){};

/**
 * @brief テスト用音声ファイルの再生を停止します。
 * @return 成功時は 0、失敗時は負の値を返します。
 * @note このメソッドは、{@link joinChannel} を使用してチャンネルに参加する前に呼び出す必要があります。
 */
public abstract int stopAudioFileTest();

/**
 * @brief テスト用音声ファイルの再生を停止します。
 * @return 成功時は 0、失敗時は負の値を返します。
 * @note このメソッドは、{@link joinChannel} を使用してチャンネルに参加する前に呼び出す必要があります。
 */
- (int)stopAudioFileTest;

/**
 * @brief テスト用音声ファイルの再生を停止します。
 * @return 成功時は 0、失敗時は負の値を返します。
 * @note このメソッドは、{@link JoinChannel} を使用してチャンネルに参加する前に呼び出す必要があります。
 */
virtual int StopAudioFileTest() = 0;

/**
 * @brief ローカルプレビュー表示の設定を行います。
 * @param viewConfig ローカル映像の表示プロパティ。詳細については、{@link com.alivc.rtc.AliRtcEngine.AliRtcVideoCanvas} をご参照ください。
 * @param track {@link AliRtcVideoTrack#AliRtcVideoTrackCamera} および {@link AliRtcVideoTrack#AliRtcVideoTrackScreen} のみサポートされています。
 * @return
 * - 0: 成功。
 * - < 0: 失敗。
 * @note チャンネル参加前後いずれでもビューの切り替えが可能です。canvas または {@link AliRtcVideoCanvas#view} が null の場合、レンダリングは停止します。
 *       {@link AliRtcVideoCanvas#renderMode} または {@link AliRtcVideoCanvas#mirrorMode} を変更するには、他のキャンバスプロパティを保持したまま、新しい値でこのメソッドを再度呼び出します。
 */
public abstract int setLocalViewConfig(AliRtcVideoCanvas viewConfig, AliRtcVideoTrack track);

/**
 * @brief ローカルプレビュー表示の設定を行います。
 * @param viewConfig ローカル映像の表示プロパティ。詳細については、{@link AliVideoCanvas} をご参照ください。
 * @param track {@link AliRtcVideoTrackCamera} および {@link AliRtcVideoTrackScreen} のみサポートされています。
 * @return
 * - 0: 成功。
 * - < 0: 失敗。
 * @note チャンネル参加前後いずれでもビューの切り替えが可能です。canvas または {@link AliVideoCanvas::view} が nil の場合、レンダリングは停止します。
 *       {@link AliVideoCanvas::renderMode} または {@link AliVideoCanvas::mirrorMode} を変更するには、他のキャンバスプロパティを保持したまま、新しい値でこのメソッドを再度呼び出します。
 */
- (int)setLocalViewConfig:(AliVideoCanvas *_Nullable)viewConfig forTrack:(AliRtcVideoTrack)track;

/**
 * @brief ローカルプレビュー表示の設定を行います。
 * @param renderConfig ローカル映像の表示プロパティ。詳細については、{@link AliEngineVideoCanvas} をご参照ください。
 * @param track {@link AliEngineVideoTrackCamera} および {@link AliEngineVideoTrackScreen} のみサポートされています。
 * @return
 * - 0: 成功。
 * - 0 以外の値: 失敗。
 * @note チャンネル参加前後いずれでもビューの切り替えが可能です。{@link AliEngineVideoCanvas::displayView} が null の場合、レンダリングは停止します。
 *       {@link AliEngineVideoCanvas::renderMode} または {@link AliEngineVideoCanvas::mirrorMode} を変更するには、他の renderConfig プロパティを保持したまま、新しい値でこのメソッドを再度呼び出します。
 */
virtual int SetLocalViewConfig(AliEngineVideoCanvas renderConfig,
AliEngineVideoTrack track) = 0;

/**
 * @brief ローカル映像プレビューを開始します。
 * @details このメソッドはローカル映像プレビューを開始し、自動的にカメラを起動します。
 * @return
 * - 0: 成功。
 * - < 0: 失敗。
 * @note {@link #setLocalViewConfig} でビューが設定されていない場合、プレビューは表示されませんが、ストリームのアップストリーミングには影響しません。
 *       プレビューを開始するには、{@link #joinChannel} の前にこのメソッドを呼び出し、自動的にカメラを起動できます。
 */
public abstract int startPreview();

/**
 * @brief ローカル映像プレビューを開始します。
 * @return
 * - 0: 成功。
 * - <0: 失敗。
 * @note {@link setLocalViewConfig:forTrack:} でビューが設定されていない場合、プレビューは表示されません。
 *       プレビューを開始するには、{@link joinChannel:name:onResultWithUserId:} の前にこのメソッドを呼び出し、自動的にカメラを起動できます。
 */
- (int)startPreview;

/**
 * @brief ローカル映像プレビューを開始します。
 * @return
 * - 0: 成功。
 * - 0 以外の値: 失敗。
 * @note {@link SetLocalViewConfig} でビューが設定されていない場合、プレビューは表示されません。
 *       プレビューを開始するには、{@link JoinChannel} の前にこのメソッドを呼び出し、自動的にカメラを起動できます。
 */
virtual int StartPreview(int width = 0, int height = 0) = 0;

/**
 * @brief ローカルデバイス例外のコールバック。
 * @param deviceType デバイスタイプ。詳細については、{@link AliRtcEngine.AliRtcEngineLocalDeviceType} をご参照ください。
 * @param exceptionType 例外タイプ。詳細については、{@link AliRtcEngine.AliRtcEngineLocalDeviceExceptionType} をご参照ください。
 * @param msg 例外メッセージ。
 * @note このコールバックは、回復不能な内部デバイス例外が発生した際にトリガーされます。このコールバックがトリガーされた場合、デバイスの可用性を確認してください。
 */
public void OnLocalDeviceException(AliRtcEngine.AliRtcEngineLocalDeviceType deviceType, AliRtcEngine.AliRtcEngineLocalDeviceExceptionType exceptionType, String msg){}

/**
 * @brief ローカルデバイス例外のコールバック。
 * @param deviceType デバイスタイプ。詳細については、{@link AliRtcLocalDeviceType} をご参照ください。
 * @param exceptionType 例外タイプ。詳細については、{@link AliRtcLocalDeviceExceptionType} をご参照ください。
 * @param msg 例外メッセージ。
 * @note このコールバックは、回復不能な内部デバイス例外が発生した際にトリガーされます。このコールバックがトリガーされた場合、デバイスの可用性を確認してください。
 */
- (void)onLocalDeviceException:(AliRtcLocalDeviceType)deviceType exceptionType:(AliRtcLocalDeviceExceptionType)exceptionType message:(NSString *_Nullable)msg;

/**
 * @brief ローカルデバイス例外のコールバック。
 * @param deviceType デバイスタイプ。詳細については、{@link AliEngineLocalDeviceType} をご参照ください。
 * @param exceptionType 例外タイプ。詳細については、{@link AliEngineLocalDeviceExceptionType} をご参照ください。
 * @param msg 例外メッセージ。
 * @note このコールバックは、回復不能な内部デバイス例外が発生した際にトリガーされます。このコールバックがトリガーされた場合、デバイスの可用性を確認してください。
 */
virtual void OnLocalDeviceException(AliEngineLocalDeviceType deviceType, AliEngineLocalDeviceExceptionType exceptionType, const char* msg){};