Docs Overview/
RTC Engine/
SDK/
iOS/
顧客インターフェース/
APIの概要/

APIの概要

TRTCCloud @ TXLiteAVSDK

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

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

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

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

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

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

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

API
説明
ローカルカメラのプレビュー画面を有効化（モバイル端末）
ローカルカメラのプレビュー画面を有効化（デスクトップ）
ローカルカメラのプレビュー画面を更新
カメラのプレビューを停止
ローカルのビデオストリームの公開を一時停止/再開
ローカル画面の一時停止中の代替画像を設定
リモートユーザーのビデオストリームをサブスクライブし、ビデオレンダリングウィジェットをバインド
リモートユーザーのビデオレンダリングウィジェットを更新
リモートユーザーのビデオストリームのサブスクライブを停止し、レンダリングウィジェットをリリース
すべてのリモートユーザーのビデオストリームのサブスクライブを停止し、すべてのレンダリングリソースをリリース
リモートユーザーのビデオストリームのサブスクライブを一時停止/再開
すべてのリモートユーザーのビデオストリームのサブスクライブを一時停止/再開
ビデオエンコーダのエンコードパラメータを設定
ネットワーク品質モニタリングの関連パラメータを設定
ローカル画面のレンダリングパラメータを設定
リモート画面のレンダリングモードを設定
ビデオエンコーダが出力する画面の方向を設定
エンコーダが出力する画面のイメージモードを設定
重力センサーの適合モードを設定
大小画面のデュアルチャンネルコーディングモード を有効化
指定リモートユーザーの画面サイズを切り替え
ビデオ画面のスクリーンキャプチャ

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

API
説明
ローカルオーディオのキャプチャおよび公開を有効化
ローカルオーディオのキャプチャおよび公開を停止
ローカルのオーディオストリームの公開を一時停止/再開
リモートのオーディオストリームの再生を一時停止/再開
すべてのリモートユーザーのオーディオストリームの再生を一時停止/再開
オーディオルートを設定
特定リモートユーザーの音声再生音量を設定
ローカルオーディオのキャプチャ音量を設定
ローカルオーディオのキャプチャ音量を取得
リモートオーディオの再生音量を設定
リモートオーディオの再生音量を取得
音声レベルのプロンプトを起動
録音を開始
録音を停止
ローカルメディアのレコーディングを有効化
ローカルメディアのレコーディングを停止
リモートオーディオストリームのインテリジェント同時再生ポリシーを設定

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

API
説明
デバイス管理タイプ（TXDeviceManager）を取得

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

API
説明
美顔管理タイプ（TXBeautyManager）を取得
ウォーターマークの追加

BGMおよび音声の特殊効果

API
説明
オーディオエフェクトマネージャー（TXAudioEffectManager）を取得
システム音声キャプチャ を有効化（Macシステムのみに適用）
システム音声キャプチャを停止（デスクトップシステムのみに適用）
システム音声のキャプチャ音量を設定

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

API
説明
アプリケーション内の画面共有を開始（ iOS 13.0以上のシステムのみをサポート）
全システムの画面共有 を開始（ iOS 11.0以上のシステムのみをサポート）
デスクトップ画面共有を開始（このインターフェースはデスクトップシステムのみをサポート）
画面共有を停止
画面共有を一時停止
画面共有を再開
共有可能な画面およびウィンドウを列挙（このインターフェースはMac OSシステムのみをサポート ）
共有したい画面またはウィンドウを選択（このインターフェースはMac OSシステムのみをサポート）
画面共有（サブストリーム）のビデオコーデックパラメータを設定（デスクトップシステムとモバイルシステムの両方をサポート）
画面共有時の音声ミキシングの音量レベルを設定（このインターフェースはデスクトップシステムのみをサポート）
指定のウィンドウを画面共有のexcludeリストに追加（このインターフェースはデスクトップシステムのみをサポート）
指定のウィンドウを画面共有のexcludeリストから削除（このインターフェースはデスクトップシステムのみをサポート）
すべてのウィンドウを画面共有のexcludeリストから削除（このインターフェースはデスクトップシステムのみをサポート）
指定のウィンドウを画面共有のincludeリストに追加（このインターフェースはデスクトップシステムのみをサポート）
指定のウィンドウを画面共有のincludeリストから削除（このインターフェースはデスクトップシステムのみをサポート）
すべてのウィンドウを画面共有のincludeリストから削除（このインターフェースはデスクトップシステムのみをサポート）

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

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

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

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

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

API
説明
ネットワークスピードテストを開始（入室前に使用）
ネットワークスピードテストを停止

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

API
説明
SDKのバージョン情報を取得
Log出力レベルを設定
コンソールのログプリント を有効化/無効化
ログのローカル圧縮を有効化/無効化
ローカルログの保存パスを設定
ログコールバックを設定
ダッシュボードを表示
ダッシュボードのマージンを設定
試験的インターフェースの呼び出し

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

API
説明
マイクの音量レベルを設定
美顔、美白および肌の色調補正エフェクトレベルを設定
デカ目レベルを設定
小顔レベルを設定
フェイスシェイプレベルを設定
下あご引き伸ばしまたは縮小幅を設定
面長修正レベルを設定
小鼻レベルを設定
動的エフェクトステッカーを設定
動的エフェクトミュートを設定
画面共有を起動
カラーフィルターエフェクトを設定
カラーフィルター濃度を設定
クロマキー背景ビデオを設定
BGMの再生を起動
BGMの再生を停止
BGMの再生を停止
BGMの再生を停止
BGMの総時間を取得（単位：ミリ秒）
BGM再生の進捗を設定
BGMの音量レベルを設定
BGMのローカル再生音量を設定
BGMのリモート再生音量を設定
リバーブエフェクトを設定
ボイスチェンジタイプを設定
オーディオエフェクトを再生
オーディオエフェクトの音量を設定
オーディオエフェクトの再生を停止
すべてのオーディオエフェクトを停止
すべてのオーディオエフェクト音量を設定
オーディオエフェクトを一時停止
オーディオエフェクトを一時停止
インイヤーモニタリングを有効化（または無効化）
リモートビデオ画面の表示を開始
リモートビデオ画面の表示を停止すると同時に、このリモートユーザーのビデオデータストリームのプルを停止
リモート画像のレンダリングモードを設定
リモート画像の時計回りの回転角度を設定
ローカル画像のレンダリングモードを設定
ローカル画像の時計回りの回転角度を設定
ローカルカメラプレビュー画面のイメージモードを設定
リモートユーザーのサブストリーム画面の表示を開始
リモートユーザーのサブストリーム画面の表示を停止
サブストリーム画面の塗りつぶしモードを設定
サブストリーム画面の時計回りの回転角度を設定
大画面または小画面の視聴優先順位を設定
オーディオ品質を設定
オーディオ品質を設定
カメラの切り替え
現在のカメラがズームをサポートしているかどうかを照会
カメラズームの倍数（フォーカス距離）を設定
フラッシュの切り替えをサポートしているかどうかを照会
フラッシュのオン/オフ
カメラがフォーカスの設定をサポートしているかどうかを照会
カメラのフォーカス座標位置を設定
顔の位置の自動認識をサポートしているかどうかを照会
顔追尾フォーカスの有効化/無効化
カメラテストを開始
カメラテストを開始
マイクテストを開始
マイクテストを開始
スピーカーテストを開始
スピーカーテストを停止
マイクデバイスリストを取得
現在のマイクデバイスを取得
現在使用するマイクを選択
現在のマイクのデバイス音量を取得
現在のマイクのデバイス音量を設定
現在のシステムのマイクデバイスがミュートされているかどうかを取得
システムの現在のマイクデバイスのミュートステータスを設定
スピーカーデバイスリストを取得
現在のスピーカーデバイスを取得
使用したいスピーカーを設定
現在のスピーカーのデバイス音量を取得
現在のスピーカーのデバイス音量を設定
システムの現在のスピーカーデバイスがミュートされているかどうかを確認
システムの現在のスピーカーデバイスのミュートステータスを設定
カメラデバイスリストを取得
現在使用しているカメラを取得
現在使用したいカメラを選択
システムの音量タイプを設定
ビデオスクリーンキャプチャ
ビデオのユーザー定義キャプチャモードを起動
自身がキャプチャしたビデオデータを送信
アプリケーション内の画面共有を開始（iOS）
全システムの画面共有を開始（iOS）
ローカルのビデオストリームの公開を一時停止/再開
リモートユーザーのビデオストリームのサブスクライブを一時停止/再開
ネットワークスピードテストを開始（入室前に使用）

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

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

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

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

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

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

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

API
説明
ネットワーク品質のリアルタイム統計のコールバック
オーディオビデオ技術指標のリアルタイム統計のコールバック
ネットワークスピードテストの結果のコールバック

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

API
説明
SDKがクラウドとの接続を切断済み
SDKがクラウドとの再接続を試行中
SDKがクラウドとの接続を再開済み

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

API
説明
カメラの準備完了
マイクの準備完了
現在のオーディオルートに変更発生（モバイルデバイスのみに適用）
音量レベルフィードバックのコールバック
ローカルデバイスのオン/オフステータスに変更発生（デスクトップシステムのみに適用）
現在のマイクのシステムキャプチャ音量に変更発生
現在のシステムの再生音量に変更発生
システム音声キャプチャが正常に開始されたかどうかのイベントコールバック（Macシステムのみに適用）

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ビデオ関連列挙値の定義

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

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

API
説明
ユースケース
ロール
トラフィックコントロールモード（破棄済み）
画質の好み
ネットワーク品質
ビデオステータスタイプ
ビデオステータス変更理由のタイプ

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

API
説明
オーディオサンプルレート
音声音質
オーディオルート（音声の再生モード）
音声リバーブモード
ボイスチェンジタイプ
システム音量タイプ（モバイルデバイスのみに適用）

その他列挙値の定義

API
説明
Logレベル
重力センサースイッチ（モバイル端末のみに適用）
画面共有のターゲットタイプ（デスクトップのみに適用）
クラウドミクスストリーミングのレイアウトモード
メディアレコーディングタイプ
ミクスストリーミング入力タイプ
デバイスタイプ（デスクトッププラットフォームのみに適用）
オーディオレコーディングコンテンツタイプ

TRTCコアタイプの定義

API
説明
入室パラメータ
ビデオコーデックパラメータ
ネットワークトラフィックコントロール（Qos）パラメータセット
ビデオ画面のレンダリングパラメータ
ネットワーク品質
音量レベル
スピードテストのパラメータ
ネットワークスピードテスト結果
ビデオフレーム情報
オーディオフレームデータ
クラウドミクスストリーミングにおける各画面の説明情報
クラウドミクスストリーミングのレイアウトおよびトランスコードパラメータ
非Tencent Cloud CDNへのオーディオビデオストリーミングの公開時に設定が必要な転送パラメータ
ローカルオーディオファイルのレコーディングパラメータ
ローカルメディアファイルのレコーディングパラメータ
オーディオエフェクトパラメータ（破棄済み）
ルーム切り替えパラメータ
オーディオカスタムコールバックの形式パラメータ
画面共有のターゲット情報（デスクトップのみに適用）