Commands
| Command | Description |
|---|---|
| listconfigs | Lists the streaming base configurations supported by the console. |
| startlistening | Starts listening for direct connect streaming connections on the console. |
| stoplistening | Stops listening for direct connect streaming connections on the console. |
| status | Queries the streaming status of the console. |
| enableremoteconnect | Enable remote connect for the specified user. This setting persists across device reboot. |
| disableremoteconnect | Disables remote connect for the specified user. This setting persists across device reboot. |
| remoteconnectstatus | Queries the remote connect status for the specified user. |
| setconfigoverride | Sets one or more setting override of the base stream configuration. The base stream configuration for direct connect is specified by the ‘config’ parameter of the ‘startlistening’ command. The base stream configuration for remote connect is determined by XBOX services. Setting overrides are applied on ‘startlistening’ for direct connect and on new stream connections for remote connect. Overrides do not persist between reboots and need to be reset after reboot if desired. |
| clearconfigoverride | Clears one or more setting override(s) that were set with the ‘setconfigoverride’ command. |
| dumpconfigoverride | Writes all setting overrides that have been set from the ‘setconfigoverride’ command to the console. |
| /LC | Specify the locale code. Used to overide the default locale code |
Global flags
The flags in the following table apply to all commands.| Column 1 |
|---|
| xbgamestream [/X[:address] [+accesskey] ] |
| Flag | Description |
|---|---|
| /X[:address] [+accesskey] | - Use this option to specify the host name or address (shown as Tools IP on the console) of a targeted console without changing the default console. For details about setting a host name for a console, see Setting a host name for the console IP address. - If you don’t use this option, the default console (previously set by Connect (xbconnect.exe)) is used. - Use the accesskey string to provide console access only to those people who have the access key. - Set the access key by using the command xbconfig accesskey=your-key, and then restart your console to make the access key effective. - To access a console that’s configured with an access key, include a plus sign (+) and the access key after the IP address or host name of the console. - If an access key is provided when the default console is set by xbconnect, the access key is stored as part of the default console’s address. - For more information about access keys, see xbconfig accesskey. - If you append /title to /X, after the address or by itself, the partition mapping that’s seen by a running exclusive app is used. For example, specifying /X/title xd: would provide access to the default console’s scratch-drive partition that’s visible to the running exclusive apps. |
Command details
startlistening
For best compatibility, it recommended to not set
version or config| Parameter | Description |
|---|---|
| version | Optional parameter that specifies the protocol version to use. Defaults to the latest protocol version that’s supported by the console. |
| config | Optional parameter to specify the stream configuration to use. The default is the highest bitrate configuration that’s supported by the targeted Development Kit. |
status
| Flag | Description |
|---|---|
| /B | Specifies bare format. When enabled, the status command only prints a bare output. Bare mode must be used with at least one other flag, indicating which of the status data you want to retrieve (for example, /S). |
| /S | Specifies streaming status only. When enabled, the status command only prints the streaming status of the console. |
enableremoteconnect
| Parameter | Description |
|---|---|
| accountEmail | Specifies the email account for which remote connect should be enabled. Please note that this account must be currently signed in on the XBOX to enable remote connect and should be used when logging into the streaming client. |
disableremoteconnect
| Parameter | Description |
|---|---|
| accountEmail | Specifies the email account for which remote connect should be disabled. Please note that this should be an account that was previously signed in with. |
remoteconnectstatus
| Parameter | Description |
|---|---|
| accountEmail | Specifies the email account for which the remote connect status should be retrieved. |
setconfigoverride
| Parameter | Description |
|---|---|
| allowDirectCapture | Optional boolean that enables or disables direct capture. Default value: true. |
| maxBitrate | Optional parameter that overrides the maximum bitrate of the stream. Example value: 12000000. |
| minBitrate | Optional parameter that overrides the minimum bitrate of the stream. Example value: 6000000. |
| maxResolution | Optional parameter that overrides the suggested maximum resolution of the video stream. Example values: 720p, 1080p. |
| minResolution | Optional parameter that overrides the suggested minimum resolution of the video stream. Example values: 720p, 1080p. |
clearconfigoverride
| Parameter | Description |
|---|---|
| allowDirectCapture | Optional parameter to clear the direct capture override. |
| maxBitrate | Optional parameter to clear the maximum bitrate override. |
| minBitrate | Optional parameter to clear the minimum bitrate override. |
| maxResolution | Optional parameter to clear the maximum resolution override. |
| minResolution | Optional parameter to clear the minimum resolution override. |
| Flag | Description |
|---|---|
| /A | Clears all overrides. |
Examples
The following examples show a few of the ways to use xbgamestream.
C:\Working Directory> xbgamestream status
Game Streaming Server Status:
Not Listening
C:\Working Directory> xbgamestream listconfigs
default : xxxx Default
5.5mbps : Max 1280 x 720 @5.5Mbps
12mbps : Max 1920 x 1080 @12Mbps
C:\Working Directory> xbgamestream startlistening
Listening started
C:\Working Directory> xbgamestream stoplistening
Listening stopped
C:\Working Directory> xbgamestream startlistening /X:255.255.255.255
Listening started
C:\Working Directory> xbgamestream status /X:255.255.255.255
Game Streaming Server Status:
Listening
- Protocol Version: ANY
- Stream Configuration: default
C:\Working Directory> xbgamestream status /B /S /X:255.255.255.255
Listening
C:\Working Directory> xbgamestream enableremoteconnect accountEmail=xxxx@y.com
Remote connect enabled for account xxxx@y.com
C:\Working Directory> xbgamestream disableremoteconnect accountEmail=xxxx@y.com
Remote connect disabled for account xxxx@y.com
C:\Working Directory> xbgamestream remoteconnectstatus accountEmail=xxxx@y.com
Remote connect status for account xxxx@y.com: enabled
C:\Working Directory> xbgamestream setconfigoverride maxBitrate=12000000 minBitrate=6000000
Stream config override(s) set
C:\Working Directory> xbgamestream setconfigoverride minResolution=1080p
Stream config override(s) set
C:\Working Directory> xbgamestream clearconfigoverride maxBitrate minBitrate
Stream config override(s) cleared
C:\Working Directory> xbgamestream clearconfigoverride /A
Stream config override(s) cleared
C:\Working Directory> xbgamestream dumpconfigoverride
maxBitrate : 12000000
minBitrate : 6000000
minResolution : 1080p