Smartglass Enumerations

Smartglass enumerations

class xbox.sg.enum.PacketType(value)

Bases: enum.Enum

Packet Types of core protocol: Connect*, Discovery*, PowerOnRequest -> SimpleMessage Message -> Message

ConnectRequest = 52224
ConnectResponse = 52225
DiscoveryRequest = 56576
DiscoveryResponse = 56577
PowerOnRequest = 56578
Message = 53261
class xbox.sg.enum.ClientType(value)

Bases: enum.Enum

Client Type

Used in DiscoveryRequest, DiscoveryResponse and LocalJoin-Message.

XboxOne = 1
Xbox360 = 2
WindowsDesktop = 3
WindowsStore = 4
WindowsPhone = 5
iPhone = 6
iPad = 7
Android = 8
class xbox.sg.enum.DeviceCapabilities(value)

Bases: enum.Flag

Bitmask for client device hardware capabilities

Non = 0
Streaming = 1
Audio = 2
Accelerometer = 4
Compass = 8
Gyrometer = 16
Inclinometer = 32
Orientation = 64
All = 18446744073709551615
class xbox.sg.enum.ConnectionResult(value)

Bases: enum.Enum

Connection Result

Used in result-field of ConnectResponse packet.

Success = 0
Pending = 1
FailureUnknown = 2
FailureAnonymousConnectionsDisabled = 3
FailureDeviceLimitExceeded = 4
FailureSmartGlassDisabled = 5
FailureUserAuthFailed = 6
FailureUserSignInFailed = 7
FailureUserSignInTimeOut = 8
FailureUserSignInRequired = 9
class xbox.sg.enum.PublicKeyType(value)

Bases: enum.Enum

Public Key Type

Used in ConnectRequest packet.

EC_DH_P256 = 0
EC_DH_P384 = 1
EC_DH_P521 = 2
Default = 65535
class xbox.sg.enum.AckStatus(value)

Bases: enum.Enum

Acknowledgement Status

Internally used to signalize the waiting caller the status of acknowledgement.

Pending = 0
Processed = 1
Rejected = 2
class xbox.sg.enum.ConnectionState(value)

Bases: enum.Enum

Connection State

Internally used by Console

Disconnected = 0
Connecting = 1
Connected = 2
Error = 3
Disconnecting = 4
Reconnecting = 5
class xbox.sg.enum.DeviceStatus(value)

Bases: enum.Enum

Device Status

Internally used by Console

DiscoveringAvailability = 1
Available = 2
Unavailable = 3
class xbox.sg.enum.PrimaryDeviceFlag(value)

Bases: enum.Flag

Primary Device Flag

Used in flags of DiscoveryResponse packet.

Null = 0
AllowConsoleUsers = 1
AllowAuthenticatedUsers = 2
AllowAnonymousUsers = 4
CertificatePending = 8
class xbox.sg.enum.DisconnectReason(value)

Bases: enum.Enum

Disconnect Reason

Used in reason-field of Disconnect-Message.

Unspecified = 0
Error = 1
PowerOff = 2
Maintenance = 3
AppClose = 4
SignOut = 5
Reboot = 6
Disabled = 7
LowPower = 8
class xbox.sg.enum.PairedIdentityState(value)

Bases: enum.Enum

Paired Identity State

Used in ConnectResponse and PairedIdentityStateChanged-Message.

NotPaired = 0
Paired = 1
class xbox.sg.enum.ServiceChannel(value)

Bases: enum.Enum

Service Channels

Used internally to identify actual Channel Ids.

Core = 0
SystemInput = 1
SystemInputTVRemote = 2
SystemMedia = 3
SystemText = 4
SystemBroadcast = 5
Ack = 6
Title = 7
class xbox.sg.enum.MessageType(value)

Bases: enum.Enum

Message Type

Used in Message-Header.

Null = 0
Ack = 1
Group = 2
LocalJoin = 3
StopActivity = 5
AuxilaryStream = 25
ActiveSurfaceChange = 26
Navigate = 27
Json = 28
Tunnel = 29
ConsoleStatus = 30
TitleTextConfiguration = 31
TitleTextInput = 32
TitleTextSelection = 33
MirroringRequest = 34
TitleLaunch = 35
StartChannelRequest = 38
StartChannelResponse = 39
StopChannel = 40
System = 41
Disconnect = 42
TitleTouch = 46
Accelerometer = 47
Gyrometer = 48
Inclinometer = 49
Compass = 50
Orientation = 51
PairedIdentityStateChanged = 54
Unsnap = 55
GameDvrRecord = 56
PowerOff = 57
MediaControllerRemoved = 3840
MediaCommand = 3841
MediaCommandResult = 3842
MediaState = 3843
Gamepad = 3850
SystemTextConfiguration = 3883
SystemTextInput = 3884
SystemTouch = 3886
SystemTextAck = 3892
SystemTextDone = 3893
class xbox.sg.enum.ActiveTitleLocation(value)

Bases: enum.Enum

Active Title Location

Full = 0
Fill = 1
Snapped = 2
StartView = 3
SystemUI = 4
Default = 5
class xbox.sg.enum.ActiveSurfaceType(value)

Bases: enum.Enum

Active Surface Type

Used in ActiveSurfaceType-Message.

Blank = 0
Direct = 1
HTML = 2
TitleTextEntry = 3
class xbox.sg.enum.MediaType(value)

Bases: enum.Enum

Media Type

Used in MediaState-Message.

NoMedia = 0
Music = 1
Video = 2
Image = 3
Conversation = 4
Game = 5
class xbox.sg.enum.MediaTransportState(value)

Bases: enum.Enum

Media Transport State

Used in MediaState-Message.

Invalid = 0
Stopped = 1
Starting = 2
Playing = 3
Paused = 4
Buffering = 5
class xbox.sg.enum.MediaPlaybackStatus(value)

Bases: enum.Enum

Media Playback Status

Used in MediaState-Message.

Closed = 0
Changing = 1
Stopped = 2
Playing = 3
Paused = 4
class xbox.sg.enum.MediaControlCommand(value)

Bases: enum.Flag

Media Control Command

Used in MediaCommand-Message.

Null = 0
Play = 2
Pause = 4
PlayPauseToggle = 8
Stop = 16
Record = 32
NextTrack = 64
PreviousTrack = 128
FastForward = 256
Rewind = 512
ChannelUp = 1024
ChannelDown = 2048
Back = 4096
View = 8192
Menu = 16384
Seek = 32768
class xbox.sg.enum.SoundLevel(value)

Bases: enum.Enum

Sound Level

Used in MediaState-Message.

Muted = 0
Low = 1
Full = 2
class xbox.sg.enum.GamePadButton(value)

Bases: enum.Enum

Gamepad Button

Used in Gamepad-Message.

Clear = 0
Enroll = 1
Nexu = 2
Menu = 4
View = 8
PadA = 16
PadB = 32
PadX = 64
PadY = 128
DPadUp = 256
DPadDown = 512
DPadLeft = 1024
DPadRight = 2048
LeftShoulder = 4096
RightShoulder = 8192
LeftThumbStick = 16384
RightThumbStick = 32768
class xbox.sg.enum.TouchAction(value)

Bases: enum.Enum

Touch Action

Used in SystemTouch/TitleTouch-Message.

Null = 0
Down = 1
Move = 2
Up = 3
Cancel = 4
class xbox.sg.enum.TextInputScope(value)

Bases: enum.Enum

Text Input Scope

Used in TextConfiguration-Message

Default = 0
Url = 1
FullFilePath = 2
FileName = 3
EmailUserName = 4
EmailSmtpAddress = 5
LogOnName = 6
PersonalFullName = 7
PersonalNamePrefix = 8
PersonalGivenName = 9
PersonalMiddleName = 10
PersonalSurname = 11
PersonalNameSuffix = 12
PostalAddress = 13
PostalCode = 14
AddressStreet = 15
AddressStateOrProvince = 16
AddressCity = 17
AddressCountryName = 18
AddressCountryShortName = 19
CurrencyAmountAndSymbol = 20
CurrencyAmount = 21
Date = 22
DateMonth = 23
DateDay = 24
DateYear = 25
DateMonthName = 26
DateDayName = 27
Digits = 28
Number = 29
OneChar = 30
Password = 31
TelephoneNumber = 32
TelephoneCountryCode = 33
TelephoneAreaCode = 34
TelephoneLocalNumber = 35
Time = 36
TimeHour = 37
TimeMinorSec = 38
NumberFullWidth = 39
AlphanumericHalfWidth = 40
AlphanumericFullWidth = 41
CurrencyChinese = 42
Bopomofo = 43
Hiragana = 44
KatakanaHalfWidth = 45
KatakanaFullWidth = 46
Hanja = 47
HangulHalfWidth = 48
HangulFullWidth = 49
Search = 50
SearchTitleText = 51
SearchIncremental = 52
ChineseHalfWidth = 53
ChineseFullWidth = 54
NativeScript = 55
Unknown = 57
class xbox.sg.enum.TextAction(value)

Bases: enum.Enum

Text Action

Cancel = 0
Accept = 1
class xbox.sg.enum.TextOption(value)

Bases: enum.Flag

Text Option

Default = 0
AcceptsReturn = 1
Password = 2
MultiLine = 4
SpellCheckEnabled = 8
PredictionEnabled = 16
RTL = 32
Dismiss = 16384
class xbox.sg.enum.TextResult(value)

Bases: enum.Enum

Text Result

Cancel = 0
Accept = 1
Null = 65535
class xbox.sg.enum.HashAlgorithm(value)

Bases: enum.Enum

Hash Algorithm

Unused

SHA256 = 0
SHA384 = 1
SHA512 = 2
class xbox.sg.enum.AsymmetricAlgorithm(value)

Bases: enum.Enum

Asymmetric Algorithm

Unused

RSA_PKCS1_1024 = 0
RSA_OAEP_1024 = 1
RSA_PKCS1_2048 = 2
RSA_OAEP_2048 = 3
EC_DSA_P256 = 4
EC_DSA_P384 = 5
EC_DSA_P521 = 6
EC_DH_P256 = 7
EC_DH_P384 = 8
EC_DH_P521 = 9
class xbox.sg.enum.SymmetricAlgorithm(value)

Bases: enum.Enum

Symmetric Algorithm

Unused

AES_CBC_128 = 0
AES_CBC_192 = 1
AES_CBC_256 = 2
class xbox.sg.enum.AuthError(value)

Bases: enum.Enum

Authentication Error

Unused

Null = 0
DevModeNotAuthorized = 2
SystemUpdateRequired = 3
ContentUpdateRequired = 4
EnforcementBan = 5
ThirdPartyBan = 6
ParentalControlsBan = 7
SubscriptionNotActivated = 8
BillingMaintenanceRequired = 9
AccountNotCreated = 10
NewTermsOfUse = 11
CountryNotAuthorized = 12
AgeVerificationRequired = 13
Curfew = 14
ChildAccountNotInFamily = 15
CSVTransitionRequired = 16
AccountMaintenanceRequired = 17
AccountTypeNotAllowed = 18
ContentIsolation = 19
GamertagMustChange = 20
DeviceChallengeRequired = 21
SignInCountExceeded = 22
RetailAccountNotAllowed = 23
SandboxNotAllowed = 24
UnknownUser = 25
RetailContentNotAuthorized = 26
ContentNotAuthorized = 27
ExpiredDeviceToken = 28
ExpiredTitleToken = 29
ExpiredUserToken = 30
InvalidDeviceToken = 31
InvalidTitleToken = 32
InvalidUserToken = 33
InvalidRefreshToken = 34
class xbox.sg.enum.TokensResetReason(value)

Bases: enum.Enum

Tokens Reset Reason

Unused

AuthTicketError = 0
AuthTicketChanged = 1
EnvironmentChanged = 2
SandboxIDChanged = 3
class xbox.sg.enum.HttpRequestMethod(value)

Bases: enum.Enum

HTTP Request Method

Unused

GET = 0
POST = 1
class xbox.sg.enum.EnvironmentType(value)

Bases: enum.Enum

Environment Type

Unused

Production = 0
DNet = 1
Mock = 2
Null = 3
class xbox.sg.enum.MetricsOrigin(value)

Bases: enum.Enum

Metrics Origin

Unused

Core = 1
SDK = 2
Canvas = 3
App = 4
class xbox.sg.enum.SGResultCode(value)

Bases: enum.Enum

Smartglass Result Code

Unused

SG_E_SUCCESS = 0
SG_E_ABORT = 2147483652
SG_E_ACCESS_DENIED = 2147483653
SG_E_FAIL = 2147483654
SG_E_HANDLE = 2147483655
SG_E_INVALID_ARG = 2147483656
SG_E_NO_INTERFACE = 2147483657
SG_E_NOT_IMPL = 2147483658
SG_E_OUT_OF_MEMORY = 2147483659
SG_E_POINTER = 2147483660
SG_E_UNEXPECTED = 2147483661
SG_E_PENDING = 2147483662
SG_E_INVALID_DATA = 2147483663
SG_E_CANCELED = 2147483664
SG_E_INVALID_STATE = 2147483665
SG_E_NOT_FOUND = 2147483666
SG_E_NO_MORE_CAPACITY = 2147483667
SG_E_FAILED_TO_START_THREAD = 2147483668
SG_E_MESSAGE_EXPIRED = 2147483669
SG_E_TIMED_OUT = 2147483670
SG_E_NOT_INITIALIZED = 2147483671
SG_E_JSON_LENGTH_EXCEEDED = 2147483672
SG_E_MESSAGE_LENGTH_EXCEEDED = 2147483673
SG_E_INVALID_CONFIGURATION = 2147483674
SG_E_EXPIRED_CONFIGURATION = 2147483675
SG_E_AUTH_REQUIRED = 2147483677
SG_E_TIMED_OUT_PRESENCE = 2147483678
SG_E_TIMED_OUT_CONNECT = 2147483679
SG_E_SOCKET_ERROR = 2147549185
SG_E_HTTP_ERROR = 2147614721
SG_E_CANCEL_SHUTDOWN = 2147614722
SG_E_HTTP_STATUS = 2147614723
SG_E_UNEXPECTED_CRYPTO_ERROR = 2147680257
SG_E_INVALID_CRYPT_ARG = 2147680258
SG_E_CRYPTO_INVALID_SIGNATURE = 2147680259
SG_E_INVALID_CERTIFICATE = 2147680260
SG_E_CHANNEL_REQUEST_UNKNOWN_ERROR = 2147746053
SG_E_FAILED_TO_JOIN = 2147876865
SG_E_ALREADY_CONNECTED = 2147876866
SG_E_NOT_CONNECTED = 2147876867
SG_E_CONSOLE_NOT_RESPONDING = 2147876868
SG_E_CONSOLE_DISCONNECTING = 2147876869
SG_E_BIG_ENDIAN_STREAM_STRING_NOT_TERMINATED = 2147942401
SG_E_CHANNEL_ALREADY_STARTED = 2148007937
SG_E_CHANNEL_FAILED_TO_START = 2148007938
SG_E_MAXIMUM_CHANNELS_STARTED = 2148007939
SG_E_JNI_CLASS_NOT_FOUND = 2148073473
SG_E_JNI_METHOD_NOT_FOUND = 2148073474
SG_E_JNI_RUNTIME_ERROR = 2148073475