tencent cloud

キーワードで検索してください

Recent Pages

ドキュメント

ドキュメント

API概要

最終更新日:2022-04-08 16:58:45

PDFファイルをダウンロード

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	他社のクラウドへのライブCDNのリツイートを開始します。
stopPublishCDNStream	Tencent Cloud以外のアドレスへのリツイートを停止します。
setMixTranscodingConfig	クラウドのミクスストリーミングトランスコードパラメータを設定します。

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

API	説明
startLocalPreview	ローカルビデオのプレビュー画面を開始します。
stopLocalPreview	ローカルビデオの収集およびプレビューを停止します。
muteLocalVideo	ローカルビデオデータのプッシュを一時停止/再開します。
startRemoteView	リモートビデオ画面の表示を開始します。
stopRemoteView	リモートビデオ画面の表示を停止すると同時に、リモートユーザーのビデオデータトラフィックのプルを停止します。
stopAllRemoteView	すべてのリモートビデオ画面の表示を停止すると同時に、リモートユーザーのビデオデータトラフィックのプルを停止します。
muteRemoteVideoStream	指定したたリモートビデオストリームの受信を一時停止/再開します。
muteAllRemoteVideoStreams	すべてのリモートビデオトラフィックを一時停止/再開します。
setVideoEncoderParam	ビデオエンコーダに関するパラメータを設定します。
setNetworkQosParam	ネットワークフロー制御に関するパラメータを設定します。
setLocalRenderParams	ローカル画像のレンダリングモードを設定します。
setRemoteRenderParams	リモート画像に関するパラメータを設定します。
setVideoEncoderRotation	ビデオコーデック出力先の画面方向、すなわちリモートユーザーが見ている画面方向とサーバーで記録された画面方向を設定します。
setVideoEncoderMirror	エンコーダ出力の画面イメージモードを設定します。
setGSensorMode	重力感知の適応モードを設定します。
enableEncSmallVideoStream	大小画面の2ウェイコーディングモードを設定します。
setRemoteVideoStreamType	指定したuidの大画面または小画面を選択します。
snapshotVideo	ビデオ画面のスクリーンショット。

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

API	説明
startLocalAudio	ローカルオーディオの収集およびアップストリームを有効にします。
stopLocalAudio	ローカルオーディオの収集およびアップストリームを無効にします。
muteLocalAudio	ローカルオーディオをミュート/ミュート解除します。
setVideoMuteImage	ローカルビデオのプッシュを一時停止するときにプッシュする画像を設定します。
setAudioRoute	オーディオルーティングを設定します。
muteRemoteAudio	指定したリモートユーザーのサウンドをミュート/ミュート解除します。
muteAllRemoteAudio	すべてのユーザーのサウンドをミュート/ミュート解除します。
setAudioCaptureVolume	SDKの収音量を設定します。
getAudioCaptureVolume	SDKの収音量を取得します。
setAudioPlayoutVolume	SDKの再生音量を設定します。
getAudioPlayoutVolume	SDKの再生音量を取得します。
enableAudioVolumeEvaluation	音量通知を有効にします。
startAudioRecording	録音を開始します。
stopAudioRecording	録音を停止します。
setSystemVolumeType	通話時に使用するシステム音量タイプを設定します。

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

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

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

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

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

API	説明
getAudioEffectManager	音色管理クラス TXAudioEffectManagerを取得し、BGM、短音色および声の特殊効果の管理に使用され、インターフェースの詳細について音色管理ドキュメントをご参照ください。

サブストリーム関連インターフェース関数

API	説明
startScreenCapture	画面共有をオンにします。
stopScreenCapture	画面収集をオフにします。
pauseScreenCapture	画面共有を一時停止します。
resumeScreenCapture	画面共有を再開します。

カスタムメッセージ送信

API	説明
sendCustomCmdMsg	カスタムメッセージをルーム内のすべてのユーザーに送信します。
sendSEIMsg	小さいデータ量のカスタムデータをビデオフレーム内に埋め込みます。

ネットワークテスト

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ごとの音量とリモートの総音量が含まれます。

カスタムメッセージ受信のコールバック

API	説明
onRecvCustomCmdMsg	カスタムメッセージ受信のコールバック。
onMissCustomCmdMsg	カスタムメッセージ紛失のコールバック。
onRecvSEIMsg	SEIメッセージ受信のコールバック。

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()インターフェースに対応します。

画面共有コールバック

API	説明
onScreenCaptureStarted	画面共有開始時にSDKがこのコールバックで通知します
onScreenCapturePaused	画面共有がpauseScreenCapture()を呼び出すときに、SDKがこのコールバックで通知します。
onScreenCaptureResumed	画面共有がresumeScreenCapture()を呼び出すときに、SDKがこのコールバックで通知します。
onScreenCaptureStoped	画面共有停止ときにはSDKがこのコールバックで通知します。

スクリーンキャプチャコールバック

API	説明
onSnapshotComplete	スクリーンショット完了時のコールバック。

主要なタイプの定義

タイプ名	説明
TRTCCloudDef	主要なタイプ定義用変数。
TRTCParams	入室パラメータ。
TRTCSwitchRoomConfig	ルームパラメータ切り替え用パラメータ。
TRTCVideoEncParam	ビデオエンコーダパラメータ。
TRTCNetworkQosParam	ネットワークフロー制御に関するパラメータ。
TRTCRenderParams	リモート画像パラメータ。
TRTCMixUser	クラウドミクスストリーミングにおける各チャンネル子画面の位置情報。
TRTCTranscodingConfig	クラウドミクスストリーミング（トランスコード）の構成。
TXVoiceChangerType	ボイス変更タイプの定義（ロリ、オヤジ、ヘビーメタル、外国人など）。
TXVoiceReverbType	ボイス変更タイプの定義（KTV、小ルーム、大会堂、低音、広音など）。
AudioMusicParam	音楽と声設定インターフェースパラメータ。
TRTCAudioRecordingParams	録音パラメータ。
TRTCPublishCDNParam	CDNリツイートパラメータ。

お問い合わせ

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

テクニカルサポート

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

電話サポート（24 時間365日対応）