Steam Remote Playセッションに関する情報を提供する機能で、ゲームコンテンツを別のコンピューター、またはSteamリンクアプリやハードウェアにストリーミングします。
詳細は
Steam Remote Playを参照してください。
メンバー関数
ISteamRemotePlayのメンバー関数は、グローバルのアクセサー関数
SteamRemotePlay()経由で呼び出されます。
GetSessionCount
uint32 GetSessionCount();
現在接続されているSteam Remote Playセッションの数を取得します。
戻り値:uint32現在接続されているSteam Remote Playセッションの数。
例:bool BSteamRemotePlayActive()
{
uint32 unSessionCount = SteamRemotePlay()->GetSessionCount();
for ( uint32 iIndex = 0; iIndex < unSessionCount; iIndex++ )
{
RemotePlaySessionID_t unSessionID = SteamRemotePlay()->GetSessionID( iIndex );
if ( !unSessionID )
{
continue;
}
return true;
}
return false;
}
GetSessionID
RemotePlaySessionID_t GetSessionID( int iSessionIndex );
| 名前 | 型 | 説明 |
| iSessionIndex | int | 指定のセッションのインデックス。 |
指定されたインデックスで現在接続されているSteam Remote PlayセッションIDを取得します。
戻り値:RemotePlaySessionID_t指定されたインデックスのセッションのセッションID。インデックスが0より小さいか、
GetSessionCount()以上の場合は0。
BSessionRemotePlayTogether
bool BSessionRemotePlayTogether( RemotePlaySessionID_t unSessionID );
セッションがRemote Play Togetherの招待を使用して参加したかどうかを取得します。
戻り値:bool
そのセッションがRemote Play Togetherの招待を使用して参加した場合は
trueを返し、Steamリンクや別のコンピューターを経由してRemote Playを使用して接続した場合は
falseを返します。
GetSessionSteamID
CSteamID GetSessionSteamID( RemotePlaySessionID_t unSessionID );
接続されているユーザーのSteamIDを取得します。
戻り値:CSteamIDRemote Playセッションに関連するユーザーのSteam ID。 これは通常、ログインしているユーザーか、Remote Play Togetherの場合にはフレンドです。
GetSessionGuestID
uint32 GetSessionGuestID( RemotePlaySessionID_t unSessionID );
接続されているユーザーがRemote Play Togetherのゲストである場合、そのユーザーのゲストIDを取得します。
戻り値:uint32Remote Playセッションに関連付けられたユーザーのゲストIDを返します。または、セッションIDが有効でない場合や、セッションがRemote Play Togetherのゲストではない場合は、0を返します。
GetSmallSessionAvatar
int GetSmallSessionAvatar( RemotePlaySessionID_t unSessionID );
接続されているユーザーの小型アバター(32x32)を取得します。これは、
ISteamUtils::GetImageRGBA()で使用されるハンドルです。
戻り値:int
接続されているユーザーの小型アバター(32x32)を返すか、セッションIDが有効でない場合は0を返します。または、この画像が読み込まれていない場合は-1を返します。その場合は、
SteamRemotePlaySessionAvatarLoaded_tコールバックを待ってからもう一度この呼び出しを実行してください。
GetMediumSessionAvatar
int GetMediumSessionAvatar( RemotePlaySessionID_t unSessionID );
接続されているユーザーの中型アバター(64x64)を取得します。これは、
ISteamUtils::GetImageRGBA()で使用されるハンドルです。
戻り値:int
接続されているユーザーの中型アバター(64x64)を返すか、セッションIDが有効でない場合は0を返します。または、この画像が読み込まれていない場合は-1を返します。その場合は、
SteamRemotePlaySessionAvatarLoaded_tコールバックを待ってからもう一度この呼び出しを実行してください。
GetLargeSessionAvatar
int GetLargeSessionAvatar( RemotePlaySessionID_t unSessionID );
接続されているユーザーの大型アバター(184x184)を取得します。これは、
ISteamUtils::GetImageRGBA()で使用されるハンドルです。
戻り値:int
接続されているユーザーの大型アバター(184x184)を返すか、セッションIDが有効でない場合は0を返します。または、この画像が読み込まれていない場合は-1を返します。その場合は、
SteamRemotePlaySessionAvatarLoaded_tコールバックを待ってからもう一度この呼び出しを実行してください。
GetSessionClientName
const char *GetSessionClientName( RemotePlaySessionID_t unSessionID );
セッションクライアントデバイスの名前を取得します。
戻り値:const char *
Remote Playセッションと関連するデバイスの名前。セッションIDが有効でない場合にはNULLです。
GetSessionClientFormFactor
ESteamDeviceFormFactor GetSessionClientFormFactor( RemotePlaySessionID_t unSessionID );
セッションクライアントデバイスのフォームファクターを取得します。
戻り値:ESteamDeviceFormFactorRemote Playセッションに関連するデバイスのフォームファクター、またはセッションIDが有効でない場合には
k_ESteamDeviceFormFactorUnknown。
例:bool BSteamRemotePlayToPhone()
{
uint32 unSessionCount = SteamRemotePlay()->GetSessionCount();
for ( uint32 iIndex = 0; iIndex < unSessionCount; iIndex++ )
{
RemotePlaySessionID_t unSessionID = SteamRemotePlay()->GetSessionID( iIndex );
if ( !unSessionID )
{
continue;
}
ESteamDeviceFormFactor eFormFactor = SteamRemotePlay()->GetSessionClientFormFactor( unSessionID );
if ( eFormFactor == k_ESteamDeviceFormFactorPhone )
{
return true;
}
}
return false;
}
BGetSessionClientResolution
bool BGetSessionClientResolution( RemotePlaySessionID_t unSessionID, int *pnResolutionX, int *pnResolutionY );
| 名前 | 型 | 説明 |
| unSessionID | RemotePlaySessionID_t | 情報を取得するセッションID。 |
| pnResolutionX | int | デバイスの解像度の幅で埋める変数へのポインター。 |
| pnResolutionY | int | デバイスの解像度の高さで埋める変数へのポインター。 |
セッションクライアントデバイスの解像度をピクセル単位で取得します。 解像度が入手できない場合には0x0に設定されます。
戻り値:bool
trueとなるのはセッションIDが有効な場合で、それ以外は
falseです。
例:// リモートデバイスがデバイスの解像度情報を提供しない場合、falseを返すことがあります。
bool BGetSteamRemotePlayResolution( int *pnX, int *pnY )
{
int nMaxResolutionX = 0, nMaxResolutionY = 0;
uint32 unSessionCount = SteamRemotePlay()->GetSessionCount();
for ( uint32 iIndex = 0; iIndex < unSessionCount; iIndex++ )
{
RemotePlaySessionID_t unSessionID = SteamRemotePlay()->GetSessionID( iIndex );
if ( !unSessionID )
{
continue;
}
int nResolutionX = 0, nResolutionY = 0;
SteamRemotePlay()->BGetSessionClientResolution( unSessionID, &nResolutionX, &nResolutionY );
if ( nResolutionX > nMaxResolutionX )
{
nMaxResolutionX = nResolutionX;
nMaxResolutionY = nResolutionY;
}
}
if ( pnX )
{
*pnX = nMaxResolutionX;
}
if ( pnY )
{
*pnY = nMaxResolutionY;
}
return ( nMaxResolutionX > 0 && nMaxResolutionY > 0 );
}
ShowRemotePlayTogetherUI
bool ShowRemotePlayTogetherUI();
ゲームオーバーレイにRemote Play TogetherのUIを表示します。
戻り値:bool
trueとなるのはゲームがRemote Play Together用に設定されている場合で、それ以外は
falseです。
BSendRemotePlayTogetherInvite
bool BSendRemotePlayTogetherInvite( CSteamID steamIDFriend );
| 名前 | 型 | 説明 |
| steamIDFriend | CSteamID | 招待するフレンドのSteam ID。または、SteamIDFriendがCSteamID()の場合はゲスト招待を作成します。 |
Remote Play Togetherを使ってゲームに参加するフレンドを招待します。
戻り値:bool
trueとなるのは招待が正常に送信された場合で、それ以外は
falseです。
BEnableRemotePlayTogetherDirectInput
bool BEnableRemotePlayTogetherDirectInput();
Remote Play Togetherセッションのマウスとキーボードの入力を、ローカル入力と統合する代わりにGetInput()経由で使用できるようにします。
戻り値:bool
trueとなるのはマウスイベントとキーボードイベントが利用可能になった場合で 、それ以外は
falseです。
DisableRemotePlayTogetherDirectInput
void DisableRemotePlayTogetherDirectInput();
Remote Play Togetherのマウスとキーボードの入力をローカル入力に統合します。
GetInput
uint32 GetInput( RemotePlayInput_t *pInput, uint32 unMaxEvents );
Remote Play Togetherセッションから入力イベントを取得します。 これは、
BEnableRemotePlayTogetherDirectInput()を呼び出した後に使用できます。
戻り値:uint32pInputにコピーされたイベントの数、またはpInputがnullptrの場合に利用可能なイベントの数。
SetMouseVisibility
void SetMouseVisibility( RemotePlaySessionID_t unSessionID, bool bVisible );
リモートプレイヤーのマウスカーソルの可視性を設定します。 これは、
BEnableRemotePlayTogetherDirectInput()を呼び出した後に使用できます。
SetMousePosition
void SetMousePosition( RemotePlaySessionID_t unSessionID, float flNormalizedX, float flNormalizedY );
| 名前 | 型 | 説明 |
| unSessionID | RemotePlaySessionID_t | 影響するセッション。 |
| flNormalizedX | float | マウスカーソルの正規化されたX位置。 |
| flNormalizedY | float | マウスカーソルの正規化されたY位置。 |
リモートプレイヤーのマウスカーソルの位置を設定します。 これは、
BEnableRemotePlayTogetherDirectInput()を呼び出した後に使用できます。 これはカーソルを特定の場所に移動させるために使用されますが、通常のイベント処理では必要ありません。 位置はウィンドウに対して正規化され、0,0は左上、1,1は右下になります。
CreateMouseCursor
RemotePlayCursorID_t CreateMouseCursor( int nWidth, int nHeight, int nHotX, int nHotY, const void *pBGRA, int nPitch = 0 );
| 名前 | 型 | 説明 |
| nWidth | int | ピクセル単位でのカーソルの幅。 |
| nHeight | int | ピクセル単位でのカーソルの高さ。 |
| nHotX | int | ピクセル単位でのカーソルホットスポットのX座標(カーソルの左側からのオフセット)。 |
| nHotY | int | ピクセル単位でのカーソルホットスポットのY座標(カーソルの上側からのオフセット)。 |
| pBGRA | const void * | カーソルのピクセルへのポインター。カラーチャンネルは赤、緑、青、アルファの順。 |
| nPitch | int | ピクセル行間のバイト単位での距離。デフォルトはnWidth * 4。 |
setMouseCursor()で使用できるカーソルを作成します。 これは、
BEnableRemotePlayTogetherDirectInput()を呼び出した後に使用できます。
戻り値:RemotePlayCursorID_tSetMouseCursor
void SetMouseCursor( RemotePlaySessionID_t unSessionID, RemotePlayCursorID_t unCursorID );
リモートプレイヤーのマウスカーソルを設定します。 これは、
BEnableRemotePlayTogetherDirectInput()を呼び出した後に使用できます。
コールバック
以下は
SteamAPI_RunCallbacksを呼び出すことによって実行されるコールバックです。
SteamRemotePlaySessionConnected_t
クライアントがセッションに接続したときに送信されます。
SteamRemotePlaySessionDisconnected_t
クライアントがセッションから切断されたときに送信されます。
SteamRemotePlayTogetherGuestInvite_t
ゲスト招待が作成されたときに送信され、ゲスト招待URLが含まれます。
| 名前 | 型 | 説明 |
| m_szConnectURL | char * | このゲストセッションへの接続に使用できるURL。 |
SteamRemotePlaySessionAvatarLoaded_t
アバターがストリーミングセッション用に読み込まれたときに送信されます。
構造体
これらはISteamRemotePlay内の関数が返す、またはやりとりする構造体です。
RemotePlayInputMouseMotion_t
マウス移動イベントデータ。RemotePlayInput_t::m_eTypeが k_ERemotePlayInputMouseMotionの場合に有効です。
| 名前 | 型 | 説明 |
| m_bAbsolute | bool | これが絶対的なマウス移動で、m_flNormalizedXとm_flNormalizedYが有効な場合はtrue。 |
| m_flNormalizedX | float | m_bAbsoluteがtrueの場合、マウスの絶対X位置(ディスプレイに正規化された値)。 |
| m_flNormalizedY | float | m_bAbsoluteがtrueの場合、マウスの絶対Y位置(ディスプレイに正規化された値)。 |
| m_nDeltaX | int | X方向の相対的なマウス移動。 |
| m_nDeltaY | int | Y方向の相対的なマウス移動。 |
RemotePlayInputMouseWheel_t
マウスホイールイベントデータ。RemotePlayInput_t::m_eTypeがk_ERemotePlayInputMouseWheelの場合に有効です。
RemotePlayInputKey_t
キーイベントデータ。RemotePlayInput_t::m_eTypeが k_ERemotePlayInputKeyDownまたはk_ERemotePlayInputKeyUpの場合に有効です。
RemotePlayInput_t
リモート入力イベント。
BEnableRemotePlayTogetherDirectInput()で有効化されます。
列挙型
これらはISteamRemotePlayで使用するために定義された列挙型です。
ESteamDeviceFormFactor
デバイスのフォームファクター
| 名前 | 値 | 説明 |
| k_ESteamDeviceFormFactorUnknown | 0 | デバイスのフォームファクターが入手できない。 |
| k_ESteamDeviceFormFactorPhone | 1 | デバイスはスマートフォンかタッチスクリーン付きの小型携帯端末です。 |
| k_ESteamDeviceFormFactorTablet | 2 | デバイスは、タブレットかタッチスクリーン付きの大型携帯端末です。 |
| k_ESteamDeviceFormFactorComputer | 3 | デバイスはデスクトップコンピュータまたはノートパソコンです。 |
| k_ESteamDeviceFormFactorTV | 4 | デバイスはテレビです。 |
ERemotePlayInputType
RemotePlayInput_t内の入力タイプ。
| 名前 | 値 | 説明 |
| k_ERemotePlayInputUnknown | 0 | 不明な入力。 |
| k_ERemotePlayInputMouseMotion | 1 | マウス移動イベント。 |
| k_ERemotePlayInputMouseButtonDown | 2 | マウスボタンの押下イベント。 |
| k_ERemotePlayInputMouseButtonUp | 3 | マウスボタンの解放イベント。 |
| k_ERemotePlayInputMouseWheel | 4 | マウスホイールイベント。 |
| k_ERemotePlayInputKeyDown | 5 | キーボードキーの押下イベント。 |
| k_ERemotePlayInputKeyUp | 6 | キーボードキーの解放イベント。 |
ERemotePlayMouseButton
RemotePlayInput_t内のマウスボタン。
| 名前 | 値 | 説明 |
| k_ERemotePlayMouseButtonLeft | 0x0001 | マウスの左ボタン。 |
| k_ERemotePlayMouseButtonRight | 0x0002 | マウスの右ボタン。 |
| k_ERemotePlayMouseButtonMiddle | 0x0010 | マウスの中央ボタン。 |
| k_ERemotePlayMouseButtonX1 | 0x0020 | マウスの1つ目の拡張ボタン。 |
| k_ERemotePlayMouseButtonX2 | 0x0040 | マウスの2つ目の拡張ボタン。 |
ERemotePlayMouseWheelDirection
RemotePlayInput_t内のマウスホイールの方向。
| 名前 | 値 | 説明 |
| k_ERemotePlayMouseWheelUp | 1 | マウスホイールが前方向にスクロールされました。 |
| k_ERemotePlayMouseWheelDown | 2 | マウスホイールが後方向にスクロールされました。 |
| k_ERemotePlayMouseWheelLeft | 3 | マウスホイールが左方向にスクロールされました。 |
| k_ERemotePlayMouseWheelRight | 4 | マウスホイールが右方向にスクロールされました。 |
ERemotePlayScancode
RemotePlayInput_t内のキースキャンコード。
これは、キーボード/キーパッドページ(0x07)で定義されているUSBスキャンコード値です。 この表は完全ではなく、最も一般的に使用されるキーだけを列挙しています。
| 名前 | 値 | 説明 |
| k_ERemotePlayScancodeUnknown | 0 | 不明なキー |
| k_ERemotePlayScancodeA | 4 | A |
| k_ERemotePlayScancodeB | 5 | B |
| k_ERemotePlayScancodeC | 6 | C |
| k_ERemotePlayScancodeD | 7 | D |
| k_ERemotePlayScancodeE | 8 | E |
| k_ERemotePlayScancodeF | 9 | F |
| k_ERemotePlayScancodeG | 10 | G |
| k_ERemotePlayScancodeH | 11 | H |
| k_ERemotePlayScancodeI | 12 | I |
| k_ERemotePlayScancodeJ | 13 | J |
| k_ERemotePlayScancodeK | 14 | K |
| k_ERemotePlayScancodeL | 15 | L |
| k_ERemotePlayScancodeM | 16 | M |
| k_ERemotePlayScancodeN | 17 | N |
| k_ERemotePlayScancodeO | 18 | O |
| k_ERemotePlayScancodeP | 19 | P |
| k_ERemotePlayScancodeQ | 20 | Q |
| k_ERemotePlayScancodeR | 21 | R |
| k_ERemotePlayScancodeS | 22 | S |
| k_ERemotePlayScancodeT | 23 | T |
| k_ERemotePlayScancodeU | 24 | U |
| k_ERemotePlayScancodeV | 25 | V |
| k_ERemotePlayScancodeW | 26 | W |
| k_ERemotePlayScancodeX | 27 | X |
| k_ERemotePlayScancodeY | 28 | Y |
| k_ERemotePlayScancodeZ | 29 | Z |
| k_ERemotePlayScancode1 | 30 | 1 |
| k_ERemotePlayScancode2 | 31 | 2 |
| k_ERemotePlayScancode3 | 32 | 3 |
| k_ERemotePlayScancode4 | 33 | 4 |
| k_ERemotePlayScancode5 | 34 | 5 |
| k_ERemotePlayScancode6 | 35 | 6 |
| k_ERemotePlayScancode7 | 36 | 7 |
| k_ERemotePlayScancode8 | 37 | 8 |
| k_ERemotePlayScancode9 | 38 | 9 |
| k_ERemotePlayScancode0 | 39 | 0 |
| k_ERemotePlayScancodeReturn | 40 | エンター |
| k_ERemotePlayScancodeEscape | 41 | エスケープ |
| k_ERemotePlayScancodeBackspace | 42 | バックスペース |
| k_ERemotePlayScancodeTab | 43 | タブ |
| k_ERemotePlayScancodeSpace | 44 | スペース |
| k_ERemotePlayScancodeMinus | 45 | マイナス |
| k_ERemotePlayScancodeEquals | 46 | イコール |
| k_ERemotePlayScancodeLeftBracket | 47 | 大カッコ |
| k_ERemotePlayScancodeRightBracket | 48 | 大カッコトジ |
| k_ERemotePlayScancodeBackslash | 49 | バックスラッシュ |
| k_ERemotePlayScancodeSemicolon | 51 | セミコロン |
| k_ERemotePlayScancodeApostrophe | 52 | アポストロフィー |
| k_ERemotePlayScancodeGrave | 53 | アクサングラーブ |
| k_ERemotePlayScancodeComma | 54 | コンマ |
| k_ERemotePlayScancodePeriod | 55 | ピリオド |
| k_ERemotePlayScancodeSlash | 56 | スラッシュ |
| k_ERemotePlayScancodeCapsLock | 57 | キャプスロック |
| k_ERemotePlayScancodeF1 | 58 | F1 |
| k_ERemotePlayScancodeF2 | 59 | F2 |
| k_ERemotePlayScancodeF3 | 60 | F3 |
| k_ERemotePlayScancodeF4 | 61 | F4 |
| k_ERemotePlayScancodeF5 | 62 | F5 |
| k_ERemotePlayScancodeF6 | 63 | F6 |
| k_ERemotePlayScancodeF7 | 64 | F7 |
| k_ERemotePlayScancodeF8 | 65 | F8 |
| k_ERemotePlayScancodeF9 | 66 | F9 |
| k_ERemotePlayScancodeF10 | 67 | F10 |
| k_ERemotePlayScancodeF11 | 68 | F11 |
| k_ERemotePlayScancodeF12 | 69 | F12 |
| k_ERemotePlayScancodeInsert | 73 | インサート |
| k_ERemotePlayScancodeHome | 74 | ホーム |
| k_ERemotePlayScancodePageUp | 75 | ページアップ |
| k_ERemotePlayScancodeDelete | 76 | デリート |
| k_ERemotePlayScancodeEnd | 77 | エンド |
| k_ERemotePlayScancodePageDown | 78 | ページダウン |
| k_ERemotePlayScancodeRight | 79 | 右 |
| k_ERemotePlayScancodeLeft | 80 | 左 |
| k_ERemotePlayScancodeDown | 81 | 下 |
| k_ERemotePlayScancodeUp | 82 | 上 |
| k_ERemotePlayScancodeKeypadDivide | 84 | テンキーの除算 |
| k_ERemotePlayScancodeKeypadMultiply | 85 | テンキーの乗算 |
| k_ERemotePlayScancodeKeypadMinus | 86 | テンキーの減算 |
| k_ERemotePlayScancodeKeypadPlus | 87 | テンキーの加算 |
| k_ERemotePlayScancodeKeypadEnter | 88 | テンキーのエンター |
| k_ERemotePlayScancodeKeypad1 | 89 | テンキーの1 |
| k_ERemotePlayScancodeKeypad2 | 90 | テンキーの2 |
| k_ERemotePlayScancodeKeypad3 | 91 | テンキーの3 |
| k_ERemotePlayScancodeKeypad4 | 92 | テンキーの4 |
| k_ERemotePlayScancodeKeypad5 | 93 | テンキーの5 |
| k_ERemotePlayScancodeKeypad6 | 94 | テンキーの6 |
| k_ERemotePlayScancodeKeypad7 | 95 | テンキーの7 |
| k_ERemotePlayScancodeKeypad8 | 96 | テンキーの8 |
| k_ERemotePlayScancodeKeypad9 | 97 | テンキーの9 |
| k_ERemotePlayScancodeKeypad0 | 98 | テンキーの0 |
| k_ERemotePlayScancodeKeypadPeriod | 99 | テンキーのピリオド |
| k_ERemotePlayScancodeLeftControl | 224 | Ctrl(左) |
| k_ERemotePlayScancodeLeftShift | 225 | Shift(左) |
| k_ERemotePlayScancodeLeftAlt | 226 | Alt(左) |
| k_ERemotePlayScancodeLeftGUI | 227 | GUI(左)-Windows、Command、Metaなど |
| k_ERemotePlayScancodeRightControl | 228 | Ctrl(右) |
| k_ERemotePlayScancodeRightShift | 229 | Shift(右) |
| k_ERemotePlayScancodeRightALT | 230 | Alt(右) |
| k_ERemotePlayScancodeRightGUI | 231 | GUI(右)-Windows、Command、Metaなど |
ERemotePlayKeyModifier
RemotePlayInput_t内のキー修飾子
| 名前 | 値 | 説明 |
| k_ERemotePlayKeyModifierNone | 0x0000 | 有効な修飾子はありません。 |
| k_ERemotePlayKeyModifierLeftShift | 0x0001 | 左Shiftが有効です。 |
| k_ERemotePlayKeyModifierRightShift | 0x0002 | 右Shiftが有効です。 |
| k_ERemotePlayKeyModifierLeftControl | 0x0040 | 左Ctrlが有効です。 |
| k_ERemotePlayKeyModifierRightControl | 0x0080 | 右Ctrlが有効です。 |
| k_ERemotePlayKeyModifierLeftAlt | 0x0100 | 左Altが有効です。 |
| k_ERemotePlayKeyModifierRightAlt | 0x0200 | 右Altが有効です。 |
| k_ERemotePlayKeyModifierLeftGUI | 0x0400 | 左GUIが有効です。 |
| k_ERemotePlayKeyModifierRightGUI | 0x0800 | 右GUIが有効です。 |
| k_ERemotePlayKeyModifierNumLock | 0x1000 | NumLockが有効です。 |
| k_ERemotePlayKeyModifierCapsLock | 0x2000 | CapsLockが有効です。 |
| k_ERemotePlayKeyModifierMask | 0xFFFF | すべての修飾子のマスク。 |
Typedef
これらはISteamRemotePlayで使用するために定義されたtypedefsです。
| 名前 | ベース型 | 説明 |
| RemotePlaySessionID_t | uint32 | Steam Remote PlayのセッションID。 |
| RemotePlayCursorID_t | uint32 | Steam Remote PlayのマウスカーソルID。 |