Skip to main content

ClientVideoPacketInput

Input for sending one webcam video FRAGMENT to the UDP game server, fanned out to nearby players as a ClientVideoNotification. A datagram carries at most ~1117 bytes of videoData, so an encoded frame is split by the SDK into fragments that each start with the 6-byte video fragment header (version, codec, frameId, fragIndex, fragCount) and are reassembled by the receiver; this mutation sends ONE such fragment. Sustained video belongs on the binary realtime relay; this path works but is a mutation per fragment.

input ClientVideoPacketInput {
  appId: BigInt!
  chunk: ChunkCoordinatesInput!
  uuid: String!
  videoData: String!
  distance: Int
  decayRate: Int
  sequenceNumber: Int
}

Fields​

ClientVideoPacketInput.appId ● BigInt! non-null scalar​

The ID of the app where the video is being sent from.

ClientVideoPacketInput.chunk ● ChunkCoordinatesInput! non-null input​

The chunk coordinates where the video source is located.

ClientVideoPacketInput.uuid ● String! non-null scalar​

A unique identifier for the video source (typically the player UUID). Must be exactly 32 bytes when encoded as UTF-8.

ClientVideoPacketInput.videoData ● String! non-null scalar​

One video fragment, base64-encoded: the 6-byte fragment header followed by that slice of the encoded frame. Opaque to the server.

ClientVideoPacketInput.distance ● Int scalar​

Chunk replication distance (0-8). Defaults to 1 for video packets. Every receiver in range pays the egress bytes; keep this small.

ClientVideoPacketInput.decayRate ● Int scalar​

Decay algorithm for replication: 0 = none, 1 = exponential, 2 = linear 50%, 3 = linear 25%, 4 = linear 10%, 5 = linear 5%. Defaults to 0 (none) for video packets.

ClientVideoPacketInput.sequenceNumber ● Int scalar​

Client-assigned correlation id for this datagram: a uint8 (0-255) that wraps at gameClientBootstrap.sequenceNumberModulo (256); defaults to 0 if omitted. For CORRELATION ONLY — it is NOT an idempotency key and the server does not dedupe replays. Echoed on any GenericErrorResponse for this send, delivered on the udpNotifications subscription.

Member Of​

sendVideoPacket mutation