tencent cloud

フィードバック

API概要

最終更新日:2022-02-23 10:22:46

    TRTCCloud

    基本的な方法

    API 説明
    sharedInstance TRTCCloudシングルトンを作成します。
    destroySharedInstance TRTCCloudシングルトンを破棄します。
    registerListener イベントリスナーを設定します。
    unRegisterListener イベントリスナーを削除します。

    ルーム関連インターフェース関数

    API 説明
    enterRoom ルームに入室します。ルームが存在しない場合は、システムが新しいルームを自動的に作成します。
    exitRoom ルームから退出します。
    switchRole ロールを切り替えます。ライブストリーミングシナリオ(TRTC_APP_SCENE_LIVEおよび TRTC_APP_SCENE_VOICE_CHATROOM)のみに適しています。
    setDefaultStreamRecvMode オーディオビデオの受信モードを設定します。有効にするには、入室する前に設定する必要があります。
    connectOtherRoom ルーム間通話をリクエストします(キャスターPK)。
    disconnectOtherRoom ルーム間通話から退出します。
    switchRoom ルームを切り替えます。

    CDN関連インターフェース関数

    API 説明
    startPublishing Tencent CloudへのライブCDNのプッシュを開始します。
    stopPublishing Tencent CloudへのライブCDNのプッシュを停止します。
    startPublishCDNStream 同業他社CloudへのライブCDNの転送を開始します。
    stopPublishCDNStream Tencent Cloud以外のアドレスへの転送を停止します。
    setMixTranscodingConfig クラウドのミクスストリーミングトランスコードパラメータを設定します。

    ビデオ関連インターフェース関数

    API 説明
    muteLocalVideo ローカルのビデオデータのプッシュを一時停止/再開します。
    startRemoteView リモートビデオ画面の表示を開始します。
    stopRemoteView リモートビデオ画面の表示を停止すると同時に、リモートユーザーのビデオデータストリームをプルしないようにします。
    muteRemoteVideoStream 指定されたリモートビデオストリームの受信を一時停止/再開します。
    muteAllRemoteVideoStreams すべてのリモートビデオストリームの受信を一時停止/再開します。
    setVideoEncoderParam ビデオエンコーダ関連のパラメータを設定します。
    setNetworkQosParam ネットワークフロー制御関連のパラメータを設定します。
    setVideoEncoderRotation ビデオコーデックが出力する画面方向、すなわち、リモートユーザーが視聴する画面およびサーバーが録画する画面方向を設定します。
    setVideoEncoderMirror エンコーダが出力する画面のミラーリングモードを設定します。
    setGSensorMode 重力センサーの適応モードを設定します。
    setVideoMuteImage ローカルビデオが一時停止したときにプッシュしたい画像を設定します。

    オーディオ関連インターフェース関数

    API 説明
    startLocalAudio ローカルオーディオのキャプチャとアップストリームをオンにします。
    stopLocalAudio ローカルオーディオのキャプチャとアップストリームをオフにします。
    muteLocalAudio ローカルのオーディオをミュート/ミュート解除します。
    setAudioRoute オーディオルーティングを設定します。
    muteRemoteAudio 指定したリモートユーザーの音声をミュート/ミュート解除します。
    muteAllRemoteAudio すべてのユーザーの音声をミュート/ミュート解除します。
    setAudioCaptureVolume SDKキャプチャ音量を設定します。
    getAudioCaptureVolume SDKキャプチャ音量を取得します。
    setAudioPlayoutVolume SDK再生音量を設定します。
    getAudioPlayoutVolume SDK再生音量を取得します。
    enableAudioVolumeEvaluation 音量のプロンプトを有効にします。
    startAudioRecording 録音を開始します。
    stopAudioRecording 録音を停止します。

    デバイス管理インターフェース

    API 説明
    getDeviceManager デバイス管理モジュールを取得します。インターフェースの詳細については、デバイス管理インターフェースのドキュメントをご参照ください。

    美顔フィルタに関するインターフェース関数

    API 説明
    getBeautyManager 美顔管理オブジェクトを取得します。インターフェースの詳細については、美顔管理のドキュメントをご参照ください。
    setWatermark ウォーターマークを追加します。

    音楽の特殊効果および声の特殊効果

    API 説明
    getAudioEffectManager BGM、ショートオーディオエフェクトおよびボーカルエフェクトに用いられるオーディオエフェクト管理クラスTXAudioEffectManagerを取得します。インターフェースの詳細については、オーディオエフェクト管理のドキュメントをご参照ください。

    ネットワークテスト

    API 説明
    startSpeedTest ネットワークスピードテストを開始します(通話品質への影響を避けるため、ビデオ通話中はテストしないでください)。
    stopSpeedTest サーバーのスピードテストを停止します。

    ログ関連インターフェース関数

    API 説明
    getSDKVersion SDKのバージョン情報を取得します。
    setLogLevel Log出力レベルを設定します。
    setLogDirPath ログ保存パスを変更します。
    setLogCompressEnabled Logのローカル圧縮を有効または無効にします。
    setConsoleEnabled コンソールログの印刷を有効または無効にします。

    TRTCCloudListener

    Tencent Cloudのビデオ通話機能のイベントコールバックインターフェース。

    エラーイベントおよび警告イベント

    API 説明
    onError エラーコールバックは、SDKのリカバリー不能なエラーを意味します。確実に監視し、状況に応じてユーザーに適切なインターフェースプロンプトを提供してください。
    onWarning アラートコールバックは、ラグやリカバリー不能なデコードの失敗など、重大ではない問題を通知するために用いられます。

    ルームイベントのコールバック

    API 説明
    onEnterRoom ルームに参加済みのコールバック。
    onExitRoom ルーム退出のイベントコールバック。
    onSwitchRole ロール切り替えのイベントコールバック。
    onConnectOtherRoom ルーム間通話リクエスト(キャスターPK)の結果のコールバック。
    onDisConnectOtherRoom ルーム間通話の終了(キャスターPK)の結果のコールバック
    onSwitchRoom ルーム切り替え(switchRoom)の結果のコールバック。

    メンバーイベントコールバック

    API 説明
    onRemoteUserEnterRoom ユーザーが現在のルームに参加しました。
    onRemoteUserLeaveRoom ユーザーが現在のルームから退出しました。
    onUserVideoAvailable リモートユーザーに再生可能なメインチャネル画面があるかどうか(通常はカメラに用いられます)。
    onUserSubStreamAvailable リモートユーザーに再生可能なサブチャネル画面があるかどうか(通常は画面共有に用いられます)。
    onUserAudioAvailable リモートユーザーに再生可能なオーディオデータがあるかどうか。
    onFirstVideoFrame ローカルまたはリモートユーザーの最初のフレーム画面のレンダリングを開始します。
    onFirstAudioFrame リモートユーザーの最初のフレームのオーディオ再生を開始します(ローカル音声は現時点では通知されません)。
    onSendFirstLocalVideoFrame 最初のフレームのローカルビデオデータが送信されました。
    onSendFirstLocalAudioFrame ローカルオーディオデータの最初のフレームが送信されました。

    BGM再生のコールバックインターフェース

    BGM再生のコールバックインターフェースです。

    API 説明
    onMusicObserverStart 音楽再生開始のコールバック通知。
    onMusicObserverPlayProgress 音楽再生の進捗状況のコールバック通知。
    onMusicObserverComplete 音楽再生終了のコールバック通知。

    統計および品質コールバック

    API 説明
    onNetworkQuality ネットワーク品質。このコールバックは2秒ごとに1度トリガーされ、現在のネットワークのアップストリームとダウンストリーム品質の統計を行います。
    onStatistics テクニカルインジケータ統計コールバック。

    サーバーイベントコールバック

    API 説明
    onConnectionLost SDKとサーバー間の接続が切断されます。
    onTryToReconnect SDKはサーバーへの再接続を試みます。
    onConnectionRecovery SDKとサーバー間の接続が復元されます。
    onSpeedTest サーバースピードテストのコールバックです。SDKは複数のサーバーIPに対するスピードテストを実行し、IPごとのスピードテスト結果をこのコールバックを使用して通知します。

    ハードウェアデバイスイベントコールバック

    API 説明
    onCameraDidReady カメラの準備ができました。
    onMicDidReady マイクの準備ができました。
    onUserVoiceVolume 音量レベルをリマインドするためのコールバックです。userIdごとの音量とリモートの総音量が含まれます。

    CDNバイパス転送コールバック

    API 説明
    onStartPublishing Tencent CloudへのライブCDNのプッシュ開始のコールバック。TRTCCloudのstartPublishing()インターフェースに対応します。
    onStopPublishing Tencent CloudへのライブCDNのプッシュ停止のコールバック。TRTCCloudのstopPublishing()インターフェースに対応します。
    onStartPublishCDNStream Relayed Pushの起動からCDN完了までのコールバック。
    onStopPublishCDNStream Relayed Push停止からCDN完了までのコールバック。
    onSetMixTranscodingConfig クラウドのミクスストリーミングトランスコードパラメータ設定のコールバック。TRTCCloudのsetMixTranscodingConfig()インターフェースに対応します。

    主要なタイプの定義

    タイプ名 説明
    TRTCCloudDef キータイプ定義変数。
    TRTCParams 入室パラメータ。
    TRTCSwitchRoomConfig ルームのパラメータを切り替えます。
    TRTCVideoEncParam ビデオコーデックパラメータ。
    TRTCNetworkQosParam ネットワークフロー制御関連のパラメータ。
    TRTCRenderParams リモート画像パラメータ。
    TRTCMixUser クラウドミクスストリーミング内の各サブ画面の位置情報。
    TRTCTranscodingConfig クラウドミクスストリーミング(トランスコード)の構成。
    TXVoiceChangerType ボイスチェンジタイプの定義(ロリ声、おじさん声、ロボット声、外国人など)。
    TXVoiceReverbType ボイスチェンジタイプの定義(KTV、狭い部屋、ホール、低く沈んだ声、大きくて響く声など)。
    AudioMusicParam 音楽とボーカルを設定するインターフェースパラメータ。
    TRTCAudioRecordingParams 録音パラメータ。
    TRTCPublishCDNParam CDN転送パラメータ。
    お問い合わせ

    カスタマーサービスをご提供できるため、ぜひお気軽にお問い合わせくださいませ。

    テクニカルサポート

    さらにサポートが必要な場合は、サポートチケットを送信して弊社サポートチームにお問い合わせください。24時間365日のサポートをご提供します。

    電話サポート(24 時間365日対応)