Funktionen, die Informationen zu Steam-Remote-Play-Sitzungen sowie zum Streamen Ihrer Spielinhalte auf einen anderen Computer oder einer Steam Link-App oder Hardware bereitstellen.
Weitere Informationen finden Sie hier:
Steam Remote Play.
Memberfunktionen
Memberfunktionen für
ISteamRemotePlay werden über die globale Accessorfunktion
SteamRemotePlay() aufgerufen.
GetSessionCount
uint32 GetSessionCount();
Ruft die Anzahl der aktuell verbundenen Steam-Remote-Play-Sitzungen ab.
Rückgabe: uint32Die Anzahl der aktuell verbundenen Steam-Remote-Play-Sitzungen.
Beispiel: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
uint32 GetSessionID( int iSessionIndex );
| Name | Typ | Beschreibung |
|---|
| iSessionIndex | int | Der Index der angegebenen Sitzung. |
Ruft die aktuell verbundenen Sitzungs-ID für Steam Remote Play beim angegebenen Index ab.
Rückgabe: uint32
Die Sitzungs-ID der Sitzung beim angegebenen Index oder „0“, wenn der Index > 0 oder ≥ bzw. =
GetSessionCount() ist.
GetSessionSteamID
const char *GetSessionClientName( uint32 unSessionID );
| Name | Typ | Beschreibung |
|---|
| unSessionID | uint32 | Die Sitzungs-ID, zu der Informationen abgerufen werden sollen. |
Ruft die Steam-ID des verbundenen Benutzers ab.
Rückgabe: uint32Die Steam-ID des mit der Steam-Remote-Play-Sitzung verbundenen Benutzers. Normalerweise handelt es sich hier um den angemeldeten Benutzer oder, im Fall von Remote Play Together, einen Freund.
GetSessionClientName
ESteamDeviceFormFactor GetSessionClientFormFactor( uint32 unSessionID );
| Name | Typ | Beschreibung |
|---|
| unSessionID | uint32 | Die Sitzungs-ID, zu der Informationen abgerufen werden sollen. |
Ruft den Namen des Client-Geräts der Sitzung ab.
Rückgabe: const char *
Der Name des mit der Steam-Remote-Play-Sitzung verbundenen Geräts oder NULL, wenn die Sitzungs-ID ungültig ist.
GetSessionClientFormFactor
bool BGetSessionClientResolution( uint32 unSessionID, int *pnResolutionX, int *pnResolutionY );
| Name | Typ | Beschreibung |
|---|
| unSessionID | uint32 | Die Sitzungs-ID, zu der Informationen abgerufen werden sollen. |
Ruft den Formfaktor des Client-Geräts der Sitzung ab.
Rückgabe: ESteamDeviceFormFactorDer Formfaktor mit der Steam-Remote-Play-Sitzung verbundenen Geräts oder
k_ESteamDeviceFormFactorUnknown, wenn die Sitzungs-ID ungültig ist.
Beispiel: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( uint32 unSessionID, int *pnResolutionX, int *pnResolutionY );
| Name | Typ | Beschreibung |
|---|
| unSessionID | uint32 | Die Sitzungs-ID, zu der Informationen abgerufen werden sollen. |
| pnResolutionX | int | Ein Zeiger zu einer Variable, die mit der Breite der Anzeigenauflösung ausgefüllt werden soll. |
| pnResolutionY | int | Ein Zeiger zu einer Variable, die mit der Höhe der Anzeigenauflösung ausgefüllt werden soll. |
Ruft die Auflösung des Client-Geräts der Sitzung in Pixeln ab. Wenn die Auflösung nicht verfügbar ist, wird dies auf 0 × 0 gesetzt.
Rückgabe: bool
true, wenn die Sitzungs-ID gültig ist, andernfalls
false.
Beispiel:// Dies kann „false“ zurückgeben, wenn das Remotegerät keine Gerätauflösungsinformation bereitstellt.
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 );
}
BSendRemotePlayTogetherInvite
bool BSendRemotePlayTogetherInvite( CSteamID steamIDFriend );
| Name | Typ | Beschreibung |
|---|
| m_unSessionID | uint32 | Die Steam-ID des einzuladenden Freunds. |
Lädt einen Freund dazu ein, dem Spiel über Remote Play Together beizutreten.
Rückgabe: bool
true, wenn die Einladung erfolgreich gesendet wurde, andernfalls
false.
Rückrufe
Dies sind Rückrufe, die durch Aufrufen von
SteamAPI_RunCallbacks ausgelöst werden können.
SteamRemotePlaySessionDisconnected_t
| Name | Typ | Beschreibung |
|---|
| m_unSessionID | uint32 | Die Sitzungs-ID der Sitzung, die sich gerade verbunden hat. |
SteamRemotePlaySessionDisconnected_t
| Name | Wert | Beschreibung |
|---|
| m_unSessionID | uint32 | Die Sitzungs-ID der Sitzung, die sich gerade getrennt hat. |
Enums
Dies sind Aufzählungstypen, die zur Verwendung mit ISteamRemotePlay definiert sind.
ESteamDeviceFormFactor
Der Formfaktor eines Geräts.
| Name | Wert | Beschreibung |
|---|
| k_ESteamDeviceFormFactorUnknown | 0 | Der Formfaktor des Geräts ist nicht verfügbar. |
| k_ESteamDeviceFormFactorPhone | 1 | Das Gerät ist ein Smartphone oder kleines Mobilgerät mit Touchscreen. |
| k_ESteamDeviceFormFactorTablet | 2 | Das Gerät ist ein Tablet oder ein anderes großes Mobilgerät mit Touchscreen. |
| k_ESteamDeviceFormFactorComputer | 3 | Das Gerät ist ein Desktop-Computer oder Laptop. |
| k_ESteamDeviceFormFactorTV | 4 | Das Gerät ist ein Fernseher. |
