語法
參數
targetChatControlCount uint32_t
targetChatControls 陣列中的目標聊天控制項數目。
targetChatControls PartyChatControlArray大小為
targetChatControlCount 的輸入陣列
包含 targetChatControlCount 個項目的目標 PartyChatControl 陣列。
chatText PartyString
要傳送的文字。
dataBufferCount uint32_t
dataBuffers 陣列中提供的緩衝區結構數目。
dataBuffers PartyDataBuffer*大小為
dataBufferCount 的輸入陣列
包含 dataBufferCount 個項目的 PartyDataBuffer 結構陣列,描述要傳送的輔助訊息承載。當 dataBufferCount 為零時會忽略此參數。
傳回值
PartyErrorc_partyErrorSuccess (如果呼叫成功),否則為錯誤碼。可透過 PartyManager::GetErrorMessage() 擷取錯誤碼的人類可讀形式。
備註
目前不支援將聊天文字傳送至本機聊天控制項。如果目標聊天控制項陣列包含任何本機目標,此呼叫將以同步方式失敗。不保證會對文字內容進行翻譯、當地語系化或冒犯性語言篩選;聊天文字字串將以原樣呈現。
文字字串只會傳遞給已透過 PartyLocalChatControl::SetPermissions() 將自己的執行個體設定為接收來自本機聊天控制項之文字訊息的目標聊天控制項。
如果目標聊天控制項未與來源聊天控制項連線到至少一個共同網路,文字字串將不會傳遞。如果有兩個本機聊天控制項,就可能發生這種情況。連線到其中一個本機聊天控制項的目標聊天控制項,不一定會連線到所有其他本機聊天控制項。
dataBuffers 陣列中的 PartyDataBuffer 結構用於與聊天文字相關聯的輔助資料,例如指出應用來轉譯文字之色彩的中繼資料,或包含要與聊天文字一起轉譯之圖示影像資料的二進位 Blob。若要傳送與文字聊天無關的遊戲資料,請參閱 PartyLocalEndpoint::SendMessage(),這是可更精細控制訊息傳輸行為的訊息選項。 呼叫者會在
dataBuffers 陣列中提供 0 個或多個 PartyDataBuffer 結構。結構所參考的記憶體不必是連續的,例如,可以輕鬆地使用固定的標頭緩衝區,後面接著可變的承載。緩衝區會依序組合、傳輸,並以單一連續資料區塊的形式,在 PartyChatTextReceivedStateChange 中與聊天文字分開傳遞給目標聊天控制項。Party 程式庫不會耗用頻寬來傳輸描述原始 PartyDataBuffer 分段的中繼資料。
需求
標頭: Party.h另請參閱
PartyLocalChatControlPartyChatTextReceivedStateChange
