chat_manager::initialize

2025-05-01

オブジェクトインスタンスを初期化します。

構文

void initialize(  
    uint32_t maxChatUserCount,  
    float defaultAudioRenderVolume= 1.0f,  
    game_chat_communication_relationship_flags defaultLocalToRemoteCommunicationRelationship= game_chat_communication_relationship_flags none,  
    game_chat_shared_device_communication_relationship_resolution_mode sharedDeviceResolutionMode= game_chat_shared_device_communication_relationship_resolution_mode permissive,  
    game_chat_speech_to_text_conversion_mode speechToTextConversionMode= game_chat_speech_to_text_conversion_mode automatic,  
    game_chat_audio_manipulation_mode_flags audioManipulationMode= game_chat_audio_manipulation_mode_flags none  
)

パラメーター

maxChatUserCount _In_
型: uint32_t

ローカルの chat_manager インスタンスに任意の時点で追加されるローカルユーザーとリモートユーザーの最大合計数。ゲームチャットでは、ユーザー数に比例してメモリを事前に割り当てます。

defaultAudioRenderVolume _In_range_(0,1)
型: float

新しいユーザーに使用されるオーディオレンダリングボリューム。

defaultLocalToRemoteCommunicationRelationship _In_
型: game_chat_communication_relationship_flags

ローカルユーザーとリモートユーザーの間で使用される既定の通信リレーションシップ。つまり、リモートユーザーが参加した場合は、これが既存のすべてのローカルユーザーとそのリモートユーザーの間で使用される既定のリレーションシップになります。ローカルユーザーが参加した場合は、これがそのローカルユーザーと既存のすべてのリモートユーザーの間の既定のリレーションシップになります。

sharedDeviceResolutionMode _In_
型: game_chat_shared_device_communication_relationship_resolution_mode

通信リレーションシップが競合している共有デバイス上のユーザーに使用される解像度モード。

speechToTextConversionMode _In_
型: game_chat_speech_to_text_conversion_mode

音声テキスト変換モードを構成します。

audioManipulationMode _In_
型: game_chat_audio_manipulation_mode_flags

このパラメーターを game_chat_audio_manipulation_mode_flags::none として渡すと、オーディオがゲームチャットを中断せずに通過できるようになります。このパラメーターを game_chat_audio_manipulation_mode_flags::p re_encode_stream_manipulation ビットセットと共に渡すと、送信者側で処理および操作するためのチャットユーザーオーディオデータへのアクセスが許可されます。オーディオデータへのアクセスは、pre_encode_audio_stream オブジェクトを使用することで有効になります。これらのオブジェクトは、 chat_manager::get_pre_encode_audio_streams メソッドを使用してクエリを実行できます。ゲームチャットが pre_encode_audio_stream オブジェクトを作成する、閉じる、破棄すると、対応する game_chat_stream_state_change イベントが生成されます。 game_chat_audio_manipulation_mode_flags::p ost_decode_stream_manipulation ビットセットを使用してこのパラメーターを渡すと、受信側で処理および操作するためのチャットユーザーオーディオデータへのアクセスが許可されます。オーディオデータへのアクセスは、post_decode_audio_source_stream オブジェクトと post_decode_audio_sink_stream オブジェクトを使用することで有効になります。これらのオブジェクトは、 chat_manager::get_post_decode_audio_source_streams メソッドと chat_manager::get_post_decode_audio_sink_streams メソッドを使用してクエリを実行できます。ゲームチャットが post_decode_audio_source_stream オブジェクトと post_decode_audio_sink_stream オブジェクトを作成する、閉じる、破棄すると、対応する game_chat_stream_state_change イベントが生成されます。

戻り値

型: void

解説

これは、静的メソッド chat_manager::singleton_instance()、chat_manager::set_memory_callbacks()、chat_manager::get_memory_callbacks()、chat_manager::set_thread_processor()、および chat_manager::get_thread_processor() 以外の他のメソッドの前に呼び出す必要があります。 chat_manager::initialize() は、後続の chat_manager::cleanup() 呼び出しなしで再度呼び出すことはできません。

chat_manager::initialize() を呼び出すたびに、対応する chat_manager::cleanup() 呼び出しが必要です。

要件

ヘッダー: GameChat2.h

サポートされているプラットフォーム: Windows、Xbox One ファミリー本体、Xbox Series 本体

次の方法で共有

chat_manager::initialize

構文

パラメーター

戻り値

解説

要件

関連項目

その他のリソース