Client

class Client(steamClient: SteamClient) : Closeable

The Client class is used for downloading game content from the Steam servers.

Parameters

steamClient

The SteamClient this instance will be associated with. The SteamClient instance must be connected and logged onto Steam.

Constructors

Link copied to clipboard
constructor(steamClient: SteamClient)

Initializes a new instance of the Client class.

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open override fun close()

Disposes of this object.

Link copied to clipboard
suspend fun downloadDepotChunk(depotId: Int, chunk: ChunkData, server: Server, destination: ByteArray, depotKey: ByteArray? = null, proxyServer: Server? = null, cdnAuthToken: String? = null): Int

Downloads the specified depot chunk, and optionally processes the chunk and verifies the checksum if the depot decryption key has been provided. This function will also validate the length of the downloaded chunk with the value of ChunkData.compressedLength, if it has been assigned a value.

Link copied to clipboard
fun downloadDepotChunkFuture(depotId: Int, chunk: ChunkData, server: Server, destination: ByteArray, depotKey: ByteArray? = null, proxyServer: Server? = null, cdnAuthToken: String? = null): CompletableFuture<Int>

Java Compat: Downloads the specified depot chunk, and optionally processes the chunk and verifies the checksum if the depot decryption key has been provided. This function will also validate the length of the downloaded chunk with the value of ChunkData.compressedLength, if it has been assigned a value.

Link copied to clipboard
suspend fun downloadManifest(depotId: Int, manifestId: Long, manifestRequestCode: ULong, server: Server, depotKey: ByteArray? = null, proxyServer: Server? = null, cdnAuthToken: String? = null): DepotManifest

Downloads the depot manifest specified by the given manifest ID, and optionally decrypts the manifest's filenames if the depot decryption key has been provided.

Link copied to clipboard
fun downloadManifestFuture(depotId: Int, manifestId: Long, manifestRequestCode: Long, server: Server, depotKey: ByteArray? = null, proxyServer: Server? = null, cdnAuthToken: String? = null): CompletableFuture<DepotManifest>

Java Compat: Downloads the depot manifest specified by the given manifest ID, and optionally decrypts the manifest's filenames if the depot decryption key has been provided.