API概要

最終更新日:2021-10-20 11:27:35

    TRTCCloud @ TXLiteAVSDK

    インスタンスの作成およびイベントコールバック

    API 説明
    sharedInstance TRTCCloudインスタンスの作成(シングルトンモード)
    destroySharedInstance TRTCCloudインスタンスを破棄 (シングルトンモード)
    setListener TRTCイベントコールバックを設定
    setListenerHandler TRTCCloudDelegate イベントコールバックを起動するキューを設定

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

    API 説明
    enterRoom ルームに入室
    exitRoom ルームを退室
    switchRole ロールの切り替え
    switchRoom ルームの切り替え
    ConnectOtherRoom ルーム間通話のリクエスト
    DisconnectOtherRoom ルーム間通話を退出
    setDefaultStreamRecvMode サブスクライブモードを設定(有効にするには入室前に設定する必要があります)
    createSubCloud サブルーム事例の作成(複数のルームで同時視聴するために使用されます)
    destroySubCloud サブルーム事例の破棄

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

    API 説明
    startPublishing Tencent Cloud CSS CDNへのオーディオビデオストリーミングの公開を開始
    stopPublishing Tencent Cloud CSS CDNへのオーディオビデオストリーミングの公開を停止
    startPublishCDNStream 非Tencent Cloud CDNへのオーディオビデオストリーミングの公開を開始
    stopPublishCDNStream 非Tencent Cloud CDNへのオーディオビデオストリーミングの公開を停止
    setMixTranscodingConfig クラウドミクスストリーミングのレイアウトおよびトランスコードパラメータを設定

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

    API 説明
    startLocalPreview ローカルカメラのプレビュー画面を有効化(モバイル端末)
    updateLocalView ローカルカメラのプレビュー画面を更新
    stopLocalPreview カメラのプレビューを停止
    muteLocalVideo ローカルのビデオストリームの公開を一時停止/再開
    setVideoMuteImage ローカル画面の一時停止中の代替画像を設定
    startRemoteView リモートユーザーのビデオストリームをサブスクライブし、ビデオレンダリングウィジェットをバインド
    updateRemoteView リモートユーザーのビデオレンダリングウィジェットを更新
    stopRemoteView リモートユーザーのビデオストリームのサブスクライブを停止し、レンダリングウィジェットをリリース
    stopAllRemoteView すべてのリモートユーザーのビデオストリームのサブスクライブを停止し、すべてのレンダリングリソースをリリース
    muteRemoteVideoStream リモートユーザーのビデオストリームのサブスクライブを一時停止/再開
    muteAllRemoteVideoStreams すべてのリモートユーザーのビデオストリームのサブスクライブを一時停止/再開
    setVideoEncoderParam ビデオエンコーダのエンコードパラメータを設定
    setNetworkQosParam ネットワーク品質モニタリングの関連パラメータを設定
    setLocalRenderParams ローカル画面のレンダリングパラメータを設定
    setRemoteRenderParams リモート画面のレンダリングモードを設定
    setVideoEncoderRotation ビデオエンコーダが出力する画面の方向を設定
    setVideoEncoderMirror エンコーダが出力する画面のイメージモードを設定
    setGSensorMode 重力センサーの適合モードを設定
    enableEncSmallVideoStream 大小画面のデュアルチャンネルコーディングモード を有効化
    setRemoteVideoStreamType 指定リモートユーザーの大小画面を切り替え
    snapshotVideo ビデオ画面のスクリーンキャプチャ

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

    API 説明
    startLocalAudio ローカルオーディオのキャプチャおよび公開を有効化
    stopLocalAudio ローカルオーディオのキャプチャおよび公開を停止
    muteLocalAudio ローカルのオーディオストリームの公開を一時停止/再開
    muteRemoteAudio リモートのオーディオストリームの再生を一時停止/再開
    muteAllRemoteAudio すべてのリモートユーザーのオーディオストリームの再生を一時停止/再開
    setAudioRoute オーディオルートを設定
    setRemoteAudioVolume 特定リモートユーザーの音声再生音量を設定
    setAudioCaptureVolume ローカルオーディオのキャプチャ音量を設定
    getAudioCaptureVolume ローカルオーディオのキャプチャ音量を取得
    setAudioPlayoutVolume リモートオーディオの再生音量を設定
    getAudioPlayoutVolume リモートオーディオの再生音量を取得
    enableAudioVolumeEvaluation 音声レベルのプロンプトを起動
    startAudioRecording 録音を開始
    stopAudioRecording 録音を停止
    startLocalRecording ローカルメディアのレコーディングを有効化
    stopLocalRecording ローカルメディアのレコーディングを停止

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

    API 説明
    getDeviceManager デバイス管理タイプ(TXDeviceManager)を取得

    美顔特殊効果および画像のウォーターマーク

    API 説明
    getBeautyManager 美顔管理タイプ(TXBeautyManager)を取得
    setWatermark ウォーターマークの追加

    BGMおよび音声の特殊効果

    API 説明
    getAudioEffectManager オーディオエフェクトマネージャー(TXAudioEffectManager)を取得

    画面共有関連インターフェース

    API 説明
    startScreenCapture 画面共有を起動
    stopScreenCapture 画面共有を停止
    pauseScreenCapture 画面共有を一時停止
    pauseScreenCapture 画面共有を再開
    setSubStreamEncoderParam 画面共有(サブストリーム)のビデオコーデックパラメータを設定(このインターフェースはデスクトップシステムのみをサポート)

    ユーザー定義キャプチャおよびカスタムレンダリング

    API 説明
    enableCustomVideoCapture ビデオユーザー定義キャプチャモード の起動/終了
    sendCustomVideoData 自身がキャプチャしたビデオフレームをSDKに送信
    enableCustomAudioCapture オーディオのユーザー定義キャプチャモードを起動
    sendCustomAudioData 自身がキャプチャしたオーディオデータをSDKに送信
    enableMixExternalAudioFrame ユーザー定義のオーディオトラックの起動/終了
    mixExternalAudioFrame ユーザー定義のオーディオトラックをSDKにミキシング
    setMixExternalAudioVolume プッシュ時にミキシングする外部オーディオのプッシュ音量および再生音量を設定
    generateCustomPTS ユーザー定義キャプチャ時のタイムスタンプを発行
    setLocalVideoProcessListener サードパーティによる美顔のビデオデータコールバックを設定
    setLocalVideoRenderListener ローカルビデオカスタムレンダリングコールバックを設定
    setRemoteVideoRenderListener リモートビデオカスタムレンダリングコールバックを設定
    setAudioFrameListener オーディオデータカスタムコールバックを設定
    setCapturedRawAudioFrameCallbackFormat ローカルマイクによってキャプチャされたオリジナルオーディオフレームコールバック形式を設定
    setLocalProcessedAudioFrameCallbackFormat 前処理後のローカルオーディオフレームコールバック形式を設定
    setMixedPlayAudioFrameCallbackFormat 最終的にシステムから再生したいオーディオフレームコールバック形式を設定
    enableCustomAudioRendering オーディオカスタム再生を有効化
    getCustomAudioRenderingFrame 再生可能なオーディオデータを取得

    カスタムメッセージ送信インターフェース

    API 説明
    sendCustomCmdMsg UDPチャネルを利用してカスタムメッセージをルーム内のすべてのユーザーに送信
    sendSEIMsg SEIチャネルを利用して送信カスタムメッセージをルーム内のすべてのユーザーに送信

    ネットワークテストインターフェース

    API 説明
    startSpeedTest ネットワークスピードテストを開始(ルーム入室前に使用)
    stopSpeedTest ネットワークスピードテストを停止

    デバック関連インターフェース

    API 説明
    getSDKVersion SDKのバージョン情報を取得
    setLogLevel Log出力レベルを設定
    setConsoleEnabled コンソールのログプリントを有効化/無効化
    setLogCompressEnabled ログのローカル圧縮を有効化/無効化
    setLogDirPath ローカルログの保存パスを設定
    setLogListener ログコールバックを設定
    showDebugView ダッシュボードを表示
    setDebugViewMargin ダッシュボードのマージンを設定
    callExperimentalAPI 試験的インターフェースの呼び出し
    setNetEnv TRTCのバックエンドクラスターを設定(Tencent Cloud研究開発チームのみに適用)

    破棄されたインターフェース

    API 説明
    setMicVolumeOnMixing マイクの音量レベルを設定
    setBeautyStyle 美顔、美白および肌の色調補正エフェクトレベルを設定
    setEyeScaleLevel デカ目レベルを設定
    setFaceSlimLevel 小顔レベルを設定
    setFaceVLevel フェイスシェイプレベルを設定
    setChinLevel 下あご引き伸ばしまたは縮小幅を設定
    setFaceShortLevel 面長修正レベルを設定
    setNoseSlimLevel 小鼻レベルを設定
    selectMotionTmpl 動的エフェクトステッカーを設定
    setMotionMute 動的エフェクトミュートを設定
    setFilter カラーフィルターエフェクトを設定
    setFilterConcentration カラーフィルター濃度を設定
    setGreenScreenFile クロマキー背景ビデオを設定
    playBGM BGMの再生を起動
    stopBGM BGMの再生を停止
    pauseBGM BGMの再生を停止
    resumeBGM BGMの再生を停止
    getBGMDuration BGMの総時間を取得(単位:ミリ秒)
    setBGMPosition BGM再生の進捗を設定
    setBGMVolume BGMの音量レベルを設定
    setBGMPlayoutVolume BGMのローカル再生音量を設定
    setBGMPublishVolume BGMのリモート再生音量を設定
    setReverbType リバーブエフェクトを設定
    setVoiceChangerType ボイスチェンジタイプを設定
    playAudioEffect オーディオエフェクトを再生
    setAudioEffectVolume オーディオエフェクトの音量を設定
    setAudioEffectVolume オーディオエフェクトの再生を停止
    stopAllAudioEffects すべてのオーディオエフェクトを停止
    setAllAudioEffectsVolume すべてのオーディオエフェクト音量を設定
    pauseAudioEffect オーディオエフェクトを一時停止
    resumeAudioEffect オーディオエフェクトを一時停止
    enableAudioEarMonitoring インイヤーモニタリングを有効化(または無効化)
    startRemoteView リモートビデオ画面の表示を開始
    stopRemoteView リモートビデオ画面の表示を停止すると同時に、このリモートユーザーのビデオデータストリームのプルを停止
    setRemoteViewFillMode リモート画像のレンダリングモードを設定
    setRemoteViewRotation リモート画像の時計回りの回転角度を設定
    setLocalViewFillMode ローカル画像のレンダリングモードを設定
    setLocalViewRotation ローカル画像の時計回りの回転角度を設定
    setLocalViewMirror ローカルカメラプレビュー画面のイメージモードを設定
    startRemoteSubStreamView リモートユーザーのサブストリーム画面の表示を開始
    stopRemoteSubStreamView リモートユーザーのサブストリーム画面の表示を停止
    setRemoteSubStreamViewFillMode サブストリーム画面の塗りつぶしモードを設定
    setRemoteSubStreamViewRotation サブストリーム画面の時計回りの回転角度を設定
    setPriorRemoteVideoStreamType 大画面または小画面の視聴優先順位を設定
    setAudioQuality オーディオ品質を設定
    startLocalAudio オーディオ品質を設定
    switchCamera カメラの切り替え
    isCameraZoomSupported 現在のカメラがズームをサポートしているかどうかを照会
    setZoom カメラズームの倍数(フォーカス距離)を設定 )
    isCameraTorchSupported フラッシュの切り替えをサポートしているかどうかを照会
    enableTorch フラッシュのオン/オフ
    isCameraFocusPositionInPreviewSupported カメラがフォーカスの設定をサポートしているかどうかを照会
    setFocusPosition カメラのフォーカス座標位置を設定
    isCameraAutoFocusFaceModeSupported 顔の位置の自動認識をサポートしているかどうかを照会
    setSystemVolumeType システムの音量タイプを設定
    enableCustomVideoCapture ビデオユーザー定義キャプチャモード の起動
    sendCustomVideoData 自身がキャプチャしたビデオデータを送信
    startScreenCapture 画面共有を起動(Android)
    muteLocalVideo ローカルのビデオストリームの公開を一時停止/再開
    muteRemoteVideoStream リモートユーザーのビデオストリームのサブスクライブを一時停止/再開

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

    API 説明
    onError エラーイベントコールバック
    onWarning 警告イベントコールバック

    ルーム関連イベントコールバック

    API 説明
    onEnterRoom 入室成功または失敗のイベントコールバック
    onExitRoom 退室のイベントコールバック
    onSwitchRole ロール切り替えのイベントコールバック
    onSwitchRoom ルーム切り替え結果のコールバック
    onConnectOtherRoom ルーム間通話リクエスト結果のコールバック
    onDisConnectOtherRoom ルーム間通話終了結果のコールバック

    ユーザー関連イベントコールバック

    API 説明
    onRemoteUserEnterRoom ユーザーが現在のルームに入室
    onRemoteUserLeaveRoom ユーザーが現在のルームを退室
    onUserVideoAvailable リモートユーザーが公開/キャンセルしたビッグストリームのビデオ画面
    onUserSubStreamAvailable リモートユーザーが公開/キャンセルしたサブストリームのビデオ画面
    onUserAudioAvailable リモートユーザーが公開/キャンセルした自身のオーディオ
    onFirstVideoFrame SDKが自身のローカルユーザーまたはリモートユーザーの最初のフレーム画面のレンダリングを開始
    onFirstAudioFrame SDKがリモートユーザーの最初のフレームのオーディオの再生を開始
    onSendFirstLocalVideoFrame 自身のローカルの最初のビデオフレームが公開済み
    onSendFirstLocalAudioFrame 自身のローカルの最初のオーディオフレームが公開済み
    onRemoteVideoStatusUpdated リモートビデオステータス変更のイベントコールバック

    ネットワークおよび技術指標統計のコールバック

    API 説明
    onNetworkQuality ネットワーク品質のリアルタイム統計のコールバック
    onStatistics オーディオビデオ技術指標のリアルタイム統計のコールバック

    クラウドとの接続状況のイベントコールバック

    API 説明
    onConnectionLost SDKがクラウドとの接続を切断済み
    onTryToReconnect SDKがクラウドとの再接続を試行中
    onConnectionRecovery SDKがクラウドとの接続を再開済み
    onSpeedTest サーバースピードテストの結果のコールバック

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

    API 説明
    onCameraDidReady カメラの準備完了
    onMicDidReady マイクの準備完了
    onAudioRouteChanged 現在のオーディオルートに変更発生(モバイルデバイスのみに適用)
    onUserVoiceVolume 音量レベルフィードバックのコールバック

    カスタムメッセージ受信イベントコールバック

    API 説明
    onRecvCustomCmdMsg カスタムメッセージ受信のイベントコールバック
    onMissCustomCmdMsg カスタムメッセージ消失のイベントコールバック
    onRecvSEIMsg SEIメッセージ受信のコールバック

    CDN関連イベントコールバック

    API 説明
    onStartPublishing Tencent Cloud CSS CDNへのオーディオビデオストリーミングのイベントコールバックの公開を開始
    onStopPublishing Tencent Cloud CSS CDNへのオーディオビデオストリーミングのイベントコールバックの公開を停止
    onStartPublishCDNStream 非Tencent Cloud CDNへのオーディオビデオストリーミングのイベントコールバックの公開を開始
    onStopPublishCDNStream 非Tencent Cloud CDNへのオーディオビデオストリーミングのイベントコールバックの公開を停止
    onSetMixTranscodingConfig クラウドミクスストリーミングのレイアウトおよびトランスコードパラメータ設定のイベントコールバック

    画面共有関連イベントコールバック

    API 説明
    onScreenCaptureStarted 画面共有開始のイベントコールバック
    onScreenCapturePaused 画面共有一時停止のイベントコールバック
    onScreenCaptureResumed 画面共有再開のイベントコールバック
    onScreenCaptureStopped 画面共有停止のイベントコールバック

    ローカルレコーディングおよびローカルスクリーンキャプチャのイベントコールバック

    API 説明
    onLocalRecordBegin ローカルレコーディングタスク開始済みのイベントコールバック
    onLocalRecording ローカルレコーディングタスク実行中の進捗のイベントコールバック
    onLocalRecordComplete ローカルレコーディングタスク完了済みのイベントコールバック

    破棄されたイベントコールバック

    API 説明
    onUserEnter キャスターが現在のルームに入室(破棄済み)
    onUserExit キャスターが現在のルームを退室(破棄済み)
    onAudioEffectFinished オーディオエフェクト再生が完了済み(破棄済み)

    ビデオデータカスタムコールバック

    API 説明
    onRenderVideoFrame カスタムビデオレンダリングのコールバック
    onGLContextCreated SDK内部のOpenGL環境作成済みの通知
    onProcessVideoFrame サードパーティによる美顔コンポーネントを結合するためのビデオ処理のコールバック
    onGLContextDestory SDK内部のOpenGL環境破棄の通知

    オーディオデータカスタムコールバック

    API 説明
    onCapturedRawAudioFrame ローカルマイクがキャプチャしたオリジナルオーディオデータのコールバック
    onLocalProcessedAudioFrame ローカルがキャプチャし、オーディオモジュールで前処理したオーディオデータのコールバック
    onRemoteUserAudioFrame 音声ミキシング前のリモートユーザーごとのオーディオデータ
    onMixedPlayAudioFrame 各再生待ちオーディオをミキシングし、最終的にシステムに送信して再生する前のデータコールバック
    onMixedAllAudioFrame SDKのすべてのオーディオミキシング後のオーディオデータ(キャプチャしたデータおよび再生待ちのデータを含む)

    その他イベントコールバックインターフェース

    API 説明
    onLog ローカルLOGのプリントコールバック

    ビデオ関連列挙値の定義

    API 説明
    TRTCVideoResolution ビデオ解像度
    TRTCVideoResolutionMode ビデオアスペクト比モード
    TRTCVideoStreamType ビデオストリームタイプ
    TRTCVideoFillMode ビデオ画面塗りつぶしモード
    TRTCVideoRotation ビデオ画面回転方向
    TRTCBeautyStyle 美顔(美肌)アルゴリズム
    TRTCVideoPixelFormat ビデオピクセル形式
    TRTCVideoBufferType ビデオデータ伝達方式
    TRTCVideoMirrorType ビデオのイメージタイプ
    TRTCSnapshotSourceType ローカルビデオスクリーンキャプチャのデータソース

    ネットワーク関連列挙値の定義

    API 説明
    TRTCAppScene ユースケース
    TRTCRoleType ロール
    TRTCQosControlMode トラフィックコントロールモード(破棄済み)
    TRTCVideoQosPreference 画質の好み
    TRTCQuality ネットワーク品質
    TRTCAVStatusType ビデオステータスタイプ
    TRTCAVStatusChangeReason ビデオステータス変更理由のタイプ

    オーディオ関連列挙値の定義

    API 説明
    TRTCAudioSampleRate オーディオサンプルレート
    TRTCAudioQuality 音声品質
    TRTCAudioRoute オーディオルート(音声の再生モード)
    TRTCReverbType 音声リバーブモード
    TRTCVoiceChangerType ボイスチェンジタイプ
    TRTCSystemVolumeType システム音量タイプ(モバイルデバイスのみに適用)

    その他列挙値の定義

    API 説明
    TRTCLogLevel Logレベル
    TRTCGSensorMode 重力センサースイッチ(モバイル端末のみに適用)
    TRTCTranscodingConfigMode クラウドミクスストリーミングのレイアウトモード
    TRTCRecordType メディアレコーディングタイプ
    TRTCMixInputType ミクスストリーミング入力タイプ
    TRTCAudioRecordingContent オーディオレコーディングコンテンツタイプ

    TRTCコアタイプの定義

    API 説明
    TRTCParams 入室パラメータ
    TRTCVideoEncParam ビデオコーデックパラメータ
    TRTCNetworkQosParam ネットワークトラフィックコントロール(Qos)パラメータセット
    TRTCRenderParams ビデオ画面のレンダリングパラメータ
    TRTCQualityInfo ネットワーク品質
    TRTCVolumeInfo 音量レベル
    TRTCSpeedTestResult ネットワークスピードテスト結果
    TRTCTexture ビデオテクスチャデータ(Androidプラットフォームのみに適用。テクスチャIDおよびEGL環境を含む)
    TRTCVideoFrame ビデオフレーム情報
    TRTCAudioFrame オーディオフレームデータ
    TRTCMixUser クラウドミクスストリーミングにおける各画面の説明情報
    TRTCTranscodingConfig クラウドミクスストリーミングのレイアウトおよびトランスコードパラメータ
    TRTCPublishCDNParam 非Tencent Cloud CDNへのオーディオビデオストリーミングの公開時に設定が必要な転送パラメータ
    TRTCAudioRecordingParams ローカルオーディオファイルのレコーディングパラメータ
    TRTCLocalRecordingParams ローカルメディアファイルのレコーディングパラメータ
    TRTCAudioEffectParam オーディオエフェクトパラメータ(破棄済み)
    TRTCSwitchRoomConfig ルーム切り替えパラメータ
    TRTCAudioFrameCallbackFormat オーディオカスタムコールバックの形式パラメータ