SteamVoipClient - stingray.SteamVoipClient オブジェクト リファレンス - Stingray Lua API リファレンス
説明
ルームで他者との通信ができるクライアントを表します。
コンストラクタとアクセサ 
その他の関連リファレンス項目
関数
 |
broken_host ( self ) : boolean 指定されたクライアントへの接続に失敗したかどうかを示します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
boolean |
接続に失敗した場合は true を返し、そうでない場合は false を返します。 |
| |
members ( self ) : string[]ルーム内のすべてのメンバーの ID をリストしたテーブルを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
string[] |
ルーム内の各ピアの ID を含むテーブルを返します。 []表記は、この型が配列(メンバーのキーは連番、各要素の値は示されている型のインスタンス)であることを示します。 |
| |
room_id ( self ) : string指定されたクライアントが接続しているルームの ID を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
string |
クライアントが接続しているルームの ID を返します。 |
| |
select_in ( self, enable, peer_id )指定されたクライアントが接続しているルーム内で音声を再生するピアを指定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
enable : | boolean | 音声通信を有効にするかどうかを指定します。音声を有効にするには true を使用し、音声を無効にするには false を使用します。 |
peer_id : | string? | ピアの ID を指定します。ピア ID を指定する場合は、そのピアのみに影響します。ピア ID が指定されていない場合は、クライアントが接続しているルーム内のすべてのメンバーに影響します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
注: 複数のクライアントを使用していて、特定のピアに複数のクライアントを介して接続している場合、1 つのクライアントのみが送信元として承認されていないと音声が送信されません。特定のピアを完全にミュートする場合は、そのピアが接続しているすべてのクライアントに対して select_in() を呼び出す必要があります。
| |
select_out ( self, enable, peer_id )このクライアントを通じてこちらからの音声を受信できる相手を指定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
enable : | boolean | 音声通信を有効にするかどうかを指定します。音声を有効にするには true を使用し、音声を無効にするには false を使用します。 |
peer_id : | string? | ピアの ID を指定します。ピア ID を指定する場合は、そのピアのみに影響します。ピア ID が指定されていない場合は、クライアントが接続しているルーム内のすべてのメンバーに影響します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
注: 複数のクライアントを使用していて、特定のピアに複数のクライアントを介して接続している場合、1 つのクライアントのみが送信元として承認されていないと音声が送信されません。特定のピアがこちらからの音声を受信できないようにブロックする場合は、そのピアが接続しているすべてのクライアントに対して select_out() を呼び出す必要があります。