InterfaceUpdateToClient

Type: object

root msg

root msg anyOf CurrentRoundUpdate

CurrentRoundUpdate

Type: object

root msg anyOf CurrentRoundUpdate type
Type: enum (of string)

Must be one of:

  • "CurrentRoundUpdate"

root msg anyOf CurrentRoundUpdate round_state

TcsAPI

Type: object

root msg anyOf CurrentRoundUpdate round_state state

RoundState

Type: enum (of string)

This describes the current game phase.
Note: It doesn't always move forward. Sometimes the system will correct itself
due to cards being occluded or intentionally moved.

When the round is over we go to DEALER_DONE.
In some situations we cannot determine if the round is over without more context
so we go to DEALER_MAYBE_DONE. For example: All players have busted,
but the dealer has to finish playing the hand anyways because of a side bet.

At the end we will go into ROUND_OVER if the round is supposed to be stored, and into
ROUND_CANCELED if we classify it as sensor noise.
This state will only be reached once, you should not miss this event.
We use this to mark what rounds we store in the database or show on the screen.
Even rounds with wrong dealer procedure will reach ROUND_OVER, they are marked
as such in the anomalies / diagnostics fields.

Must be one of:

  • "DEALER_DONE"
  • "DEALER_MAYBE_DONE"
  • "DEALER_ONE_CARD"
  • "DEALER_TWO_CARDS"
  • "EMPTY"
  • "FAILED"
  • "ROUND_CANCELED"
  • "ROUND_OVER"
  • "STARTED"

root msg anyOf CurrentRoundUpdate round_state players
Type: array

The length of this list is fixed and determined with the calibration procedure.

 No Additional Items

Each item of this array must be:

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI

PlayerAPI

Type: object

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks
Type: array

Players consist of 0 or more stacks. If the player has 0 stacks, it is inactive. If the player has >1 stack, then the player has split its cards.

 No Additional Items

Each item of this array must be:

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI

StackAPI

Type: object

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI cards
Type: array

The cards might be removed as the system handles movement and occlusions.

 No Additional Items

Each item of this array must be:

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI cards CardAPI

CardAPI

Type: object

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI cards CardAPI label

Label52

Type: object

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI cards CardAPI label card

Value

Type: enum (of string)

Must be one of:

  • "10"
  • "2"
  • "3"
  • "4"
  • "5"
  • "6"
  • "7"
  • "8"
  • "9"
  • "A"
  • "J"
  • "K"
  • "Q"

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI cards CardAPI label suit

Suit

Type: enum (of string)

Must be one of:

  • "C"
  • "D"
  • "H"
  • "S"

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI cards CardAPI center
Type: array

Must contain a minimum of 2 items

Must contain a maximum of 2 items

No Additional Items

Tuple Validation

Item at 1 must be:
root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI cards CardAPI center center item 0
Type: number
Item at 2 must be:
root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI cards CardAPI center center item 1
Type: number

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI stacks StackAPI is_doubled
Type: boolean

Whether the stack was doubled.

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI chip_stacks

All chip stacks associated with this player.

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI chip_stacks anyOf item 0
Type: array
No Additional Items

Each item of this array must be:

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI chip_stacks anyOf item 0 ChipStackAPI

ChipStackAPI

Type: object

root msg anyOf CurrentRoundUpdate round_state players PlayerAPI chip_stacks anyOf item 0 ChipStackAPI center
Type: array

Must contain a minimum of 2 items

Must contain a maximum of 2 items

No Additional Items

Tuple Validation

Item at 1 must be:
root msg anyOf CurrentRoundUpdate round_state players PlayerAPI chip_stacks anyOf item 0 ChipStackAPI center center item 0
Type: number
Item at 2 must be:
root msg anyOf CurrentRoundUpdate round_state players PlayerAPI chip_stacks anyOf item 0 ChipStackAPI center center item 1
Type: number
root msg anyOf CurrentRoundUpdate round_state players PlayerAPI chip_stacks anyOf item 1
Type: null

root msg anyOf CurrentRoundUpdate round_state dealer

DealerAPI

Type: object

Contains the info about the dealer (mainly cards). Note: We don't guarantee that we won't take cards out of here. You should treat this as our current best guess for what cards are actually on the table, while handling occlusions, lighting changes, etc. The final value for the dealer cards is given when the phase is ROUND_OVER.

root msg anyOf CurrentRoundUpdate round_state lifetime
Type: integer

The number of frames since this round was started.

root msg anyOf CurrentRoundUpdate round_state anomalies
Type: array of string

Used to communicate issues with this round. This is unstable in this form and undocumented. In the future we can expose a structured stable API here. We use it to identify: errors in the dealer procedure, issues with our system for debugging.

 No Additional Items

Each item of this array must be:

root msg anyOf CurrentRoundUpdate round_state anomalies anomalies items
Type: string

root msg anyOf CurrentRoundUpdate round_state initialized_ts
Type: string

The timestamp when this round was initialized. It also includes the number of frames passed since round begin.

root msg anyOf CurrentRoundUpdate round_state started_ts

The timestamp when a first card was assigned to the round. This is later than the initialization timestamp, because a round can be initialized by chip stack detections.

root msg anyOf CurrentRoundUpdate round_state phase_timestamps
Type: array of array
No Additional Items

Each item of this array must be:

root msg anyOf CurrentRoundUpdate round_state phase_timestamps phase_timestamps items
Type: array

Must contain a minimum of 2 items

Must contain a maximum of 2 items

No Additional Items

Tuple Validation

Item at 1 must be:
root msg anyOf CurrentRoundUpdate round_state phase_timestamps phase_timestamps items RoundState

RoundState

Type: enum (of string)

This describes the current game phase.
Note: It doesn't always move forward. Sometimes the system will correct itself
due to cards being occluded or intentionally moved.

When the round is over we go to DEALER_DONE.
In some situations we cannot determine if the round is over without more context
so we go to DEALER_MAYBE_DONE. For example: All players have busted,
but the dealer has to finish playing the hand anyways because of a side bet.

At the end we will go into ROUND_OVER if the round is supposed to be stored, and into
ROUND_CANCELED if we classify it as sensor noise.
This state will only be reached once, you should not miss this event.
We use this to mark what rounds we store in the database or show on the screen.
Even rounds with wrong dealer procedure will reach ROUND_OVER, they are marked
as such in the anomalies / diagnostics fields.

Same definition as state
Item at 2 must be:
root msg anyOf CurrentRoundUpdate round_state phase_timestamps phase_timestamps items phase_timestamps items item 1
Type: string

root msg anyOf CurrentRoundUpdate round_state id
Type: stringFormat: uuid Default: "00000000-0000-0000-0000-000000000000"

UUID v4. It is generated each new round. A round starts as soon as anything relevant is detected. Currently 'anything relevant' means cards, chips or cash. The latter two are only considered if these models are deployed and configured. Not every UUID should be treated as a full round — it might be canceled and never reach ROUNDOVER but only ROUNDCANCELED. Example: a chip stack is recognized and then disappears.

root msg anyOf CurrentRoundUpdate licensing_info

LicensingInfo

Type: object

root msg anyOf CurrentRoundUpdate licensing_info license_type
Type: enum (of string)

Must be one of:

  • "Development"
  • "Internal"
  • "Paid"
  • "Trial"

root msg anyOf CurrentRoundUpdate licensing_info errors
Type: array of string
No Additional Items

Each item of this array must be:

root msg anyOf CurrentRoundUpdate licensing_info errors errors items
Type: string
root msg anyOf RoundHistory

RoundHistory

Type: object

root msg anyOf RoundHistory type
Type: enum (of string)

Must be one of:

  • "RoundHistory"

root msg anyOf RoundHistory rounds
Type: array
No Additional Items

Each item of this array must be:

root msg anyOf RoundHistory rounds TcsAPI

TcsAPI

Type: object
Same definition as round_state
root msg anyOf SideBetUpdate

SideBetUpdate

Type: object

Side bet payout results for all players in the current round.
Sent whenever the results change. Will be sent multiple times per round as more cards are revealed.

root msg anyOf SideBetUpdate type
Type: enum (of string)

Must be one of:

  • "SideBetUpdate"

root msg anyOf SideBetUpdate round_id
Type: stringFormat: uuid

The UUID of the round these results belong to.

root msg anyOf SideBetUpdate player_results
Type: array

One entry per player.

 No Additional Items

Each item of this array must be:

root msg anyOf SideBetUpdate player_results PlayerSideBetResultsAPI

PlayerSideBetResultsAPI

Type: object

root msg anyOf SideBetUpdate player_results PlayerSideBetResultsAPI player_index
Type: integer

0-based index of the player, matching the players array in TcsAPI.

root msg anyOf SideBetUpdate player_results PlayerSideBetResultsAPI side_bet_results
Type: array

One entry per configured side bet for this player.

 No Additional Items

Each item of this array must be:

root msg anyOf SideBetUpdate player_results PlayerSideBetResultsAPI side_bet_results SideBetResultAPI

SideBetResultAPI

Type: object

root msg anyOf SideBetUpdate player_results PlayerSideBetResultsAPI side_bet_results SideBetResultAPI side_bet_name

SupportedPlayerSideBet

Type: enum (of string)

The name of the side bet (e.g. '21+3', 'PerfectPairs').

Must be one of:

  • "21+3"
  • "BlackJackPot"
  • "Blackjack Xtra"
  • "Blazing Seven"
  • "Crazy Twins"
  • "Get The Picture"
  • "Kings Bounty"
  • "Perfect Pairs"
  • "Progressive"
  • "Progressive Swisscasinos"
  • "Pure Pairs"
  • "Sweet 16"

root msg anyOf SideBetUpdate player_results PlayerSideBetResultsAPI side_bet_results SideBetResultAPI is_played
Type: boolean

True if the player placed a bet on this side bet this round.

root msg anyOf SideBetUpdate player_results PlayerSideBetResultsAPI side_bet_results SideBetResultAPI result

The payout result for this side bet. NotYetDetermined if the round has not progressed far enough to calculate the result. PayoutTableUnknown if no payout table is configured for this side bet.

root msg anyOf SideBetUpdate player_results PlayerSideBetResultsAPI side_bet_results SideBetResultAPI result anyOf SideBetDetermined

SideBetDetermined

Type: object

The side bet outcome has been fully evaluated.

outcome is a string label for the winning hand category (e.g. "STRAIGHT_FLUSH",
"PERFECT_PAIRS") or "LOSS" when the player loses. It is a plain string rather than
an enumeration so that operator-configured side bets with arbitrary hand categories can be
supported in the future without changing this type.

payout encodes the multiplier applied to the player's stake:
- -1.0 — loss (stake forfeited)
- A positive float — win multiplier (e.g. 3.0 means 3 : 1)
- "MAJOR" / "MINOR" — jackpot tier whose exact value is resolved by the casino's
progressive payout system rather than a fixed multiplier.

root msg anyOf SideBetUpdate player_results PlayerSideBetResultsAPI side_bet_results SideBetResultAPI result anyOf NotYetDetermined

NotYetDetermined

Type: object

root msg anyOf SideBetUpdate player_results PlayerSideBetResultsAPI side_bet_results SideBetResultAPI result anyOf PayoutTableUnknown

PayoutTableUnknown

Type: object

root type
Type: string Default: "InterfaceUpdate"