tencent cloud

フィードバック

Unity SDKのクイック導入

最終更新日:2024-01-18 15:42:47
    開発者がGME製品APIのデバッグ・アクセスを行いやすいように、ここで、Unity開発に適用されるクイックアクセス技術ドキュメントを説明させていただきます。
    GMEクイックスタート文書は、ユーザーのアクセスを助けるための最も主要なアクセスインターフェースのみを提供しています。

    GME利用上の重要事項

    GMEは2つの部分に分かれます。リアルタイム音声サービス、音声メッセージおよびテキスト変換サービスを提供しており、これらのサービスの利用はInitやPollなどのコアインターフェースに依存しています。
    关于 Init 接口
    例えば、リアルタイムの音声サービスを使用する同時に音声メッセージ・サービスも使用する場合、Init初期化インターフェースを1回だけ呼び出す必要があります

    インターフェース呼び出しのフローチャート

    
    image
    
    

    統合の手順

    SDKの統合

    プロジェクトにSDKを統合するには、Unity SDK統合ドキュメントをご参照ください。

    コアインターフェース

    リアルタイム音声

    音声メッセージ

    コアインターフェースのアクセス

    1. SDKのダウンロード

    ダウンロード案内ページにアクセスして、必要な クライアンSDKをダウンロードします

    2. ヘッダーファイルを取り込む

    using GME;

    3. Contextインスタンスの取得

    QAVContext.GetInstance()の直接呼び出しでインスタンスを取得するのではなく、ITMGContextのメソッドでContextのインスタンスを取得してください。

    サンプルコード

    int ret = ITMGContext.GetInstance().Init(sdkAppId, openID);

    4. SDKを初期化する

    初期化前のSDKは初期化されていない状態です。リアルタイム音声サービス、音声メッセージサービスおよびボイスツーテキスト変換サービスを使用するには、インターフェースInitを使用してSDKを初期化する必要があります。Initインターフェースを呼び出すスレッドは、他のインターフェースと同じスレッドである必要があります。すべてのメインスレッドでインターフェースを呼び出すことをお勧めします。

    インターフェースのプロトタイプ

    //class ITMGContext
    public abstract int Init(string sdkAppID, string openID);
    パラメータ
    タイプ
    意味
    sdkAppId
    string
    Tencent Cloud ConsoleのGMEサービスが提供するAppIDです。取得についてはサービス開始ガイドラインをご参照ください。
    openID
    string
    openIDはInt64型(stringに変換して渡す)のみに対応しており、ルールはApp開発者が独自に定め、App内で重複しなければよい。文字列をOpenidとして渡す必要がある場合は、チケットを提出をして開発者に連絡してください。

    サンプルコード

    int ret = ITMGContext.GetInstance().Init(sdkAppId, openID);
    //戻り値で初期化が成功したかどうかを判断する
    if (ret != QAVError.OK)
    {
    Debug.Log("SDK初期化失敗:"+ret);
    return;
    }

    5. イベントコールバックのトリガー

    updateで周期的にPollを呼び出すことで、イベントのコールバックをトリガできます。PollはGMEのメッセージポンプであり、GMEはイベントのコールバックをトリガするためにPollインターフェースを定期的に呼び出す必要があります。Pollが呼び出されないと、SDKサービス全体が異常に動作します。詳細については、Sample ProjectのEnginePollHelperファイルをご参照ください。

    サンプルコード

    public void Update()
    {
    ITMGContext.GetInstance().Poll();
    }

    6. 入退室の通知監視

    入室通知

    //委託関数:
    public delegate void QAVEnterRoomComplete(int result, string error_info);
    //イベント関数:
    public abstract event QAVEnterRoomComplete OnEnterRoomCompleteEvent;

    退室通知

    委託関数:
    public delegate void QAVExitRoomComplete();
    イベント関数:
    public abstract event QAVExitRoomComplete OnExitRoomCompleteEvent;

    7. ローカル認証計算

    AuthBufferを生成し、関連機能の暗号化と認証に使用します。本格なリリースについてバックグラウンドのデプロイキーを使用してください。バックグラウンドのデプロイについては、認証キーをご参照ください。

    インターフェースのプロトタイプ

    QAVAuthBuffer GenAuthBuffer(int appId, string roomId, string openId, string key)
    パラメータ
    タイプ
    意味
    appId
    int
    Tencent CloudコンソールからのAppId番号。
    roomId
    string
    ルーム番号であり、最大127文字まで対応しています(オフライン音声ルーム番号のパラメータをnullに設定しなければなりません)。
    openId
    string
    ユーザーID。Initの場合のopenIdと同じです。
    key
    string
    Tencent Cloudコンソールからの権限キー。

    サンプルコード

    public static byte[] GetAuthBuffer(string AppID, string RoomID,string OpenId, string AuthKey){
    return QAVAuthBuffer.GenAuthBuffer(int.Parse(AppID), RoomID, OpenId, AuthKey);
    }
    

    リアルタイム音声アクセス

    1. ルームに参加

    生成した認証情報を用いてルームに参加します。ルームに参加するとき、デフォルトでマイクとスピーカーはオフです。戻り値がAV_OKの場合はルーム参加が成功したことでなく、呼び出しが成功したことを意味します。

    インターフェースのプロトタイプ

    ITMGContext EnterRoom(string roomId, int roomType, byte[] authBuffer)
    パラメータ
    タイプ
    意味
    roomId
    String
    ルーム番号、127文字まで入力可能
    roomType
    ITMGRoomType
    ITMGRoomType.ITMG_ROOM_TYPE_FLUENCYのみ入力すればよい
    authBuffer
    byte[]
    認証コード

    サンプルコード

    ITMGContext.GetInstance().EnterRoom(strRoomId, ITMGRoomType.ITMG_ROOM_TYPE_FLUENCY, byteAuthbuffer);

    入室イベントのコールバック

    ルーム参加が完了するとコールバックにより入室結果が返され、入室結果イベントを監視して処理が行われます。コールバックが成功した場合は、その時点で入室が成功し、課金が開始されます。
    サンプルコードコールバック処理の関連参照コード
    //イベントを監視します:
    ITMGContext.GetInstance().OnEnterRoomCompleteEvent += new QAVEnterRoomComplete(OnEnterRoomComplete);
    //監視処理:
    void OnEnterRoomComplete(int err, string errInfo)
    {
    if (err != 0) {
    ShowLoginPanel("エラーコード:" + err + "エラーメッセージ:" + errInfo);
    return;
    }
    else{
    //入室に成功
    }
    }
    エラーコード
    エラーコードの値
    原因と解決策
    7006
    次の理由で認証に失敗しました:
    AppIDが存在しないか、エラーです
    authbuff認証エラーです
    認証期限切れです
    openIdが仕様に準拠していません
    7007
    他のルームにいます
    1001
    ルーム参加中でこの操作を繰り返しています。コールバックが戻るまで、ルーム参加インターフェースを呼び出さないことをお勧めします
    1003
    ルームに参加してルームにいますが、もう1回ルーム参加インターフェースを呼び出しました
    1101
    SDKが初期化されていること、openIdが規則に準拠していること、またはインターフェースが同じスレッドで呼び出されていること、およびPollインタフェースが正常に呼び出されていることを確認してください

    2. マイクのオン/オフ

    このインターフェースは、マイクのオン/オフに使用されます。入室する際、マイクとスピーカーはデフォルトでオフになっています。

    サンプルコード

    //イベントを監視します:
    ITMGContext.GetInstance().OnEnterRoomCompleteEvent += new QAVEnterRoomComplete(OnEnterRoomComplete);
    //監視処理:
    void OnEnterRoomComplete(int err, string errInfo)
    {
    if (err != 0) {
    ShowLoginPanel("エラーコード:" + err + "エラーメッセージ:" + errInfo);
    return;
    }
    else{
    //入室に成功
    // マイクの起動
    ITMGContext.GetInstance().GetAudioCtrl().EnableMic(true);
    }
    }

    3. スピーカーのオン/オフ

    このインターフェースは、スピーカーのオン/オフに使用されます。

    サンプルコード

    //イベントを監視します:
    ITMGContext.GetInstance().OnEnterRoomCompleteEvent += new QAVEnterRoomComplete(OnEnterRoomComplete);
    //監視処理:
    void OnEnterRoomComplete(int err, string errInfo)
    {
    if (err != 0) {
    ShowLoginPanel("エラーコード:" + err + "エラーメッセージ:" + errInfo);
    return;
    }
    else{
    //入室に成功
    //スピーカーをオンにする
    ITMGContext.GetInstance().GetAudioCtrl().EnableSpeaker(true);
    }
    }

    4. 退室

    このインターフェースを呼び出すと、退室することができます。処理の実行は退室のコールバックを待つ必要があります。

    サンプルコード

    ITMGContext.GetInstance().ExitRoom();

    退室コールバック

    退室してからはコールバックが発生します、サンプルコードは次の通りです:
    イベントを監視します。
    ITMGContext.GetInstance().OnExitRoomCompleteEvent += new QAVExitRoomComplete(OnExitRoomComplete);
    監視処理:
    void OnExitRoomComplete(){
    //退室した後の処理
    }

    音声メッセージの導入

    1. 認証初期化

    SDKを初期化してから認証の初期化を呼び出します。authBufferの取得については、前記のリアルタイム音声の認証情報インターフェースgenAuthBufferをご参照ください。

    インターフェースのプロトタイプ

    ITMGPTT int ApplyPTTAuthbuffer (byte[] authBuffer)
    パラメータ
    タイプ
    意味
    authBuffer
    String
    認証

    サンプルコード

    UserConfig.SetAppID(transform.Find ("appId").GetComponent<InputField> ().text);
    UserConfig.SetUserID(transform.Find ("userId").GetComponent<InputField> ().text);
    UserConfig.SetAuthKey(transform.Find("authKey").GetComponent<InputField>().text);
    byte[] authBuffer = UserConfig.GetAuthBuffer(UserConfig.GetAppID(), UserConfig.GetUserID(), null,UserConfig.GetAuthKey());
    ITMGContext.GetInstance().GetPttCtrl().ApplyPTTAuthbuffer(authBuffer);

    2. ストリーミング音声認識を起動

    このインターフェースは、ストリーミング音声識別の開始に使われています。コールバックにおいて、音声はリアルタイムでテキストに変換されて返されます。録音の停止にはStopRecordingを呼び出します。停止後にコールバックが発生します。

    インターフェースのプロトタイプ

    ITMGPTT int StartRecordingWithStreamingRecognition(string filePath)
    パラメータ
    タイプ
    意味
    filePath
    String
    ボイスの保存パス

    サンプルコード

    string recordPath = Application.persistentDataPath + string.Format("/{0}.silk", sUid++);
    int ret = ITMGContext.GetInstance().GetPttCtrl().StartRecordingWithStreamingRecognition(recordPath);

    ストリーミング音声識別コールバック

    ストリーミング音声識別を開始した後、OnStreamingSpeechCompleteまたはOnStreamingSpeechisRunning通知でコールバックメッセージを監視する必要があります。イベントメッセージは次の2つがあります。
    OnStreamingSpeechCompleteはレコーディングを停止して認識が完了した後にテキストを返します。これは、発話が完了した後に認識されたテキストを返すことに相当します。
    OnStreamingSpeechisRunningは録音中に認識されたテキストをリアルタイムで返すことであり、発話しながら認識された文字を返すことに相当します。
    OnEvent関数で、必要に応じて適切なイベントメッセージを判断します。渡されるパラメータには次の4つの情報が含まれます。
    メッセージ名称
    意味
    result
    ストリーミングボイス認識が完了したかどうかを判断するための戻りコード
    text
    ボイステキスト変換で認識されたテキスト
    file_path
    録音を保存するローカルアドレス
    file_id
    録音はバックグラウンドのURLアドレスにあり、録音はサーバーで90日間保存されます
    サンプルコード
    //イベントを監視します:
    ITMGContext.GetInstance().GetPttCtrl().OnStreamingSpeechComplete +=new QAVStreamingRecognitionCallback (OnStreamingSpeechComplete);
    ITMGContext.GetInstance().GetPttCtrl().OnStreamingSpeechisRunning += new QAVStreamingRecognitionCallback (OnStreamingRecisRunning);
    //監視処理:
    void OnStreamingSpeechComplete(int code, string fileid, string filepath, string result){
    // ストリーミングAutomatic Speech Recognitionのコールバックの起動
    }
    void OnStreamingRecisRunning(int code, string fileid, string filePath, string result){
    if (code == 0)
    {
    setBtnText(mStreamBtn, "ストリーミング");
    InputField field = transform.Find("recordFilePath").GetComponent<InputField>();
    field.text = filePath;
    field = transform.Find("downloadUrl").GetComponent<InputField>();
    field.text = "Stream is Running";
    field = transform.Find("convertTextResult").GetComponent<InputField>();
    field.text = result;
    showWarningText("レコーディング中");
    }
    }
    エラーコード
    エラーコード
    意味
    処理方式
    32775
    ストリーミング音声をテキストに変更できませんが、録音は成功しました
    UploadRecordedFileインターフェースを呼び出して録音をアップロードし、SpeechToTextインターフェースを呼び出して音声を文字に変換します
    32777
    ストリーミング音声をテキストに変更できませんが、録音とアップロードは成功しました
    返されたメッセージには正常にアップロードしたバックグラウンドURLがあり、SpeechToTextインターフェースを呼び出して音声から文字への変換操作を行います
    32786
    ストリーミング音声をテキストに変更できませんでした
    ストリーミングレコーディングステータスでは、ストリーミングレコーディングインターフェースの実行結果が返されるまで待ってください

    3. 録音を停止

    このインターフェースは、録音の停止に使われています。このインターフェースが非同期インターフェースであるため、録音を停止した後には録音完了のコールバックがあります。コールバックが成功してから、録音ファイルが利用できるようになります。

    インターフェースのプロトタイプ

    ITMGPTT int StopRecording()

    サンプルコード

    ITMGContext.GetInstance().GetPttCtrl().StopRecording();
    
    お問い合わせ

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

    テクニカルサポート

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

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