VoiceChat - stingray.VoiceChat ネームスペース リファレンス - Stingray Lua API リファレンス
説明
Xbox One のボイス チャット機能にアクセスするためのインタフェースです。
その他の関連リファレンス項目 
関数
 |
add_user_to_channel ( user_id, channel ) チャット チャネルにユーザを追加する非同期タスクを開始します。
|
user_id : | integer | ローカル ユーザの ID です。 |
channel : | integer | チャット チャネルのインデックスです。0 ～ 255 で指定する必要があります。 |
| この関数は値を返しません。 |
終了したら、latest_added_users() を使用して追跡します。
その他の関連リファレンス項目
| |
chat_users ( ) : chat_user[] |
| この関数はパラメータを受け入れません。 |
|
チャット中のユーザのリスト []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。 |
| |
has_mic_focus ( ) : boolean |
| この関数はパラメータを受け入れません。 |
boolean |
ゲームに MIC フォーカスがある場合は true を返します。 |
| |
has_running_jobs ( ) : boolean |
| この関数はパラメータを受け入れません。 |
boolean |
ボイス チャットが非同期ジョブの完了を待っている場合は true を返します。 |
その他の関連リファレンス項目
| |
init ( )VoiceChat システムを初期化して Game Chat システム内のビルドを使用します。
|
| この関数はパラメータを受け入れません。 |
| この関数は値を返しません。 |
その他の関連リファレンス項目
| |
latest_added_users ( ) : chat_user_channel*前回の呼び出しから、add_user_to_channel() でチャットに追加されたユーザを返します。
|
| この関数はパラメータを受け入れません。 |
|
ユーザの xbox_user_id と、ユーザが追加されたチャネルのリストです。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。 |
その他の関連リファレンス項目
| |
latest_removed_users ( ) : chat_user_channel*前回の呼び出しから、remove_user_from_channel() でチャットから除去されたユーザを返します。
|
| この関数はパラメータを受け入れません。 |
|
ユーザの xbox_user_id と、ユーザが除去されたチャネルのリストです。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。 |
その他の関連リファレンス項目
| |
mute_all_users ( )すべてのユーザをミュートします。
|
| この関数はパラメータを受け入れません。 |
| この関数は値を返しません。 |
| |
mute_user ( xbox_user_id )単一のユーザをミュートします。
|
xbox_user_id : | string | ミュートするユーザ |
| この関数は値を返しません。 |
| |
remove_user_from_channel ( user_id, channel )チャット チャネルからユーザを除去する非同期タスクを開始します。
|
user_id : | integer | ローカル ユーザの ID です。 |
channel : | integer | チャット チャネルのインデックスです。0 ～ 255 で指定する必要があります。 |
| この関数は値を返しません。 |
終了したら、latest_removed_users() を使用して追跡します。
その他の関連リファレンス項目
| |
remove_user_from_channel_with_xuid ( xbox_user_id, channel )チャット チャネルからユーザを除去する非同期タスクを開始します。
|
xbox_user_id : | string | ローカル ユーザの Xbox ユーザ ID です。 |
channel : | integer | チャット チャネルのインデックスです。0 ～ 255 で指定する必要があります。 |
| この関数は値を返しません。 |
この関数でチャットから除去できるのは、ローカル ユーザのみであることに注意してください。
終了したら、latest_removed_users() を使用して追跡します。
| |
shutdown ( )VoiceChat.init() で作成した VoiceChat をシャット ダウンします。
|
| この関数はパラメータを受け入れません。 |
| この関数は値を返しません。 |
シャット ダウンする前に、VoiceChat.has_running_jobs() を呼び出して実行中のジョブがないことを確認します。
| |
unmute_all_users ( )すべてのユーザをミュート解除します。
|
| この関数はパラメータを受け入れません。 |
| この関数は値を返しません。 |
| |
unmute_user ( xbox_user_id )単一のユーザをミュート解除します。
|
xbox_user_id : | string | ミュート解除するユーザ |
| この関数は値を返しません。 |